Skip rule execution when it has a newer typeVersion than Kibana instance

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

@@ -172,6 +172,7 @@ export interface Rule<Params extends RuleTypeParams = never> {
   revision: number;
   running?: boolean | null;
   viewInAppRelativeUrl?: string;
+  typeVersion?: number;
 }
 
 export interface SanitizedAlertsFilter extends AlertsFilter {

x-pack/plugins/alerting/server/application/rule/methods/create/create_rule.test.ts

@@ -164,6 +164,7 @@ describe('create()', () => {
       ownerId: null,
     });
     rulesClientParams.getActionsClient.mockResolvedValue(actionsClient);
+    ruleTypeRegistry.getLatestRuleVersion.mockReturnValue(1);
   });
 
   describe('authorization', () => {
@@ -499,6 +500,7 @@ describe('create()', () => {
           "foo",
         ],
         "throttle": null,
+        "typeVersion": 1,
         "updatedAt": "2019-02-12T21:01:22.479Z",
         "updatedBy": "elastic",
       }
@@ -727,6 +729,7 @@ describe('create()', () => {
           "foo",
         ],
         "throttle": null,
+        "typeVersion": 1,
         "updatedAt": "2019-02-12T21:01:22.479Z",
         "updatedBy": "elastic",
       }
@@ -1167,6 +1170,7 @@ describe('create()', () => {
         schedule: { interval: '1m' },
         tags: ['foo'],
         throttle: null,
+        typeVersion: 1,
         updatedAt: '2019-02-12T21:01:22.479Z',
         updatedBy: 'elastic',
       },
@@ -1426,6 +1430,7 @@ describe('create()', () => {
         schedule: { interval: '1m' },
         tags: ['foo'],
         throttle: null,
+        typeVersion: 1,
         updatedAt: '2019-02-12T21:01:22.479Z',
         updatedBy: 'elastic',
       },
@@ -1648,6 +1653,7 @@ describe('create()', () => {
         schedule: { interval: '1m' },
         tags: ['foo'],
         throttle: null,
+        typeVersion: 1,
         updatedAt: '2019-02-12T21:01:22.479Z',
         updatedBy: 'elastic',
       },
@@ -1837,6 +1843,7 @@ describe('create()', () => {
         schedule: { interval: '1m' },
         tags: ['foo'],
         throttle: null,
+        typeVersion: 1,
         updatedAt: '2019-02-12T21:01:22.479Z',
         updatedBy: 'elastic',
       },
@@ -2004,6 +2011,7 @@ describe('create()', () => {
         },
         schedule: { interval: '1m' },
         throttle: '10m',
+        typeVersion: 1,
         notifyWhen: 'onActionGroupChange',
         muteAll: false,
         snoozeSchedule: [],
@@ -2145,6 +2153,7 @@ describe('create()', () => {
         },
         schedule: { interval: '1m' },
         throttle: '10m',
+        typeVersion: 1,
         notifyWhen: 'onThrottleInterval',
         muteAll: false,
         snoozeSchedule: [],
@@ -2286,6 +2295,7 @@ describe('create()', () => {
         },
         schedule: { interval: '1m' },
         throttle: null,
+        typeVersion: 1,
         notifyWhen: null,
         muteAll: false,
         snoozeSchedule: [],
@@ -2479,6 +2489,7 @@ describe('create()', () => {
         },
         revision: 0,
         running: false,
+        typeVersion: 1,
       },
       {
         references: [
@@ -2836,6 +2847,7 @@ describe('create()', () => {
         },
         schedule: { interval: '1m' },
         throttle: null,
+        typeVersion: 1,
         notifyWhen: null,
         muteAll: false,
         snoozeSchedule: [],
@@ -2942,6 +2954,7 @@ describe('create()', () => {
         },
         schedule: { interval: '1m' },
         throttle: null,
+        typeVersion: 1,
         notifyWhen: null,
         muteAll: false,
         snoozeSchedule: [],
@@ -3821,6 +3834,7 @@ describe('create()', () => {
         },
         schedule: { interval: '1m' },
         throttle: null,
+        typeVersion: 1,
         notifyWhen: null,
         muteAll: false,
         snoozeSchedule: [],

x-pack/plugins/alerting/server/application/rule/methods/create/create_rule.ts

@@ -187,6 +187,7 @@ export async function createRule<Params extends RuleParams = never>(
       monitoring: getDefaultMonitoringRuleDomainProperties(lastRunTimestamp.toISOString()),
       revision: 0,
       running: false,
+      typeVersion: context.ruleTypeRegistry.getLatestRuleVersion(),
     },
     {
       legacyId,

x-pack/plugins/alerting/server/application/rule/schemas/rule_schemas.ts

@@ -168,6 +168,7 @@ export const ruleDomainSchema = schema.object({
   revision: schema.number(),
   running: schema.maybe(schema.nullable(schema.boolean())),
   viewInAppRelativeUrl: schema.maybe(schema.nullable(schema.string())),
+  typeVersion: schema.maybe(schema.number()),
 });
 
 /**

x-pack/plugins/alerting/server/application/rule/transforms/transform_rule_domain_to_rule_attributes.ts

@@ -68,5 +68,6 @@ export const transformRuleDomainToRuleAttributes = (
     ...(rule.nextRun !== undefined ? { nextRun: rule.nextRun?.toISOString() || null } : {}),
     revision: rule.revision,
     ...(rule.running !== undefined ? { running: rule.running } : {}),
+    typeVersion: rule.typeVersion,
   };
 };

x-pack/plugins/alerting/server/application/rule/types/rule.ts

@@ -120,4 +120,5 @@ export interface RuleDomain<Params extends RuleParams = never> {
   revision: RuleDomainSchemaType['revision'];
   running?: RuleDomainSchemaType['running'];
   viewInAppRelativeUrl?: RuleDomainSchemaType['viewInAppRelativeUrl'];
+  typeVersion?: RuleDomainSchemaType['typeVersion'];
 }

x-pack/plugins/alerting/server/data/rule/types/rule_attributes.ts

@@ -174,4 +174,5 @@ export interface RuleAttributes {
   nextRun?: string | null;
   revision: number;
   running?: boolean | null;
+  typeVersion?: number;
 }

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

@@ -93,6 +93,7 @@ export function getPartialRuleFromRaw<Params extends RuleTypeParams>(
     actions,
     snoozeSchedule,
     lastRun,
+    typeVersion,
     ...partialRawRule
   }: Partial<RawRule>,
   references: SavedObjectReference[] | undefined,

x-pack/plugins/alerting/server/rules_client/methods/update.ts

@@ -267,6 +267,7 @@ async function updateAlert<Params extends RuleTypeParams>(
     revision,
     updatedBy: username,
     updatedAt: new Date().toISOString(),
+    typeVersion: context.ruleTypeRegistry.getLatestRuleVersion(),
   });
 
   const mappedParams = getMappedParams(updatedParams);

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

@@ -80,6 +80,7 @@ const fieldsToExcludeFromPublicApi: Array<keyof SanitizedRule> = [
   'mapped_params',
   'snoozeSchedule',
   'activeSnoozes',
+  'typeVersion',
 ];
 
 export const fieldsToExcludeFromRevisionUpdates: ReadonlySet<keyof RuleTypeParams> = new Set([

x-pack/plugins/alerting/server/rules_client/tests/update.test.ts

@@ -191,6 +191,7 @@ describe('update()', () => {
       },
       validLegacyConsumers: [],
     });
+    ruleTypeRegistry.getLatestRuleVersion.mockReturnValue(1);
     (migrateLegacyActions as jest.Mock).mockResolvedValue({
       hasLegacyActions: false,
       resultedActions: [],
@@ -444,6 +445,7 @@ describe('update()', () => {
           "foo",
         ],
         "throttle": null,
+        "typeVersion": 1,
         "updatedAt": "2019-02-12T21:01:22.479Z",
         "updatedBy": "elastic",
       }
@@ -674,6 +676,7 @@ describe('update()', () => {
         scheduledTaskId: 'task-123',
         tags: ['foo'],
         throttle: null,
+        typeVersion: 1,
         updatedAt: '2019-02-12T21:01:22.479Z',
         updatedBy: 'elastic',
       },
@@ -914,6 +917,7 @@ describe('update()', () => {
         scheduledTaskId: 'task-123',
         tags: ['foo'],
         throttle: null,
+        typeVersion: 1,
         updatedAt: '2019-02-12T21:01:22.479Z',
         updatedBy: 'elastic',
       },
@@ -1103,6 +1107,7 @@ describe('update()', () => {
         scheduledTaskId: 'task-123',
         tags: ['foo'],
         throttle: null,
+        typeVersion: 1,
         updatedAt: '2019-02-12T21:01:22.479Z',
         updatedBy: 'elastic',
       },
@@ -1291,6 +1296,7 @@ describe('update()', () => {
           "foo",
         ],
         "throttle": "5m",
+        "typeVersion": 1,
         "updatedAt": "2019-02-12T21:01:22.479Z",
         "updatedBy": "elastic",
       }
@@ -1444,6 +1450,7 @@ describe('update()', () => {
           "foo",
         ],
         "throttle": "5m",
+        "typeVersion": 1,
         "updatedAt": "2019-02-12T21:01:22.479Z",
         "updatedBy": "elastic",
       }
@@ -2464,6 +2471,7 @@ describe('update()', () => {
         scheduledTaskId: 'task-123',
         tags: ['foo'],
         throttle: null,
+        typeVersion: 1,
         updatedAt: '2019-02-12T21:01:22.479Z',
         updatedBy: 'elastic',
       },
@@ -3017,6 +3025,7 @@ describe('update()', () => {
         tags: ['foo'],
         updatedAt: '2019-02-12T21:01:22.479Z',
         updatedBy: 'elastic',
+        typeVersion: 1,
       },
       {
         id: '1',
@@ -3227,6 +3236,7 @@ describe('update()', () => {
           "foo",
         ],
         "throttle": "5m",
+        "typeVersion": 1,
         "updatedAt": "2019-02-12T21:01:22.479Z",
         "updatedBy": "elastic",
       }

x-pack/plugins/alerting/server/saved_objects/index.ts

@@ -49,6 +49,7 @@ export const AlertAttributesExcludedFromAAD = [
   'nextRun',
   'revision',
   'running',
+  'typeVersion',
 ];
 
 // useful for Pick<RawAlert, AlertAttributesExcludedFromAADType> which is a
@@ -69,7 +70,8 @@ export type AlertAttributesExcludedFromAADType =
   | 'lastRun'
   | 'nextRun'
   | 'revision'
-  | 'running';
+  | 'running'
+  | 'typeVersion';
 
 export function setupSavedObjects(
   savedObjects: SavedObjectsServiceSetup,

x-pack/plugins/alerting/server/saved_objects/rule_model_versions.test.ts

@@ -14,7 +14,7 @@ import { schema } from '@kbn/config-schema';
 import { RawRule } from '../types';
 
 describe('rule model versions', () => {
-  const ruleModelVersions: CustomSavedObjectsModelVersionMap = {
+  const modelVersions: CustomSavedObjectsModelVersionMap = {
     '1': {
       changes: [],
       schemas: {
@@ -58,14 +58,22 @@ describe('rule model versions', () => {
 
   describe('getMinimumCompatibleVersion', () => {
     it('should return the minimum compatible version for the matching rawRule', () => {
-      expect(getMinimumCompatibleVersion(ruleModelVersions, 1, rawRule)).toBe(1);
-      expect(getMinimumCompatibleVersion(ruleModelVersions, 2, rawRule)).toBe(2);
-      expect(getMinimumCompatibleVersion(ruleModelVersions, 3, rawRule)).toBe(2);
-      expect(getMinimumCompatibleVersion(ruleModelVersions, 4, rawRule)).toBe(2);
+      expect(getMinimumCompatibleVersion({ modelVersions, version: 1, rawRule })).toBe(1);
+      expect(getMinimumCompatibleVersion({ modelVersions, version: 2, rawRule })).toBe(2);
+      expect(getMinimumCompatibleVersion({ modelVersions, version: 3, rawRule })).toBe(2);
+      expect(getMinimumCompatibleVersion({ modelVersions, version: 4, rawRule })).toBe(2);
     });
     it('should return the minimum compatible version for the mismatching rawRule', () => {
-      expect(getMinimumCompatibleVersion(ruleModelVersions, 3, mismatchingRawRule)).toBe(3);
-      expect(getMinimumCompatibleVersion(ruleModelVersions, 4, mismatchingRawRule)).toBe(4);
+      expect(
+        getMinimumCompatibleVersion({ modelVersions, version: 3, rawRule: mismatchingRawRule })
+      ).toBe(3);
+      expect(
+        getMinimumCompatibleVersion({ modelVersions, version: 4, rawRule: mismatchingRawRule })
+      ).toBe(4);
+    });
+
+    it('should return the given version number if the number does not exist in ruleModelVersions', () => {
+      expect(getMinimumCompatibleVersion({ version: 999, rawRule: mismatchingRawRule })).toBe(999);
     });
   });
 

x-pack/plugins/alerting/server/saved_objects/rule_model_versions.ts

@@ -32,17 +32,25 @@ export const ruleModelVersions: CustomSavedObjectsModelVersionMap = {
 
 export const getLatestRuleVersion = () => Math.max(...Object.keys(ruleModelVersions).map(Number));
 
-export function getMinimumCompatibleVersion(
-  modelVersions: CustomSavedObjectsModelVersionMap,
-  version: number,
-  rawRule: RawRule
-): number {
+export function getMinimumCompatibleVersion({
+  modelVersions = ruleModelVersions,
+  version = getLatestRuleVersion(),
+  rawRule,
+}: {
+  modelVersions?: CustomSavedObjectsModelVersionMap;
+  version?: number;
+  rawRule: RawRule;
+}): number {
   if (version === 1) {
     return 1;
   }
 
-  if (modelVersions[version].isCompatibleWithPreviousVersion(rawRule)) {
-    return getMinimumCompatibleVersion(modelVersions, version - 1, rawRule);
+  if (modelVersions[version] && modelVersions[version].isCompatibleWithPreviousVersion(rawRule)) {
+    return getMinimumCompatibleVersion({
+      modelVersions,
+      version: version - 1,
+      rawRule,
+    });
   }
 
   return version;

x-pack/plugins/alerting/server/task_runner/fixtures.ts

@@ -126,6 +126,7 @@ export const generateSavedObjectParams = ({
     },
     nextRun,
     running: false,
+    typeVersion: 1,
   },
   { refresh: false, namespace: undefined },
 ];
@@ -358,26 +359,6 @@ export const generateRunnerResult = ({
   taskRunError,
 }: GeneratorParams = {}) => {
   return {
-    monitoring: {
-      run: {
-        calculated_metrics: {
-          success_ratio: successRatio,
-        },
-        // @ts-ignore
-        history: history.map((success) => ({ success, timestamp: 0 })),
-        last_run: {
-          metrics: {
-            duration: 0,
-            gap_duration_s: null,
-            total_alerts_created: null,
-            total_alerts_detected: null,
-            total_indexing_duration_ms: null,
-            total_search_duration_ms: null,
-          },
-          timestamp: '1970-01-01T00:00:00.000Z',
-        },
-      },
-    },
     schedule: {
       interval,
     },