[Cases] Restrict the Find Comment API query params by adcoelho · Pull Request #156863 · elastic/kibana

adcoelho · 2023-05-05T13:42:51Z

Fixes #155983

Summary

This PR changes the accepted params for the Find Comments API to be only perPage, page and sort_order.

…-api-params

…-fix'

…-ref HEAD~1..HEAD --fix'

elasticmachine · 2023-05-09T08:52:41Z

Pinging @elastic/response-ops (Team:ResponseOps)

elasticmachine · 2023-05-09T08:52:43Z

Pinging @elastic/response-ops-cases (Feature:Cases)

cnasikas

Great job. I left some comments.

Avoid spread notation in find comments.

New tests for validation.

…-api-params

adcoelho · 2023-05-16T14:42:52Z

@elasticmachine merge upstream

lcawl

Docs LGTM

jonathan-buttner

Looking good, left a few comments. How about we switch the integration tests to use the helper functions that we have?

jonathan-buttner · 2023-05-16T15:46:53Z

+  if (
+    queryParams?.page &&
+    queryParams?.perPage &&
+    queryParams?.page * queryParams?.perPage > MAX_DOCS_PER_PAGE


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?

jonathan-buttner · 2023-05-16T15:49:40Z

+      // post 5 comments of all possible types
      await supertest
-        .post(`${CASES_URL}/${postedCase.id}/comments`)
+        .post(INTERNAL_BULK_CREATE_ATTACHMENTS_URL.replace('{case_id}', postedCase.id))


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

jonathan-buttner · 2023-05-16T15:51:00Z

        .expect(200);

-      const { body: patchedCase } = await supertest
+      const { body: caseComments } = await supertest


Let's use the helper here: https://github.com/elastic/kibana/blob/main/x-pack/test/cases_api_integration/common/lib/api/attachments.ts#L286

jonathan-buttner · 2023-05-16T15:51:54Z

    });

