[Actions] Notify only on action group change

x-pack/plugins/alerts/common/alert.ts

@@ -67,6 +67,7 @@ export interface Alert {
   apiKey: string | null;
   apiKeyOwner: string | null;
   throttle: string | null;
+  notifyOnStateChange: boolean;
   muteAll: boolean;
   mutedInstanceIds: string[];
   executionStatus: AlertExecutionStatus;

x-pack/plugins/alerts/server/alert_instance/alert_instance.test.ts

@@ -72,6 +72,57 @@ describe('isThrottled', () => {
   });
 });
 
+describe('actionGroupHasChanged()', () => {
+  test('should be false if no last scheduled and nothing scheduled', () => {
+    const alertInstance = new AlertInstance();
+    expect(alertInstance.actionGroupHasChanged()).toEqual(false);
+  });
+
+  test('should be false if group does not change', () => {
+    const alertInstance = new AlertInstance({
+      meta: {
+        lastScheduledActions: {
+          date: new Date(),
+          group: 'default',
+        },
+      },
+    });
+    alertInstance.scheduleActions('default');
+    expect(alertInstance.actionGroupHasChanged()).toEqual(false);
+  });
+
+  test('should be true if no last scheduled and group is scheduled', () => {
+    const alertInstance = new AlertInstance();
+    alertInstance.scheduleActions('default');
+    expect(alertInstance.actionGroupHasChanged()).toEqual(true);
+  });
+
+  test('should be true if last scheduled group and next action is undefined', () => {
+    const alertInstance = new AlertInstance({
+      meta: {
+        lastScheduledActions: {
+          date: new Date(),
+          group: 'default',
+        },
+      },
+    });
+    expect(alertInstance.actionGroupHasChanged()).toEqual(true);
+  });
+
+  test('should be true if group does change', () => {
+    const alertInstance = new AlertInstance({
+      meta: {
+        lastScheduledActions: {
+          date: new Date(),
+          group: 'default',
+        },
+      },
+    });
+    alertInstance.scheduleActions('penguin');
+    expect(alertInstance.actionGroupHasChanged()).toEqual(true);
+  });
+});
+
 describe('getScheduledActionOptions()', () => {
   test('defaults to undefined', () => {
     const alertInstance = new AlertInstance();

x-pack/plugins/alerts/server/alert_instance/alert_instance.ts

@@ -51,6 +51,10 @@ export class AlertInstance<
     return false;
   }
 
+  actionGroupHasChanged(): boolean {
+    return this.scheduledExecutionOptions?.actionGroup !== this.meta?.lastScheduledActions?.group;
+  }
+
   getScheduledActionOptions() {
     return this.scheduledExecutionOptions;
   }

x-pack/plugins/alerts/server/alerts_client/alerts_client.ts

@@ -154,6 +154,7 @@ interface UpdateOptions {
     actions: NormalizedAlertAction[];
     params: Record<string, unknown>;
     throttle: string | null;
+    notifyOnStateChange: boolean;
   };
 }
 

x-pack/plugins/alerts/server/alerts_client/tests/create.test.ts

@@ -57,6 +57,7 @@ function getMockData(overwrites: Record<string, unknown> = {}): CreateOptions['d
     consumer: 'bar',
     schedule: { interval: '10s' },
     throttle: null,
+    notifyOnStateChange: false,
     params: {
       bar: true,
     },
@@ -273,6 +274,7 @@ describe('create()', () => {
         "muteAll": false,
         "mutedInstanceIds": Array [],
         "name": "abc",
+        "notifyOnStateChange": false,
         "params": Object {
           "bar": true,
         },
@@ -321,6 +323,7 @@ describe('create()', () => {
         "muteAll": false,
         "mutedInstanceIds": Array [],
         "name": "abc",
+        "notifyOnStateChange": false,
         "params": Object {
           "bar": true,
         },
@@ -964,6 +967,7 @@ describe('create()', () => {
         },
         schedule: { interval: '10s' },
         throttle: null,
+        notifyOnStateChange: false,
         muteAll: false,
         mutedInstanceIds: [],
         tags: ['foo'],
@@ -1085,6 +1089,7 @@ describe('create()', () => {
         },
         schedule: { interval: '10s' },
         throttle: null,
+        notifyOnStateChange: false,
         muteAll: false,
         mutedInstanceIds: [],
         tags: ['foo'],

x-pack/plugins/alerts/server/alerts_client/tests/get_alert_instance_summary.test.ts

@@ -80,6 +80,7 @@ const BaseAlertInstanceSummarySavedObject: SavedObject<RawAlert> = {
     apiKey: null,
     apiKeyOwner: null,
     throttle: null,
+    notifyOnStateChange: false,
     muteAll: false,
     mutedInstanceIds: [],
     executionStatus: {

x-pack/plugins/alerts/server/alerts_client/tests/update.test.ts

@@ -66,6 +66,7 @@ describe('update()', () => {
       scheduledTaskId: 'task-123',
       params: {},
       throttle: null,
+      notifyOnStateChange: false,
       actions: [
         {
           group: 'default',
@@ -171,6 +172,7 @@ describe('update()', () => {
           bar: true,
         },
         throttle: null,
+        notifyOnStateChange: false,
         actions: [
           {
             group: 'default',
@@ -281,6 +283,7 @@ describe('update()', () => {
           "versionApiKeyLastmodified": "v7.10.0",
         },
         "name": "abc",
+        "notifyOnStateChange": false,
         "params": Object {
           "bar": true,
         },
@@ -386,6 +389,7 @@ describe('update()', () => {
           bar: true,
         },
         throttle: '5m',
+        notifyOnStateChange: false,
         actions: [
           {
             group: 'default',
@@ -447,6 +451,7 @@ describe('update()', () => {
           "versionApiKeyLastmodified": "v7.10.0",
         },
         "name": "abc",
+        "notifyOnStateChange": false,
         "params": Object {
           "bar": true,
         },
@@ -540,6 +545,7 @@ describe('update()', () => {
           bar: true,
         },
         throttle: '5m',
+        notifyOnStateChange: false,
         actions: [
           {
             group: 'default',
@@ -602,6 +608,7 @@ describe('update()', () => {
           "versionApiKeyLastmodified": "v7.10.0",
         },
         "name": "abc",
+        "notifyOnStateChange": false,
         "params": Object {
           "bar": true,
         },
@@ -657,6 +664,7 @@ describe('update()', () => {
             bar: true,
           },
           throttle: null,
+          notifyOnStateChange: false,
           actions: [
             {
               group: 'default',
@@ -785,6 +793,7 @@ describe('update()', () => {
           bar: true,
         },
         throttle: null,
+        notifyOnStateChange: false,
         actions: [
           {
             group: 'default',
@@ -892,6 +901,7 @@ describe('update()', () => {
           bar: true,
         },
         throttle: '5m',
+        notifyOnStateChange: false,
         actions: [
           {
             group: 'default',
@@ -953,6 +963,7 @@ describe('update()', () => {
             bar: true,
           },
           throttle: null,
+          notifyOnStateChange: false,
           actions: [
             {
               group: 'default',
@@ -1071,6 +1082,7 @@ describe('update()', () => {
             bar: true,
           },
           throttle: null,
+          notifyOnStateChange: false,
           actions: [
             {
               group: 'default',
@@ -1102,6 +1114,7 @@ describe('update()', () => {
             bar: true,
           },
           throttle: null,
+          notifyOnStateChange: false,
           actions: [
             {
               group: 'default',
@@ -1138,6 +1151,7 @@ describe('update()', () => {
             bar: true,
           },
           throttle: null,
+          notifyOnStateChange: false,
           actions: [
             {
               group: 'default',
@@ -1173,6 +1187,7 @@ describe('update()', () => {
             bar: true,
           },
           throttle: null,
+          notifyOnStateChange: false,
           actions: [
             {
               group: 'default',
@@ -1226,6 +1241,7 @@ describe('update()', () => {
             bar: true,
           },
           throttle: null,
+          notifyOnStateChange: false,
           actions: [],
         },
       });
@@ -1249,6 +1265,7 @@ describe('update()', () => {
               bar: true,
             },
             throttle: null,
+            notifyOnStateChange: false,
             actions: [],
           },
         })

x-pack/plugins/alerts/server/alerts_client_conflict_retries.test.ts

@@ -105,6 +105,7 @@ async function update(success: boolean) {
         tags: ['bar'],
         params: { bar: true },
         throttle: '10s',
+        notifyOnStateChange: false,
         actions: [],
       },
     });

x-pack/plugins/alerts/server/lib/alert_instance_summary_from_event_log.test.ts

@@ -587,6 +587,7 @@ const BaseAlert: SanitizedAlert = {
   tags: [],
   consumer: 'alert-consumer',
   throttle: null,
+  notifyOnStateChange: false,
   muteAll: false,
   mutedInstanceIds: [],
   params: { bar: true },

x-pack/plugins/alerts/server/routes/create.test.ts

@@ -36,6 +36,7 @@ describe('createAlertRoute', () => {
       bar: true,
     },
     throttle: '30s',
+    notifyOnStateChange: false,
     actions: [
       {
         group: 'default',
@@ -110,6 +111,7 @@ describe('createAlertRoute', () => {
             "alertTypeId": "1",
             "consumer": "bar",
             "name": "abc",
+            "notifyOnStateChange": false,
             "params": Object {
               "bar": true,
             },

x-pack/plugins/alerts/server/routes/create.ts

@@ -38,6 +38,7 @@ export const bodySchema = schema.object({
     }),
     { defaultValue: [] }
   ),
+  notifyOnStateChange: schema.boolean({ defaultValue: false }),
 });
 
 export const createAlertRoute = (router: IRouter, licenseState: LicenseState) => {

x-pack/plugins/alerts/server/routes/get.test.ts

@@ -46,6 +46,7 @@ describe('getAlertRoute', () => {
     tags: ['foo'],
     enabled: true,
     muteAll: false,
+    notifyOnStateChange: false,
     createdBy: '',
     updatedBy: '',
     apiKey: '',

x-pack/plugins/alerts/server/routes/update.test.ts

@@ -41,6 +41,7 @@ describe('updateAlertRoute', () => {
         },
       },
     ],
+    notifyOnStateChange: false,
   };
 
   it('updates an alert with proper parameters', async () => {
@@ -78,6 +79,7 @@ describe('updateAlertRoute', () => {
               },
             },
           ],
+          notifyOnStateChange: false,
         },
       },
       ['ok']
@@ -100,6 +102,7 @@ describe('updateAlertRoute', () => {
               },
             ],
             "name": "abc",
+            "notifyOnStateChange": false,
             "params": Object {
               "otherField": false,
             },

x-pack/plugins/alerts/server/routes/update.ts

@@ -39,6 +39,7 @@ const bodySchema = schema.object({
     }),
     { defaultValue: [] }
   ),
+  notifyOnStateChange: schema.boolean({ defaultValue: false }),
 });
 
 export const updateAlertRoute = (router: IRouter, licenseState: LicenseState) => {
@@ -62,11 +63,11 @@ export const updateAlertRoute = (router: IRouter, licenseState: LicenseState) =>
         }
         const alertsClient = context.alerting.getAlertsClient();
         const { id } = req.params;
-        const { name, actions, params, schedule, tags, throttle } = req.body;
+        const { name, actions, params, schedule, tags, throttle, notifyOnStateChange } = req.body;
         return res.ok({
           body: await alertsClient.update({
             id,
-            data: { name, actions, params, schedule, tags, throttle },
+            data: { name, actions, params, schedule, tags, throttle, notifyOnStateChange },
           }),
         });
       })

x-pack/plugins/alerts/server/saved_objects/mappings.json

@@ -71,6 +71,9 @@
       "throttle": {
         "type": "keyword"
       },
+      "notifyOnStateChange": {
+        "type": "boolean"
+      },
       "muteAll": {
         "type": "boolean"
       },

x-pack/plugins/alerts/server/task_runner/alert_task_instance.test.ts

@@ -27,6 +27,7 @@ const alert: SanitizedAlert = {
   updatedAt: new Date(),
   apiKeyOwner: null,
   throttle: null,
+  notifyOnStateChange: false,
   muteAll: false,
   mutedInstanceIds: [],
   executionStatus: {