Add rule model versions in alerting

x-pack/plugins/alerting/server/lib/create_get_alert_indices_alias.test.ts

@@ -33,6 +33,7 @@ describe('createGetAlertIndicesAliasFn', () => {
     licensing: licensingMock.createSetup(),
     minimumScheduleInterval: { value: '1m', enforce: false },
     inMemoryMetrics,
+    latestRuleVersion: 1,
   };
   const registry = new RuleTypeRegistry(ruleTypeRegistryParams);
   registry.register({

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

@@ -77,7 +77,7 @@ import {
 } from './types';
 import { registerAlertingUsageCollector } from './usage';
 import { initializeAlertingTelemetry, scheduleAlertingTelemetry } from './usage/task';
-import { setupSavedObjects } from './saved_objects';
+import { setupSavedObjects, getLatestRuleVersion } from './saved_objects';
 import {
   initializeApiKeyInvalidator,
   scheduleApiKeyInvalidatorTask,
@@ -305,6 +305,7 @@ export class AlertingPlugin {
       alertsService: this.alertsService,
       minimumScheduleInterval: this.config.rules.minimumScheduleInterval,
       inMemoryMetrics: this.inMemoryMetrics,
+      latestRuleVersion: getLatestRuleVersion(),
     });
     this.ruleTypeRegistry = ruleTypeRegistry;
 

x-pack/plugins/alerting/server/rule_type_registry.mock.ts

@@ -18,6 +18,7 @@ const createRuleTypeRegistryMock = () => {
     list: jest.fn(),
     getAllTypes: jest.fn(),
     ensureRuleTypeEnabled: jest.fn(),
+    getLatestRuleVersion: jest.fn(),
   };
   return mocked;
 };

x-pack/plugins/alerting/server/rule_type_registry.test.ts

@@ -40,6 +40,7 @@ beforeEach(() => {
     licensing: licensingMock.createSetup(),
     minimumScheduleInterval: { value: '1m', enforce: false },
     inMemoryMetrics,
+    latestRuleVersion: 1,
   };
 });
 
@@ -911,6 +912,16 @@ describe('Create Lifecycle', () => {
       ).toThrowErrorMatchingInlineSnapshot(`"Fail"`);
     });
   });