-    it('unhappy path - 400s when query is bad', async () => {
+    it('unhappy path - 400s when total items invalid', async () => {


Can we add a test when page is 0?

kibana-ci · 2023-05-16T16:25:55Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 0704e1e

Failed CI Steps

FTR Configs #1

Metrics [docs]

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`cases`	166.2KB	166.0KB	-210.0B

Unknown metric groups

ESLint disabled line counts

id	before	after	diff
`enterpriseSearch`	19	21	+2
`securitySolution`	400	404	+4
total			+6

Total ESLint disabled count

id	before	after	diff
`enterpriseSearch`	20	22	+2
`securitySolution`	480	484	+4
total			+6

History

💚 Build #128201 succeeded 7eb455c
💔 Build #128121 failed 8f50e8e
💔 Build #126479 failed 009849a
💔 Build #126465 failed 68e44f8
💔 Build #126374 failed 50d34bb
💔 Build #126321 failed a051353

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @adcoelho

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>

## 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.

## Summary Updated cases API docs to address: - Removed alert reference in find comment api. Related: #156863 - Updated response schema and examples - existing response uses full case response, which is not correct - Removed `includeComment` param in get case api. [it is always false for public api](https://github.com/elastic/kibana/blob/ab858f5d9f3f91104b083c5b6d31363e41804828/x-pack/platform/plugins/shared/cases/server/routes/api/cases/get_case.ts#L40-L42) but the response example contains comments, related: #207739 - Included `extractObservables` to case request and response - Fixed typos ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) - [x] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

## Summary Updated cases API docs to address: - Removed alert reference in find comment api. Related: elastic#156863 - Updated response schema and examples - existing response uses full case response, which is not correct - Removed `includeComment` param in get case api. [it is always false for public api](https://github.com/elastic/kibana/blob/ab858f5d9f3f91104b083c5b6d31363e41804828/x-pack/platform/plugins/shared/cases/server/routes/api/cases/get_case.ts#L40-L42) but the response example contains comments, related: elastic#207739 - Included `extractObservables` to case request and response - Fixed typos ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) - [x] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

adcoelho added 2 commits May 5, 2023 15:31

Limit FindCommentsQueryParams.

2d6ca8f

Merge remote-tracking branch 'upstream/main' into limit-find-comments…

48e616c

…-api-params

adcoelho added release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// Feature:Cases Cases feature v8.9.0 labels May 5, 2023

adcoelho self-assigned this May 5, 2023

adcoelho commented May 5, 2023

View reviewed changes

Comment thread x-pack/plugins/cases/common/api/saved_object.ts

adcoelho commented May 5, 2023

View reviewed changes

Comment thread x-pack/plugins/cases/server/client/attachments/get.ts

adcoelho commented May 5, 2023

View reviewed changes

Comment thread x-pack/plugins/cases/server/client/utils.ts Outdated

adcoelho added 5 commits May 8, 2023 11:13

Merge remote-tracking branch 'upstream/main' into limit-find-comments…

a4e303b

…-api-params

Remove type option from find Comments api.

f8b35a5

Merge remote-tracking branch 'upstream/main' into limit-find-comments…

1f5ec7f

…-api-params

attachmentService.find instead of getAllComments

c44a13c

Remove test from changed API.

475c731

adcoelho force-pushed the limit-find-comments-api-params branch from e21af7b to 475c731 Compare May 8, 2023 10:58

adcoelho and others added 13 commits May 8, 2023 14:15

Fix failing tests.

7719341

Merge remote-tracking branch 'upstream/main' into limit-find-comments…

d7dddb5

…-api-params

Add tests.

0fb164f

Added OpenAPI documentation for find comments.

cf49f50

Merge remote-tracking branch 'upstream/main' into limit-find-comments…

e7b5261

…-api-params

Search parameter is not available anymore.

d9cddaf

Merge remote-tracking branch 'upstream/main' into limit-find-comments…

2f7ee6b

…-api-params

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

da58862

…-fix'

[DOCS] Add new path specification for find comments

4ea3968

[DOCS] Generate docs for find case comments

a051353

Delete outdated test.

933e9bf

[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…

50d34bb

…-ref HEAD~1..HEAD --fix'

Merge branch 'main' into limit-find-comments-api-params

68e44f8

adcoelho marked this pull request as ready for review May 9, 2023 08:52

adcoelho requested review from a team as code owners May 9, 2023 08:52

Merge branch 'main' into limit-find-comments-api-params

009849a

cnasikas reviewed May 10, 2023

View reviewed changes

jonathan-buttner reviewed May 11, 2023

View reviewed changes

Comment thread x-pack/plugins/cases/server/client/attachments/get.ts

Comment thread x-pack/plugins/cases/server/client/attachments/get.ts

adcoelho added 4 commits May 16, 2023 18:47

Bulk create attachments in test.

8f50e8e

Avoid spread notation in find comments.

Add validation to findComments.

f670d15

New tests for validation.

Merge remote-tracking branch 'upstream/main' into limit-find-comments…

3d6174b

…-api-params

Fixed failing FTR.

7eb455c

adcoelho enabled auto-merge (squash) May 16, 2023 14:42

kibanamachine and others added 2 commits May 16, 2023 10:42

Merge branch 'main' into limit-find-comments-api-params

1122d15

[DOCS] Add descriptions and reuse new parameter definitions

0704e1e

lcawl approved these changes May 16, 2023

View reviewed changes

jonathan-buttner reviewed May 16, 2023

View reviewed changes

adcoelho merged commit 927743a into elastic:main May 16, 2023

kibanamachine added the backport:skip This PR does not require backporting label May 16, 2023

cnasikas mentioned this pull request May 17, 2023

[Cases] findComments small fix and updated tests #157977

Merged

christineweng mentioned this pull request Mar 9, 2026

[Cases] Update cases api docs #256805

Merged

8 tasks

Conversation

adcoelho commented May 5, 2023 • edited by cnasikas Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

Uh oh!

Uh oh!

Uh oh!

elasticmachine commented May 9, 2023

Uh oh!

elasticmachine commented May 9, 2023

Uh oh!

cnasikas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adcoelho commented May 16, 2023

Uh oh!

lcawl left a comment

Choose a reason for hiding this comment

Uh oh!

jonathan-buttner left a comment

Choose a reason for hiding this comment

Uh oh!

jonathan-buttner May 16, 2023

Choose a reason for hiding this comment

Uh oh!

jonathan-buttner May 16, 2023

Choose a reason for hiding this comment

Uh oh!

jonathan-buttner May 16, 2023

Choose a reason for hiding this comment

Uh oh!

jonathan-buttner May 16, 2023

Choose a reason for hiding this comment

Uh oh!

kibana-ci commented May 16, 2023

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Page load bundle

ESLint disabled line counts

Total ESLint disabled count

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

adcoelho commented May 5, 2023 •

edited by cnasikas

Loading