[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": "2568bf6d8ba0876441c61c9e58e08016c1dc1617",
+        "alert": "b5e89cf14a72ec1d8ff81c58e71188f6c5bd812a",
         "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

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

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

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

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

@@ -46,6 +46,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,
@@ -185,6 +186,7 @@ describe('common_transformations', () => {
             ],
           },
         },
+        "revision": 0,
         "schedule": Object {
           "interval": "1s",
         },
@@ -229,6 +231,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',
@@ -344,6 +347,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

@@ -59,6 +59,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

@@ -65,6 +65,7 @@ describe('cloneRuleRoute', () => {
       status: 'unknown',
       lastExecutionDate: new Date('2020-08-20T19:23:38Z'),
     },
+    revision: 0,
   };
 
   const ruleToClone: AsApiContract<CreateOptions<{ bar: boolean }>['data']> = {
@@ -90,6 +91,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

@@ -68,6 +68,7 @@ describe('createRuleRoute', () => {
       status: 'unknown',
       lastExecutionDate: new Date('2020-08-20T19:23:38Z'),
     },
+    revision: 0,
   };
 
   const ruleToCreate: AsApiContract<CreateOptions<{ bar: boolean }>['data']> = {
@@ -93,6 +94,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

@@ -62,6 +62,7 @@ describe('getRuleRoute', () => {
       status: 'unknown',
       lastExecutionDate: new Date('2020-08-20T19:23:38Z'),
     },
+    revision: 0,
   };
 
   const getResult: AsApiContract<SanitizedRule<{ bar: boolean }>> = {
@@ -76,6 +77,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

@@ -64,6 +64,7 @@ describe('resolveRuleRoute', () => {
     },
     outcome: 'aliasMatch',
     alias_target_id: '2',
+    revision: 0,
   };
 
   const resolveResult: AsApiContract<ResolvedSanitizedRule<{ bar: boolean }>> = {
@@ -88,6 +89,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.test.ts

@@ -0,0 +1,100 @@
+/*
+ * 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 { UpdateOptions } from '..';
+import { mockedDateString } from '../tests/lib';
+import { incrementRevision } from './increment_revision';
+import { SavedObject } from '@kbn/core/server';
+import { RawRule, RuleTypeParams } from '../../types';
+
+describe('incrementRevision', () => {
+  const currentRule: SavedObject<RawRule> = {
+    id: '1',
+    type: 'alert',
+    attributes: {
+      enabled: true,
+      name: 'rule-name',
+      tags: ['tag-1', 'tag-2'],
+      alertTypeId: '123',
+      consumer: 'rule-consumer',
+      legacyId: null,
+      schedule: { interval: '1s' },
+      actions: [],
+      params: {},
+      createdBy: null,
+      updatedBy: null,
+      createdAt: mockedDateString,
+      updatedAt: mockedDateString,
+      apiKey: null,
+      apiKeyOwner: null,
+      throttle: null,
+      notifyWhen: null,
+      muteAll: false,
+      mutedInstanceIds: [],
+      executionStatus: {
+        status: 'unknown',
+        lastExecutionDate: '2020-08-20T19:23:38Z',
+        error: null,
+        warning: null,
+      },
+      revision: 0,
+    },
+    references: [],
+  };
+
+  const updateOptions: UpdateOptions<RuleTypeParams> = {
+    id: '1',
+    data: {
+      schedule: {
+        interval: '1m',
+      },
+      name: 'abc',
+      tags: ['foo'],
+      params: {
+        bar: true,
+        risk_score: 40,
+        severity: 'low',
+      },
+      throttle: null,
+      notifyWhen: 'onActiveAlert',
+      actions: [],
+    },
+  };
+  const updatedParams: RuleTypeParams = { bar: true, risk_score: 40, severity: 'low' };
+
+  it('should return the current revision if no attrs or params are updated', () => {
+    // @ts-expect-error
+    expect(incrementRevision(currentRule, { data: {} }, {})).toBe(0);
+  });
+
+  it('should increment the revision if a root level attr is updated', () => {
+    expect(incrementRevision(currentRule, updateOptions, {})).toBe(1);
+  });
+
+  it('should increment the revision if a rule param is updated', () => {
+    // @ts-expect-error
+    expect(incrementRevision(currentRule, { data: {} }, updatedParams)).toBe(1);
+  });
+
+  it('should not increment the revision if an excluded attr is updated', () => {
+    // @ts-expect-error
+    expect(incrementRevision(currentRule, { data: { activeSnoozes: 'excludedValue' } }, {})).toBe(
+      0
+    );
+  });
+
+  it('should not increment the revision if an excluded param is updated', () => {
+    expect(
+      incrementRevision(
+        currentRule,
+        // @ts-expect-error
+        { data: {} },
+        { isSnoozedUntil: '1970-01-02T00:00:00.000Z' }
+      )
+    ).toBe(0);
+  });
+});

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 attrs
+  for (const [field, value] of Object.entries(data).filter(([key]) => key !== 'params')) {
+    if (!fieldsToExcludeFromRevisionUpdates.has(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.has(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

@@ -16,3 +16,4 @@ export { scheduleTask } from './schedule_task';
 export { createNewAPIKeySet } from './create_new_api_key_set';
 export { recoverRuleAlerts } from './recover_rule_alerts';
 export { addUuid } from './add_uuid';
+export { incrementRevision } from './increment_revision';

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

@@ -69,6 +69,11 @@ export type BulkEditFields = keyof Pick<
   'actions' | 'tags' | 'schedule' | 'throttle' | 'notifyWhen' | 'snoozeSchedule' | 'apiKey'
 >;
 
+export const bulkEditFieldsToExcludeFromRevisionUpdates: Set<BulkEditOperation['field']> = new Set([
+  'snoozeSchedule',
+  'apiKey',
+]);
+
 export type BulkEditOperation =
   | {
       operation: 'add' | 'delete' | 'set';
@@ -427,6 +432,11 @@ async function updateRuleAttributesAndParamsInMemory<Params extends RuleTypePara
           isParamsUpdateSkipped: true,
         };
 
+    // Increment revision if params ended up being modified AND it wasn't already incremented as part of attribute update
+    if (!isParamsUpdateSkipped && rule.attributes.revision === attributes.revision) {
+      attributes.revision += 1;
+    }
+
     // If neither attributes nor parameters were updated, mark
     // the rule as skipped and continue to the next rule.
     if (isAttributesUpdateSkipped && isParamsUpdateSkipped) {
@@ -646,6 +656,13 @@ async function getUpdatedAttributesFromOperations(
         }
       }
     }
+    // Only increment revision if update wasn't skipped and `operation.field` should result in a revision increment
+    if (
+      !isAttributesUpdateSkipped &&
+      !bulkEditFieldsToExcludeFromRevisionUpdates.has(operation.field)
+    ) {
+      attributes.revision += 1;
+    }
   }
   return {
     attributes,

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

@@ -43,6 +43,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,
   };