[Cases] Register connector adapter by cnasikas · Pull Request #179796 · elastic/kibana

cnasikas · 2024-04-02T08:44:55Z

Summary

Now that the system actions PR is merged (#166267) we can use the connector adapters to transform the case action params. This PR:

Registers a connector adapter for the case action.
Uses flattened objects in the description and the tags.
Change the integration tests to use an internal router to execute system actions. PR [Actions] System actions MVP #166267 disabled execution of system actions through the public execute API.
Skip execution of the case action if the grouping did not produce any alerts.
Add references to the cases oracle saved objects.
Remove the owner from the UI and deduct the owner from the rule's consumer in the connector adapter.

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

elasticmachine · 2024-04-02T13:36:45Z

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

elasticmachine · 2024-04-02T13:36:46Z

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

cnasikas · 2024-04-03T10:46:13Z

Sorry for the noise!

…from the UI

cnasikas · 2024-04-04T09:00:05Z

x-pack/plugins/actions/server/create_system_actions.ts

    id: `system-connector-${systemActionType.id}`,
    actionTypeId: systemActionType.id,
-    name: `System action: ${systemActionType.id}`,
+    name: systemActionType.name,


The name of a system connector will be the same name as the action type name. This change affected some tests.

cnasikas · 2024-04-04T09:00:38Z

x-pack/plugins/cases/common/constants/owner.test.ts

+import { OWNER_INFO } from './owners';
+
+describe('OWNER_INFO', () => {
+  it('should use all available rule consumers', () => {


If a new consumer is added the test will fail and we will get notified.

cnasikas · 2024-04-04T09:01:21Z

x-pack/plugins/cases/public/components/system_actions/cases/cases_params.tsx

  ActionParamsProps<CasesActionParams>
 > = ({ actionParams, editAction, errors, index, producerId }) => {
-  const { appId } = useApplication();
-  const owner = getCaseOwnerByAppId(appId);


The owner will be automatically mapped in the connector adapter.

cnasikas · 2024-04-04T09:03:46Z

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

+  auth?: { user: User; space: string | null };
+}): Promise<ActionTypeExecutorResult<unknown>> => {
+  const { body: res } = await supertest
+    .post(`${getSpaceUrlPrefix(auth.space)}/api/cases_fixture/${connectorId}/connectors:execute`)


I had to create a new route for executing system actions only for testing because the public execute API does not allow the execution of system actions.

js-jankisalvi · 2024-04-04T09:08:49Z

x-pack/plugins/cases/common/constants/owners.ts

    iconType: 'logoObservability',
    appRoute: '/app/observability',
+    validRuleConsumers: [
+      // only valid in serverless


Should there be separate list of validRuleConsumers for serverless and ESS?

In both deployments, a valid consumer will be found in the validRuleConsumers array so there is no need to separate the list. If we separate it into two lists we will have to add logic to check if we are in serverless or ESS which will increase the complexity of the code.

js-jankisalvi

Nice work!! 👍 🎉

js-jankisalvi · 2024-04-04T09:10:40Z

x-pack/plugins/cases/kibana.jsonc

      "cases"
    ],
    "requiredPlugins": [
+      "alerting",


Ohh.. I wonder how UI worked without this 🤔

The UI is in the triggers_actions_ui plugin. The alerting plugin is used to register the connector adapter.

js-jankisalvi · 2024-04-04T09:12:23Z

x-pack/plugins/cases/public/components/system_actions/cases/cases.tsx

      return validationResult;
    },
    actionParamsFields: lazy(() => import('./cases_params')),
+    isSystemActionType: true,


Thanks for this 🙂

js-jankisalvi · 2024-04-04T09:18:46Z

x-pack/plugins/cases/server/connectors/cases/cases_connector_executor.ts

     */
    const filteredAlerts = alerts.filter((alert) =>
-      uniqueGroupingByFields.every((groupingByField) => Object.hasOwn(alert, groupingByField))
+      uniqueGroupingByFields.every((groupingByField) => Boolean(get(alert, groupingByField, null)))


Nice use of get 👍

kibana-ci · 2024-04-04T10:42:33Z

💔 Build Failed

Failed CI Steps

Test Failures

[job] [logs] Jest Integration Tests #7 / transition from md5 hashes to model versions ensures the hashToVersionMap does not miss any mappings changes
[job] [logs] Jest Integration Tests #7 / transition from md5 hashes to model versions ensures the hashToVersionMap does not miss any mappings changes
[job] [logs] Jest Tests #9 / unified data table should update row Height correctly

Metrics [docs]

‼️ ERROR: no builds found for mergeBase sha [44b9d94]

History

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

cc @cnasikas

cnasikas added 4 commits April 2, 2024 11:43

Register connector adapter

f803d32

Type cases connector adapter

99a92aa

Fix bug with nested alert properties

ffb8ffd

Use an internal router to execute system actions

7b673e3

cnasikas 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.14.0 labels Apr 2, 2024

cnasikas self-assigned this Apr 2, 2024

cnasikas mentioned this pull request Apr 2, 2024

[Cases] Case action #168369

Merged

3 tasks

cnasikas added 3 commits April 2, 2024 12:46

Add references to the oracle records

c5af486

Show flatten objects in the description

f1a148d

Flatten objects in tags

ed03d4a

cnasikas marked this pull request as ready for review April 2, 2024 13:36

cnasikas requested review from a team as code owners April 2, 2024 13:36

pgayvallet approved these changes Apr 2, 2024

View reviewed changes

Merge branch 'case_action' into ca_connector_adapter

520c0b0

cnasikas requested review from a team as code owners April 3, 2024 10:43

cnasikas removed request for a team April 3, 2024 10:45

cnasikas added 11 commits April 3, 2024 15:11

Use the action type name for system connectors

a66b590

Remove owner from the UI

8a055e4

Map owners with rule consumers

e393404

Pass the rule consumer to connector adapters

b47ee4d

Map the consumer to the onwer on the connectro adapter and remove it …

f5b9c39

…from the UI

Fix types

3dac10a

Hide the case action in security solution

71578e8

Fix cases unit tests

13b1f0d

Fix integration tests

d649f0d

Fix notify when text

9518b5b

Fix integration tests

71a44ba

cnasikas commented Apr 4, 2024

View reviewed changes

js-jankisalvi reviewed Apr 4, 2024

View reviewed changes

js-jankisalvi approved these changes Apr 4, 2024

View reviewed changes

Conversation

cnasikas commented Apr 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

For maintainers

Uh oh!

elasticmachine commented Apr 2, 2024

Uh oh!

elasticmachine commented Apr 2, 2024

Uh oh!

cnasikas commented Apr 3, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

js-jankisalvi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kibana-ci commented Apr 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💔 Build Failed

Failed CI Steps

Test Failures

Metrics [docs]

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

cnasikas commented Apr 2, 2024 •

edited

Loading

kibana-ci commented Apr 4, 2024 •

edited

Loading