Add UUID to RuleAction

packages/kbn-securitysolution-io-ts-alerting-types/src/actions/index.ts

@@ -5,6 +5,7 @@
  * in compliance with, at your election, the Elastic License 2.0 or the Server
  * Side Public License, v 1.
  */
+import { NonEmptyString } from '@kbn/securitysolution-io-ts-types';
 
 import * as t from 'io-ts';
 import { saved_object_attributes } from '../saved_object_attributes';
@@ -18,6 +19,9 @@ export const RuleActionId = t.string;
 export type RuleActionTypeId = t.TypeOf<typeof RuleActionTypeId>;
 export const RuleActionTypeId = t.string;
 
+export type RuleActionUuid = t.TypeOf<typeof RuleActionUuid>;
+export const RuleActionUuid = NonEmptyString;
+
 /**
  * Params is an "object", since it is a type of RuleActionParams which is action templates.
  * @see x-pack/plugins/alerting/common/rule.ts
@@ -27,25 +31,31 @@ export const RuleActionParams = saved_object_attributes;
 
 export type RuleAction = t.TypeOf<typeof RuleAction>;
 export const RuleAction = t.exact(
-  t.type({
-    group: RuleActionGroup,
-    id: RuleActionId,
-    action_type_id: RuleActionTypeId,
-    params: RuleActionParams,
-  })
+  t.intersection([
+    t.type({
+      group: RuleActionGroup,
+      id: RuleActionId,
+      action_type_id: RuleActionTypeId,
+      params: RuleActionParams,
+    }),
+    t.partial({ uuid: RuleActionUuid }),
+  ])
 );
 
 export type RuleActionArray = t.TypeOf<typeof RuleActionArray>;
 export const RuleActionArray = t.array(RuleAction);
 
 export type RuleActionCamel = t.TypeOf<typeof RuleActionCamel>;
 export const RuleActionCamel = t.exact(
-  t.type({
-    group: RuleActionGroup,
-    id: RuleActionId,
-    actionTypeId: RuleActionTypeId,
-    params: RuleActionParams,
-  })
+  t.intersection([
+    t.type({
+      group: RuleActionGroup,
+      id: RuleActionId,
+      actionTypeId: RuleActionTypeId,
+      params: RuleActionParams,
+    }),
+    t.partial({ uuid: RuleActionUuid }),
+  ])
 );
 
 export type RuleActionArrayCamel = t.TypeOf<typeof RuleActionArrayCamel>;

src/core/server/integration_tests/saved_objects/migrations/group2/check_registered_types.test.ts

@@ -57,7 +57,7 @@ describe('checking migration metadata changes on all registered SO types', () =>
       Object {
         "action": "6cfc277ed3211639e37546ac625f4a68f2494215",
         "action_task_params": "db2afea7d78e00e725486b791554d0d4e81956ef",
-        "alert": "f81ad957a7936522482e4539c7a96a963ebdbc3e",
+        "alert": "2568bf6d8ba0876441c61c9e58e08016c1dc1617",
         "api_key_pending_invalidation": "16e7bcf8e78764102d7f525542d5b616809a21ee",
         "apm-indices": "d19dd7fb51f2d2cbc1f8769481721e0953f9a6d2",
         "apm-server-schema": "1d42f17eff9ec6c16d3a9324d9539e2d123d0a9a",

x-pack/plugins/alerting/common/rule.ts

@@ -77,6 +77,7 @@ export type RuleActionParams = SavedObjectAttributes;
 export type RuleActionParam = SavedObjectAttribute;
 
 export interface RuleAction {
+  uuid?: string;
   group: string;
   id: string;
   actionTypeId: string;

x-pack/plugins/alerting/public/alert_api.test.ts

@@ -109,6 +109,7 @@ describe('loadRule', () => {
             "params": Object {
               "message": "alert 37: {{context.message}}",
             },
+            "uuid": "123-456",
           },
         ],
         "alertTypeId": ".index-threshold",
@@ -278,6 +279,7 @@ function getApiRule() {
         },
         group: 'threshold met',
         id: '3619a0d0-582b-11ec-8995-2b1578a3bc5d',
+        uuid: '123-456',
       },
     ],
     params: { x: 42 },
@@ -319,6 +321,7 @@ function getRule(): Rule<{ x: number }> {
         },
         group: 'threshold met',
         id: '3619a0d0-582b-11ec-8995-2b1578a3bc5d',
+        uuid: '123-456',
       },
     ],
     params: { x: 42 },

x-pack/plugins/alerting/public/lib/common_transformations.test.ts

@@ -31,6 +31,7 @@ describe('common_transformations', () => {
           group: 'some group',
           id: 'some-connector-id',
           params: { foo: 'car', bar: [1, 2, 3] },
+          uuid: '123-456',
         },
       ],
       params: { bar: 'foo', numbers: { 1: [2, 3] } } as never,
@@ -108,6 +109,7 @@ describe('common_transformations', () => {
               ],
               "foo": "car",
             },
+            "uuid": "123-456",
           },
         ],
         "alertTypeId": "some-rule-type",
@@ -213,6 +215,7 @@ describe('common_transformations', () => {
           group: 'some group',
           id: 'some-connector-id',
           params: {},
+          uuid: '123-456',
         },
       ],
       params: {} as never,
@@ -277,6 +280,7 @@ describe('common_transformations', () => {
             "group": "some group",
             "id": "some-connector-id",
             "params": Object {},
+            "uuid": "123-456",
           },
         ],
         "alertTypeId": "some-rule-type",

x-pack/plugins/alerting/server/routes/bulk_edit_rules.test.ts

@@ -41,6 +41,7 @@ describe('bulkEditInternalRulesRoute', () => {
         params: {
           foo: true,
         },
+        uuid: '123-456',
       },
     ],
     consumer: 'bar',
@@ -111,6 +112,7 @@ describe('bulkEditInternalRulesRoute', () => {
                 params: {
                   foo: true,
                 },
+                uuid: '123-456',
               },
             ],
           }),

x-pack/plugins/alerting/server/routes/bulk_edit_rules.ts

@@ -18,6 +18,7 @@ const ruleActionSchema = schema.object({
   group: schema.string(),
   id: schema.string(),
   params: schema.recordOf(schema.string(), schema.any(), { defaultValue: {} }),
+  uuid: schema.maybe(schema.string()),
 });
 
 const operationsSchema = schema.arrayOf(

x-pack/plugins/alerting/server/routes/clone_rule.test.ts

@@ -48,6 +48,7 @@ describe('cloneRuleRoute', () => {
         params: {
           foo: true,
         },
+        uuid: '123-456',
       },
     ],
     enabled: true,
@@ -97,6 +98,7 @@ describe('cloneRuleRoute', () => {
       {
         ...ruleToClone.actions[0],
         connector_type_id: 'test',
+        uuid: '123-456',
       },
     ],
   };

x-pack/plugins/alerting/server/routes/create_rule.test.ts

@@ -51,6 +51,7 @@ describe('createRuleRoute', () => {
         params: {
           foo: true,
         },
+        uuid: '123-456',
       },
     ],
     enabled: true,
@@ -100,6 +101,7 @@ describe('createRuleRoute', () => {
       {
         ...ruleToCreate.actions[0],
         connector_type_id: 'test',
+        uuid: '123-456',
       },
     ],
   };

x-pack/plugins/alerting/server/routes/get_rule.test.ts

@@ -44,6 +44,7 @@ describe('getRuleRoute', () => {
         params: {
           foo: true,
         },
+        uuid: '123-456',
       },
     ],
     consumer: 'bar',
@@ -85,6 +86,7 @@ describe('getRuleRoute', () => {
         id: mockedAlert.actions[0].id,
         params: mockedAlert.actions[0].params,
         connector_type_id: mockedAlert.actions[0].actionTypeId,
+        uuid: mockedAlert.actions[0].uuid,
       },
     ],
   };

x-pack/plugins/alerting/server/routes/get_rule.ts

@@ -60,7 +60,7 @@ const rewriteBodyRes: RewriteResponseCase<SanitizedRule<RuleTypeParams>> = ({
     last_execution_date: executionStatus.lastExecutionDate,
     last_duration: executionStatus.lastDuration,
   },
-  actions: actions.map(({ group, id, actionTypeId, params, frequency }) => ({
+  actions: actions.map(({ group, id, actionTypeId, params, frequency, uuid }) => ({
     group,
     id,
     params,
@@ -72,6 +72,7 @@ const rewriteBodyRes: RewriteResponseCase<SanitizedRule<RuleTypeParams>> = ({
           throttle: frequency.throttle,
         }
       : undefined,
+    ...(uuid && { uuid }),
   })),
   ...(lastRun ? { last_run: rewriteRuleLastRun(lastRun) } : {}),
   ...(nextRun ? { next_run: nextRun } : {}),

x-pack/plugins/alerting/server/routes/lib/actions_schema.ts

@@ -24,6 +24,7 @@ export const actionsSchema = schema.arrayOf(
         throttle: schema.nullable(schema.string({ validate: validateDurationSchema })),
       })
     ),
+    uuid: schema.maybe(schema.string()),
   }),
   { defaultValue: [] }
 );

x-pack/plugins/alerting/server/routes/lib/rewrite_rule.ts

@@ -57,7 +57,7 @@ export const rewriteRule = ({
     last_execution_date: executionStatus.lastExecutionDate,
     last_duration: executionStatus.lastDuration,
   },
-  actions: actions.map(({ group, id, actionTypeId, params, frequency }) => ({
+  actions: actions.map(({ group, id, actionTypeId, params, frequency, uuid }) => ({
     group,
     id,
     params,
@@ -71,6 +71,7 @@ export const rewriteRule = ({
           },
         }
       : {}),
+    ...(uuid && { uuid }),
   })),
   ...(lastRun ? { last_run: rewriteRuleLastRun(lastRun) } : {}),
   ...(nextRun ? { next_run: nextRun } : {}),

x-pack/plugins/alerting/server/routes/resolve_rule.test.ts

@@ -44,6 +44,7 @@ describe('resolveRuleRoute', () => {
         params: {
           foo: true,
         },
+        uuid: '123-456',
       },
     ],
     consumer: 'bar',
@@ -97,6 +98,7 @@ describe('resolveRuleRoute', () => {
         id: mockedRule.actions[0].id,
         params: mockedRule.actions[0].params,
         connector_type_id: mockedRule.actions[0].actionTypeId,
+        uuid: mockedRule.actions[0].uuid,
       },
     ],
     outcome: 'aliasMatch',

x-pack/plugins/alerting/server/routes/update_rule.test.ts

@@ -42,6 +42,7 @@ describe('updateRuleRoute', () => {
     updatedAt: new Date(),
     actions: [
       {
+        uuid: '1234-5678',
         group: 'default',
         id: '2',
         actionTypeId: 'test',
@@ -58,6 +59,7 @@ describe('updateRuleRoute', () => {
     notify_when: mockedAlert.notifyWhen,
     actions: [
       {
+        uuid: '1234-5678',
         group: mockedAlert.actions[0].group,
         id: mockedAlert.actions[0].id,
         params: mockedAlert.actions[0].params,
@@ -114,6 +116,7 @@ describe('updateRuleRoute', () => {
                 "params": Object {
                   "baz": true,
                 },
+                "uuid": "1234-5678",
               },
             ],
             "name": "abc",

x-pack/plugins/alerting/server/rules_client/lib/add_uuid.ts

@@ -0,0 +1,16 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { v4 } from 'uuid';
+import { NormalizedAlertAction, NormalizedAlertActionWithUuid } from '..';
+
+export function addUuid(actions: NormalizedAlertAction[] = []): NormalizedAlertActionWithUuid[] {
+  return actions.map((action) => ({
+    ...action,
+    uuid: action.uuid || v4(),
+  }));
+}

x-pack/plugins/alerting/server/rules_client/lib/denormalize_actions.ts

@@ -8,12 +8,11 @@
 import { SavedObjectReference } from '@kbn/core/server';
 import { RawRule } from '../../types';
 import { preconfiguredConnectorActionRefPrefix } from '../common/constants';
-import { RulesClientContext } from '../types';
-import { NormalizedAlertAction } from '../types';
+import { NormalizedAlertActionWithUuid, RulesClientContext } from '../types';
 
 export async function denormalizeActions(
   context: RulesClientContext,
-  alertActions: NormalizedAlertAction[]
+  alertActions: NormalizedAlertActionWithUuid[]
 ): Promise<{ actions: RawRule['actions']; references: SavedObjectReference[] }> {
   const references: SavedObjectReference[] = [];
   const actions: RawRule['actions'] = [];

x-pack/plugins/alerting/server/rules_client/lib/extract_references.ts

@@ -8,7 +8,7 @@
 import { SavedObjectReference } from '@kbn/core/server';
 import { RawRule, RuleTypeParams } from '../../types';
 import { UntypedNormalizedRuleType } from '../../rule_type_registry';
-import { NormalizedAlertAction } from '../types';
+import { NormalizedAlertActionWithUuid } from '../types';
 import { extractedSavedObjectParamReferenceNamePrefix } from '../common/constants';
 import { RulesClientContext } from '../types';
 import { denormalizeActions } from './denormalize_actions';
@@ -19,7 +19,7 @@ export async function extractReferences<
 >(
   context: RulesClientContext,
   ruleType: UntypedNormalizedRuleType,
-  ruleActions: NormalizedAlertAction[],
+  ruleActions: NormalizedAlertActionWithUuid[],
   ruleParams: Params
 ): Promise<{
   actions: RawRule['actions'];

x-pack/plugins/alerting/server/rules_client/lib/index.ts

@@ -15,3 +15,4 @@ export { checkAuthorizationAndGetTotal } from './check_authorization_and_get_tot
 export { scheduleTask } from './schedule_task';
 export { createNewAPIKeySet } from './create_new_api_key_set';
 export { recoverRuleAlerts } from './recover_rule_alerts';
+export { addUuid } from './add_uuid';

x-pack/plugins/alerting/server/rules_client/lib/validate_actions.ts

@@ -31,6 +31,15 @@ export async function validateActions(
 
   const errors = [];
 
+  const uniqueActions = new Set(actions.map((action) => action.uuid));
+  if (uniqueActions.size < actions.length) {
+    errors.push(
+      i18n.translate('xpack.alerting.rulesClient.validateActions.hasDuplicatedUuid', {
+        defaultMessage: 'Actions have duplicated UUIDs',
+      })
+    );
+  }
+
   // check for actions using connectors with missing secrets
   const actionsClient = await context.getActionsClient();
   const actionIds = [...new Set(actions.map((action) => action.id))];