[Cases] Total number of user actions on a case. #161848

adcoelho · 2023-07-13T10:42:34Z

Connected to #146945

Summary

Description	Limit	Done?	Documented?
Total number of user actions and comments combined on a case	10000	✅	No

Checklist

Delete any items that are not applicable to this PR.

Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios

Release Notes

Updating a case will now fail if the operation makes it reach more than 10000 user actions.

Tests.

adcoelho · 2023-07-17T09:52:52Z

x-pack/plugins/cases/server/services/user_actions/operations/create.ts

-  }: BulkCreateBulkUpdateCaseUserActions): Promise<void> {
-    const builtUserActions = updatedCases.reduce<UserActionEvent[]>((acc, updatedCase) => {
-      const originalCase = originalCases.find(({ id }) => id === updatedCase.id);
+  public buildUserActions({ updatedCases, user }: BuildUserActionsDictParams): UserActionsDict {


An UserActionsDict is a dictionary where the key is the caseId and the value is an array of all user actions to be created.

This will help us during the validation where we can check for each case independently if they will break the limit.

adcoelho · 2023-07-17T09:54:23Z

x-pack/plugins/cases/server/client/cases/update.ts

+  userActionsDict: UserActionsDict;
+  userActionService: CaseUserActionService;
+}) {
+  const result = await userActionService.getMultipleCasesUserActionsTotal({


Do the aggregation for each case being updated.

adcoelho · 2023-07-17T09:54:54Z

x-pack/plugins/cases/server/client/cases/update.ts

+    caseIds: Object.keys(userActionsDict),
+  });
+
+  result.aggregations?.references.caseUserActions.buckets.forEach(


For each case check if the result of the aggregation + the user actions to be created is bigger than the max allowed value.

Does this mean once reaching maximum limit user can't delete or update the existing comment?

…comments

cnasikas

Great job with splitting the logic of the creation of user actions. I did a review only of the code. I will do another pass when the PR is ready for review.

x-pack/plugins/cases/common/utils/validators.ts

x-pack/plugins/cases/server/services/user_actions/types.ts

elasticmachine · 2023-07-19T14:59:44Z

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

elasticmachine · 2023-07-19T14:59:47Z

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

Additional tests.

…comments

js-jankisalvi

Complex validation 😅 , great work 👍

js-jankisalvi · 2023-07-20T16:29:52Z

x-pack/plugins/cases/server/services/user_actions/index.test.ts

@@ -500,13 +504,73 @@ describe('CaseUserActionService', () => {
      });
    });

+    describe('buildUserActions', () => {


great work with tests and mocks 🎉

Thank you, it was such a headache 😅

…comments

cnasikas

Great job 🚀!

x-pack/plugins/cases/common/utils/validators.test.ts

x-pack/plugins/cases/server/client/cases/update.test.ts

cnasikas · 2023-07-26T10:50:46Z

x-pack/plugins/cases/server/client/cases/update.test.ts

Could you please add a test where you check updating multiple cases with multiple attributes to update? Some cases should fail and some of them not.

Just to make sure I understood

Some cases should fail and some of them not.

but the call is expected to fail right? because some cases in the payload will hit the limit

I pushed some changes, is this what you had in mind?

Yes, this is what I have in mind, thanks!

x-pack/plugins/cases/server/services/user_actions/index.test.ts

cnasikas · 2023-07-26T12:48:49Z

x-pack/plugins/cases/server/services/user_actions/operations/create.test.ts

@@ -141,4 +164,59 @@ describe('UserActionPersister', () => {
      });
    });
  });
