[Cases] Support bulk creating cases though the cases client #170326

cnasikas · 2023-11-01T16:06:44Z

Summary

This PR extends the cases client to support bulk-creating cases. It is needed by the case action.

Checklist

Delete any items that are not applicable to this PR.

Unit or functional tests were updated or added to match the most common scenarios

For maintainers

This was checked for breaking API changes and was labeled appropriately

cnasikas · 2023-11-06T09:04:24Z

x-pack/plugins/cases/server/services/attachments/test_utils.ts

@@ -22,19 +22,6 @@ import {
 } from '../../../common/constants';
 import { CASE_REF_NAME, EXTERNAL_REFERENCE_REF_NAME } from '../../common/constants';

-export const createErrorSO = () =>


Moved to the upper level.

cnasikas · 2023-11-06T09:07:09Z

x-pack/plugins/cases/common/types/api/case/v1.ts

+
+export const CaseCreateRequestWithOptionalId = rt.intersection([
+  CasePostRequestRt,
+  rt.exact(rt.partial({ id: rt.string })),


The case action needs to provide the ids of the cases.

cnasikas · 2023-11-06T09:11:58Z

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

-    payload,
-    connectorId,
-    attachmentId,
+    userAction,


Small refactor to separate the data from the options.

This was a bit confusing in the PR 😅 Does it actually affect the changes you will need for the subactions?

cnasikas · 2023-11-06T09:13:33Z

x-pack/test/cases_api_integration/common/plugins/cases/server/routes.ts

+
+  router.post(
+    {
+      path: '/api/cases_fixture/cases:bulkCreate',


Testing route to test the bulk create cases method.

elasticmachine · 2023-11-06T09:16:13Z

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

elasticmachine · 2023-11-06T09:16:15Z

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

adcoelho

lgtm, left a few comments 👍

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

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

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

adcoelho · 2023-11-06T12:00:09Z

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

+      saved_objects: [caseSO],
+    });
+
+    it('sets an ID if not provided', async () => {


nit: I find this test name a bit confusing. Is this what we wanna test under authorization? Or rather that ensureAuth is called?

With this test we want to test this line id: theCase.id ?? SavedObjectsUtils.generateId(),. Any suggestions for the name?

With this test we want to test this line id: theCase.id ?? SavedObjectsUtils.generateId(),.

But that is basically 'sets an ID if not provided' on line 199.

I was asking because this is inside describe('authorization', () => { so I was thinking something like ensureAuthorized is called with the right params.

But not a big deal, ill leave it up to you

sets a custom ID correctly tests the theCase.id and sets an ID if not provided test the SavedObjectsUtils.generateId() part. I will rename it to something like it generates an ID if not provided in the request. Does it make sense?

Ok, I just noticed what is going on. Sorry my bad. Inside describe('authorization' the title is wrong. Inside describe('execution' the titles are correct. In describe('authorization' I am testing a different think. I am going to fix the title.

adcoelho · 2023-11-06T12:08:59Z

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

+    }
+
+    for (const theCase of casesSOs) {
+      const userActionPayload: CasePostRequest = {


Should this now be CaseCreateRequestWithOptionalId?

The user action does not accept the ID of the case in the payload. This is why I used the CasePostRequest.

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

adcoelho · 2023-11-06T13:23:18Z

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

-    payload,
-    connectorId,
-    attachmentId,
+    userAction,


This was a bit confusing in the PR 😅 Does it actually affect the changes you will need for the subactions?

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

adcoelho · 2023-11-06T13:27:41Z

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

      }
    } catch (error) {
      this.context.log.error(`Error on creating user action of type: ${type}. Error: ${error}`);
      throw error;
    }
  }

+  public async bulkCreateUserAction<T extends keyof BuilderParameters>({


Could you add some tests for this function? (x-pack/plugins/cases/server/services/user_actions/operations/create.test.ts)

Thanks, I totally missed that.

adcoelho · 2023-11-06T13:35:28Z

x-pack/test/cases_api_integration/security_and_spaces/tests/common/cases/bulk_create_cases.ts

+   *
+   * The test route is configured here x-pack/test/cases_api_integration/common/plugins/cases/server/routes.ts
+   */
+  describe('bulk_create_cases', () => {


Maybe we could include a test for the assignees/platinum license logic. I also didn't see any(for existing similar logic) in x-pack/test/cases_api_integration/security_and_spaces/tests/common/cases/post_case.ts.

I thought the unit test would be sufficient. Do you prefer an integration test?

cnasikas · 2023-11-06T15:58:25Z

This was a bit confusing in the PR 😅 Does it actually affect the changes you will need for the subactions?

No, but I could not stand it anymore hahahaha. Sorry for the confusion.

jcger · 2023-11-07T08:23:33Z

x-pack/plugins/cases/common/types/api/case/v1.ts

+]);
+
+export const BulkCreateCasesRequestRt = rt.strict({
+  cases: rt.array(CaseCreateRequestWithOptionalId),


I really like the API contract as by default I would have thought about just an array of cases.

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

jcger · 2023-11-07T08:43:36Z

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

+        };
+      });
+
+      const bulkCreateResponse =


I'm missing a test to check the right behaviour when the user wants to create two cases but the second one fails

There is a test in x-pack/plugins/cases/server/services/cases/index.test.ts called return cases with the SO errors correctly that tests this behavior. Do you have something else in mind?

sorry, missed it, that was it

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

cnasikas · 2023-11-07T17:18:27Z

@elasticmachine merge upstream

kibana-ci · 2023-11-07T18:32:56Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: cf7f8e5

Failed CI Steps

Defend Workflows Cypress Tests on Serverless #4

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`	155.1KB	155.2KB	+118.0B

History

💔 Build #173785 failed f3115f0
💛 Build #173581 was flaky 9656f10
💚 Build #173386 succeeded c0525fd
💛 Build #173341 was flaky 2740099
💔 Build #173332 failed fc78f28

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

cc @cnasikas

## Summary Depends on: #166267, #170326, #169484, #173740, #173763, #178068, #178307, #178600, #180437 PRs: - #168370 - #169229 - #171754 - #172709 - #173012 - #175107 - #175452 - #175505 - #177033 - #178277 - #177139 - #179796 Fixes: #153837 ## Testing Run Kibana with `--run-examples` if you want to use the "Always firing" rule. Create a rule with a case action in observability and the stack. The security solution is not supported. You should not be able to assign a case action in a security solution rule. 1. Test the "Reopen closed cases" configuration. 2. Test the "Grouping by" configuration. Only one field is allowed. Not all fields are persisted in alerts. If you select a field not part of the alert the case action will create a case where the grouping value is set to `unknow`. 3. Test the "Time window" feature. You can comment out the validation to test for shorter times. 4. Verify that the case action is experimental. 5. Verify that based on the rule type the case is created in the correct solution. 6. Verify that you cannot create a rule with the case action on the basic license. 7. Verify that the execution of the case action fails if you do not have permission for cases. Pending work on the system actions framework level to not allow users to create rules with system actions where they do not have permission. 8. Stress test the case action by creating multiple rules. ### 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 ### For maintainers - [x] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ## Release notes Automatically create cases when an alert is triggered. --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: adcoelho <[email protected]> Co-authored-by: Janki Salvi <[email protected]>

cnasikas added 5 commits November 1, 2023 17:59

Rename notification service types

3d72b68

Case service: bulk create cases

797e88a

User action service: bulk create user actions

2582525

Case client: bulk create cases

4817093

Add integration tests

8cd4830

cnasikas added Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Feature:Cases Cases feature v8.12.0 labels Nov 1, 2023

cnasikas self-assigned this Nov 1, 2023

cnasikas mentioned this pull request Nov 1, 2023

[Cases] Case action #168369

Merged

3 tasks

cnasikas added the release_note:skip Skip the PR/issue when compiling release notes label Nov 1, 2023

cnasikas added 4 commits November 3, 2023 16:42

Merge branch 'main' into ca_bulk_create

af6784c

Add test for the case service

dca7e81

Add test for the cases client

fc78f28

Fix tests and types

2740099

cnasikas commented Nov 6, 2023

View reviewed changes

Minor improvements

17c0df5

cnasikas marked this pull request as ready for review November 6, 2023 09:16

cnasikas requested a review from a team as a code owner November 6, 2023 09:16

Merge branch 'main' into ca_bulk_create

c0525fd

adcoelho approved these changes Nov 6, 2023

View reviewed changes

Merge branch 'main' into ca_bulk_create

98fcb2f

PR feedback

9656f10

jcger reviewed Nov 7, 2023

View reviewed changes

PR feedback

f3115f0

jcger approved these changes Nov 7, 2023

View reviewed changes

cnasikas enabled auto-merge (squash) November 7, 2023 17:15

Merge branch 'main' into ca_bulk_create

cf7f8e5

cnasikas merged commit 30e6677 into elastic:main Nov 7, 2023

cnasikas deleted the ca_bulk_create branch November 7, 2023 18:32

kibanamachine added the backport:skip This commit does not require backporting label Nov 7, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Cases] Support bulk creating cases though the cases client #170326

[Cases] Support bulk creating cases though the cases client #170326

cnasikas commented Nov 1, 2023

cnasikas Nov 6, 2023

cnasikas Nov 6, 2023

cnasikas Nov 6, 2023

adcoelho Nov 6, 2023

cnasikas Nov 6, 2023

elasticmachine commented Nov 6, 2023

elasticmachine commented Nov 6, 2023

adcoelho left a comment

adcoelho Nov 6, 2023

cnasikas Nov 6, 2023

adcoelho Nov 6, 2023

cnasikas Nov 6, 2023 •

edited

Loading

cnasikas Nov 6, 2023

adcoelho Nov 6, 2023

cnasikas Nov 6, 2023

adcoelho Nov 6, 2023

adcoelho Nov 6, 2023

cnasikas Nov 6, 2023

adcoelho Nov 6, 2023 •

edited

Loading

cnasikas Nov 6, 2023

cnasikas commented Nov 6, 2023

jcger Nov 7, 2023

jcger Nov 7, 2023

cnasikas Nov 7, 2023

jcger Nov 7, 2023

cnasikas commented Nov 7, 2023

kibana-ci commented Nov 7, 2023

[Cases] Support bulk creating cases though the cases client #170326

[Cases] Support bulk creating cases though the cases client #170326

Conversation

cnasikas commented Nov 1, 2023

Summary

Checklist

For maintainers

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

elasticmachine commented Nov 6, 2023

elasticmachine commented Nov 6, 2023

adcoelho 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

cnasikas Nov 6, 2023 • edited Loading

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

adcoelho Nov 6, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cnasikas commented Nov 6, 2023

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 commented Nov 7, 2023

kibana-ci commented Nov 7, 2023

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Page load bundle

History

cnasikas Nov 6, 2023 •

edited

Loading

adcoelho Nov 6, 2023 •

edited

Loading