migrate TaskManager Plugin to the Kibana Platform (#53869)

Migrates the existing TaskManager plugin from Legacy to Kibana Platform. We retain the Legacy API to prevent a breaking change, but under the hood, the legacy plugin is now using the Kibana Platform plugin. Another reason we retain the Legacy plugin to support several features that the Platform team has yet to migrate to Kibana Platform (mapping, SO schema and migrations).
elastic · Jan 13, 2020 · ea9a7b8 · ea9a7b8
1 parent ec69443
commit ea9a7b8
Show file tree

Hide file tree

Showing 95 changed files with 1,006 additions and 619 deletions.
diff --git a/src/core/server/mocks.ts b/src/core/server/mocks.ts
@@ -37,6 +37,7 @@ export { elasticsearchServiceMock } from './elasticsearch/elasticsearch_service.
 export { httpServiceMock } from './http/http_service.mock';
 export { loggingServiceMock } from './logging/logging_service.mock';
 export { savedObjectsClientMock } from './saved_objects/service/saved_objects_client.mock';
+export { savedObjectsRepositoryMock } from './saved_objects/service/lib/repository.mock';
 export { uiSettingsServiceMock } from './ui_settings/ui_settings_service.mock';
 import { uuidServiceMock } from './uuid/uuid_service.mock';
 

diff --git a/x-pack/legacy/plugins/actions/server/action_type_registry.test.ts b/x-pack/legacy/plugins/actions/server/action_type_registry.test.ts
@@ -4,13 +4,13 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { taskManagerMock } from '../../task_manager/server/task_manager.mock';
+import { taskManagerMock } from '../../../../plugins/task_manager/server/task_manager.mock';
 import { ActionTypeRegistry } from './action_type_registry';
 import { ExecutorType } from './types';
 import { ActionExecutor, ExecutorError, TaskRunnerFactory } from './lib';
 import { configUtilsMock } from './actions_config.mock';
 
-const mockTaskManager = taskManagerMock.create();
+const mockTaskManager = taskManagerMock.setup();
 const actionTypeRegistryParams = {
   taskManager: mockTaskManager,
   taskRunnerFactory: new TaskRunnerFactory(new ActionExecutor()),

diff --git a/x-pack/legacy/plugins/actions/server/action_type_registry.ts b/x-pack/legacy/plugins/actions/server/action_type_registry.ts
@@ -6,11 +6,11 @@
 
 import Boom from 'boom';
 import { i18n } from '@kbn/i18n';
-import { TaskManagerSetupContract } from './shim';
-import { RunContext } from '../../task_manager/server';
+import { RunContext, TaskManagerSetupContract } from '../../../../plugins/task_manager/server';
 import { ExecutorError, TaskRunnerFactory } from './lib';
 import { ActionType } from './types';
 import { ActionsConfigurationUtilities } from './actions_config';
+
 interface ConstructorOptions {
   taskManager: TaskManagerSetupContract;
   taskRunnerFactory: TaskRunnerFactory;

diff --git a/x-pack/legacy/plugins/actions/server/actions_client.test.ts b/x-pack/legacy/plugins/actions/server/actions_client.test.ts
@@ -10,7 +10,7 @@ import { ActionTypeRegistry } from './action_type_registry';
 import { ActionsClient } from './actions_client';
 import { ExecutorType } from './types';
 import { ActionExecutor, TaskRunnerFactory } from './lib';
-import { taskManagerMock } from '../../task_manager/server/task_manager.mock';
+import { taskManagerMock } from '../../../../plugins/task_manager/server/task_manager.mock';
 import { configUtilsMock } from './actions_config.mock';
 import { getActionsConfigurationUtilities } from './actions_config';
 
@@ -23,7 +23,7 @@ const defaultKibanaIndex = '.kibana';
 const savedObjectsClient = savedObjectsClientMock.create();
 const scopedClusterClient = elasticsearchServiceMock.createScopedClusterClient();
 
-const mockTaskManager = taskManagerMock.create();
+const mockTaskManager = taskManagerMock.setup();
 
 const actionTypeRegistryParams = {
   taskManager: mockTaskManager,

diff --git a/x-pack/legacy/plugins/actions/server/builtin_action_types/index.test.ts b/x-pack/legacy/plugins/actions/server/builtin_action_types/index.test.ts
@@ -6,7 +6,7 @@
 
 import { ActionExecutor, TaskRunnerFactory } from '../lib';
 import { ActionTypeRegistry } from '../action_type_registry';
-import { taskManagerMock } from '../../../task_manager/server/task_manager.mock';
+import { taskManagerMock } from '../../../../../plugins/task_manager/server/task_manager.mock';
 import { registerBuiltInActionTypes } from './index';
 import { Logger } from '../../../../../../src/core/server';
 import { loggingServiceMock } from '../../../../../../src/core/server/mocks';
@@ -20,7 +20,7 @@ export function createActionTypeRegistry(): {
 } {
   const logger = loggingServiceMock.create().get() as jest.Mocked<Logger>;
   const actionTypeRegistry = new ActionTypeRegistry({
-    taskManager: taskManagerMock.create(),
+    taskManager: taskManagerMock.setup(),
     taskRunnerFactory: new TaskRunnerFactory(new ActionExecutor()),
     actionsConfigUtils: configUtilsMock,
   });

diff --git a/x-pack/legacy/plugins/actions/server/create_execute_function.test.ts b/x-pack/legacy/plugins/actions/server/create_execute_function.test.ts
@@ -4,11 +4,11 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { taskManagerMock } from '../../task_manager/server/task_manager.mock';
+import { taskManagerMock } from '../../../../plugins/task_manager/server/task_manager.mock';
 import { createExecuteFunction } from './create_execute_function';
 import { savedObjectsClientMock } from '../../../../../src/core/server/mocks';
 
-const mockTaskManager = taskManagerMock.create();
+const mockTaskManager = taskManagerMock.start();
 const savedObjectsClient = savedObjectsClientMock.create();
 const getBasePath = jest.fn();
 

diff --git a/x-pack/legacy/plugins/actions/server/create_execute_function.ts b/x-pack/legacy/plugins/actions/server/create_execute_function.ts
@@ -5,7 +5,7 @@
  */
 
 import { SavedObjectsClientContract } from 'src/core/server';
-import { TaskManagerStartContract } from './shim';
+import { TaskManagerStartContract } from '../../../../plugins/task_manager/server';
 import { GetBasePathFunction } from './types';
 
 interface CreateExecuteFunctionOptions {

diff --git a/x-pack/legacy/plugins/actions/server/init.ts b/x-pack/legacy/plugins/actions/server/init.ts
@@ -4,11 +4,12 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
+import { Legacy } from 'kibana';
 import { Plugin } from './plugin';
-import { shim, Server } from './shim';
+import { shim } from './shim';
 import { ActionsPlugin } from './types';
 
-export async function init(server: Server) {
+export async function init(server: Legacy.Server) {
   const { initializerContext, coreSetup, coreStart, pluginsSetup, pluginsStart } = shim(server);
 
   const plugin = new Plugin(initializerContext);

diff --git a/x-pack/legacy/plugins/actions/server/lib/task_runner_factory.test.ts b/x-pack/legacy/plugins/actions/server/lib/task_runner_factory.test.ts
@@ -7,7 +7,7 @@
 import sinon from 'sinon';
 import { ExecutorError } from './executor_error';
 import { ActionExecutor } from './action_executor';
-import { ConcreteTaskInstance, TaskStatus } from '../../../task_manager/server';
+import { ConcreteTaskInstance, TaskStatus } from '../../../../../plugins/task_manager/server';
 import { TaskRunnerFactory } from './task_runner_factory';
 import { actionTypeRegistryMock } from '../action_type_registry.mock';
 import { actionExecutorMock } from './action_executor.mock';

diff --git a/x-pack/legacy/plugins/actions/server/lib/task_runner_factory.ts b/x-pack/legacy/plugins/actions/server/lib/task_runner_factory.ts
@@ -6,7 +6,7 @@
 
 import { ActionExecutorContract } from './action_executor';
 import { ExecutorError } from './executor_error';
-import { RunContext } from '../../../task_manager/server';
+import { RunContext } from '../../../../../plugins/task_manager/server';
 import { PluginStartContract as EncryptedSavedObjectsStartContract } from '../../../../../plugins/encrypted_saved_objects/server';
 import { ActionTaskParams, GetBasePathFunction, SpaceIdToNamespaceFunction } from '../types';
 

diff --git a/x-pack/legacy/plugins/actions/server/plugin.ts b/x-pack/legacy/plugins/actions/server/plugin.ts
@@ -93,7 +93,7 @@ export class Plugin {
     const actionsConfigUtils = getActionsConfigurationUtilities(config as ActionsConfigType);
     const actionTypeRegistry = new ActionTypeRegistry({
       taskRunnerFactory,
-      taskManager: plugins.task_manager,
+      taskManager: plugins.taskManager,
       actionsConfigUtils,
     });
     this.taskRunnerFactory = taskRunnerFactory;
@@ -164,7 +164,7 @@ export class Plugin {
     });
 
     const executeFn = createExecuteFunction({
-      taskManager: plugins.task_manager,
+      taskManager: plugins.taskManager,
       getScopedSavedObjectsClient: core.savedObjects.getScopedSavedObjectsClient,
       getBasePath,
     });

diff --git a/x-pack/legacy/plugins/actions/server/shim.ts b/x-pack/legacy/plugins/actions/server/shim.ts
@@ -8,7 +8,11 @@ import Hapi from 'hapi';
 import { Legacy } from 'kibana';
 import * as Rx from 'rxjs';
 import { ActionsConfigType } from './types';
-import { TaskManager } from '../../task_manager/server';
+import {
+  TaskManagerStartContract,
+  TaskManagerSetupContract,
+} from '../../../../plugins/task_manager/server';
+import { getTaskManagerSetup, getTaskManagerStart } from '../../task_manager/server';
 import { XPackMainPlugin } from '../../xpack_main/server/xpack_main';
 import KbnServer from '../../../../../src/legacy/server/kbn_server';
 import { LegacySpacesPlugin as SpacesPluginStartContract } from '../../spaces';
@@ -24,31 +28,16 @@ import {
 } from '../../../../../src/core/server';
 import { LicensingPluginSetup } from '../../../../plugins/licensing/server';
 
-// Extend PluginProperties to indicate which plugins are guaranteed to exist
-// due to being marked as dependencies
-interface Plugins extends Hapi.PluginProperties {
-  task_manager: TaskManager;
-}
-
-export interface Server extends Legacy.Server {
-  plugins: Plugins;
-}
-
 export interface KibanaConfig {
   index: string;
 }
 
 /**
  * Shim what we're thinking setup and start contracts will look like
  */
-export type TaskManagerStartContract = Pick<TaskManager, 'schedule' | 'fetch' | 'remove'>;
 export type XPackMainPluginSetupContract = Pick<XPackMainPlugin, 'registerFeature'>;
 export type SecurityPluginSetupContract = Pick<SecurityPlugin, '__legacyCompat'>;
 export type SecurityPluginStartContract = Pick<SecurityPlugin, 'authc'>;
-export type TaskManagerSetupContract = Pick<
-  TaskManager,
-  'addMiddleware' | 'registerTaskDefinitions'
->;
 
 /**
  * New platform interfaces
@@ -74,7 +63,7 @@ export interface ActionsCoreStart {
 }
 export interface ActionsPluginsSetup {
   security?: SecurityPluginSetupContract;
-  task_manager: TaskManagerSetupContract;
+  taskManager: TaskManagerSetupContract;
   xpack_main: XPackMainPluginSetupContract;
   encryptedSavedObjects: EncryptedSavedObjectsSetupContract;
   licensing: LicensingPluginSetup;
@@ -83,7 +72,7 @@ export interface ActionsPluginsStart {
   security?: SecurityPluginStartContract;
   spaces: () => SpacesPluginStartContract | undefined;
   encryptedSavedObjects: EncryptedSavedObjectsStartContract;
-  task_manager: TaskManagerStartContract;
+  taskManager: TaskManagerStartContract;
 }
 
 /**
@@ -92,7 +81,7 @@ export interface ActionsPluginsStart {
  * @param server Hapi server instance
  */
 export function shim(
-  server: Server
+  server: Legacy.Server
 ): {
   initializerContext: ActionsPluginInitializerContext;
   coreSetup: ActionsCoreSetup;
@@ -132,7 +121,7 @@ export function shim(
 
   const pluginsSetup: ActionsPluginsSetup = {
     security: newPlatform.setup.plugins.security as SecurityPluginSetupContract | undefined,
-    task_manager: server.plugins.task_manager,
+    taskManager: getTaskManagerSetup(server)!,
     xpack_main: server.plugins.xpack_main,
     encryptedSavedObjects: newPlatform.setup.plugins
       .encryptedSavedObjects as EncryptedSavedObjectsSetupContract,
@@ -146,7 +135,7 @@ export function shim(
     spaces: () => server.plugins.spaces,
     encryptedSavedObjects: newPlatform.start.plugins
       .encryptedSavedObjects as EncryptedSavedObjectsStartContract,
-    task_manager: server.plugins.task_manager,
+    taskManager: getTaskManagerStart(server)!,
   };
 
   return {

diff --git a/x-pack/legacy/plugins/alerting/server/alert_type_registry.test.ts b/x-pack/legacy/plugins/alerting/server/alert_type_registry.test.ts
@@ -6,10 +6,9 @@
 
 import { TaskRunnerFactory } from './task_runner';
 import { AlertTypeRegistry } from './alert_type_registry';
-import { taskManagerMock } from '../../task_manager/server/task_manager.mock';
-
-const taskManager = taskManagerMock.create();
+import { taskManagerMock } from '../../../../plugins/task_manager/server/task_manager.mock';
 
+const taskManager = taskManagerMock.setup();
 const alertTypeRegistryParams = {
   taskManager,
   taskRunnerFactory: new TaskRunnerFactory(),

diff --git a/x-pack/legacy/plugins/alerting/server/alert_type_registry.ts b/x-pack/legacy/plugins/alerting/server/alert_type_registry.ts
@@ -6,9 +6,8 @@
 
 import Boom from 'boom';
 import { i18n } from '@kbn/i18n';
+import { RunContext, TaskManagerSetupContract } from '../../../../plugins/task_manager/server';
 import { TaskRunnerFactory } from './task_runner';
-import { RunContext } from '../../task_manager';
-import { TaskManagerSetupContract } from './shim';
 import { AlertType } from './types';
 
 interface ConstructorOptions {

diff --git a/x-pack/legacy/plugins/alerting/server/alerts_client.test.ts b/x-pack/legacy/plugins/alerting/server/alerts_client.test.ts
@@ -7,14 +7,14 @@ import uuid from 'uuid';
 import { schema } from '@kbn/config-schema';
 import { AlertsClient } from './alerts_client';
 import { savedObjectsClientMock, loggingServiceMock } from '../../../../../src/core/server/mocks';
-import { taskManagerMock } from '../../task_manager/server/task_manager.mock';
+import { taskManagerMock } from '../../../../plugins/task_manager/server/task_manager.mock';
 import { alertTypeRegistryMock } from './alert_type_registry.mock';
-import { TaskStatus } from '../../task_manager/server';
+import { TaskStatus } from '../../../../plugins/task_manager/server';
 import { IntervalSchedule } from './types';
 import { resolvable } from './test_utils';
 import { encryptedSavedObjectsMock } from '../../../../plugins/encrypted_saved_objects/server/mocks';
 
-const taskManager = taskManagerMock.create();
+const taskManager = taskManagerMock.start();
 const alertTypeRegistry = alertTypeRegistryMock.create();
 const savedObjectsClient = savedObjectsClientMock.create();
 const encryptedSavedObjects = encryptedSavedObjectsMock.createStart();

diff --git a/x-pack/legacy/plugins/alerting/server/alerts_client.ts b/x-pack/legacy/plugins/alerting/server/alerts_client.ts
@@ -22,14 +22,14 @@ import {
   AlertType,
   IntervalSchedule,
 } from './types';
-import { TaskManagerStartContract } from './shim';
 import { validateAlertTypeParams } from './lib';
 import {
   InvalidateAPIKeyParams,
   CreateAPIKeyResult as SecurityPluginCreateAPIKeyResult,
   InvalidateAPIKeyResult as SecurityPluginInvalidateAPIKeyResult,
 } from '../../../../plugins/security/server';
 import { PluginStartContract as EncryptedSavedObjectsStartContract } from '../../../../plugins/encrypted_saved_objects/server';
+import { TaskManagerStartContract } from '../../../../plugins/task_manager/server';
 
 type NormalizedAlertAction = Omit<AlertAction, 'actionTypeId'>;
 export type CreateAPIKeyResult =

diff --git a/x-pack/legacy/plugins/alerting/server/alerts_client_factory.test.ts b/x-pack/legacy/plugins/alerting/server/alerts_client_factory.test.ts
@@ -7,7 +7,7 @@
 import { Request } from 'hapi';
 import { AlertsClientFactory, ConstructorOpts } from './alerts_client_factory';
 import { alertTypeRegistryMock } from './alert_type_registry.mock';
-import { taskManagerMock } from '../../task_manager/server/task_manager.mock';
+import { taskManagerMock } from '../../../../plugins/task_manager/server/task_manager.mock';
 import { KibanaRequest } from '../../../../../src/core/server';
 import { loggingServiceMock } from '../../../../../src/core/server/mocks';
 import { encryptedSavedObjectsMock } from '../../../../plugins/encrypted_saved_objects/server/mocks';
@@ -23,7 +23,7 @@ const securityPluginSetup = {
 };
 const alertsClientFactoryParams: jest.Mocked<ConstructorOpts> = {
   logger: loggingServiceMock.create().get(),
-  taskManager: taskManagerMock.create(),
+  taskManager: taskManagerMock.start(),
   alertTypeRegistry: alertTypeRegistryMock.create(),
   getSpaceId: jest.fn(),
   spaceIdToNamespace: jest.fn(),

diff --git a/x-pack/legacy/plugins/alerting/server/alerts_client_factory.ts b/x-pack/legacy/plugins/alerting/server/alerts_client_factory.ts
@@ -8,10 +8,11 @@ import Hapi from 'hapi';
 import uuid from 'uuid';
 import { AlertsClient } from './alerts_client';
 import { AlertTypeRegistry, SpaceIdToNamespaceFunction } from './types';
-import { SecurityPluginStartContract, TaskManagerStartContract } from './shim';
+import { SecurityPluginStartContract } from './shim';
 import { KibanaRequest, Logger } from '../../../../../src/core/server';
 import { InvalidateAPIKeyParams } from '../../../../plugins/security/server';
 import { PluginStartContract as EncryptedSavedObjectsStartContract } from '../../../../plugins/encrypted_saved_objects/server';
+import { TaskManagerStartContract } from '../../../../plugins/task_manager/server';
 
 export interface ConstructorOpts {
   logger: Logger;

diff --git a/x-pack/legacy/plugins/alerting/server/plugin.ts b/x-pack/legacy/plugins/alerting/server/plugin.ts
@@ -79,7 +79,7 @@ export class Plugin {
     });
 
     const alertTypeRegistry = new AlertTypeRegistry({
-      taskManager: plugins.task_manager,
+      taskManager: plugins.taskManager,
       taskRunnerFactory: this.taskRunnerFactory,
     });
     this.alertTypeRegistry = alertTypeRegistry;
@@ -116,7 +116,7 @@ export class Plugin {
     const alertsClientFactory = new AlertsClientFactory({
       alertTypeRegistry: this.alertTypeRegistry!,
       logger: this.logger,
-      taskManager: plugins.task_manager,
+      taskManager: plugins.taskManager,
       securityPluginSetup: plugins.security,
       encryptedSavedObjectsPlugin: plugins.encryptedSavedObjects,
       spaceIdToNamespace,