[Cases] Restrict the Find Comment API query params #156863
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adcoelho
added
release_note:skip
adcoelho
commented
May 5, 2023
adcoelho
commented
May 5, 2023
adcoelho
commented
May 5, 2023
adcoelho
force-pushed
the
limit-find-comments-api-params
branch
from
e21af7b
to
475c731
Compare
…-ref HEAD~1..HEAD --fix'
|
Pinging @elastic/response-ops (Team:ResponseOps) |
|
Pinging @elastic/response-ops-cases (Feature:Cases) |
cnasikas
reviewed
May 10, 2023
x-pack/plugins/cases/docs/openapi/paths/s@{spaceid}@api@cases@{caseid}@comments@_find.yaml
Show resolved
Hide resolved
x-pack/test/cases_api_integration/security_and_spaces/tests/common/comments/find_comments.ts
Outdated
Show resolved
Hide resolved
Avoid spread notation in find comments.
New tests for validation.
|
@elasticmachine merge upstream |
| if ( | ||
| queryParams?.page && | ||
| queryParams?.perPage && | ||
| queryParams?.page * queryParams?.perPage > MAX_DOCS_PER_PAGE |
There was a problem hiding this comment.
queryParams.page can be 0 right? If it is 0 and perPage is 1 million we'll still want to throw. Also if queryParams.page was 0 it is falsy right?
| await supertest | ||
| .post(`${CASES_URL}/${postedCase.id}/comments`) | ||
| .post(INTERNAL_BULK_CREATE_ATTACHMENTS_URL.replace('{case_id}', postedCase.id)) |
There was a problem hiding this comment.
Let's use the helper function here: https://github.com/elastic/kibana/blob/main/x-pack/test/cases_api_integration/common/lib/api/attachments.ts#L82
| .expect(200); | ||
|
|
||
| const { body: patchedCase } = await supertest | ||
| const { body: caseComments } = await supertest |
There was a problem hiding this comment.
| }); | ||
|
|
||
| it('unhappy path - 400s when query is bad', async () => { | ||
| it('unhappy path - 400s when total items invalid', async () => { |
There was a problem hiding this comment.
Can we add a test when page is 0?
💛 Build succeeded, but was flaky
Failed CI StepsMetrics [docs]Page load bundle
Unknown metric groupsESLint disabled line counts
Total ESLint disabled count
History
To update your PR or re-run it, just comment with: cc @adcoelho |
jasonrhodes
pushed a commit
that referenced
this pull request
May 17, 2023
Fixes #155983 ## Summary This PR changes the accepted params for the Find Comments API to be only `perPage`, `page` and `sort_order`. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: lcawl <lcawley@elastic.co>
adcoelho
added a commit
that referenced
this pull request
May 17, 2023
## Summary [This PR was merged too soon](#156863). (my bad, I pressed merged automatically and some comments showed up afterwards). I am addressing them now. Basically: 1. Check for possible 0 as `page` query param in the `findComments` API. 2. Use the test utils in the `findComments` tests. I also deleted a test that was duplicated and used the same utils in every test not just the one connected to the PR comment.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #155983
Summary
This PR changes the accepted params for the Find Comments API to be only
perPage,pageandsort_order.