[8.8] [RAM][Maintenance Window][8.8]Fix window maintenance workflow (#…

…156427) (#156770) # Backport This will backport the following commits from `main` to `8.8`: - [[RAM][Maintenance Window][8.8]Fix window maintenance workflow (#156427)](#156427)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Jiawei Wu <74562234+JiaweiWu@users.noreply.github.com>
elastic · May 5, 2023 · e76daa4 · e76daa4
1 parent d802d4f
commit e76daa4
Show file tree

Hide file tree

Showing 26 changed files with 542 additions and 103 deletions.
diff --git a/x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts b/x-pack/packages/kbn-alerting-state-types/src/alert_instance.ts
@@ -36,6 +36,7 @@ const metaSchema = t.partial({
   flappingHistory: t.array(t.boolean),
   // flapping flag that indicates whether the alert is flapping
   flapping: t.boolean,
+  maintenanceWindowIds: t.array(t.string),
   pendingRecoveredCount: t.number,
   uuid: t.string,
 });

diff --git a/x-pack/plugins/alerting/server/alert/alert.test.ts b/x-pack/plugins/alerting/server/alert/alert.test.ts
@@ -344,6 +344,7 @@ describe('updateLastScheduledActions()', () => {
           group: 'default',
         },
         flappingHistory: [],
+        maintenanceWindowIds: [],
       },
     });
   });
