[Cases] API to return a case's connectors information #147295

jonathan-buttner · 2022-12-08T21:46:03Z

This PR implements a new internal API to return the information relating to all the connectors used throughout a case's lifespan.

Fixes: #134346

GET http://localhost:5601/internal/cases/<case id>/_connectors

Response

{
    "my-jira": {
        "name": "preconfigured-jira",
        "type": ".jira",
        "fields": {
            "issueType": "10001",
            "parent": null,
            "priority": null
        },
        "id": "my-jira",
        "needsToBePushed": true,
        "hasBeenPushed": false
    }
}

cURL example

curl --location --request GET 'http://localhost:5601/internal/cases/ae038370-91d9-11ed-97ce-c35961718f7b/_connectors' \
--header 'kbn-xsrf: hello' \
--header 'Authorization: Basic <token>' \
--data-raw ''

Response

{
    "my-jira": {
        "name": "preconfigured-jira",
        "type": ".jira",
        "fields": {
            "issueType": "10001",
            "parent": null,
            "priority": null
        },
        "id": "my-jira",
        "needsToBePushed": true,
        "hasBeenPushed": false
    }
}

Notable changes:

Refactored the user actions service to move the functions that create user actions (builders etc) to its own class UserActionPersister
Refactored the CaseUserActionService class to pull the saved object client, logger, and other fields passed to each function via parameters to be wrapped in a context member field within the class
Plumbed in savedObjectsService.createSerializer to transform a raw elasticsearch document into the saved object representation
Added new internal _connectors route and getConnectors client function
Refactored the integration tests by extracting the connector related utility functions into their own file

Needs to be pushed algorithm

To determine whether a case needs to be pushed for a certain connector we follow this algorithm:

Get all unique connectors
- For each connector
  - Find the most recent user action contain the connector's fields, this will be in the most recent connector user action or if the connector was configured only once when the case was initially created it'll be on the create_case user action
  - Grab the most recent push user action if it exists
For each push search for the connector fields that were used in that push
Get the most recent user action that would cause a push to occur (title, description, tags, or comment change)
For each connector
- If a push does not exist, we need to push
- If a push exists but the fields do not match the field of the most recent connector fields, we need to push because the fields changed
- If the timestamp of the most recent user action is more recent than that of the last push (aka the user changed something since we last pushed) we need to push

…-fix'

…-api

…-fix'

jonathan-buttner · 2023-01-11T18:43:22Z

...bjects/core-saved-objects-api-server-internal/src/lib/aggregations/aggs_types/bucket_aggs.ts

@@ -61,6 +61,36 @@ const existsSchema = s.object({
    })
  ),
 });
