Introduce basic alerting and actions plugin

.i18nrc.json

@@ -23,6 +23,8 @@
  "tagCloud": "src/legacy/core_plugins/tagcloud",
  "tsvb": "src/legacy/core_plugins/metrics",
  "kbnESQuery": "packages/kbn-es-query",
+ "xpack.actions": "x-pack/plugins/actions",
+ "xpack.alerting": "x-pack/plugins/alerting",
  "xpack.apm": "x-pack/plugins/apm",
  "xpack.beatsManagement": "x-pack/plugins/beats_management",
  "xpack.canvas": "x-pack/plugins/canvas",

src/core/server/mocks.ts

@@ -21,3 +21,4 @@ export { configServiceMock } from './config/config_service.mock';
 export { elasticsearchServiceMock } from './elasticsearch/elasticsearch_service.mock';
 export { httpServiceMock } from './http/http_service.mock';
 export { loggingServiceMock } from './logging/logging_service.mock';
+export { SavedObjectsClientMock } from './saved_objects/service/saved_objects_client.mock';

src/core/server/saved_objects/service/saved_objects_client.ts

@@ -142,12 +142,25 @@ export interface SavedObjectsMigrationVersion {
  [pluginName: string]: string;
 }
 
+/**
+ *
+ * @public
+ */
+export type SavedObjectAttribute =
+ | string
+ | number
+ | boolean
+ | null
+ | undefined
+ | SavedObjectAttributes
+ | SavedObjectAttributes[];
+
 /**
  *
  * @public
  */
 export interface SavedObjectAttributes {
- [key: string]: SavedObjectAttributes | string | number | boolean | null;
+ [key: string]: SavedObjectAttribute | SavedObjectAttribute[];
 }
 
 /**

src/core/server/server.api.md

@@ -424,8 +424,10 @@ export interface SavedObject<T extends SavedObjectAttributes = any> {
 
 // @public (undocumented)
 export interface SavedObjectAttributes {
+ // Warning: (ae-forgotten-export) The symbol "SavedObjectAttribute" needs to be exported by the entry point index.d.ts
+ // 
  // (undocumented)
- [key: string]: SavedObjectAttributes | string | number | boolean | null;
+ [key: string]: SavedObjectAttribute | SavedObjectAttribute[];
 }
 
 // @public

x-pack/index.js

@@ -43,6 +43,8 @@ import { fileUpload } from './plugins/file_upload';
 import { telemetry } from './plugins/telemetry';
 import { encryptedSavedObjects } from './plugins/encrypted_saved_objects';
 import { snapshotRestore } from './plugins/snapshot_restore';
+import { actions } from './plugins/actions';
+import { alerting } from './plugins/alerting';
 
 module.exports = function (kibana) {
  return [
@@ -85,5 +87,7 @@ module.exports = function (kibana) {
  fileUpload(kibana),
  encryptedSavedObjects(kibana),
  snapshotRestore(kibana),
+ actions(kibana),
+ alerting(kibana),
  ];
 };

x-pack/plugins/actions/index.ts

@@ -0,0 +1,38 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { Legacy } from 'kibana';
+import { Root } from 'joi';
+import mappings from './mappings.json';
+import { init } from './server';
+
+export { ActionsPlugin, ActionsClient, ActionType, ActionTypeExecutorOptions } from './server';
+
+export function actions(kibana: any) {
+ return new kibana.Plugin({
+ id: 'actions',
+ configPrefix: 'xpack.actions',
+ require: ['kibana', 'elasticsearch', 'task_manager', 'encrypted_saved_objects'],
+ isEnabled(config: Legacy.KibanaConfig) {
+ return (
+ config.get('xpack.encrypted_saved_objects.enabled') === true &&
+ config.get('xpack.actions.enabled') === true &&
+ config.get('xpack.task_manager.enabled') === true
+ );
+ },
+ config(Joi: Root) {
+ return Joi.object()
+ .keys({
+ enabled: Joi.boolean().default(true),
+ })
+ .default();
+ },
+ init,
+ uiExports: {
+ mappings,
+ },
+ });
+}

x-pack/plugins/actions/mappings.json

@@ -0,0 +1,19 @@
+{
+ "action": {
+ "properties": {
+ "description": {
+ "type": "text"
+ },
+ "actionTypeId": {
+ "type": "keyword"
+ },
+ "actionTypeConfig": {
+ "enabled": false,
+ "type": "object"
+ },
+ "actionTypeConfigSecrets": {
+ "type": "binary"
+ }
+ }
+ }
+}

x-pack/plugins/actions/server/action_type_registry.mock.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { ActionTypeRegistry } from './action_type_registry';
+
+type ActionTypeRegistryContract = PublicMethodsOf<ActionTypeRegistry>;
+
+const createActionTypeRegistryMock = () => {
+ const mocked: jest.Mocked<ActionTypeRegistryContract> = {
+ has: jest.fn(),
+ register: jest.fn(),
+ get: jest.fn(),
+ list: jest.fn(),
+ };
+ return mocked;
+};
+
+export const actionTypeRegistryMock = {
+ create: createActionTypeRegistryMock,
+};

x-pack/plugins/actions/server/action_type_registry.test.ts

@@ -0,0 +1,151 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+jest.mock('./lib/get_create_task_runner_function', () => ({
+ getCreateTaskRunnerFunction: jest.fn(),
+}));
+
+import { taskManagerMock } from '../../task_manager/task_manager.mock';
+import { encryptedSavedObjectsMock } from '../../encrypted_saved_objects/server/plugin.mock';
+import { ActionTypeRegistry } from './action_type_registry';
+import { SavedObjectsClientMock } from '../../../../src/core/server/mocks';
+
+const mockTaskManager = taskManagerMock.create();
+
+function getServices() {
+ return {
+ log: jest.fn(),
+ callCluster: jest.fn(),
+ savedObjectsClient: SavedObjectsClientMock.create(),
+ };
+}
+const actionTypeRegistryParams = {
+ getServices,
+ taskManager: mockTaskManager,
+ encryptedSavedObjectsPlugin: encryptedSavedObjectsMock.create(),
+};
+
+beforeEach(() => jest.resetAllMocks());
+
+describe('register()', () => {
+ test('able to register action types', () => {
+ const executor = jest.fn();
+ // eslint-disable-next-line @typescript-eslint/no-var-requires
+ const { getCreateTaskRunnerFunction } = require('./lib/get_create_task_runner_function');
+ getCreateTaskRunnerFunction.mockReturnValueOnce(jest.fn());
+ const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
+ actionTypeRegistry.register({
+ id: 'my-action-type',
+ name: 'My action type',
+ executor,
+ });
+ expect(actionTypeRegistry.has('my-action-type')).toEqual(true);
+ expect(mockTaskManager.registerTaskDefinitions).toHaveBeenCalledTimes(1);
+ expect(mockTaskManager.registerTaskDefinitions.mock.calls[0]).toMatchInlineSnapshot(`
+Array [
+ Object {
+ "actions:my-action-type": Object {
+ "createTaskRunner": [MockFunction],
+ "title": "My action type",
+ "type": "actions:my-action-type",
+ },
+ },
+]
+`);
+ expect(getCreateTaskRunnerFunction).toHaveBeenCalledTimes(1);
+ const call = getCreateTaskRunnerFunction.mock.calls[0][0];
+ expect(call.actionType).toMatchInlineSnapshot(`
+Object {
+ "executor": [MockFunction],
+ "id": "my-action-type",
+ "name": "My action type",
+}
+`);
+ expect(call.encryptedSavedObjectsPlugin).toBeTruthy();
+ expect(call.getServices).toBeTruthy();
+ });
+
+ test('throws error if action type already registered', () => {
+ const executor = jest.fn();
+ const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
+ actionTypeRegistry.register({
+ id: 'my-action-type',
+ name: 'My action type',
+ executor,
+ });
+ expect(() =>
+ actionTypeRegistry.register({
+ id: 'my-action-type',
+ name: 'My action type',
+ executor,
+ })
+ ).toThrowErrorMatchingInlineSnapshot(
+ `"Action type \\"my-action-type\\" is already registered."`
+ );
+ });
+});
+
+describe('get()', () => {
+ test('returns action type', () => {
+ const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
+ actionTypeRegistry.register({
+ id: 'my-action-type',
+ name: 'My action type',
+ async executor() {},
+ });
+ const actionType = actionTypeRegistry.get('my-action-type');
+ expect(actionType).toMatchInlineSnapshot(`
+Object {
+ "executor": [Function],
+ "id": "my-action-type",
+ "name": "My action type",
+}
+`);
+ });
+
+ test(`throws an error when action type doesn't exist`, () => {
+ const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
+ expect(() => actionTypeRegistry.get('my-action-type')).toThrowErrorMatchingInlineSnapshot(
+ `"Action type \\"my-action-type\\" is not registered."`
+ );
+ });
+});
+
+describe('list()', () => {
+ test('returns list of action types', () => {
+ const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
+ actionTypeRegistry.register({
+ id: 'my-action-type',
+ name: 'My action type',
+ async executor() {},
+ });
+ const actionTypes = actionTypeRegistry.list();
+ expect(actionTypes).toEqual([
+ {
+ id: 'my-action-type',
+ name: 'My action type',
+ },
+ ]);
+ });
+});
+
+describe('has()', () => {
+ test('returns false for unregistered action types', () => {
+ const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
+ expect(actionTypeRegistry.has('my-action-type')).toEqual(false);
+ });
+
+ test('returns true after registering an action type', () => {
+ const executor = jest.fn();
+ const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
+ actionTypeRegistry.register({
+ id: 'my-action-type',
+ name: 'My action type',
+ executor,
+ });
+ expect(actionTypeRegistry.has('my-action-type'));
+ });
+});

x-pack/plugins/actions/server/action_type_registry.ts

@@ -0,0 +1,93 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import Boom from 'boom';
+import { i18n } from '@kbn/i18n';
+import { ActionType, Services } from './types';
+import { TaskManager } from '../../task_manager';
+import { getCreateTaskRunnerFunction } from './lib';
+import { EncryptedSavedObjectsPlugin } from '../../encrypted_saved_objects';
+
+interface ConstructorOptions {
+ getServices: (basePath: string) => Services;
+ taskManager: TaskManager;
+ encryptedSavedObjectsPlugin: EncryptedSavedObjectsPlugin;
+}
+
+export class ActionTypeRegistry {
+ private readonly getServices: (basePath: string) => Services;
+ private readonly taskManager: TaskManager;
+ private readonly actionTypes: Map<string, ActionType> = new Map();
+ private readonly encryptedSavedObjectsPlugin: EncryptedSavedObjectsPlugin;
+
+ constructor({ getServices, taskManager, encryptedSavedObjectsPlugin }: ConstructorOptions) {
+ this.getServices = getServices;
+ this.taskManager = taskManager;
+ this.encryptedSavedObjectsPlugin = encryptedSavedObjectsPlugin;
+ }
+
+ /**
+ * Returns if the action type registry has the given action type registered
+ */
+ public has(id: string) {
+ return this.actionTypes.has(id);
+ }
+
+ /**
+ * Registers an action type to the action type registry
+ */
+ public register(actionType: ActionType) {
+ if (this.has(actionType.id)) {
+ throw new Error(
+ i18n.translate('xpack.actions.actionTypeRegistry.register.duplicateActionTypeError', {
+ defaultMessage: 'Action type "{id}" is already registered.',
+ values: {
+ id: actionType.id,
+ },
+ })
+ );
+ }
+ this.actionTypes.set(actionType.id, actionType);
+ this.taskManager.registerTaskDefinitions({
+ [`actions:${actionType.id}`]: {
+ title: actionType.name,
+ type: `actions:${actionType.id}`,
+ createTaskRunner: getCreateTaskRunnerFunction({
+ actionType,
+ getServices: this.getServices,
+ encryptedSavedObjectsPlugin: this.encryptedSavedObjectsPlugin,
+ }),
+ },
+ });
+ }
+
+ /**
+ * Returns an action type, throws if not registered
+ */
+ public get(id: string): ActionType {
+ if (!this.has(id)) {
+ throw Boom.badRequest(
+ i18n.translate('xpack.actions.actionTypeRegistry.get.missingActionTypeError', {
+ defaultMessage: 'Action type "{id}" is not registered.',
+ values: {
+ id,
+ },
+ })
+ );
+ }
+ return this.actionTypes.get(id)!;
+ }
+
+ /**
+ * Returns a list of registered action types [{ id, name }]
+ */
+ public list() {
+ return Array.from(this.actionTypes).map(([actionTypeId, actionType]) => ({
+ id: actionTypeId,
+ name: actionType.name,
+ }));
+ }
+}