[RAM] Add toggle for AAD fields in alert templating (elastic#170162)

## Summary Reopen of elastic#161213 Closes elastic#160838 Feature can be activated via feature flag: `xpack.trigger_actions_ui.enableExperimental: ['isMustacheAutocompleteOn', 'showMustacheAutocompleteSwitch']` <img width="605" alt="Screenshot 2023-10-30 at 5 52 39 PM" src="https://github.com/elastic/kibana/assets/1445834/da24b419-3b08-4014-be2f-99692773755f"> <img width="583" alt="Screenshot 2023-10-30 at 5 52 22 PM" src="https://github.com/elastic/kibana/assets/1445834/fc5b8a1e-8202-4491-b4fb-694b70809f4d"> ### Checklist - [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 --------- Co-authored-by: Julian Gernun <[email protected]> Co-authored-by: Xavier Mouligneau <[email protected]> Co-authored-by: kibanamachine <[email protected]>
kibanamachine · Nov 14, 2023 · 603a045 · 603a045
1 parent a46923c
commit 603a045
Show file tree

Hide file tree

Showing 42 changed files with 537 additions and 183 deletions.
diff --git a/x-pack/plugins/alerting/common/routes/rule/apis/create/schemas/v1.ts b/x-pack/plugins/alerting/common/routes/rule/apis/create/schemas/v1.ts
@@ -63,6 +63,7 @@ export const actionSchema = schema.object({
   params: schema.recordOf(schema.string(), schema.maybe(schema.any()), { defaultValue: {} }),
   frequency: schema.maybe(actionFrequencySchema),
   alerts_filter: schema.maybe(actionAlertsFilterSchema),
+  use_alert_data_for_template: schema.maybe(schema.boolean()),
 });
 
 export const createBodySchema = schema.object({

diff --git a/x-pack/plugins/alerting/common/rule.ts b/x-pack/plugins/alerting/common/rule.ts
@@ -116,6 +116,7 @@ export interface RuleAction {
   params: RuleActionParams;
   frequency?: RuleActionFrequency;
   alertsFilter?: AlertsFilter;
+  useAlertDataForTemplate?: boolean;
 }
 
 export interface RuleLastRun {

diff --git a/x-pack/plugins/alerting/server/alert/alert.ts b/x-pack/plugins/alerting/server/alert/alert.ts
@@ -6,6 +6,7 @@
  */
 
 import { v4 as uuidV4 } from 'uuid';
+import { AADAlert } from '@kbn/alerts-as-data-utils';
 import { get, isEmpty } from 'lodash';
 import { MutableAlertInstanceMeta } from '@kbn/alerting-state-types';
 import { ALERT_UUID } from '@kbn/rule-data-utils';
@@ -36,7 +37,7 @@ export type PublicAlert<
   Context extends AlertInstanceContext = AlertInstanceContext,
   ActionGroupIds extends string = DefaultActionGroupId
 > = Pick<
-  Alert<State, Context, ActionGroupIds>,
+  Alert<State, Context, ActionGroupIds, AADAlert>,
   | 'getContext'
   | 'getState'
   | 'getUuid'
@@ -50,13 +51,15 @@ export type PublicAlert<
 export class Alert<
   State extends AlertInstanceState = AlertInstanceState,
   Context extends AlertInstanceContext = AlertInstanceContext,
-  ActionGroupIds extends string = never
+  ActionGroupIds extends string = never,
+  AlertAsData extends AADAlert = AADAlert
 > {
   private scheduledExecutionOptions?: ScheduledExecutionOptions<State, Context, ActionGroupIds>;
   private meta: MutableAlertInstanceMeta;
   private state: State;
   private context: Context;
   private readonly id: string;
+  private alertAsData: AlertAsData | undefined;
 
   constructor(id: string, { state, meta = {} }: RawAlertInstance = {}) {
     this.id = id;
@@ -78,6 +81,18 @@ export class Alert<
     return this.meta.uuid!;
   }
 
+  isAlertAsData() {
+    return this.alertAsData !== undefined;
+  }
+
+  setAlertAsData(alertAsData: AlertAsData) {
+    this.alertAsData = alertAsData;
+  }
+
+  getAlertAsData() {
+    return this.alertAsData;
+  }
+
   getStart(): string | null {
     return this.state.start ? `${this.state.start}` : null;
   }

diff --git a/...lugins/alerting/server/application/rule/methods/create/schemas/create_rule_data_schema.ts b/...lugins/alerting/server/application/rule/methods/create/schemas/create_rule_data_schema.ts
@@ -35,6 +35,7 @@ export const createRuleDataSchema = schema.object({
       ),
       uuid: schema.maybe(schema.string()),
       alertsFilter: schema.maybe(actionAlertsFilterSchema),
+      useAlertDataForTemplate: schema.maybe(schema.boolean()),
     }),
     { defaultValue: [] }
   ),

diff --git a/x-pack/plugins/alerting/server/application/rule/schemas/action_schemas.ts b/x-pack/plugins/alerting/server/application/rule/schemas/action_schemas.ts
@@ -65,6 +65,7 @@ export const actionDomainSchema = schema.object({
   params: actionParamsSchema,
   frequency: schema.maybe(actionFrequencySchema),
   alertsFilter: schema.maybe(actionDomainAlertsFilterSchema),
+  useAlertDataAsTemplate: schema.maybe(schema.boolean()),
 });
 
 /**
@@ -89,4 +90,5 @@ export const actionSchema = schema.object({
   params: actionParamsSchema,
   frequency: schema.maybe(actionFrequencySchema),
   alertsFilter: schema.maybe(actionAlertsFilterSchema),
+  useAlertDataForTemplate: schema.maybe(schema.boolean()),
 });
diff --git a/x-pack/plugins/alerting/server/routes/lib/actions_schema.ts b/x-pack/plugins/alerting/server/routes/lib/actions_schema.ts
@@ -68,6 +68,7 @@ export const actionsSchema = schema.arrayOf(
         ),
       })
     ),
+    use_alert_data_for_template: schema.maybe(schema.boolean()),
   }),
   { defaultValue: [] }
 );
diff --git a/x-pack/plugins/alerting/server/routes/lib/rewrite_actions.ts b/x-pack/plugins/alerting/server/routes/lib/rewrite_actions.ts
@@ -15,20 +15,28 @@ export const rewriteActionsReq = (
 ): NormalizedAlertAction[] => {
   if (!actions) return [];
 
-  return actions.map(({ frequency, alerts_filter: alertsFilter, ...action }) => {
-    return {
-      ...action,
-      ...(frequency
-        ? {
-            frequency: {
-              ...omit(frequency, 'notify_when'),
-              notifyWhen: frequency.notify_when,
-            },
-          }
-        : {}),
-      ...(alertsFilter ? { alertsFilter } : {}),
-    };
-  });
+  return actions.map(
+    ({
+      frequency,
+      alerts_filter: alertsFilter,
+      use_alert_data_for_template: useAlertDataForTemplate,
+      ...action
+    }) => {
+      return {
+        ...action,
+        useAlertDataForTemplate,
+        ...(frequency
+          ? {
+              frequency: {
+                ...omit(frequency, 'notify_when'),
+                notifyWhen: frequency.notify_when,
+              },
+            }
+          : {}),
+        ...(alertsFilter ? { alertsFilter } : {}),
+      };
+    }
+  );
 };
 
 export const rewriteActionsRes = (actions?: RuleAction[]) => {
@@ -37,14 +45,17 @@ export const rewriteActionsRes = (actions?: RuleAction[]) => {
     notify_when: notifyWhen,
   });
   if (!actions) return [];
-  return actions.map(({ actionTypeId, frequency, alertsFilter, ...action }) => ({
-    ...action,
-    connector_type_id: actionTypeId,
-    ...(frequency ? { frequency: rewriteFrequency(frequency) } : {}),
-    ...(alertsFilter
-      ? {
-          alerts_filter: alertsFilter,
-        }
-      : {}),
-  }));
+  return actions.map(
+    ({ actionTypeId, frequency, alertsFilter, useAlertDataForTemplate, ...action }) => ({
+      ...action,
+      connector_type_id: actionTypeId,
+      use_alert_data_for_template: useAlertDataForTemplate,
+      ...(frequency ? { frequency: rewriteFrequency(frequency) } : {}),
+      ...(alertsFilter
+        ? {
+            alerts_filter: alertsFilter,
+          }
+        : {}),
+    })
+  );
 };
diff --git a/x-pack/plugins/alerting/server/routes/rule/apis/bulk_edit/bulk_edit_rules_route.test.ts b/x-pack/plugins/alerting/server/routes/rule/apis/bulk_edit/bulk_edit_rules_route.test.ts
@@ -114,6 +114,7 @@ describe('bulkEditRulesRoute', () => {
                   foo: true,
                 },
                 uuid: '123-456',
+                use_alert_data_for_template: false,
               },
             ],
           }),

diff --git a/x-pack/plugins/alerting/server/routes/rule/apis/create/create_rule_route.test.ts b/x-pack/plugins/alerting/server/routes/rule/apis/create/create_rule_route.test.ts
@@ -124,6 +124,7 @@ describe('createRuleRoute', () => {
         },
         connector_type_id: 'test',
         uuid: '123-456',
+        use_alert_data_for_template: false,
       },
     ],
   };
@@ -198,6 +199,7 @@ describe('createRuleRoute', () => {
                 "params": Object {
                   "foo": true,
                 },
+                "useAlertDataForTemplate": undefined,
               },
             ],
             "alertTypeId": "1",
@@ -314,6 +316,7 @@ describe('createRuleRoute', () => {
                 "params": Object {
                   "foo": true,
                 },
+                "useAlertDataForTemplate": undefined,
               },
             ],
             "alertTypeId": "1",
@@ -431,6 +434,7 @@ describe('createRuleRoute', () => {
                 "params": Object {
                   "foo": true,
                 },
+                "useAlertDataForTemplate": undefined,
               },
             ],
             "alertTypeId": "1",
@@ -548,6 +552,7 @@ describe('createRuleRoute', () => {
                 "params": Object {
                   "foo": true,
                 },
+                "useAlertDataForTemplate": undefined,
               },
             ],
             "alertTypeId": "1",

diff --git a/...ck/plugins/alerting/server/routes/rule/apis/create/transforms/transform_create_body/v1.ts b/...ck/plugins/alerting/server/routes/rule/apis/create/transforms/transform_create_body/v1.ts
@@ -15,25 +15,33 @@ import type { RuleParams } from '../../../../../../application/rule/types';
 const transformCreateBodyActions = (actions: CreateRuleActionV1[]): CreateRuleData['actions'] => {
   if (!actions) return [];
 
-  return actions.map(({ frequency, alerts_filter: alertsFilter, ...action }) => {
-    return {
-      group: action.group,
-      id: action.id,
-      params: action.params,
-      actionTypeId: action.actionTypeId,
-      ...(action.uuid ? { uuid: action.uuid } : {}),
-      ...(frequency
-        ? {
-            frequency: {
-              summary: frequency.summary,
-              throttle: frequency.throttle,
-              notifyWhen: frequency.notify_when,
-            },
-          }
-        : {}),
-      ...(alertsFilter ? { alertsFilter } : {}),
-    };
-  });
+  return actions.map(
+    ({
+      frequency,
+      alerts_filter: alertsFilter,
+      use_alert_data_for_template: useAlertDataForTemplate,
+      ...action
+    }) => {
+      return {
+        group: action.group,
+        id: action.id,
+        params: action.params,
+        actionTypeId: action.actionTypeId,
+        useAlertDataForTemplate,
+        ...(action.uuid ? { uuid: action.uuid } : {}),
+        ...(frequency
+          ? {
+              frequency: {
+                summary: frequency.summary,
+                throttle: frequency.throttle,
+                notifyWhen: frequency.notify_when,
+              },
+            }
+          : {}),
+        ...(alertsFilter ? { alertsFilter } : {}),
+      };
+    }
+  );
 };
 
 export const transformCreateBody = <Params extends RuleParams = never>(

diff --git a/x-pack/plugins/alerting/server/routes/rule/apis/resolve/resolve_rule_route.test.ts b/x-pack/plugins/alerting/server/routes/rule/apis/resolve/resolve_rule_route.test.ts
@@ -45,6 +45,7 @@ describe('resolveRuleRoute', () => {
           foo: true,
         },
         uuid: '123-456',
+        useAlertDataForTemplate: false,
       },
     ],
     consumer: 'bar',
@@ -101,6 +102,7 @@ describe('resolveRuleRoute', () => {
         params: mockedRule.actions[0].params,
         connector_type_id: mockedRule.actions[0].actionTypeId,
         uuid: mockedRule.actions[0].uuid,
+        use_alert_data_for_template: mockedRule.actions[0].useAlertDataForTemplate,
       },
     ],
     outcome: 'aliasMatch',

diff --git a/x-pack/plugins/alerting/server/routes/rule/transforms/transform_rule_to_rule_response/v1.ts b/x-pack/plugins/alerting/server/routes/rule/transforms/transform_rule_to_rule_response/v1.ts
@@ -49,11 +49,21 @@ export const transformRuleToRuleResponse = <Params extends RuleParams = never>(
   consumer: rule.consumer,
   schedule: rule.schedule,
   actions: rule.actions.map(
-    ({ group, id, actionTypeId, params, frequency, uuid, alertsFilter }) => ({
+    ({
+      group,
+      id,
+      actionTypeId,
+      params,
+      frequency,
+      uuid,
+      alertsFilter,
+      useAlertDataForTemplate,
+    }) => ({
       group,
       id,
       params,
       connector_type_id: actionTypeId,
+      use_alert_data_for_template: useAlertDataForTemplate ?? false,
       ...(frequency
         ? {
             frequency: {

diff --git a/x-pack/plugins/alerting/server/routes/update_rule.test.ts b/x-pack/plugins/alerting/server/routes/update_rule.test.ts
@@ -132,6 +132,7 @@ describe('updateRuleRoute', () => {
                 "params": Object {
                   "baz": true,
                 },
+                "useAlertDataForTemplate": undefined,
                 "uuid": "1234-5678",
               },
             ],
-Original file line number
+Diff line change
@@ Expand Up / @@ -68,6 +68,7 @@ export const actionsSchema = schema.arrayOf( @@
             ),
           })
         ),
+        use_alert_data_for_template: schema.maybe(schema.boolean()),
       }),
       { defaultValue: [] }
     );