[RAM][HTTP Versioning] Version GET Rule Route (#181304)

## Summary Parent Issue: #157883 Issue: #181263 Versions the GET rule endpoint with added input and output validation. ``` GET /internal/alerting/rule/{id} GET /api/alerting/rule/{id} ``` ### Checklist Delete any items that are not applicable to this PR. - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios
elastic · Apr 30, 2024 · a1ada76 · a1ada76
1 parent 5814f2e
commit a1ada76
Show file tree

Hide file tree

Showing 39 changed files with 707 additions and 299 deletions.
diff --git a/x-pack/plugins/alerting/common/routes/rule/apis/get/index.ts b/x-pack/plugins/alerting/common/routes/rule/apis/get/index.ts
@@ -0,0 +1,15 @@
+/*
+ * 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 { getRuleRequestParamsSchema } from './schemas/latest';
+export type { GetRuleRequestParams, GetRuleResponse } from './types/latest';
+
+export { getRuleRequestParamsSchema as getRuleRequestParamsSchemaV1 } from './schemas/v1';
+export type {
+  GetRuleRequestParams as GetRuleRequestParamsV1,
+  GetRuleResponse as GetRuleResponseV1,
+} from './types/v1';
diff --git a/x-pack/plugins/alerting/common/routes/rule/apis/get/schemas/latest.ts b/x-pack/plugins/alerting/common/routes/rule/apis/get/schemas/latest.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 * from './v1';
diff --git a/x-pack/plugins/alerting/common/routes/rule/apis/get/schemas/v1.ts b/x-pack/plugins/alerting/common/routes/rule/apis/get/schemas/v1.ts
@@ -0,0 +1,12 @@
+/*
+ * 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 { schema } from '@kbn/config-schema';
+
+export const getRuleRequestParamsSchema = schema.object({
+  id: schema.string(),
+});
diff --git a/x-pack/plugins/alerting/common/routes/rule/apis/get/types/latest.ts b/x-pack/plugins/alerting/common/routes/rule/apis/get/types/latest.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 * from './v1';
diff --git a/x-pack/plugins/alerting/common/routes/rule/apis/get/types/v1.ts b/x-pack/plugins/alerting/common/routes/rule/apis/get/types/v1.ts
@@ -0,0 +1,16 @@
+/*
+ * 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 type { TypeOf } from '@kbn/config-schema';
+import { RuleParamsV1, RuleResponseV1 } from '../../../response';
+import { getRuleRequestParamsSchemaV1 } from '..';
+
+export type GetRuleRequestParams = TypeOf<typeof getRuleRequestParamsSchemaV1>;
+
+export interface GetRuleResponse<Params extends RuleParamsV1 = never> {
+  body: RuleResponseV1<Params>;
+}
diff --git a/x-pack/plugins/alerting/common/routes/rule/response/types/v1.ts b/x-pack/plugins/alerting/common/routes/rule/response/types/v1.ts
@@ -43,7 +43,7 @@ export interface RuleResponse<Params extends RuleParams = never> {
   mute_all: RuleResponseSchemaType['mute_all'];
   notify_when?: RuleResponseSchemaType['notify_when'];
   muted_alert_ids: RuleResponseSchemaType['muted_alert_ids'];
-  execution_status: RuleResponseSchemaType['execution_status'];
+  execution_status?: RuleResponseSchemaType['execution_status'];
   monitoring?: RuleResponseSchemaType['monitoring'];
   snooze_schedule?: RuleResponseSchemaType['snooze_schedule'];
   active_snoozes?: RuleResponseSchemaType['active_snoozes'];

diff --git a/...k/plugins/alerting/server/application/backfill/methods/schedule/schedule_backfill.test.ts b/...k/plugins/alerting/server/application/backfill/methods/schedule/schedule_backfill.test.ts
@@ -400,6 +400,7 @@ describe('scheduleBackfill()', () => {
       rules: [
         {
           id: existingDecryptedRule1.id,
+          legacyId: null,
           actions: existingDecryptedRule1.attributes.actions,
           alertTypeId: existingDecryptedRule1.attributes.alertTypeId,
           apiKey: existingDecryptedRule1.attributes.apiKey,
@@ -430,6 +431,7 @@ describe('scheduleBackfill()', () => {
         },
         {
           id: existingDecryptedRule2.id,
+          legacyId: null,
           actions: existingDecryptedRule2.attributes.actions,
           alertTypeId: existingDecryptedRule2.attributes.alertTypeId,
           apiKey: existingDecryptedRule2.attributes.apiKey,

diff --git a/...ing/server/rules_client/tests/get.test.ts → ...ication/rule/methods/get/get_rule.test.ts b/...ing/server/rules_client/tests/get.test.ts → ...ication/rule/methods/get/get_rule.test.ts
@@ -6,29 +6,29 @@
  */
 import { AlertConsumers } from '@kbn/rule-data-utils';
 
-import { RulesClient, ConstructorOptions } from '../rules_client';
+import { RulesClient, ConstructorOptions } from '../../../../rules_client/rules_client';
 import {
   savedObjectsClientMock,
   loggingSystemMock,
   savedObjectsRepositoryMock,
   uiSettingsServiceMock,
 } from '@kbn/core/server/mocks';
 import { taskManagerMock } from '@kbn/task-manager-plugin/server/mocks';
-import { ruleTypeRegistryMock } from '../../rule_type_registry.mock';
-import { alertingAuthorizationMock } from '../../authorization/alerting_authorization.mock';
+import { ruleTypeRegistryMock } from '../../../../rule_type_registry.mock';
+import { alertingAuthorizationMock } from '../../../../authorization/alerting_authorization.mock';
 import { encryptedSavedObjectsMock } from '@kbn/encrypted-saved-objects-plugin/server/mocks';
 import { actionsAuthorizationMock } from '@kbn/actions-plugin/server/mocks';
-import { AlertingAuthorization } from '../../authorization/alerting_authorization';
+import { AlertingAuthorization } from '../../../../authorization/alerting_authorization';
 import { ActionsAuthorization } from '@kbn/actions-plugin/server';
 import { auditLoggerMock } from '@kbn/security-plugin/server/audit/mocks';
-import { getBeforeSetup, setGlobalDate } from './lib';
-import { RecoveredActionGroup } from '../../../common';
-import { formatLegacyActions } from '../lib';
-import { ConnectorAdapterRegistry } from '../../connector_adapters/connector_adapter_registry';
-import { RULE_SAVED_OBJECT_TYPE } from '../../saved_objects';
-import { backfillClientMock } from '../../backfill_client/backfill_client.mock';
+import { getBeforeSetup, setGlobalDate } from '../../../../rules_client/tests/lib';
+import { RecoveredActionGroup } from '../../../../../common';
+import { formatLegacyActions } from '../../../../rules_client/lib';
+import { ConnectorAdapterRegistry } from '../../../../connector_adapters/connector_adapter_registry';
+import { RULE_SAVED_OBJECT_TYPE } from '../../../../saved_objects';
+import { backfillClientMock } from '../../../../backfill_client/backfill_client.mock';
 
-jest.mock('../lib/siem_legacy_actions/format_legacy_actions', () => {
+jest.mock('../../../../rules_client/lib/siem_legacy_actions/format_legacy_actions', () => {
   return {
     formatLegacyActions: jest.fn(),
   };
@@ -91,6 +91,10 @@ describe('get()', () => {
         params: {
           bar: true,
         },
+        executionStatus: {
+          status: 'unknown',
+          lastExecutionDate: new Date('2020-08-20T19:23:38Z'),
+        },
         createdAt: new Date().toISOString(),
         updatedAt: new Date().toISOString(),
         actions: [
@@ -128,6 +132,10 @@ describe('get()', () => {
         ],
         "alertTypeId": "123",
         "createdAt": 2019-02-12T21:01:22.479Z,
+        "executionStatus": Object {
+          "lastExecutionDate": 2020-08-20T19:23:38.000Z,
+          "status": "unknown",
+        },
         "id": "1",
         "notifyWhen": "onActiveAlert",
         "params": Object {
@@ -143,11 +151,12 @@ describe('get()', () => {
     `);
     expect(unsecuredSavedObjectsClient.get).toHaveBeenCalledTimes(1);
     expect(unsecuredSavedObjectsClient.get.mock.calls[0]).toMatchInlineSnapshot(`
-                                                                                                                  Array [
-                                                                                                                    "alert",
-                                                                                                                    "1",
-                                                                                                                  ]
-                                                                            `);
+      Array [
+        "alert",
+        "1",
+        undefined,
+      ]
+    `);
   });
 
   test('gets rule with actions using preconfigured connectors', async () => {
@@ -161,6 +170,10 @@ describe('get()', () => {
         params: {
           bar: true,
         },
+        executionStatus: {
+          status: 'unknown',
+          lastExecutionDate: new Date('2020-08-20T19:23:38Z'),
+        },
         createdAt: new Date().toISOString(),
         updatedAt: new Date().toISOString(),
         actions: [
@@ -214,6 +227,10 @@ describe('get()', () => {
         ],
         "alertTypeId": "123",
         "createdAt": 2019-02-12T21:01:22.479Z,
+        "executionStatus": Object {
+          "lastExecutionDate": 2020-08-20T19:23:38.000Z,
+          "status": "unknown",
+        },
         "id": "1",
         "notifyWhen": "onActiveAlert",
         "params": Object {
@@ -229,11 +246,12 @@ describe('get()', () => {
     `);
     expect(unsecuredSavedObjectsClient.get).toHaveBeenCalledTimes(1);
     expect(unsecuredSavedObjectsClient.get.mock.calls[0]).toMatchInlineSnapshot(`
-                                                                                                                  Array [
-                                                                                                                    "alert",
-                                                                                                                    "1",
-                                                                                                                  ]
-                                                                            `);
+      Array [
+        "alert",
+        "1",
+        undefined,
+      ]
+    `);
   });
 
   test('gets rule with actions using system connectors', async () => {
@@ -247,6 +265,10 @@ describe('get()', () => {
         params: {
           bar: true,
         },
+        executionStatus: {
+          status: 'unknown',
+          lastExecutionDate: new Date('2020-08-20T19:23:38Z'),
+        },
         createdAt: new Date().toISOString(),
         updatedAt: new Date().toISOString(),
         actions: [
@@ -289,6 +311,10 @@ describe('get()', () => {
         ],
         "alertTypeId": "123",
         "createdAt": 2019-02-12T21:01:22.479Z,
+        "executionStatus": Object {
+          "lastExecutionDate": 2020-08-20T19:23:38.000Z,
+          "status": "unknown",
+        },
         "id": "1",
         "notifyWhen": "onActiveAlert",
         "params": Object {
@@ -311,11 +337,12 @@ describe('get()', () => {
     `);
     expect(unsecuredSavedObjectsClient.get).toHaveBeenCalledTimes(1);
     expect(unsecuredSavedObjectsClient.get.mock.calls[0]).toMatchInlineSnapshot(`
-                                                                                                                  Array [
-                                                                                                                    "alert",
-                                                                                                                    "1",
-                                                                                                                  ]
-                                                                            `);
+      Array [
+        "alert",
+        "1",
+        undefined,
+      ]
+    `);
   });
 
   test('should call useSavedObjectReferences.injectReferences if defined for rule type', async () => {
@@ -356,6 +383,10 @@ describe('get()', () => {
           bar: true,
           parameterThatIsSavedObjectRef: 'soRef_0',
         },
+        executionStatus: {
+          status: 'unknown',
+          lastExecutionDate: new Date('2020-08-20T19:23:38Z'),
+        },
         createdAt: new Date().toISOString(),
         updatedAt: new Date().toISOString(),
         actions: [
@@ -406,6 +437,10 @@ describe('get()', () => {
         ],
         "alertTypeId": "123",
         "createdAt": 2019-02-12T21:01:22.479Z,
+        "executionStatus": Object {
+          "lastExecutionDate": 2020-08-20T19:23:38.000Z,
+          "status": "unknown",
+        },
         "id": "1",
         "notifyWhen": "onActiveAlert",
         "params": Object {
@@ -487,6 +522,10 @@ describe('get()', () => {
           bar: true,
           parameterThatIsSavedObjectRef: 'soRef_0',
         },
+        executionStatus: {
+          status: 'unknown',
+          lastExecutionDate: new Date('2020-08-20T19:23:38Z'),
+        },
         createdAt: new Date().toISOString(),
         updatedAt: new Date().toISOString(),
         actions: [
@@ -530,6 +569,10 @@ describe('get()', () => {
           params: {
             bar: true,
           },
+          executionStatus: {
+            status: 'unknown',
+            lastExecutionDate: new Date('2020-08-20T19:23:38Z'),
+          },
           actions: [
             {
               group: 'default',
@@ -592,6 +635,10 @@ describe('get()', () => {
           params: {
             bar: true,
           },
+          executionStatus: {
+            status: 'unknown',
+            lastExecutionDate: new Date('2020-08-20T19:23:38Z'),
+          },
           actions: [],
         },
         references: [],
@@ -648,6 +695,10 @@ describe('get()', () => {
         params: {
           bar: true,
         },
+        executionStatus: {
+          status: 'unknown',
+          lastExecutionDate: new Date('2020-08-20T19:23:38Z'),
+        },
         createdAt: new Date().toISOString(),
         updatedAt: new Date().toISOString(),
         actions: [