[RAM] Adds auto-incrementing revision field to rules

src/core/server/integration_tests/saved_objects/migrations/group2/check_registered_types.test.ts

@@ -57,7 +57,7 @@ describe('checking migration metadata changes on all registered SO types', () =>
       Object {
         "action": "6cfc277ed3211639e37546ac625f4a68f2494215",
         "action_task_params": "db2afea7d78e00e725486b791554d0d4e81956ef",
-        "alert": "f81ad957a7936522482e4539c7a96a963ebdbc3e",
+        "alert": "38213efd0ec097dcf9a0d9d608f957ae8724e387",
         "api_key_pending_invalidation": "16e7bcf8e78764102d7f525542d5b616809a21ee",
         "apm-indices": "d19dd7fb51f2d2cbc1f8769481721e0953f9a6d2",
         "apm-server-schema": "1d42f17eff9ec6c16d3a9324d9539e2d123d0a9a",

x-pack/examples/triggers_actions_ui_example/public/components/rules_list_notify_badge_sandbox.tsx

@@ -45,6 +45,7 @@ const mockRule: RuleTableItem = {
   ruleType: 'Test Rule Type',
   isEditable: true,
   enabledInLicense: true,
+  revision: 0,
 };
 
 export const RulesListNotifyBadgeSandbox = ({ triggersActionsUi }: SandboxProps) => {

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

@@ -146,6 +146,7 @@ export interface Rule<Params extends RuleTypeParams = never> {
   isSnoozedUntil?: Date | null;
   lastRun?: RuleLastRun | null;
   nextRun?: Date | null;
+  revision: number;
   running?: boolean | null;
 }
 

x-pack/plugins/alerting/public/alert_api.test.ts

@@ -131,6 +131,7 @@ describe('loadRule', () => {
         "params": Object {
           "x": 42,
         },
+        "revision": 0,
         "schedule": Object {
           "interval": "1s",
         },
@@ -267,6 +268,7 @@ function getApiRule() {
     updated_by: '2889684073',
     mute_all: false,
     muted_alert_ids: [],
+    revision: 0,
     schedule: {
       interval: '1s',
     },
@@ -330,5 +332,6 @@ function getRule(): Rule<{ x: number }> {
       lastExecutionDate: RuleExecuteDate,
       lastDuration: 1194,
     },
+    revision: 0,
   };
 }

x-pack/plugins/alerting/public/lib/common_transformations.test.ts

@@ -45,6 +45,7 @@ describe('common_transformations', () => {
       notify_when: 'onActiveAlert',
       mute_all: false,
       muted_alert_ids: ['bob', 'jim'],
+      revision: 0,
       execution_status: {
         last_execution_date: dateExecuted.toISOString(),
         last_duration: 42,
@@ -183,6 +184,7 @@ describe('common_transformations', () => {
             ],
           },
         },
+        "revision": 0,
         "schedule": Object {
           "interval": "1s",
         },
@@ -226,6 +228,7 @@ describe('common_transformations', () => {
       notify_when: 'onActiveAlert',
       mute_all: false,
       muted_alert_ids: ['bob', 'jim'],
+      revision: 0,
       execution_status: {
         last_execution_date: dateExecuted.toISOString(),
         status: 'error',
@@ -340,6 +343,7 @@ describe('common_transformations', () => {
         "nextRun": 2021-12-15T12:34:55.789Z,
         "notifyWhen": "onActiveAlert",
         "params": Object {},
+        "revision": 0,
         "schedule": Object {
           "interval": "1s",
         },

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

@@ -784,4 +784,5 @@ const BaseRule: SanitizedRule<{ bar: boolean }> = {
     status: 'unknown',
     lastExecutionDate: new Date('2020-08-20T19:23:38Z'),
   },
+  revision: 0,
 };

x-pack/plugins/alerting/server/routes/bulk_edit_rules.test.ts

@@ -58,6 +58,7 @@ describe('bulkEditInternalRulesRoute', () => {
       status: 'unknown',
       lastExecutionDate: new Date('2020-08-20T19:23:38Z'),
     },
+    revision: 0,
   };
 
   const mockedAlerts: Array<SanitizedRule<{}>> = [mockedAlert];

x-pack/plugins/alerting/server/routes/clone_rule.test.ts

@@ -64,6 +64,7 @@ describe('cloneRuleRoute', () => {
       status: 'unknown',
       lastExecutionDate: new Date('2020-08-20T19:23:38Z'),
     },
+    revision: 0,
   };
 
   const ruleToClone: AsApiContract<CreateOptions<{ bar: boolean }>['data']> = {
@@ -89,6 +90,7 @@ describe('cloneRuleRoute', () => {
     created_at: mockedRule.createdAt,
     updated_at: mockedRule.updatedAt,
     id: mockedRule.id,
+    revision: 0, // TODO: Finalize clone rule behavior. Clone or reset revision?
     execution_status: {
       status: mockedRule.executionStatus.status,
       last_execution_date: mockedRule.executionStatus.lastExecutionDate,

x-pack/plugins/alerting/server/routes/create_rule.test.ts

@@ -67,6 +67,7 @@ describe('createRuleRoute', () => {
       status: 'unknown',
       lastExecutionDate: new Date('2020-08-20T19:23:38Z'),
     },
+    revision: 0,
   };
 
   const ruleToCreate: AsApiContract<CreateOptions<{ bar: boolean }>['data']> = {
@@ -92,6 +93,7 @@ describe('createRuleRoute', () => {
     created_at: mockedAlert.createdAt,
     updated_at: mockedAlert.updatedAt,
     id: mockedAlert.id,
+    revision: mockedAlert.revision,
     execution_status: {
       status: mockedAlert.executionStatus.status,
       last_execution_date: mockedAlert.executionStatus.lastExecutionDate,

x-pack/plugins/alerting/server/routes/get_rule.test.ts

@@ -61,6 +61,7 @@ describe('getRuleRoute', () => {
       status: 'unknown',
       lastExecutionDate: new Date('2020-08-20T19:23:38Z'),
     },
+    revision: 0,
   };
 
   const getResult: AsApiContract<SanitizedRule<{ bar: boolean }>> = {
@@ -75,6 +76,7 @@ describe('getRuleRoute', () => {
     created_at: mockedAlert.createdAt,
     updated_at: mockedAlert.updatedAt,
     id: mockedAlert.id,
+    revision: mockedAlert.revision,
     execution_status: {
       status: mockedAlert.executionStatus.status,
       last_execution_date: mockedAlert.executionStatus.lastExecutionDate,

x-pack/plugins/alerting/server/routes/legacy/create.test.ts

@@ -80,6 +80,7 @@ describe('createAlertRoute', () => {
       status: 'unknown',
       lastExecutionDate: new Date('2020-08-20T19:23:38Z'),
     },
+    revision: 0,
   };
 
   it('creates an alert with proper parameters', async () => {

x-pack/plugins/alerting/server/routes/legacy/get.test.ts

@@ -66,6 +66,7 @@ describe('getAlertRoute', () => {
       status: 'unknown',
       lastExecutionDate: new Date('2020-08-20T19:23:38Z'),
     },
+    revision: 0,
   };
 
   it('gets an alert with proper parameters', async () => {

x-pack/plugins/alerting/server/routes/lib/rewrite_rule.test.ts

@@ -60,6 +60,7 @@ const sampleRule: SanitizedRule<RuleTypeParams> & { activeSnoozes?: string[] } =
     },
   },
   nextRun: DATE_2020,
+  revision: 0,
 };
 
 describe('rewriteRule', () => {

x-pack/plugins/alerting/server/routes/resolve_rule.test.ts

@@ -63,6 +63,7 @@ describe('resolveRuleRoute', () => {
     },
     outcome: 'aliasMatch',
     alias_target_id: '2',
+    revision: 0,
   };
 
   const resolveResult: AsApiContract<ResolvedSanitizedRule<{ bar: boolean }>> = {
@@ -87,6 +88,7 @@ describe('resolveRuleRoute', () => {
     created_at: mockedRule.createdAt,
     updated_at: mockedRule.updatedAt,
     id: mockedRule.id,
+    revision: mockedRule.revision,
     execution_status: {
       status: mockedRule.executionStatus.status,
       last_execution_date: mockedRule.executionStatus.lastExecutionDate,

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

@@ -0,0 +1,37 @@
+/*
+ * 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 { SavedObject } from '@kbn/core/server';
+import { get, isEqual } from 'lodash';
+import { RawRule, RuleTypeParams } from '../../types';
+import { fieldsToExcludeFromRevisionUpdates, UpdateOptions } from '..';
+
+export function incrementRevision<Params extends RuleTypeParams>(
+  currentRule: SavedObject<RawRule>,
+  { data }: UpdateOptions<Params>,
+  updatedParams: RuleTypeParams
+): number {
+  // Diff root level fields
+  for (const [field, value] of Object.entries(data).filter(([key]) => key !== 'params')) {
+    if (!fieldsToExcludeFromRevisionUpdates.map(toString).includes(field)) {
+      if (!isEqual(value, get(currentRule.attributes, field))) {
+        return currentRule.attributes.revision + 1;
+      }
+    }
+  }
+
+  // Diff rule params
+  for (const [field, value] of Object.entries(updatedParams)) {
+    // TODO: Should RuleTypes have a way to declare fields that should be revision skipped as well?
+    if (!fieldsToExcludeFromRevisionUpdates.map(toString).includes(field)) {
+      if (!isEqual(value, get(currentRule.attributes.params, field))) {
+        return currentRule.attributes.revision + 1;
+      }
+    }
+  }
+  return currentRule.attributes.revision;
+}

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

@@ -15,3 +15,4 @@ export { checkAuthorizationAndGetTotal } from './check_authorization_and_get_tot
 export { scheduleTask } from './schedule_task';
 export { createNewAPIKeySet } from './create_new_api_key_set';
 export { recoverRuleAlerts } from './recover_rule_alerts';
+export { incrementRevision } from './increment_revision';

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

@@ -562,6 +562,7 @@ async function getUpdatedAttributesFromOperations(
         if (isAttributeModified) {
           ruleActions = modifiedAttributes;
           isAttributesUpdateSkipped = false;
+          attributes.revision = attributes.revision + 1;
         }
 
         // TODO https://github.com/elastic/kibana/issues/148414
@@ -631,6 +632,7 @@ async function getUpdatedAttributesFromOperations(
           attributes = {
             ...attributes,
             ...modifiedAttributes,
+            revision: attributes.revision + 1,
           };
           isAttributesUpdateSkipped = false;
         }

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

@@ -117,6 +117,7 @@ export async function clone<Params extends RuleTypeParams = never>(
     mutedInstanceIds: [],
     executionStatus: getRuleExecutionStatusPending(lastRunTimestamp.toISOString()),
     monitoring: getDefaultMonitoring(lastRunTimestamp.toISOString()),
+    revision: 0, // TODO: Clarify if we're resetting revision since it's a new rule, or carrying over from previous rule (existing security solution behavior)
     scheduledTaskId: null,
     running: false,
   };

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

@@ -44,6 +44,7 @@ export interface CreateOptions<Params extends RuleTypeParams> {
     | 'isSnoozedUntil'
     | 'lastRun'
     | 'nextRun'
+    | 'revision'
   > & { actions: NormalizedAlertAction[] };
   options?: SavedObjectOptions;
   allowMissingConnectorSecrets?: boolean;
@@ -153,6 +154,7 @@ export async function create<Params extends RuleTypeParams = never>(
     throttle,
     executionStatus: getRuleExecutionStatusPending(lastRunTimestamp.toISOString()),
     monitoring: getDefaultMonitoring(lastRunTimestamp.toISOString()),
+    revision: 0,
     running: false,
   };
 

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

@@ -24,7 +24,13 @@ import { bulkMarkApiKeysForInvalidation } from '../../invalidate_pending_api_key
 import { ruleAuditEvent, RuleAuditAction } from '../common/audit_events';
 import { getMappedParams } from '../common/mapped_params_utils';
 import { NormalizedAlertAction, RulesClientContext } from '../types';
-import { validateActions, extractReferences, updateMeta, getPartialRuleFromRaw } from '../lib';
+import {
+  validateActions,
+  extractReferences,
+  updateMeta,
+  getPartialRuleFromRaw,
+  incrementRevision,
+} from '../lib';
 import { generateAPIKeyName, apiKeyAsAlertAttributes } from '../common';
 
 export interface UpdateOptions<Params extends RuleTypeParams> {
@@ -144,8 +150,9 @@ async function updateWithOCC<Params extends RuleTypeParams>(
 async function updateAlert<Params extends RuleTypeParams>(
   context: RulesClientContext,
   { id, data, allowMissingConnectorSecrets }: UpdateOptions<Params>,
-  { attributes, version }: SavedObject<RawRule>
+  currentRule: SavedObject<RawRule>
 ): Promise<PartialRule<Params>> {
+  const { attributes, version } = currentRule;
   const ruleType = context.ruleTypeRegistry.get(attributes.alertTypeId);
 
   // TODO https://github.com/elastic/kibana/issues/148414
@@ -195,6 +202,13 @@ async function updateAlert<Params extends RuleTypeParams>(
   const apiKeyAttributes = apiKeyAsAlertAttributes(createdAPIKey, username);
   const notifyWhen = getRuleNotifyWhenType(data.notifyWhen ?? null, data.throttle ?? null);
 
+  // Increment revision if applicable field has changed
+  const revision = incrementRevision<Params>(
+    currentRule,
+    { id, data, allowMissingConnectorSecrets },
+    updatedParams
+  );
+
   let updatedObject: SavedObject<RawRule>;
   const createAttributes = updateMeta(context, {
     ...attributes,
@@ -203,6 +217,7 @@ async function updateAlert<Params extends RuleTypeParams>(
     params: updatedParams as RawRule['params'],
     actions,
     notifyWhen,
+    revision,
     updatedBy: username,
     updatedAt: new Date().toISOString(),
   });

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

@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { SanitizedRule, RuleTypeParams } from '../types';
+import { SanitizedRule, RuleTypeParams, Rule } from '../types';
 import { parseDuration } from '../../common/parse_duration';
 import { RulesClientContext, BulkOptions, MuteOptions } from './types';
 
@@ -66,6 +66,30 @@ const fieldsToExcludeFromPublicApi: Array<keyof SanitizedRule> = [
   'activeSnoozes',
 ];
 
+export const fieldsToExcludeFromRevisionUpdates: Array<keyof Rule> = [
+  'activeSnoozes',
+  'alertTypeId',
+  'apiKey',
+  'apiKeyOwner',
+  'consumer',
+  'createdAt',
+  'createdBy',
+  'enabled',
+  'executionStatus',
+  'id',
+  'isSnoozedUntil',
+  'lastRun',
+  'monitoring',
+  'muteAll',
+  'mutedInstanceIds',
+  'nextRun',
+  'revision',
+  'running',
+  'snoozeSchedule',
+  'updatedBy',
+  'updatedAt',
+];
+
 export class RulesClient {
   private readonly context: RulesClientContext;