+
+  describe('getLatestRuleVersion', () => {
+    test('should return the latest rule version', async () => {
+      const ruleTypeRegistry = new RuleTypeRegistry({
+        ...ruleTypeRegistryParams,
+        latestRuleVersion: 5,
+      });
+      expect(ruleTypeRegistry.getLatestRuleVersion()).toBe(5);
+    });
+  });
 });
 
 function ruleTypeWithVariables<ActionGroupIds extends string>(

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

@@ -14,7 +14,6 @@ import { Logger } from '@kbn/core/server';
 import { LicensingPluginSetup } from '@kbn/licensing-plugin/server';
 import { RunContext, TaskManagerSetupContract } from '@kbn/task-manager-plugin/server';
 import { stateSchemaByVersion } from '@kbn/alerting-state-types';
-import { rawRuleSchema } from './raw_rule_schema';
 import { TaskRunnerFactory } from './task_runner';
 import {
   RuleType,
@@ -40,6 +39,7 @@ import { AlertingRulesConfig } from '.';
 import { AlertsService } from './alerts_service/alerts_service';
 import { getRuleTypeIdValidLegacyConsumers } from './rule_type_registry_deprecated_consumers';
 import { AlertingConfig } from './config';
+import { rawRuleSchemaV1 } from './saved_objects/schemas/raw_rule';
 
 export interface ConstructorOptions {
   config: AlertingConfig;
@@ -51,6 +51,7 @@ export interface ConstructorOptions {
   minimumScheduleInterval: AlertingRulesConfig['minimumScheduleInterval'];
   inMemoryMetrics: InMemoryMetrics;
   alertsService: AlertsService | null;
+  latestRuleVersion: number;
 }
 
 export interface RegistryRuleType
@@ -160,6 +161,7 @@ export class RuleTypeRegistry {
   private readonly licensing: LicensingPluginSetup;
   private readonly inMemoryMetrics: InMemoryMetrics;
   private readonly alertsService: AlertsService | null;
+  private readonly latestRuleVersion: number;
 
   constructor({
     config,
@@ -171,6 +173,7 @@ export class RuleTypeRegistry {
     minimumScheduleInterval,
     inMemoryMetrics,
     alertsService,
+    latestRuleVersion,
   }: ConstructorOptions) {
     this.config = config;
     this.logger = logger;
@@ -181,6 +184,7 @@ export class RuleTypeRegistry {
     this.minimumScheduleInterval = minimumScheduleInterval;
     this.inMemoryMetrics = inMemoryMetrics;
     this.alertsService = alertsService;
+    this.latestRuleVersion = latestRuleVersion;
   }
 
   public has(id: string) {
@@ -311,7 +315,7 @@ export class RuleTypeRegistry {
           spaceId: schema.string(),
           consumer: schema.maybe(schema.string()),
         }),
-        indirectParamsSchema: rawRuleSchema,
+        indirectParamsSchema: rawRuleSchemaV1,
       },
     });
 
@@ -433,6 +437,10 @@ export class RuleTypeRegistry {
   public getAllTypes(): string[] {
     return [...this.ruleTypes.keys()];
   }
+
+  public getLatestRuleVersion() {
+    return this.latestRuleVersion;
+  }
 }
 
 function normalizedActionVariables(actionVariables: RuleType['actionVariables']) {

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

@@ -24,10 +24,12 @@ import { getImportWarnings } from './get_import_warnings';
 import { isRuleExportable } from './is_rule_exportable';
 import { RuleTypeRegistry } from '../rule_type_registry';
 export { partiallyUpdateAlert } from './partially_update_alert';
+export { getLatestRuleVersion, getMinimumCompatibleVersion } from './rule_model_versions';
 import {
   RULES_SETTINGS_SAVED_OBJECT_TYPE,
   MAINTENANCE_WINDOW_SAVED_OBJECT_TYPE,
 } from '../../common';
+import { ruleModelVersions } from './rule_model_versions';
 
 // Use caution when removing items from this array! Any field which has
 // ever existed in the rule SO must be included in this array to prevent
@@ -106,6 +108,7 @@ export function setupSavedObjects(
         return isRuleExportable(ruleSavedObject, ruleTypeRegistry, logger);
       },
     },
+    modelVersions: ruleModelVersions,
   });
 
   savedObjects.registerType({

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

@@ -37,6 +37,7 @@ beforeEach(() => {
     licensing: licensingMock.createSetup(),
     minimumScheduleInterval: { value: '1m', enforce: false },
     inMemoryMetrics,
+    latestRuleVersion: 1,
   };
 });
 

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

@@ -0,0 +1,45 @@
+/*
+ * 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 {
+  SavedObjectsModelVersion,
+  SavedObjectsModelVersionMap,
+} from '@kbn/core-saved-objects-server';
+import { RawRule } from '../types';
+import { rawRuleSchemaV1 } from './schemas/raw_rule';
+
+interface CustomSavedObjectsModelVersion extends SavedObjectsModelVersion {
+  isCompatibleWithPreviousVersion: (param: RawRule) => boolean;
+}
+
+interface CustomSavedObjectsModelVersionMap extends SavedObjectsModelVersionMap {
+  [modelVersion: string]: CustomSavedObjectsModelVersion;
+}
+
+export const ruleModelVersions: CustomSavedObjectsModelVersionMap = {
+  '1': {
+    changes: [],
+    schemas: {
+      create: rawRuleSchemaV1,
+    },
+    isCompatibleWithPreviousVersion: (rawRule) => true,
+  },
+};
+
+export const getLatestRuleVersion = () => Math.max(...Object.keys(ruleModelVersions).map(Number));
+
+export function getMinimumCompatibleVersion(version: number, rawRule: RawRule): number {
+  if (version === 1) {
+    return 1;
+  }
+
+  if (ruleModelVersions[version].isCompatibleWithPreviousVersion(rawRule)) {
+    return getMinimumCompatibleVersion(version - 1, rawRule);
+  }
+
+  return version;
+}

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

@@ -0,0 +1,8 @@
+/*
+ * 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.
+ */
+
+export { rawRuleSchema as rawRuleSchemaV1 } from './v1';

x-pack/plugins/alerting/server/raw_rule_schema.ts → x-pack/plugins/alerting/server/saved_objects/schemas/raw_rule/v1.ts

@@ -209,6 +209,7 @@ const rawRuleActionSchema = schema.object({
     })
   ),
   alertsFilter: schema.maybe(rawRuleAlertsFilterSchema),
+  useAlertDataForTemplate: schema.maybe(schema.boolean()),
 });
 
 export const rawRuleSchema = schema.object({
@@ -266,5 +267,6 @@ export const rawRuleSchema = schema.object({
       severity: schema.maybe(schema.string()),
     })
   ),
-  params: schema.recordOf(schema.string(), schema.any()),
+  params: schema.recordOf(schema.string(), schema.maybe(schema.any())),
+  typeVersion: schema.maybe(schema.number()),
 });