[Alerts][License] Define minimum license required for each alert type

x-pack/examples/alerting_example/server/alert_types/always_firing.ts

@@ -41,6 +41,7 @@ export const alertType: AlertType<AlwaysFiringParams> = {
   name: 'Always firing',
   actionGroups: ACTION_GROUPS,
   defaultActionGroupId: DEFAULT_ACTION_GROUP,
+  minimumLicenseRequired: 'basic',
   async executor({
     services,
     params: { instances = DEFAULT_INSTANCES_TO_GENERATE, thresholds },

x-pack/examples/alerting_example/server/alert_types/astros.ts

@@ -42,6 +42,7 @@ export const alertType: AlertType = {
   id: 'example.people-in-space',
   name: 'People In Space Right Now',
   actionGroups: [{ id: 'default', name: 'default' }],
+  minimumLicenseRequired: 'basic',
   defaultActionGroupId: 'default',
   recoveryActionGroup: {
     id: 'hasLandedBackOnEarth',

x-pack/plugins/alerts/README.md

@@ -172,6 +172,7 @@ server.newPlatform.setup.plugins.alerts.registerType({
 			{ name: 'cpuUsage', description: 'CPU usage' },
 		],
 	},
+	minimumLicenseRequired: 'basic',
 	async executor({
     alertId,
 		startedAt,
@@ -239,6 +240,7 @@ server.newPlatform.setup.plugins.alerts.registerType({
 		},
 	],
 	defaultActionGroupId: 'default',
+	minimumLicenseRequired: 'basic',
 	actionVariables: {
 		context: [
 			{ name: 'server', description: 'the server' },

x-pack/plugins/alerts/common/alert_type.ts

@@ -4,6 +4,8 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
+import { LicenseType } from '../../licensing/common/types';
+
 export interface AlertType {
   id: string;
   name: string;
@@ -12,6 +14,7 @@ export interface AlertType {
   actionVariables: string[];
   defaultActionGroupId: ActionGroup['id'];
   producer: string;
+  minimumLicenseRequired: LicenseType;
 }
 
 export interface ActionGroup {

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

@@ -22,6 +22,7 @@ describe('loadAlertTypes', () => {
         actionVariables: ['var1'],
         actionGroups: [{ id: 'default', name: 'Default' }],
         defaultActionGroupId: 'default',
+        minimumLicenseRequired: 'basic',
         recoveryActionGroup: RecoveredActionGroup,
         producer: 'alerts',
       },
@@ -46,6 +47,7 @@ describe('loadAlertType', () => {
       actionVariables: ['var1'],
       actionGroups: [{ id: 'default', name: 'Default' }],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       recoveryActionGroup: RecoveredActionGroup,
       producer: 'alerts',
     };
@@ -67,6 +69,7 @@ describe('loadAlertType', () => {
       actionVariables: [],
       actionGroups: [{ id: 'default', name: 'Default' }],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       recoveryActionGroup: RecoveredActionGroup,
       producer: 'alerts',
     };
@@ -83,6 +86,7 @@ describe('loadAlertType', () => {
         actionVariables: [],
         actionGroups: [{ id: 'default', name: 'Default' }],
         defaultActionGroupId: 'default',
+        minimumLicenseRequired: 'basic',
         recoveryActionGroup: RecoveredActionGroup,
         producer: 'alerts',
       },

x-pack/plugins/alerts/public/alert_navigation_registry/alert_navigation_registry.test.ts

@@ -18,6 +18,7 @@ const mockAlertType = (id: string): AlertType => ({
   actionVariables: [],
   defaultActionGroupId: 'default',
   producer: 'alerts',
+  minimumLicenseRequired: 'basic',
 });
 
 describe('AlertNavigationRegistry', () => {

x-pack/plugins/alerts/server/alert_type_registry.test.ts

@@ -35,6 +35,7 @@ describe('has()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     });
@@ -44,7 +45,7 @@ describe('has()', () => {
 
 describe('register()', () => {
   test('throws if AlertType Id contains invalid characters', () => {
-    const alertType = {
+    const alertType: AlertType = {
       id: 'test',
       name: 'Test',
       actionGroups: [
@@ -54,6 +55,7 @@ describe('register()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     };
@@ -75,7 +77,7 @@ describe('register()', () => {
   });
 
   test('throws if AlertType Id isnt a string', () => {
-    const alertType = {
+    const alertType: AlertType = {
       id: (123 as unknown) as string,
       name: 'Test',
       actionGroups: [
@@ -85,6 +87,7 @@ describe('register()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     };
@@ -96,7 +99,7 @@ describe('register()', () => {
   });
 
   test('throws if AlertType action groups contains reserved group id', () => {
-    const alertType = {
+    const alertType: AlertType = {
       id: 'test',
       name: 'Test',
       actionGroups: [
@@ -110,6 +113,7 @@ describe('register()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     };
@@ -123,7 +127,7 @@ describe('register()', () => {
   });
 
   test('allows an AlertType to specify a custom recovery group', () => {
-    const alertType = {
+    const alertType: AlertType = {
       id: 'test',
       name: 'Test',
       actionGroups: [
@@ -139,6 +143,7 @@ describe('register()', () => {
       },
       executor: jest.fn(),
       producer: 'alerts',
+      minimumLicenseRequired: 'basic',
     };
     const registry = new AlertTypeRegistry(alertTypeRegistryParams);
     registry.register(alertType);
@@ -157,7 +162,7 @@ describe('register()', () => {
   });
 
   test('throws if the custom recovery group is contained in the AlertType action groups', () => {
-    const alertType = {
+    const alertType: AlertType = {
       id: 'test',
       name: 'Test',
       actionGroups: [
@@ -175,6 +180,7 @@ describe('register()', () => {
         name: 'Back To Awesome',
       },
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     };
@@ -188,7 +194,7 @@ describe('register()', () => {
   });
 
   test('registers the executor with the task manager', () => {
-    const alertType = {
+    const alertType: AlertType = {
       id: 'test',
       name: 'Test',
       actionGroups: [
@@ -198,6 +204,7 @@ describe('register()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     };
@@ -227,6 +234,7 @@ describe('register()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     };
@@ -248,6 +256,7 @@ describe('register()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     });
@@ -262,6 +271,7 @@ describe('register()', () => {
           },
         ],
         defaultActionGroupId: 'default',
+        minimumLicenseRequired: 'basic',
         executor: jest.fn(),
         producer: 'alerts',
       })
@@ -282,6 +292,7 @@ describe('get()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     });
@@ -306,6 +317,7 @@ describe('get()', () => {
         "defaultActionGroupId": "default",
         "executor": [MockFunction],
         "id": "test",
+        "minimumLicenseRequired": "basic",
         "name": "Test",
         "producer": "alerts",
         "recoveryActionGroup": Object {
@@ -343,6 +355,7 @@ describe('list()', () => {
         },
       ],
       defaultActionGroupId: 'testActionGroup',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     });
@@ -367,6 +380,7 @@ describe('list()', () => {
           },
           "defaultActionGroupId": "testActionGroup",
           "id": "test",
+          "minimumLicenseRequired": "basic",
           "name": "Test",
           "producer": "alerts",
           "recoveryActionGroup": Object {
@@ -414,11 +428,12 @@ describe('list()', () => {
 });
 
 function alertTypeWithVariables(id: string, context: string, state: string): AlertType {
-  const baseAlert = {
+  const baseAlert: AlertType = {
     id,
     name: `${id}-name`,
     actionGroups: [],
     defaultActionGroupId: id,
+    minimumLicenseRequired: 'basic',
     async executor() {},
     producer: 'alerts',
   };

x-pack/plugins/alerts/server/alert_type_registry.ts

@@ -146,6 +146,7 @@ export class AlertTypeRegistry {
             defaultActionGroupId,
             actionVariables,
             producer,
+            minimumLicenseRequired,
           },
         ]: [string, NormalizedAlertType]) => ({
           id,
@@ -155,6 +156,7 @@ export class AlertTypeRegistry {
           defaultActionGroupId,
           actionVariables,
           producer,
+          minimumLicenseRequired,
         })
       )
     );

x-pack/plugins/alerts/server/alerts_client/tests/aggregate.test.ts

@@ -54,6 +54,7 @@ describe('aggregate()', () => {
       actionGroups: [],
       actionVariables: undefined,
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       recoveryActionGroup: RecoveredActionGroup,
       id: 'myType',
       name: 'myType',
@@ -104,6 +105,7 @@ describe('aggregate()', () => {
           name: 'Test',
           actionGroups: [{ id: 'default', name: 'Default' }],
           defaultActionGroupId: 'default',
+          minimumLicenseRequired: 'basic',
           recoveryActionGroup: RecoveredActionGroup,
           producer: 'alerts',
           authorizedConsumers: {

x-pack/plugins/alerts/server/alerts_client/tests/create.test.ts

@@ -759,6 +759,7 @@ describe('create()', () => {
           threshold: schema.number({ min: 0, max: 1 }),
         }),
       },
+      minimumLicenseRequired: 'basic',
       async executor() {},
       producer: 'alerts',
     });

x-pack/plugins/alerts/server/alerts_client/tests/find.test.ts

@@ -59,6 +59,7 @@ describe('find()', () => {
       recoveryActionGroup: RecoveredActionGroup,
       actionVariables: undefined,
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       id: 'myType',
       name: 'myType',
       producer: 'myApp',
@@ -115,6 +116,7 @@ describe('find()', () => {
           actionGroups: [{ id: 'default', name: 'Default' }],
           recoveryActionGroup: RecoveredActionGroup,
           defaultActionGroupId: 'default',
+          minimumLicenseRequired: 'basic',
           producer: 'alerts',
           authorizedConsumers: {
             myApp: { read: true, all: true },

x-pack/plugins/alerts/server/alerts_client/tests/lib.ts

@@ -85,6 +85,7 @@ export function getBeforeSetup(
     actionGroups: [{ id: 'default', name: 'Default' }],
     recoveryActionGroup: RecoveredActionGroup,
     defaultActionGroupId: 'default',
+    minimumLicenseRequired: 'basic',
     async executor() {},
     producer: 'alerts',
   }));

x-pack/plugins/alerts/server/alerts_client/tests/list_alert_types.test.ts

@@ -51,6 +51,7 @@ describe('listAlertTypes', () => {
     actionGroups: [],
     actionVariables: undefined,
     defaultActionGroupId: 'default',
+    minimumLicenseRequired: 'basic',
     recoveryActionGroup: RecoveredActionGroup,
     id: 'alertingAlertType',
     name: 'alertingAlertType',
@@ -60,6 +61,7 @@ describe('listAlertTypes', () => {
     actionGroups: [],
     actionVariables: undefined,
     defaultActionGroupId: 'default',
+    minimumLicenseRequired: 'basic',
     recoveryActionGroup: RecoveredActionGroup,
     id: 'myAppAlertType',
     name: 'myAppAlertType',
@@ -99,6 +101,7 @@ describe('listAlertTypes', () => {
         actionGroups: [],
         actionVariables: undefined,
         defaultActionGroupId: 'default',
+        minimumLicenseRequired: 'basic',
         recoveryActionGroup: RecoveredActionGroup,
         id: 'myType',
         name: 'myType',
@@ -109,6 +112,7 @@ describe('listAlertTypes', () => {
         name: 'Test',
         actionGroups: [{ id: 'default', name: 'Default' }],
         defaultActionGroupId: 'default',
+        minimumLicenseRequired: 'basic',
         recoveryActionGroup: RecoveredActionGroup,
         producer: 'alerts',
       },
@@ -124,6 +128,7 @@ describe('listAlertTypes', () => {
           name: 'Test',
           actionGroups: [{ id: 'default', name: 'Default' }],
           defaultActionGroupId: 'default',
+          minimumLicenseRequired: 'basic',
           recoveryActionGroup: RecoveredActionGroup,
           producer: 'alerts',
           authorizedConsumers: {

x-pack/plugins/alerts/server/alerts_client/tests/update.test.ts

@@ -102,6 +102,7 @@ describe('update()', () => {
       name: 'Test',
       actionGroups: [{ id: 'default', name: 'Default' }],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       recoveryActionGroup: RecoveredActionGroup,
       async executor() {},
       producer: 'alerts',
@@ -682,6 +683,7 @@ describe('update()', () => {
       name: 'Test',
       actionGroups: [{ id: 'default', name: 'Default' }],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       recoveryActionGroup: RecoveredActionGroup,
       validate: {
         params: schema.object({
@@ -1028,6 +1030,7 @@ describe('update()', () => {
         name: 'Test',
         actionGroups: [{ id: 'default', name: 'Default' }],
         defaultActionGroupId: 'default',
+        minimumLicenseRequired: 'basic',
         recoveryActionGroup: RecoveredActionGroup,
         async executor() {},
         producer: 'alerts',