+
+const rangeSchema = s.object({


These changes are needed for a filter used here: https://github.com/elastic/kibana/pull/147295/files#diff-94dd88fd0956fc92263b02e7ea005e640da97008a8c22d7acd8a13fe2eb11c70R161

jonathan-buttner · 2023-01-11T18:43:57Z

...bjects/core-saved-objects-api-server-internal/src/lib/aggregations/aggs_types/bucket_aggs.ts

+  ),
+});
+
+const termValueSchema = s.object({


These changes are needed for the filter used here: https://github.com/elastic/kibana/pull/147295/files#diff-94dd88fd0956fc92263b02e7ea005e640da97008a8c22d7acd8a13fe2eb11c70R174

jonathan-buttner · 2023-01-11T18:44:52Z

...bjects/core-saved-objects-api-server-internal/src/lib/aggregations/aggs_types/bucket_aggs.ts

+  term: s.recordOf(s.string(), s.object({ value: s.string() })),
+});
+
+const nestedSchema = s.object({


These changes are needed for the filter here: https://github.com/elastic/kibana/pull/147295/files#diff-94dd88fd0956fc92263b02e7ea005e640da97008a8c22d7acd8a13fe2eb11c70R168

jonathan-buttner · 2023-01-11T18:46:09Z

x-pack/plugins/cases/server/client/attachments/delete.ts

@@ -86,7 +86,7 @@ export async function deleteAll(
      concurrency: MAX_CONCURRENT_SEARCHES,
    });

-    await userActionService.bulkCreateAttachmentDeletion({
+    await userActionService.creator.bulkCreateAttachmentDeletion({


All methods related to creating a user action or audit logging were moved to a new class. This class is accessible through the original user action service class via the creator public accessor method.

jonathan-buttner · 2023-01-11T18:47:43Z

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

@@ -119,8 +120,11 @@ export class CasesClientFactory {
      excludedExtensions: [SECURITY_EXTENSION_ID],
    });

+    const savedObjectsSerializer = savedObjectsService.createSerializer();


We now use top hits aggregations that return a raw elasticsearch version of a saved object document. To interact with that document we need to convert it to a saved object. This serializer does the conversion for us so we're passing it through to the user action service.

jonathan-buttner · 2023-01-11T18:55:47Z

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

@@ -0,0 +1,428 @@
+/*


Shouldn't be any new functionality in here just the class structure and copied methods from the user action service.

jonathan-buttner · 2023-01-11T18:56:15Z

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

@@ -126,3 +134,24 @@ export type CommonBuilderArguments = CommonArguments & {
 export interface BuilderDeps {
  persistableStateAttachmentTypeRegistry: PersistableStateAttachmentTypeRegistry;
 }
+
+export interface ServiceContext {


Refactored the parameters to the user action service into this context interface

jonathan-buttner · 2023-01-11T18:56:59Z

x-pack/plugins/cases/tsconfig.json

@@ -52,6 +52,7 @@
    "@kbn/safer-lodash-set",
    "@kbn/logging-mocks",
    "@kbn/ecs",
+    "@kbn/core-saved-objects-base-server-mocks",


I think this is so we can get the mock for the serializer? I didn't add it explicitly, maybe vs code did 🤷‍♂️

jonathan-buttner · 2023-01-11T18:57:27Z

x-pack/test/cases_api_integration/common/lib/connectors.ts

@@ -0,0 +1,324 @@
+/*


Moved all the connector related utility functions for the integrations tests to this file

jonathan-buttner · 2023-01-11T18:58:16Z

x-pack/test/cases_api_integration/security_and_spaces/tests/trial/internal/get_connectors.ts

@@ -0,0 +1,676 @@
+/*


Integration tests for the new API are here

…-api

…ana into cases-connector-api

elasticmachine · 2023-01-11T20:15:20Z

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

elasticmachine · 2023-01-11T20:15:22Z

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

cnasikas

Code LGTM! Tested and is working as expected 🚀 . I left some nit comments.

cnasikas · 2023-01-16T10:20:54Z

x-pack/plugins/cases/server/client/user_actions/connectors.ts

+  const enrichedConnectors: EnrichedConnector[] = [];
+
+  for (const aggregationConnector of connectors) {
+    const connectorDetails = await actionsClient.get({ id: aggregationConnector.connectorId });


To my understanding the actionsClient do not provide a bulk get operation. Do you think it makes sense to do a Promise.all or it is too early to optimize? Another suggestion would be to not do the call at all and rely to the pushed info to get the name. This has the downside that the name would not get updated if the connector's name is updated (on the next push it will be updated). Also, could you please open an issue about adding the bulk get operation to the actionsClient?

Oh great point, looks like they do have a bulk get 🙌 I'll use that.

cnasikas · 2023-01-16T10:35:29Z

x-pack/plugins/cases/server/client/user_actions/connectors.ts

+  if (pushRequest.length <= 0) {
+    return new Map();
+  }


nit: should we move this check inside getConnectorFieldsUsedInPushes?

Great idea 👍

cnasikas · 2023-01-16T11:00:13Z

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

-type CreatePayloadFunction<Item, ActionType extends ActionTypeValues> = (
-  items: Item[]
-) => UserActionParameters<ActionType>['payload'];
+  public async getConnectorFieldsUsedInPushes(


nit: I found the name a bit confusing. To my understanding, this function returns the connector's fields before the latest push for each connector. What do you think about getConnectorFieldsBeforeLatestPush?

cnasikas · 2023-01-16T11:08:11Z

x-pack/plugins/cases/server/client/user_actions/connectors.ts

+
+    await checkConnectorsAuthorization({ authorization, connectors, latestUserAction });
+
+    const enrichedConnectors = await enrichConnectors({


I am wondering if it makes sense for the enrichConnectors to return the final response (GetCaseConnectorsResponseRt). What do you think?

…-api

kibana-ci · 2023-01-17T20:18:56Z

💚 Build Succeeded

Buildkite Build
Commit: 13972dc

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`	128.4KB	128.5KB	+151.0B

History

💚 Build #100174 succeeded 860142f
💚 Build #99664 succeeded 3ca464f
💔 Build #99606 failed 2804c40
💔 Build #99350 failed cd86aad
💔 Build #98971 failed 792a5e1
💔 Build #98472 failed 57fb9e5

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

## Summary This PR updates the UI to use the new connector's API introduced by this PR #147295. In this PR I refactor a bit some of the logic we have for the connectors. I left comments to explain the reasoning. ## Testing Please test the following: - The fields of each connector are preserved correctly when changing connectors - The following callout is shown when you do not have selected any connector <img width="784" alt="Screenshot 2023-01-23 at 2 21 33 PM" src="https://user-images.githubusercontent.com/7871006/214534706-5d447472-a40b-4fb4-aa4f-733bdcc76d9e.png"> - The edit connector button (pencil) is not shown if you do not have access to use connectors. Also, the following text should be shown. <img width="784" alt="Screenshot 2023-01-23 at 2 20 30 PM" src="https://user-images.githubusercontent.com/7871006/214535027-4b6b17a6-9d2c-4634-b78a-e966d70ae966.png"> - You see the following callout if a) select a connector to a case and b) then delete the connector <img width="778" alt="Screenshot 2023-01-23 at 2 11 49 PM" src="https://user-images.githubusercontent.com/7871006/214535408-ad72ed87-d9ea-4449-8340-4b17d63ed7b4.png"> - The text of the connector's push button is shown correctly. It should be `Push <connector_nane>` for the first push and `Updated Push <connector_nane>` for any other push. <img width="214" alt="Screenshot 2023-01-25 at 12 09 29 PM" src="https://user-images.githubusercontent.com/7871006/214536143-72e8f5f7-bb9d-4e4f-b2e7-66186ac76cdb.png"> <img width="292" alt="Screenshot 2023-01-25 at 12 09 17 PM" src="https://user-images.githubusercontent.com/7871006/214536169-765a682f-f4d9-4389-ad25-ec8184f99040.png"> - The connector's push button is disabled correctly. - When the connector's push button is disabled a tooltip is shown <img width="291" alt="Screenshot 2023-01-25 at 12 11 27 PM" src="https://user-images.githubusercontent.com/7871006/214536498-4058f1bd-2548-4a87-8e7c-589e1717e0a2.png"> - The push user action label is displayed correctly. It should be `pushed as new incident...` for the first push and `updated incident...` for any other push. <img width="630" alt="Screenshot 2023-01-25 at 9 54 23 AM" src="https://user-images.githubusercontent.com/7871006/214533317-ed29f938-298c-4d5f-94f9-9f11821f9365.png"> <img width="614" alt="Screenshot 2023-01-25 at 11 56 56 AM" src="https://user-images.githubusercontent.com/7871006/214533604-5be88d51-a021-4095-ab70-1938d82c6bdc.png"> - The push arrow indicators are shown correctly. The top arrow should be displayed only if it is the latest push. The bottom arrow should be displayed only if it is the latest push and new changes need to be pushed. Changes are considered the update of text or description, the addition or edit of a comment, and the addition or removal of a case. <img width="371" alt="Screenshot 2023-01-11 at 1 38 37 PM" src="https://user-images.githubusercontent.com/7871006/214534308-29da895a-2dff-4ae7-ace5-31ff7574feac.png"> <img width="322" alt="Screenshot 2023-01-11 at 1 37 31 PM" src="https://user-images.githubusercontent.com/7871006/214534312-9e28a398-ae64-4cc2-9f07-0ed72546e337.png"> - The "View <incident_name>" shows the latest push incident of each connector when changing connectors. <img width="229" alt="Screenshot 2023-01-23 at 2 25 30 PM" src="https://user-images.githubusercontent.com/7871006/214039111-0d4692c3-e7c3-4b7b-825b-bd86a0f03a96.png"> Depends on: #149451, #149535 ### Checklist Delete any items that are not applicable to this PR. - [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) --------- Co-authored-by: Jonathan Buttner <[email protected]>

## Summary This PR updates the UI to use the new connector's API introduced by this PR elastic#147295. In this PR I refactor a bit some of the logic we have for the connectors. I left comments to explain the reasoning. ## Testing Please test the following: - The fields of each connector are preserved correctly when changing connectors - The following callout is shown when you do not have selected any connector <img width="784" alt="Screenshot 2023-01-23 at 2 21 33 PM" src="https://user-images.githubusercontent.com/7871006/214534706-5d447472-a40b-4fb4-aa4f-733bdcc76d9e.png"> - The edit connector button (pencil) is not shown if you do not have access to use connectors. Also, the following text should be shown. <img width="784" alt="Screenshot 2023-01-23 at 2 20 30 PM" src="https://user-images.githubusercontent.com/7871006/214535027-4b6b17a6-9d2c-4634-b78a-e966d70ae966.png"> - You see the following callout if a) select a connector to a case and b) then delete the connector <img width="778" alt="Screenshot 2023-01-23 at 2 11 49 PM" src="https://user-images.githubusercontent.com/7871006/214535408-ad72ed87-d9ea-4449-8340-4b17d63ed7b4.png"> - The text of the connector's push button is shown correctly. It should be `Push <connector_nane>` for the first push and `Updated Push <connector_nane>` for any other push. <img width="214" alt="Screenshot 2023-01-25 at 12 09 29 PM" src="https://user-images.githubusercontent.com/7871006/214536143-72e8f5f7-bb9d-4e4f-b2e7-66186ac76cdb.png"> <img width="292" alt="Screenshot 2023-01-25 at 12 09 17 PM" src="https://user-images.githubusercontent.com/7871006/214536169-765a682f-f4d9-4389-ad25-ec8184f99040.png"> - The connector's push button is disabled correctly. - When the connector's push button is disabled a tooltip is shown <img width="291" alt="Screenshot 2023-01-25 at 12 11 27 PM" src="https://user-images.githubusercontent.com/7871006/214536498-4058f1bd-2548-4a87-8e7c-589e1717e0a2.png"> - The push user action label is displayed correctly. It should be `pushed as new incident...` for the first push and `updated incident...` for any other push. <img width="630" alt="Screenshot 2023-01-25 at 9 54 23 AM" src="https://user-images.githubusercontent.com/7871006/214533317-ed29f938-298c-4d5f-94f9-9f11821f9365.png"> <img width="614" alt="Screenshot 2023-01-25 at 11 56 56 AM" src="https://user-images.githubusercontent.com/7871006/214533604-5be88d51-a021-4095-ab70-1938d82c6bdc.png"> - The push arrow indicators are shown correctly. The top arrow should be displayed only if it is the latest push. The bottom arrow should be displayed only if it is the latest push and new changes need to be pushed. Changes are considered the update of text or description, the addition or edit of a comment, and the addition or removal of a case. <img width="371" alt="Screenshot 2023-01-11 at 1 38 37 PM" src="https://user-images.githubusercontent.com/7871006/214534308-29da895a-2dff-4ae7-ace5-31ff7574feac.png"> <img width="322" alt="Screenshot 2023-01-11 at 1 37 31 PM" src="https://user-images.githubusercontent.com/7871006/214534312-9e28a398-ae64-4cc2-9f07-0ed72546e337.png"> - The "View <incident_name>" shows the latest push incident of each connector when changing connectors. <img width="229" alt="Screenshot 2023-01-23 at 2 25 30 PM" src="https://user-images.githubusercontent.com/7871006/214039111-0d4692c3-e7c3-4b7b-825b-bd86a0f03a96.png"> Depends on: elastic#149451, elastic#149535 ### Checklist Delete any items that are not applicable to this PR. - [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) --------- Co-authored-by: Jonathan Buttner <[email protected]>

jonathan-buttner added 2 commits December 8, 2022 16:43

Refactored the creation flow making progress

205b237

Refactored and making progress

866f353

jonathan-buttner added release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Feature:Cases Cases feature v8.7.0 labels Dec 8, 2022

kibanamachine and others added 10 commits December 8, 2022 22:20

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

0e1a260

…-fix'

Merge branch 'main' of github.com:elastic/kibana into cases-connector…

b8fe694

…-api

Working through getting connector fields

5350d7d

Aggregations working

57fb9e5

Adding integration tests

bcd0f84

Merge branch 'main' of github.com:elastic/kibana into cases-connector…

792a5e1

…-api

Completing integration tests

cd86aad

Expanding API response fields

2804c40

Fix test failures

5f97d1a

[CI] Auto-commit changed files from 'node scripts/ts_project_linter -…

b36100b

…-fix'

jonathan-buttner commented Jan 11, 2023

View reviewed changes

jonathan-buttner added 2 commits January 11, 2023 14:06

Merge branch 'main' of github.com:elastic/kibana into cases-connector…

f37447d

…-api

Merge branch 'cases-connector-api' of github.com:jonathan-buttner/kib…

3ca464f

…ana into cases-connector-api

jonathan-buttner marked this pull request as ready for review January 11, 2023 20:15

jonathan-buttner requested review from a team as code owners January 11, 2023 20:15

jonathan-buttner requested a review from cnasikas January 11, 2023 20:15

pgayvallet approved these changes Jan 13, 2023

View reviewed changes

Adding an algorithm explanation

860142f

cnasikas approved these changes Jan 16, 2023

View reviewed changes

jonathan-buttner added 2 commits January 17, 2023 14:11

Addressing feedback

093e749

Merge branch 'main' of github.com:elastic/kibana into cases-connector…

9f95db3

…-api

fixing merge

13972dc

jonathan-buttner merged commit 92418a6 into elastic:main Jan 17, 2023

jonathan-buttner deleted the cases-connector-api branch January 17, 2023 20:21

kibanamachine added the backport:skip This commit does not require backporting label Jan 17, 2023

This was referenced Jan 19, 2023

[Cases] Filter & paginate cases activity #140096

Closed

[Cases] Update UI to use the new connector's API #149276

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Cases] API to return a case's connectors information #147295

[Cases] API to return a case's connectors information #147295

jonathan-buttner commented Dec 8, 2022 •

edited by cnasikas

Loading

jonathan-buttner Jan 11, 2023

jonathan-buttner Jan 11, 2023

jonathan-buttner Jan 11, 2023

jonathan-buttner Jan 11, 2023

jonathan-buttner Jan 11, 2023

jonathan-buttner Jan 11, 2023

jonathan-buttner Jan 11, 2023

jonathan-buttner Jan 11, 2023

jonathan-buttner Jan 11, 2023

jonathan-buttner Jan 11, 2023

elasticmachine commented Jan 11, 2023

elasticmachine commented Jan 11, 2023

cnasikas left a comment

cnasikas Jan 16, 2023

jonathan-buttner Jan 17, 2023

cnasikas Jan 16, 2023

jonathan-buttner Jan 17, 2023

cnasikas Jan 16, 2023

cnasikas Jan 16, 2023

kibana-ci commented Jan 17, 2023


		await checkConnectorsAuthorization({ authorization, connectors, latestUserAction });

		const enrichedConnectors = await enrichConnectors({

[Cases] API to return a case's connectors information #147295

[Cases] API to return a case's connectors information #147295

Conversation

jonathan-buttner commented Dec 8, 2022 • edited by cnasikas Loading

Needs to be pushed algorithm

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Jan 11, 2023

elasticmachine commented Jan 11, 2023

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

kibana-ci commented Jan 17, 2023

💚 Build Succeeded

Metrics [docs]

Page load bundle

History

jonathan-buttner commented Dec 8, 2022 •

edited by cnasikas

Loading