Feature/wb-41: GET for attack-objects by new 'users' parameter

elegantmoose commented 1 year ago

Adds additional parameter to GET /attack-objects controller to allow the GET request to specify users to filter retrieved att&Ck objects on.
Added test for single case of a user creating an attack-object, and then getting that attack-object back, given there are many other attack-objects in the database.
- Attempted to add test for multiple users creating objects and then doing a multi user GET for the objects, however test became larger LOE with trying to login and logout in test setup with different users. *Can pursue this test case if desired, just was taking longer than expected, and diminishing utility so simple test case.
Added REST API docs for 'users' parameter.

codecov[bot] commented 1 year ago

Codecov Report

Patch coverage: 50.00% and project coverage change: +0.09 :tada:

Comparison is base (79fbef7) 55.31% compared to head (ebcda9b) 55.41%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## develop #250 +/- ## =========================================== + Coverage 55.31% 55.41% +0.09% =========================================== Files 114 114 Lines 6405 6410 +5 Branches 1335 1337 +2 =========================================== + Hits 3543 3552 +9 + Misses 2140 2138 -2 + Partials 722 720 -2 ``` | [Impacted Files](https://app.codecov.io/gh/center-for-threat-informed-defense/attack-workbench-rest-api/pull/250?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=center-for-threat-informed-defense) | Coverage Δ | | |---|---|---| | [app/controllers/relationships-controller.js](https://app.codecov.io/gh/center-for-threat-informed-defense/attack-workbench-rest-api/pull/250?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=center-for-threat-informed-defense#diff-YXBwL2NvbnRyb2xsZXJzL3JlbGF0aW9uc2hpcHMtY29udHJvbGxlci5qcw==) | `56.25% <ø> (ø)` | | | [app/services/attack-objects-service.js](https://app.codecov.io/gh/center-for-threat-informed-defense/attack-workbench-rest-api/pull/250?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=center-for-threat-informed-defense#diff-YXBwL3NlcnZpY2VzL2F0dGFjay1vYmplY3RzLXNlcnZpY2UuanM=) | `67.36% <ø> (+2.10%)` | :arrow_up: | | [app/services/relationships-service.js](https://app.codecov.io/gh/center-for-threat-informed-defense/attack-workbench-rest-api/pull/250?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=center-for-threat-informed-defense#diff-YXBwL3NlcnZpY2VzL3JlbGF0aW9uc2hpcHMtc2VydmljZS5qcw==) | `50.23% <50.00%> (-0.01%)` | :arrow_down: | ... and [3 files with indirect coverage changes](https://app.codecov.io/gh/center-for-threat-informed-defense/attack-workbench-rest-api/pull/250/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=center-for-threat-informed-defense)

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

ElJocko commented 1 year ago

Hey Michael -

There's some overlap here with the PR that Vince created. Please make the following changes so that everything is lined up:

The changes in this PR for attack-objects-paths.yml, attack-objects-controller.js, and attack-objects-service.js are redundant with the previous PR and can be removed
In relationships-paths.yml, relationships-controller.js, and relationships-service.js, update the name of the query parameter to be lastUpdatedBy
In relationships-paths.yml change the schema for the new query parameter from type: string to
```
        oneOf:
          - type: string
          - type: array
            items:
              type: string
```
(this allows the query parameter to be either a string or an array of strings, which the rest of your new code already supports)
Let's keep the test you created for the attack objects query parameter, but change the query parameter from users to lastUpdatedBy

elegantmoose commented 1 year ago

@clemiller - After making the requested changes from @ElJocko , it looks like the get-objects call will now return relationship objects as well, whereas before just the attack-objects. Does this mess up your use case @clemiller ?

Update: --> Belay. vscode wasnt using newer file changes...