[7.x] [Alerting] make actionGroup name's i18n-able (#57404) (#57505)

* [Alerting] make actionGroup name's i18n-able (#57404)

We want to make the Action Group i18n-able for display in the AlertDetails page, so instead of just a list of ids, the AlertType now registers an object where key is the id and value is the human readable, and translatable, value.

* fixed issue introduced by merge conflict

* fixed merge conflict

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Author: gmmorris

x-pack/legacy/plugins/alerting/README.md

@@ -85,7 +85,7 @@ The following table describes the properties of the `options` object.
 |---|---|---|
 |id|Unique identifier for the alert type. For convention purposes, ids starting with `.` are reserved for built in alert types. We recommend using a convention like `<plugin_id>.mySpecialAlert` for your alert types to avoid conflicting with another plugin.|string|
 |name|A user-friendly name for the alert type. These will be displayed in dropdowns when choosing alert types.|string|
-|actionGroups|An explicit list of groups the alert type may schedule actions for. Alert `actions` validation will use this array to ensure groups are valid.|string[]|
+|actionGroups|An explicit list of groups the alert type may schedule actions for, each specifying the ActionGroup's unique ID and human readable name. Alert `actions` validation will use this configuartion to ensure groups are valid. We highly encourage using `kbn-i18n` to translate the names of actionGroup  when registering the AlertType. |Array<{id:string, name:string}>|
 |validate.params|When developing an alert type, you can choose to accept a series of parameters. You may also have the parameters validated before they are passed to the `executor` function or created as an alert saved object. In order to do this, provide a `@kbn/config-schema` schema that we will use to validate the `params` attribute.|@kbn/config-schema|
 |executor|This is where the code of the alert type lives. This is a function to be called when executing an alert on an interval basis. For full details, see executor section below.|Function|
 

x-pack/legacy/plugins/alerting/server/alert_type_registry.test.ts