+
+  describe('buildUserActions', () => {


Should we test more user action types?

Which ones?

All tests have different payloads and:

patchCasesRequest changes status, title, connector, and category.

patchAssigneesCasesRequest, patchRemoveAssigneesCasesRequest and patchAddRemoveAssigneesCasesRequest handle the assignees

and patchTagsCasesRequest the tags user actions

Oh, I missed that the patchCasesRequest contains all these changes. It is difficult to verify the tests without having inline snapshots. Thanks!

…comments

kibana-ci · 2023-07-27T14:20:02Z

💚 Build Succeeded

Buildkite Build
Commit: 0a82897

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`cases`	664	665	+1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`cases`	421.5KB	421.6KB	+27.0B

Page load bundle

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

id	before	after	diff
`cases`	150.5KB	150.5KB	+43.0B

History

💚 Build #144614 succeeded 08900bc
💔 Build #144545 failed bfb48c4
💔 Build #144270 failed bbbd345
💔 Build #143959 failed 4ac707b
💔 Build #143906 failed 2d8faf5
💔 Build #143868 failed bed38e5

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

cc @adcoelho

Connected to elastic#146945 ## Summary | Description | Limit | Done? | Documented? | ------------- | ---- | :---: | ---- | | Total number of user actions and comments combined on a case | 10000 | ✅ | No | ### Checklist Delete any items that are not applicable to this PR. - [x] [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 ### Release Notes Updating a case will now fail if the operation makes it reach more than 10000 user actions.

adcoelho added release_note:breaking Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Feature:Cases Cases feature v8.10.0 labels Jul 13, 2023

adcoelho self-assigned this Jul 13, 2023

adcoelho added 2 commits July 14, 2023 15:13

Validate max user actions.

1d90526

Restructure userAction creation on patch case.

eba58af

Tests.

adcoelho force-pushed the total-user-actions-comments branch from e85a59a to eba58af Compare July 14, 2023 13:16

adcoelho commented Jul 17, 2023

View reviewed changes

adcoelho added 4 commits July 17, 2023 11:58

Fix bulk create attachments.

7a357af

Merge remote-tracking branch 'upstream/main' into total-user-actions-…

ded4d5c

…comments

Merge remote-tracking branch 'upstream/main' into total-user-actions-…

16ed448

…comments

Check if userActionsDict is undefined.

e2490f2

cnasikas reviewed Jul 18, 2023

View reviewed changes

x-pack/plugins/cases/common/utils/validators.ts Outdated Show resolved Hide resolved

x-pack/plugins/cases/common/utils/validators.ts Outdated Show resolved Hide resolved

x-pack/plugins/cases/server/services/user_actions/types.ts Show resolved Hide resolved

cnasikas mentioned this pull request Jul 19, 2023

[Cases] Guardrails in Cases APIs #146945

Closed

Tests.

abf156f

adcoelho marked this pull request as ready for review July 19, 2023 14:59

adcoelho requested a review from a team as a code owner July 19, 2023 14:59

adcoelho added 5 commits July 20, 2023 14:19

Addressing PR comments.

c84abca

Additional tests.

Merge remote-tracking branch 'upstream/main' into total-user-actions-…

bed38e5

…comments

New Tests.

0d581f9

Merge remote-tracking branch 'upstream/main' into total-user-actions-…

2d8faf5

…comments

Merge branch 'main' into total-user-actions-comments

4ac707b

js-jankisalvi reviewed Jul 20, 2023

View reviewed changes

adcoelho added 2 commits July 24, 2023 14:02

Merge remote-tracking branch 'upstream/main' into total-user-actions-…

bbbd345

…comments

Merge remote-tracking branch 'upstream/main' into total-user-actions-…

bfb48c4

…comments

Fix failing test.

08900bc

cnasikas approved these changes Jul 26, 2023

View reviewed changes

adcoelho added 2 commits July 27, 2023 14:49

Merge remote-tracking branch 'upstream/main' into total-user-actions-…

2d1a641

…comments

Addressing PR comments

0a82897

adcoelho merged commit 33195fb into elastic:main Jul 27, 2023

kibanamachine added the backport:skip This commit does not require backporting label Jul 27, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Cases] Total number of user actions on a case. #161848

[Cases] Total number of user actions on a case. #161848

adcoelho commented Jul 13, 2023

adcoelho Jul 17, 2023

adcoelho Jul 17, 2023

adcoelho Jul 17, 2023

js-jankisalvi Jul 20, 2023

cnasikas left a comment

elasticmachine commented Jul 19, 2023

elasticmachine commented Jul 19, 2023

js-jankisalvi left a comment

js-jankisalvi Jul 20, 2023

adcoelho Jul 24, 2023

cnasikas left a comment

cnasikas Jul 26, 2023

adcoelho Jul 27, 2023

adcoelho Jul 27, 2023

cnasikas Jul 27, 2023

cnasikas Jul 26, 2023

adcoelho Jul 27, 2023

cnasikas Jul 27, 2023

kibana-ci commented Jul 27, 2023

[Cases] Total number of user actions on a case. #161848

[Cases] Total number of user actions on a case. #161848

Conversation

adcoelho commented Jul 13, 2023

Summary

Checklist

Release Notes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cnasikas left a comment

Choose a reason for hiding this comment

elasticmachine commented Jul 19, 2023

elasticmachine commented Jul 19, 2023

js-jankisalvi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cnasikas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kibana-ci commented Jul 27, 2023

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

History