@@ -357,6 +358,7 @@ describe('updateLastScheduledActions()', () => {
       state: {},
       meta: {
         flappingHistory: [],
+        maintenanceWindowIds: [],
         uuid: expect.any(String),
         lastScheduledActions: {
           date: new Date().toISOString(),
@@ -373,6 +375,7 @@ describe('updateLastScheduledActions()', () => {
     const alert = new Alert<AlertInstanceState, AlertInstanceContext, DefaultActionGroupId>('1', {
       meta: {
         flappingHistory: [],
+        maintenanceWindowIds: [],
         lastScheduledActions: {
           date: new Date(),
           group: 'default',
@@ -387,6 +390,7 @@ describe('updateLastScheduledActions()', () => {
       state: {},
       meta: {
         flappingHistory: [],
+        maintenanceWindowIds: [],
         uuid: expect.any(String),
         lastScheduledActions: {
           date: new Date().toISOString(),
@@ -484,6 +488,7 @@ describe('toJSON', () => {
             group: 'default',
           },
           flappingHistory: [false, true],
+          maintenanceWindowIds: [],
           flapping: false,
           pendingRecoveredCount: 2,
         },
@@ -548,6 +553,7 @@ describe('toRaw', () => {
       meta: {
         flappingHistory: [false, true, true],
         flapping: false,
+        maintenanceWindowIds: [],
         uuid: expect.any(String),
       },
     });
@@ -570,6 +576,7 @@ describe('setFlappingHistory', () => {
           "flappingHistory": Array [
             false,
           ],
+          "maintenanceWindowIds": Array [],
           "uuid": Any<String>,
         },
         "state": Object {},
@@ -602,6 +609,7 @@ describe('setFlapping', () => {
         "meta": Object {
           "flapping": false,
           "flappingHistory": Array [],
+          "maintenanceWindowIds": Array [],
           "uuid": Any<String>,
         },
         "state": Object {},

diff --git a/x-pack/plugins/alerting/server/alert/alert.ts b/x-pack/plugins/alerting/server/alert/alert.ts
@@ -63,7 +63,7 @@ export class Alert<
     this.context = {} as Context;
     this.meta = meta;
     this.meta.uuid = meta.uuid ?? uuidV4();
-
+    this.meta.maintenanceWindowIds = meta.maintenanceWindowIds ?? [];
     if (!this.meta.flappingHistory) {
       this.meta.flappingHistory = [];
     }
@@ -229,6 +229,7 @@ export class Alert<
           // for a recovered alert, we only care to track the flappingHistory,
           // the flapping flag, and the UUID
           meta: {
+            maintenanceWindowIds: this.meta.maintenanceWindowIds,
             flappingHistory: this.meta.flappingHistory,
             flapping: this.meta.flapping,
             uuid: this.meta.uuid,
@@ -296,4 +297,12 @@ export class Alert<
         get(alert, ALERT_UUID) === this.getId() || get(alert, ALERT_UUID) === this.getUuid()
     );
   }
+
+  setMaintenanceWindowIds(maintenanceWindowIds: string[] = []) {
+    this.meta.maintenanceWindowIds = maintenanceWindowIds;
+  }
+
+  getMaintenanceWindowIds() {
+    return this.meta.maintenanceWindowIds ?? [];
+  }
 }
diff --git a/x-pack/plugins/alerting/server/alert/create_alert_factory.test.ts b/x-pack/plugins/alerting/server/alert/create_alert_factory.test.ts
@@ -31,6 +31,7 @@ describe('createAlertFactory()', () => {
       logger,
       maxAlerts: 1000,
       autoRecoverAlerts: true,
+      maintenanceWindowIds: [],
     });
     const result = alertFactory.create('1');
     expect(result).toMatchObject({
@@ -58,6 +59,7 @@ describe('createAlertFactory()', () => {
       logger,
       maxAlerts: 1000,
       autoRecoverAlerts: true,
+      maintenanceWindowIds: [],
     });
     const result = alertFactory.create('1');
     expect(result).toMatchObject({
@@ -82,6 +84,7 @@ describe('createAlertFactory()', () => {
       logger,
       maxAlerts: 1000,
       autoRecoverAlerts: true,
+      maintenanceWindowIds: [],
     });
     alertFactory.create('1');
     expect(alerts).toMatchObject({
@@ -103,6 +106,7 @@ describe('createAlertFactory()', () => {
       logger,
       maxAlerts: 3,
       autoRecoverAlerts: true,
+      maintenanceWindowIds: [],
     });
 
     expect(alertFactory.hasReachedAlertLimit()).toBe(false);
@@ -123,6 +127,7 @@ describe('createAlertFactory()', () => {
       logger,
       maxAlerts: 1000,
       autoRecoverAlerts: true,
+      maintenanceWindowIds: [],
     });
     const result = alertFactory.create('1');
     expect(result).toMatchObject({
@@ -166,6 +171,7 @@ describe('createAlertFactory()', () => {
       canSetRecoveryContext: true,
       maxAlerts: 1000,
       autoRecoverAlerts: true,
+      maintenanceWindowIds: ['test-id-1'],
     });
     const result = alertFactory.create('1');
     expect(result).toMatchObject({
@@ -184,6 +190,11 @@ describe('createAlertFactory()', () => {
     const recoveredAlerts = getRecoveredAlertsFn!();
     expect(Array.isArray(recoveredAlerts)).toBe(true);
     expect(recoveredAlerts.length).toEqual(2);
+    expect(processAlerts).toHaveBeenLastCalledWith(
+      expect.objectContaining({
+        maintenanceWindowIds: ['test-id-1'],
+      })
+    );
   });
 
   test('returns empty array if no recovered alerts', () => {
@@ -194,6 +205,7 @@ describe('createAlertFactory()', () => {
       maxAlerts: 1000,
       canSetRecoveryContext: true,
       autoRecoverAlerts: true,
+      maintenanceWindowIds: [],
     });
     const result = alertFactory.create('1');
     expect(result).toMatchObject({
@@ -221,6 +233,7 @@ describe('createAlertFactory()', () => {
       maxAlerts: 1000,
       canSetRecoveryContext: true,
       autoRecoverAlerts: true,
+      maintenanceWindowIds: [],
     });
     const result = alertFactory.create('1');
     expect(result).toMatchObject({
@@ -247,6 +260,7 @@ describe('createAlertFactory()', () => {
       maxAlerts: 1000,
       canSetRecoveryContext: false,
       autoRecoverAlerts: true,
+      maintenanceWindowIds: [],
     });
     const result = alertFactory.create('1');
     expect(result).toMatchObject({
@@ -275,6 +289,7 @@ describe('createAlertFactory()', () => {
       logger,
       maxAlerts: 1000,
       autoRecoverAlerts: true,
+      maintenanceWindowIds: [],
     });
 
     const limit = alertFactory.alertLimit.getValue();
@@ -293,6 +308,7 @@ describe('createAlertFactory()', () => {
       logger,
       maxAlerts: 1000,
       autoRecoverAlerts: true,
+      maintenanceWindowIds: [],
     });
 
     const limit = alertFactory.alertLimit.getValue();
@@ -308,6 +324,7 @@ describe('createAlertFactory()', () => {
       logger,
       maxAlerts: 1000,
       autoRecoverAlerts: true,
+      maintenanceWindowIds: [],
     });
 
     const limit = alertFactory.alertLimit.getValue();
@@ -324,11 +341,13 @@ describe('createAlertFactory()', () => {
       maxAlerts: 1000,
       canSetRecoveryContext: true,
       autoRecoverAlerts: false,
+      maintenanceWindowIds: [],
     });
     const result = alertFactory.create('1');
     expect(result).toEqual({
       meta: {
         flappingHistory: [],
+        maintenanceWindowIds: [],
         uuid: expect.any(String),
       },
       state: {},
@@ -354,6 +373,7 @@ describe('getPublicAlertFactory', () => {
       logger,
       maxAlerts: 1000,
       autoRecoverAlerts: true,
+      maintenanceWindowIds: [],
     });
 
     expect(alertFactory.create).toBeDefined();

diff --git a/x-pack/plugins/alerting/server/alert/create_alert_factory.ts b/x-pack/plugins/alerting/server/alert/create_alert_factory.ts
@@ -54,6 +54,7 @@ export interface CreateAlertFactoryOpts<
   logger: Logger;
   maxAlerts: number;
   autoRecoverAlerts: boolean;
+  maintenanceWindowIds: string[];
   canSetRecoveryContext?: boolean;
 }
 
@@ -66,6 +67,7 @@ export function createAlertFactory<
   logger,
   maxAlerts,
   autoRecoverAlerts,
+  maintenanceWindowIds,
   canSetRecoveryContext = false,
 }: CreateAlertFactoryOpts<State, Context>): AlertFactory<State, Context, ActionGroupIds> {
   // Keep track of which alerts we started with so we can determine which have recovered
@@ -152,6 +154,7 @@ export function createAlertFactory<
             autoRecoverAlerts,
             // flappingSettings.enabled is false, as we only want to use this function to get the recovered alerts
             flappingSettings: DISABLE_FLAPPING_SETTINGS,
+            maintenanceWindowIds,
           });
           return Object.keys(currentRecoveredAlerts ?? {}).map(
             (alertId: string) => currentRecoveredAlerts[alertId]

diff --git a/x-pack/plugins/alerting/server/alerts_client/legacy_alerts_client.test.ts b/x-pack/plugins/alerting/server/alerts_client/legacy_alerts_client.test.ts
@@ -124,7 +124,8 @@ describe('Legacy Alerts Client', () => {
         '1': testAlert1,
         '2': testAlert2,
       },
-      {}
+      {},
+      ['test-id-1']
     );
 
     expect(createAlertFactory).toHaveBeenCalledWith({
@@ -136,6 +137,7 @@ describe('Legacy Alerts Client', () => {
       maxAlerts: 1000,
       canSetRecoveryContext: false,
       autoRecoverAlerts: true,
+      maintenanceWindowIds: ['test-id-1'],
     });
   });
 
@@ -151,7 +153,8 @@ describe('Legacy Alerts Client', () => {
         '1': testAlert1,
         '2': testAlert2,
       },
-      {}
+      {},
+      []
     );
 
     alertsClient.getExecutorServices();
@@ -170,7 +173,8 @@ describe('Legacy Alerts Client', () => {
         '1': testAlert1,
         '2': testAlert2,
       },
-      {}
+      {},
+      []
     );
 
     alertsClient.checkLimitUsage();
@@ -189,7 +193,8 @@ describe('Legacy Alerts Client', () => {
         '1': testAlert1,
         '2': testAlert2,
       },
-      {}
+      {},
+      []
     );
 
     alertsClient.hasReachedAlertLimit();
@@ -230,7 +235,8 @@ describe('Legacy Alerts Client', () => {
         '1': testAlert1,
         '2': testAlert2,
       },
-      {}
+      {},
+      []
     );
 
     alertsClient.processAndLogAlerts({
@@ -257,6 +263,7 @@ describe('Legacy Alerts Client', () => {
       alertLimit: 1000,
       autoRecoverAlerts: true,
       flappingSettings: DEFAULT_FLAPPING_SETTINGS,
+      maintenanceWindowIds: ['window-id1', 'window-id2'],
     });
 
     expect(getAlertsForNotification).toHaveBeenCalledWith(
@@ -289,7 +296,6 @@ describe('Legacy Alerts Client', () => {
       ruleRunMetricsStore,
       canSetRecoveryContext: false,
       shouldPersistAlerts: true,
-      maintenanceWindowIds: ['window-id1', 'window-id2'],
     });
 
     expect(alertsClient.getProcessedAlerts('active')).toEqual({

diff --git a/x-pack/plugins/alerting/server/alerts_client/legacy_alerts_client.ts b/x-pack/plugins/alerting/server/alerts_client/legacy_alerts_client.ts
@@ -75,7 +75,8 @@ export class LegacyAlertsClient<
 
   public initialize(
     activeAlertsFromState: Record<string, RawAlertInstance>,
-    recoveredAlertsFromState: Record<string, RawAlertInstance>
+    recoveredAlertsFromState: Record<string, RawAlertInstance>,
+    maintenanceWindowIds: string[]
   ) {
     for (const id in activeAlertsFromState) {
       if (activeAlertsFromState.hasOwnProperty(id)) {
@@ -107,6 +108,7 @@ export class LegacyAlertsClient<
       maxAlerts: this.options.maxAlerts,
       autoRecoverAlerts: this.options.ruleType.autoRecoverAlerts ?? true,
       canSetRecoveryContext: this.options.ruleType.doesSetRecoveryContext ?? false,
+      maintenanceWindowIds,
     });
   }
 
@@ -125,7 +127,7 @@ export class LegacyAlertsClient<
     ruleRunMetricsStore: RuleRunMetricsStore;
     flappingSettings: RulesSettingsFlappingProperties;
     notifyWhen: RuleNotifyWhenType | null;
-    maintenanceWindowIds?: string[];
+    maintenanceWindowIds: string[];
   }) {
     const {
       newAlerts: processedAlertsNew,
@@ -143,6 +145,7 @@ export class LegacyAlertsClient<
           ? this.options.ruleType.autoRecoverAlerts
           : true,
       flappingSettings,
+      maintenanceWindowIds,
     });
 
     const { trimmedAlertsRecovered, earlyRecoveredAlerts } = trimRecoveredAlerts(
@@ -178,7 +181,6 @@ export class LegacyAlertsClient<
       ruleRunMetricsStore,
       canSetRecoveryContext: this.options.ruleType.doesSetRecoveryContext ?? false,
       shouldPersistAlerts: shouldLogAndScheduleActionsForAlerts,
-      maintenanceWindowIds,
     });
   }