@@ -118,7 +118,12 @@ describe('list()', () => {
     registry.register({
       id: 'test',
       name: 'Test',
-      actionGroups: [],
+      actionGroups: [
+        {
+          id: 'testActionGroup',
+          name: 'Test Action Group',
+        },
+      ],
       executor: jest.fn(),
     });
     const result = registry.list();

x-pack/legacy/plugins/alerting/server/alerts_client.test.ts

@@ -86,7 +86,7 @@ describe('create()', () => {
     alertTypeRegistry.get.mockReturnValue({
       id: '123',
       name: 'Test',
-      actionGroups: ['default'],
+      actionGroups: [{ id: 'default', name: 'Default' }],
       async executor() {},
     });
   });
@@ -1884,7 +1884,7 @@ describe('update()', () => {
     alertTypeRegistry.get.mockReturnValue({
       id: '123',
       name: 'Test',
-      actionGroups: ['default'],
+      actionGroups: [{ id: 'default', name: 'Default' }],
       async executor() {},
     });
   });
@@ -2414,7 +2414,7 @@ describe('update()', () => {
     alertTypeRegistry.get.mockReturnValueOnce({
       id: '123',
       name: 'Test',
-      actionGroups: ['default'],
+      actionGroups: [{ id: 'default', name: 'Default' }],
       validate: {
         params: schema.object({
           param1: schema.string(),
@@ -2646,7 +2646,7 @@ describe('update()', () => {
       alertTypeRegistry.get.mockReturnValueOnce({
         id: '123',
         name: 'Test',
-        actionGroups: ['default'],
+        actionGroups: [{ id: 'default', name: 'Default' }],
         async executor() {},
       });
       savedObjectsClient.bulkGet.mockResolvedValueOnce({

x-pack/legacy/plugins/alerting/server/alerts_client.ts

@@ -5,7 +5,7 @@
  */
 
 import Boom from 'boom';
-import { omit, isEqual } from 'lodash';
+import { omit, isEqual, pluck } from 'lodash';
 import { i18n } from '@kbn/i18n';
 import {
   Logger,
@@ -639,8 +639,9 @@ export class AlertsClient {
   private validateActions(alertType: AlertType, actions: NormalizedAlertAction[]): void {
     const { actionGroups: alertTypeActionGroups } = alertType;
     const usedAlertActionGroups = actions.map(action => action.group);
+    const availableAlertTypeActionGroups = new Set(pluck(alertTypeActionGroups, 'id'));
     const invalidActionGroups = usedAlertActionGroups.filter(
-      group => !alertTypeActionGroups.includes(group)
+      group => !availableAlertTypeActionGroups.has(group)
     );
     if (invalidActionGroups.length) {
       throw Boom.badRequest(

x-pack/legacy/plugins/alerting/server/task_runner/create_execution_handler.test.ts

@@ -11,7 +11,10 @@ import { loggingServiceMock } from '../../../../../../src/core/server/mocks';
 const alertType: AlertType = {
   id: 'test',
   name: 'Test',
-  actionGroups: ['default', 'other-group'],
+  actionGroups: [
+    { id: 'default', name: 'Default' },
+    { id: 'other-group', name: 'Other Group' },
+  ],
   executor: jest.fn(),
 };
 

x-pack/legacy/plugins/alerting/server/task_runner/create_execution_handler.ts

@@ -4,6 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
+import { pluck } from 'lodash';
 import { AlertAction, State, Context, AlertType } from '../types';
 import { Logger } from '../../../../../../src/core/server';
 import { transformActionParams } from './transform_action_params';
@@ -35,8 +36,9 @@ export function createExecutionHandler({
   apiKey,
   alertType,
 }: CreateExecutionHandlerOptions) {
+  const alertTypeActionGroups = new Set(pluck(alertType.actionGroups, 'id'));
   return async ({ actionGroup, context, state, alertInstanceId }: ExecutionHandlerOptions) => {
-    if (!alertType.actionGroups.includes(actionGroup)) {
+    if (!alertTypeActionGroups.has(actionGroup)) {
       logger.error(`Invalid action group "${actionGroup}" for alert "${alertType.id}".`);
       return;
     }

x-pack/legacy/plugins/alerting/server/task_runner/task_runner.test.ts

@@ -19,7 +19,7 @@ import {
 const alertType = {
   id: 'test',
   name: 'My test alert',
-  actionGroups: ['default'],
+  actionGroups: [{ id: 'default', name: 'Default' }],
   executor: jest.fn(),
 };
 let fakeTimer: sinon.SinonFakeTimers;

x-pack/legacy/plugins/alerting/server/task_runner/task_runner_factory.test.ts

@@ -16,7 +16,7 @@ import {
 const alertType = {
   id: 'test',
   name: 'My test alert',
-  actionGroups: ['default'],
+  actionGroups: [{ id: 'default', name: 'Default' }],
   executor: jest.fn(),
 };
 let fakeTimer: sinon.SinonFakeTimers;

x-pack/legacy/plugins/alerting/server/types.ts

@@ -42,13 +42,18 @@ export interface AlertExecutorOptions {
   updatedBy: string | null;
 }
 
+export interface ActionGroup {
+  id: string;
+  name: string;
+}
+
 export interface AlertType {
   id: string;
   name: string;
   validate?: {
     params?: { validate: (object: any) => any };
   };
-  actionGroups: string[];
+  actionGroups: ActionGroup[];
   executor: ({ services, params, state }: AlertExecutorOptions) => Promise<State | void>;
 }
 

x-pack/legacy/plugins/monitoring/server/alerts/license_expiration.test.ts

@@ -102,7 +102,7 @@ describe('getLicenseExpiration', () => {
   it('should have the right id and actionGroups', () => {
     const alert = getLicenseExpiration(server, getMonitoringCluster, getLogger, ccrEnabled);
     expect(alert.id).toBe(ALERT_TYPE_LICENSE_EXPIRATION);
-    expect(alert.actionGroups).toEqual(['default']);
+    expect(alert.actionGroups).toEqual([{ id: 'default', name: 'Default' }]);
   });
 
   it('should return the state if no license is provided', async () => {