diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.es_field_types.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.es_field_types.md index c5e01715534d1..ad762cae489c8 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.es_field_types.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.es_field_types.md @@ -43,4 +43,5 @@ export declare enum ES_FIELD_TYPES | STRING | "string" | | | TEXT | "text" | | | TOKEN\_COUNT | "token_count" | | +| UNSIGNED\_LONG | "unsigned_long" | | diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.es_field_types.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.es_field_types.md index d071955f4f522..545b7b9d27e10 100644 --- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.es_field_types.md +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.es_field_types.md @@ -43,4 +43,5 @@ export declare enum ES_FIELD_TYPES | STRING | "string" | | | TEXT | "text" | | | TOKEN\_COUNT | "token_count" | | +| UNSIGNED\_LONG | "unsigned_long" | | diff --git a/src/plugins/data/common/kbn_field_types/kbn_field_types.test.ts b/src/plugins/data/common/kbn_field_types/kbn_field_types.test.ts index 6a2d6edd04692..dd1a9a7f689a9 100644 --- a/src/plugins/data/common/kbn_field_types/kbn_field_types.test.ts +++ b/src/plugins/data/common/kbn_field_types/kbn_field_types.test.ts @@ -66,6 +66,7 @@ describe('utils/kbn_field_types', () => { test('returns the kbnFieldType name that matches the esType', () => { expect(castEsToKbnFieldTypeName(ES_FIELD_TYPES.KEYWORD)).toBe('string'); expect(castEsToKbnFieldTypeName(ES_FIELD_TYPES.FLOAT)).toBe('number'); + expect(castEsToKbnFieldTypeName(ES_FIELD_TYPES.UNSIGNED_LONG)).toBe('number'); }); test('returns unknown for unknown es types', () => { diff --git a/src/plugins/data/common/kbn_field_types/kbn_field_types_factory.ts b/src/plugins/data/common/kbn_field_types/kbn_field_types_factory.ts index b93ebcbbca9c8..373cdfda30607 100644 --- a/src/plugins/data/common/kbn_field_types/kbn_field_types_factory.ts +++ b/src/plugins/data/common/kbn_field_types/kbn_field_types_factory.ts @@ -48,6 +48,7 @@ export const createKbnFieldTypes = (): KbnFieldType[] => [ ES_FIELD_TYPES.DOUBLE, ES_FIELD_TYPES.INTEGER, ES_FIELD_TYPES.LONG, + ES_FIELD_TYPES.UNSIGNED_LONG, ES_FIELD_TYPES.SHORT, ES_FIELD_TYPES.BYTE, ES_FIELD_TYPES.TOKEN_COUNT, diff --git a/src/plugins/data/common/kbn_field_types/types.ts b/src/plugins/data/common/kbn_field_types/types.ts index acd7a36b01fb3..ba9fd3e70b315 100644 --- a/src/plugins/data/common/kbn_field_types/types.ts +++ b/src/plugins/data/common/kbn_field_types/types.ts @@ -52,6 +52,7 @@ export enum ES_FIELD_TYPES { INTEGER = 'integer', LONG = 'long', SHORT = 'short', + UNSIGNED_LONG = 'unsigned_long', NESTED = 'nested', BYTE = 'byte', diff --git a/src/plugins/data/public/public.api.md b/src/plugins/data/public/public.api.md index 688509a0758c0..1390b28ec830d 100644 --- a/src/plugins/data/public/public.api.md +++ b/src/plugins/data/public/public.api.md @@ -514,7 +514,9 @@ export enum ES_FIELD_TYPES { // (undocumented) TOKEN_COUNT = "token_count", // (undocumented) - _TYPE = "_type" + _TYPE = "_type", + // (undocumented) + UNSIGNED_LONG = "unsigned_long" } // Warning: (ae-missing-release-tag) "ES_SEARCH_STRATEGY" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) diff --git a/src/plugins/data/server/server.api.md b/src/plugins/data/server/server.api.md index add923ad2da47..65313adfc0e0f 100644 --- a/src/plugins/data/server/server.api.md +++ b/src/plugins/data/server/server.api.md @@ -211,7 +211,9 @@ export enum ES_FIELD_TYPES { // (undocumented) TOKEN_COUNT = "token_count", // (undocumented) - _TYPE = "_type" + _TYPE = "_type", + // (undocumented) + UNSIGNED_LONG = "unsigned_long" } // Warning: (ae-missing-release-tag) "ES_SEARCH_STRATEGY" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) diff --git a/x-pack/plugins/actions/server/action_type_registry.test.ts b/x-pack/plugins/actions/server/action_type_registry.test.ts index e641b81189b93..95e7784e51acf 100644 --- a/x-pack/plugins/actions/server/action_type_registry.test.ts +++ b/x-pack/plugins/actions/server/action_type_registry.test.ts @@ -4,7 +4,7 @@ * 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 '../../task_manager/server/mocks'; import { ActionTypeRegistry, ActionTypeRegistryOpts } from './action_type_registry'; import { ActionType, ExecutorType } from './types'; import { ActionExecutor, ExecutorError, ILicenseState, TaskRunnerFactory } from './lib'; @@ -13,7 +13,7 @@ import { licenseStateMock } from './lib/license_state.mock'; import { ActionsConfigurationUtilities } from './actions_config'; import { licensingMock } from '../../licensing/server/mocks'; -const mockTaskManager = taskManagerMock.setup(); +const mockTaskManager = taskManagerMock.createSetup(); let mockedLicenseState: jest.Mocked; let mockedActionsConfig: jest.Mocked; let actionTypeRegistryParams: ActionTypeRegistryOpts; @@ -66,7 +66,6 @@ describe('register()', () => { "getRetry": [Function], "maxAttempts": 1, "title": "My action type", - "type": "actions:my-action-type", }, }, ] diff --git a/x-pack/plugins/actions/server/action_type_registry.ts b/x-pack/plugins/actions/server/action_type_registry.ts index b93d4a6e78ac6..cacf7166b96ba 100644 --- a/x-pack/plugins/actions/server/action_type_registry.ts +++ b/x-pack/plugins/actions/server/action_type_registry.ts @@ -125,7 +125,6 @@ export class ActionTypeRegistry { this.taskManager.registerTaskDefinitions({ [`actions:${actionType.id}`]: { title: actionType.name, - type: `actions:${actionType.id}`, maxAttempts: actionType.maxAttempts || 1, getRetry(attempts: number, error: unknown) { if (error instanceof ExecutorError) { diff --git a/x-pack/plugins/actions/server/actions_client.test.ts b/x-pack/plugins/actions/server/actions_client.test.ts index 2b6aec42e0d21..171f8d4b0b1d4 100644 --- a/x-pack/plugins/actions/server/actions_client.test.ts +++ b/x-pack/plugins/actions/server/actions_client.test.ts @@ -10,7 +10,7 @@ import { ActionTypeRegistry, ActionTypeRegistryOpts } from './action_type_regist import { ActionsClient } from './actions_client'; import { ExecutorType, ActionType } from './types'; import { ActionExecutor, TaskRunnerFactory, ILicenseState } from './lib'; -import { taskManagerMock } from '../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../task_manager/server/mocks'; import { actionsConfigMock } from './actions_config.mock'; import { getActionsConfigurationUtilities } from './actions_config'; import { licenseStateMock } from './lib/license_state.mock'; @@ -34,7 +34,7 @@ const authorization = actionsAuthorizationMock.create(); const executionEnqueuer = jest.fn(); const request = {} as KibanaRequest; -const mockTaskManager = taskManagerMock.setup(); +const mockTaskManager = taskManagerMock.createSetup(); let actionsClient: ActionsClient; let mockedLicenseState: jest.Mocked; diff --git a/x-pack/plugins/actions/server/builtin_action_types/index.test.ts b/x-pack/plugins/actions/server/builtin_action_types/index.test.ts index f7882849708e5..a9d1e28182b29 100644 --- a/x-pack/plugins/actions/server/builtin_action_types/index.test.ts +++ b/x-pack/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 '../../../task_manager/server/mocks'; import { registerBuiltInActionTypes } from './index'; import { Logger } from '../../../../../src/core/server'; import { loggingSystemMock } from '../../../../../src/core/server/mocks'; @@ -22,8 +22,8 @@ export function createActionTypeRegistry(): { } { const logger = loggingSystemMock.create().get() as jest.Mocked; const actionTypeRegistry = new ActionTypeRegistry({ + taskManager: taskManagerMock.createSetup(), licensing: licensingMock.createSetup(), - taskManager: taskManagerMock.setup(), taskRunnerFactory: new TaskRunnerFactory( new ActionExecutor({ isESOUsingEphemeralEncryptionKey: false }) ), diff --git a/x-pack/plugins/actions/server/create_execute_function.test.ts b/x-pack/plugins/actions/server/create_execute_function.test.ts index 33e78ee444cd0..ed06bd888f919 100644 --- a/x-pack/plugins/actions/server/create_execute_function.test.ts +++ b/x-pack/plugins/actions/server/create_execute_function.test.ts @@ -6,7 +6,7 @@ import { KibanaRequest } from 'src/core/server'; import uuid from 'uuid'; -import { taskManagerMock } from '../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../task_manager/server/mocks'; import { createExecutionEnqueuerFunction } from './create_execute_function'; import { savedObjectsClientMock } from '../../../../src/core/server/mocks'; import { actionTypeRegistryMock } from './action_type_registry.mock'; @@ -15,7 +15,7 @@ import { asSavedObjectExecutionSource, } from './lib/action_execution_source'; -const mockTaskManager = taskManagerMock.start(); +const mockTaskManager = taskManagerMock.createStart(); const savedObjectsClient = savedObjectsClientMock.create(); const request = {} as KibanaRequest; diff --git a/x-pack/plugins/actions/server/usage/actions_usage_collector.test.ts b/x-pack/plugins/actions/server/usage/actions_usage_collector.test.ts index 2e2944aab425c..0e6c2ff37eb02 100644 --- a/x-pack/plugins/actions/server/usage/actions_usage_collector.test.ts +++ b/x-pack/plugins/actions/server/usage/actions_usage_collector.test.ts @@ -6,9 +6,9 @@ import { UsageCollectionSetup } from 'src/plugins/usage_collection/server'; import { registerActionsUsageCollector } from './actions_usage_collector'; -import { taskManagerMock } from '../../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../../task_manager/server/mocks'; -const mockTaskManagerStart = taskManagerMock.start(); +const mockTaskManagerStart = taskManagerMock.createStart(); beforeEach(() => jest.resetAllMocks()); diff --git a/x-pack/plugins/actions/server/usage/task.ts b/x-pack/plugins/actions/server/usage/task.ts index efa695cdc2667..f7af480aa9fb3 100644 --- a/x-pack/plugins/actions/server/usage/task.ts +++ b/x-pack/plugins/actions/server/usage/task.ts @@ -39,7 +39,6 @@ function registerActionsTelemetryTask( taskManager.registerTaskDefinitions({ [TELEMETRY_TASK_TYPE]: { title: 'Actions usage fetch task', - type: TELEMETRY_TASK_TYPE, timeout: '5m', createTaskRunner: telemetryTaskRunner(logger, core, kibanaIndex), }, diff --git a/x-pack/plugins/alerts/server/alert_type_registry.test.ts b/x-pack/plugins/alerts/server/alert_type_registry.test.ts index 048cc3d5a4440..9e1545bae5384 100644 --- a/x-pack/plugins/alerts/server/alert_type_registry.test.ts +++ b/x-pack/plugins/alerts/server/alert_type_registry.test.ts @@ -7,9 +7,9 @@ import { TaskRunnerFactory } from './task_runner'; import { AlertTypeRegistry } from './alert_type_registry'; import { AlertType } from './types'; -import { taskManagerMock } from '../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../task_manager/server/mocks'; -const taskManager = taskManagerMock.setup(); +const taskManager = taskManagerMock.createSetup(); const alertTypeRegistryParams = { taskManager, taskRunnerFactory: new TaskRunnerFactory(), @@ -118,7 +118,6 @@ describe('register()', () => { "alerting:test": Object { "createTaskRunner": [Function], "title": "Test", - "type": "alerting:test", }, }, ] diff --git a/x-pack/plugins/alerts/server/alert_type_registry.ts b/x-pack/plugins/alerts/server/alert_type_registry.ts index 7f34803b05a81..0cd218571035a 100644 --- a/x-pack/plugins/alerts/server/alert_type_registry.ts +++ b/x-pack/plugins/alerts/server/alert_type_registry.ts @@ -86,7 +86,6 @@ export class AlertTypeRegistry { this.taskManager.registerTaskDefinitions({ [`alerting:${alertType.id}`]: { title: alertType.name, - type: `alerting:${alertType.id}`, createTaskRunner: (context: RunContext) => this.taskRunnerFactory.create({ ...alertType } as AlertType, context), }, diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/create.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/create.test.ts index 56e868732e3fb..bce1af203fb0e 100644 --- a/x-pack/plugins/alerts/server/alerts_client/tests/create.test.ts +++ b/x-pack/plugins/alerts/server/alerts_client/tests/create.test.ts @@ -6,7 +6,7 @@ import { schema } from '@kbn/config-schema'; import { AlertsClient, ConstructorOptions, CreateOptions } from '../alerts_client'; import { savedObjectsClientMock, loggingSystemMock } from '../../../../../../src/core/server/mocks'; -import { taskManagerMock } from '../../../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../../../task_manager/server/mocks'; import { alertTypeRegistryMock } from '../../alert_type_registry.mock'; import { alertsAuthorizationMock } from '../../authorization/alerts_authorization.mock'; import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/server/mocks'; @@ -16,7 +16,7 @@ import { ActionsAuthorization, ActionsClient } from '../../../../actions/server' import { TaskStatus } from '../../../../task_manager/server'; import { getBeforeSetup, setGlobalDate } from './lib'; -const taskManager = taskManagerMock.start(); +const taskManager = taskManagerMock.createStart(); const alertTypeRegistry = alertTypeRegistryMock.create(); const unsecuredSavedObjectsClient = savedObjectsClientMock.create(); const encryptedSavedObjects = encryptedSavedObjectsMock.createClient(); diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/delete.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/delete.test.ts index 1ebd9fc296b13..d9b253c3a56e8 100644 --- a/x-pack/plugins/alerts/server/alerts_client/tests/delete.test.ts +++ b/x-pack/plugins/alerts/server/alerts_client/tests/delete.test.ts @@ -5,7 +5,7 @@ */ import { AlertsClient, ConstructorOptions } from '../alerts_client'; import { savedObjectsClientMock, loggingSystemMock } from '../../../../../../src/core/server/mocks'; -import { taskManagerMock } from '../../../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../../../task_manager/server/mocks'; import { alertTypeRegistryMock } from '../../alert_type_registry.mock'; import { alertsAuthorizationMock } from '../../authorization/alerts_authorization.mock'; import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/server/mocks'; @@ -14,7 +14,7 @@ import { AlertsAuthorization } from '../../authorization/alerts_authorization'; import { ActionsAuthorization } from '../../../../actions/server'; import { getBeforeSetup } from './lib'; -const taskManager = taskManagerMock.start(); +const taskManager = taskManagerMock.createStart(); const alertTypeRegistry = alertTypeRegistryMock.create(); const unsecuredSavedObjectsClient = savedObjectsClientMock.create(); const encryptedSavedObjects = encryptedSavedObjectsMock.createClient(); diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/disable.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/disable.test.ts index 2dd3da07234ce..d0557df622028 100644 --- a/x-pack/plugins/alerts/server/alerts_client/tests/disable.test.ts +++ b/x-pack/plugins/alerts/server/alerts_client/tests/disable.test.ts @@ -5,7 +5,7 @@ */ import { AlertsClient, ConstructorOptions } from '../alerts_client'; import { savedObjectsClientMock, loggingSystemMock } from '../../../../../../src/core/server/mocks'; -import { taskManagerMock } from '../../../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../../../task_manager/server/mocks'; import { alertTypeRegistryMock } from '../../alert_type_registry.mock'; import { alertsAuthorizationMock } from '../../authorization/alerts_authorization.mock'; import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/server/mocks'; @@ -14,7 +14,7 @@ import { AlertsAuthorization } from '../../authorization/alerts_authorization'; import { ActionsAuthorization } from '../../../../actions/server'; import { getBeforeSetup } from './lib'; -const taskManager = taskManagerMock.start(); +const taskManager = taskManagerMock.createStart(); const alertTypeRegistry = alertTypeRegistryMock.create(); const unsecuredSavedObjectsClient = savedObjectsClientMock.create(); diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/enable.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/enable.test.ts index b214d8ba697b1..f098bbcad8d05 100644 --- a/x-pack/plugins/alerts/server/alerts_client/tests/enable.test.ts +++ b/x-pack/plugins/alerts/server/alerts_client/tests/enable.test.ts @@ -5,7 +5,7 @@ */ import { AlertsClient, ConstructorOptions } from '../alerts_client'; import { savedObjectsClientMock, loggingSystemMock } from '../../../../../../src/core/server/mocks'; -import { taskManagerMock } from '../../../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../../../task_manager/server/mocks'; import { alertTypeRegistryMock } from '../../alert_type_registry.mock'; import { alertsAuthorizationMock } from '../../authorization/alerts_authorization.mock'; import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/server/mocks'; @@ -15,7 +15,7 @@ import { ActionsAuthorization } from '../../../../actions/server'; import { TaskStatus } from '../../../../task_manager/server'; import { getBeforeSetup } from './lib'; -const taskManager = taskManagerMock.start(); +const taskManager = taskManagerMock.createStart(); const alertTypeRegistry = alertTypeRegistryMock.create(); const unsecuredSavedObjectsClient = savedObjectsClientMock.create(); diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/find.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/find.test.ts index bf55a2070d8fe..c1adaddc80d9e 100644 --- a/x-pack/plugins/alerts/server/alerts_client/tests/find.test.ts +++ b/x-pack/plugins/alerts/server/alerts_client/tests/find.test.ts @@ -5,7 +5,7 @@ */ import { AlertsClient, ConstructorOptions } from '../alerts_client'; import { savedObjectsClientMock, loggingSystemMock } from '../../../../../../src/core/server/mocks'; -import { taskManagerMock } from '../../../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../../../task_manager/server/mocks'; import { alertTypeRegistryMock } from '../../alert_type_registry.mock'; import { alertsAuthorizationMock } from '../../authorization/alerts_authorization.mock'; import { nodeTypes } from '../../../../../../src/plugins/data/common'; @@ -16,7 +16,7 @@ import { AlertsAuthorization } from '../../authorization/alerts_authorization'; import { ActionsAuthorization } from '../../../../actions/server'; import { getBeforeSetup, setGlobalDate } from './lib'; -const taskManager = taskManagerMock.start(); +const taskManager = taskManagerMock.createStart(); const alertTypeRegistry = alertTypeRegistryMock.create(); const unsecuredSavedObjectsClient = savedObjectsClientMock.create(); diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/get.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/get.test.ts index 327a1fa23ef05..004230403de2e 100644 --- a/x-pack/plugins/alerts/server/alerts_client/tests/get.test.ts +++ b/x-pack/plugins/alerts/server/alerts_client/tests/get.test.ts @@ -5,7 +5,7 @@ */ import { AlertsClient, ConstructorOptions } from '../alerts_client'; import { savedObjectsClientMock, loggingSystemMock } from '../../../../../../src/core/server/mocks'; -import { taskManagerMock } from '../../../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../../../task_manager/server/mocks'; import { alertTypeRegistryMock } from '../../alert_type_registry.mock'; import { alertsAuthorizationMock } from '../../authorization/alerts_authorization.mock'; import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/server/mocks'; @@ -14,7 +14,7 @@ import { AlertsAuthorization } from '../../authorization/alerts_authorization'; import { ActionsAuthorization } from '../../../../actions/server'; import { getBeforeSetup, setGlobalDate } from './lib'; -const taskManager = taskManagerMock.start(); +const taskManager = taskManagerMock.createStart(); const alertTypeRegistry = alertTypeRegistryMock.create(); const unsecuredSavedObjectsClient = savedObjectsClientMock.create(); diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/get_alert_instance_summary.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/get_alert_instance_summary.test.ts index 09212732b76e7..a53e49337f385 100644 --- a/x-pack/plugins/alerts/server/alerts_client/tests/get_alert_instance_summary.test.ts +++ b/x-pack/plugins/alerts/server/alerts_client/tests/get_alert_instance_summary.test.ts @@ -5,7 +5,7 @@ */ import { AlertsClient, ConstructorOptions } from '../alerts_client'; import { savedObjectsClientMock, loggingSystemMock } from '../../../../../../src/core/server/mocks'; -import { taskManagerMock } from '../../../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../../../task_manager/server/mocks'; import { alertTypeRegistryMock } from '../../alert_type_registry.mock'; import { alertsAuthorizationMock } from '../../authorization/alerts_authorization.mock'; import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/server/mocks'; @@ -19,7 +19,7 @@ import { EventsFactory } from '../../lib/alert_instance_summary_from_event_log.t import { RawAlert } from '../../types'; import { getBeforeSetup, mockedDateString, setGlobalDate } from './lib'; -const taskManager = taskManagerMock.start(); +const taskManager = taskManagerMock.createStart(); const alertTypeRegistry = alertTypeRegistryMock.create(); const unsecuredSavedObjectsClient = savedObjectsClientMock.create(); const eventLogClient = eventLogClientMock.create(); diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/get_alert_state.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/get_alert_state.test.ts index 42e573aea347f..8b32f05f6d5a1 100644 --- a/x-pack/plugins/alerts/server/alerts_client/tests/get_alert_state.test.ts +++ b/x-pack/plugins/alerts/server/alerts_client/tests/get_alert_state.test.ts @@ -5,7 +5,7 @@ */ import { AlertsClient, ConstructorOptions } from '../alerts_client'; import { savedObjectsClientMock, loggingSystemMock } from '../../../../../../src/core/server/mocks'; -import { taskManagerMock } from '../../../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../../../task_manager/server/mocks'; import { alertTypeRegistryMock } from '../../alert_type_registry.mock'; import { alertsAuthorizationMock } from '../../authorization/alerts_authorization.mock'; import { TaskStatus } from '../../../../task_manager/server'; @@ -15,7 +15,7 @@ import { AlertsAuthorization } from '../../authorization/alerts_authorization'; import { ActionsAuthorization } from '../../../../actions/server'; import { getBeforeSetup } from './lib'; -const taskManager = taskManagerMock.start(); +const taskManager = taskManagerMock.createStart(); const alertTypeRegistry = alertTypeRegistryMock.create(); const unsecuredSavedObjectsClient = savedObjectsClientMock.create(); diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/lib.ts b/x-pack/plugins/alerts/server/alerts_client/tests/lib.ts index 96e49e21b9045..5ebb4e90d4b50 100644 --- a/x-pack/plugins/alerts/server/alerts_client/tests/lib.ts +++ b/x-pack/plugins/alerts/server/alerts_client/tests/lib.ts @@ -3,8 +3,7 @@ * or more contributor license agreements. Licensed under the Elastic License; * you may not use this file except in compliance with the Elastic License. */ -// eslint-disable-next-line @kbn/eslint/no-restricted-paths -import { TaskManager } from '../../../../task_manager/server/task_manager'; +import { taskManagerMock } from '../../../../task_manager/server/mocks'; import { IEventLogClient } from '../../../../event_log/server'; import { actionsClientMock } from '../../../../actions/server/mocks'; import { ConstructorOptions } from '../alerts_client'; @@ -41,9 +40,7 @@ export function setGlobalDate() { export function getBeforeSetup( alertsClientParams: jest.Mocked, - taskManager: jest.Mocked< - Pick - >, + taskManager: ReturnType, alertTypeRegistry: jest.Mocked>, eventLogClient?: jest.Mocked ) { diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/list_alert_types.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/list_alert_types.test.ts index 4337ed6c491d4..b2f5c5498f848 100644 --- a/x-pack/plugins/alerts/server/alerts_client/tests/list_alert_types.test.ts +++ b/x-pack/plugins/alerts/server/alerts_client/tests/list_alert_types.test.ts @@ -5,7 +5,7 @@ */ import { AlertsClient, ConstructorOptions } from '../alerts_client'; import { savedObjectsClientMock, loggingSystemMock } from '../../../../../../src/core/server/mocks'; -import { taskManagerMock } from '../../../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../../../task_manager/server/mocks'; import { alertTypeRegistryMock } from '../../alert_type_registry.mock'; import { alertsAuthorizationMock } from '../../authorization/alerts_authorization.mock'; import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/server/mocks'; @@ -14,7 +14,7 @@ import { AlertsAuthorization } from '../../authorization/alerts_authorization'; import { ActionsAuthorization } from '../../../../actions/server'; import { getBeforeSetup } from './lib'; -const taskManager = taskManagerMock.start(); +const taskManager = taskManagerMock.createStart(); const alertTypeRegistry = alertTypeRegistryMock.create(); const unsecuredSavedObjectsClient = savedObjectsClientMock.create(); diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/mute_all.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/mute_all.test.ts index 44ee6713f2560..88199dfd1f7b9 100644 --- a/x-pack/plugins/alerts/server/alerts_client/tests/mute_all.test.ts +++ b/x-pack/plugins/alerts/server/alerts_client/tests/mute_all.test.ts @@ -5,7 +5,7 @@ */ import { AlertsClient, ConstructorOptions } from '../alerts_client'; import { savedObjectsClientMock, loggingSystemMock } from '../../../../../../src/core/server/mocks'; -import { taskManagerMock } from '../../../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../../../task_manager/server/mocks'; import { alertTypeRegistryMock } from '../../alert_type_registry.mock'; import { alertsAuthorizationMock } from '../../authorization/alerts_authorization.mock'; import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/server/mocks'; @@ -14,7 +14,7 @@ import { AlertsAuthorization } from '../../authorization/alerts_authorization'; import { ActionsAuthorization } from '../../../../actions/server'; import { getBeforeSetup } from './lib'; -const taskManager = taskManagerMock.start(); +const taskManager = taskManagerMock.createStart(); const alertTypeRegistry = alertTypeRegistryMock.create(); const unsecuredSavedObjectsClient = savedObjectsClientMock.create(); const encryptedSavedObjects = encryptedSavedObjectsMock.createClient(); diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/mute_instance.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/mute_instance.test.ts index dc9a1600a5776..cd7112b3551b3 100644 --- a/x-pack/plugins/alerts/server/alerts_client/tests/mute_instance.test.ts +++ b/x-pack/plugins/alerts/server/alerts_client/tests/mute_instance.test.ts @@ -5,7 +5,7 @@ */ import { AlertsClient, ConstructorOptions } from '../alerts_client'; import { savedObjectsClientMock, loggingSystemMock } from '../../../../../../src/core/server/mocks'; -import { taskManagerMock } from '../../../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../../../task_manager/server/mocks'; import { alertTypeRegistryMock } from '../../alert_type_registry.mock'; import { alertsAuthorizationMock } from '../../authorization/alerts_authorization.mock'; import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/server/mocks'; @@ -14,7 +14,7 @@ import { AlertsAuthorization } from '../../authorization/alerts_authorization'; import { ActionsAuthorization } from '../../../../actions/server'; import { getBeforeSetup } from './lib'; -const taskManager = taskManagerMock.start(); +const taskManager = taskManagerMock.createStart(); const alertTypeRegistry = alertTypeRegistryMock.create(); const unsecuredSavedObjectsClient = savedObjectsClientMock.create(); diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/unmute_all.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/unmute_all.test.ts index 45920db105c2a..07666c1cc6261 100644 --- a/x-pack/plugins/alerts/server/alerts_client/tests/unmute_all.test.ts +++ b/x-pack/plugins/alerts/server/alerts_client/tests/unmute_all.test.ts @@ -5,7 +5,7 @@ */ import { AlertsClient, ConstructorOptions } from '../alerts_client'; import { savedObjectsClientMock, loggingSystemMock } from '../../../../../../src/core/server/mocks'; -import { taskManagerMock } from '../../../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../../../task_manager/server/mocks'; import { alertTypeRegistryMock } from '../../alert_type_registry.mock'; import { alertsAuthorizationMock } from '../../authorization/alerts_authorization.mock'; import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/server/mocks'; @@ -14,7 +14,7 @@ import { AlertsAuthorization } from '../../authorization/alerts_authorization'; import { ActionsAuthorization } from '../../../../actions/server'; import { getBeforeSetup } from './lib'; -const taskManager = taskManagerMock.start(); +const taskManager = taskManagerMock.createStart(); const alertTypeRegistry = alertTypeRegistryMock.create(); const unsecuredSavedObjectsClient = savedObjectsClientMock.create(); diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/unmute_instance.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/unmute_instance.test.ts index 5604011501130..97711b8c14579 100644 --- a/x-pack/plugins/alerts/server/alerts_client/tests/unmute_instance.test.ts +++ b/x-pack/plugins/alerts/server/alerts_client/tests/unmute_instance.test.ts @@ -5,7 +5,7 @@ */ import { AlertsClient, ConstructorOptions } from '../alerts_client'; import { savedObjectsClientMock, loggingSystemMock } from '../../../../../../src/core/server/mocks'; -import { taskManagerMock } from '../../../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../../../task_manager/server/mocks'; import { alertTypeRegistryMock } from '../../alert_type_registry.mock'; import { alertsAuthorizationMock } from '../../authorization/alerts_authorization.mock'; import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/server/mocks'; @@ -14,7 +14,7 @@ import { AlertsAuthorization } from '../../authorization/alerts_authorization'; import { ActionsAuthorization } from '../../../../actions/server'; import { getBeforeSetup } from './lib'; -const taskManager = taskManagerMock.start(); +const taskManager = taskManagerMock.createStart(); const alertTypeRegistry = alertTypeRegistryMock.create(); const unsecuredSavedObjectsClient = savedObjectsClientMock.create(); diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/update.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/update.test.ts index 60b5b62954f05..1dcde6addb9bf 100644 --- a/x-pack/plugins/alerts/server/alerts_client/tests/update.test.ts +++ b/x-pack/plugins/alerts/server/alerts_client/tests/update.test.ts @@ -7,7 +7,7 @@ import uuid from 'uuid'; import { schema } from '@kbn/config-schema'; import { AlertsClient, ConstructorOptions } from '../alerts_client'; import { savedObjectsClientMock, loggingSystemMock } from '../../../../../../src/core/server/mocks'; -import { taskManagerMock } from '../../../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../../../task_manager/server/mocks'; import { alertTypeRegistryMock } from '../../alert_type_registry.mock'; import { alertsAuthorizationMock } from '../../authorization/alerts_authorization.mock'; import { IntervalSchedule } from '../../types'; @@ -19,7 +19,7 @@ import { ActionsAuthorization, ActionsClient } from '../../../../actions/server' import { TaskStatus } from '../../../../task_manager/server'; import { getBeforeSetup, setGlobalDate } from './lib'; -const taskManager = taskManagerMock.start(); +const taskManager = taskManagerMock.createStart(); const alertTypeRegistry = alertTypeRegistryMock.create(); const unsecuredSavedObjectsClient = savedObjectsClientMock.create(); diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/update_api_key.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/update_api_key.test.ts index 97ddfa5e4adb4..1f3b567b2c031 100644 --- a/x-pack/plugins/alerts/server/alerts_client/tests/update_api_key.test.ts +++ b/x-pack/plugins/alerts/server/alerts_client/tests/update_api_key.test.ts @@ -5,7 +5,7 @@ */ import { AlertsClient, ConstructorOptions } from '../alerts_client'; import { savedObjectsClientMock, loggingSystemMock } from '../../../../../../src/core/server/mocks'; -import { taskManagerMock } from '../../../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../../../task_manager/server/mocks'; import { alertTypeRegistryMock } from '../../alert_type_registry.mock'; import { alertsAuthorizationMock } from '../../authorization/alerts_authorization.mock'; import { encryptedSavedObjectsMock } from '../../../../encrypted_saved_objects/server/mocks'; @@ -14,7 +14,7 @@ import { AlertsAuthorization } from '../../authorization/alerts_authorization'; import { ActionsAuthorization } from '../../../../actions/server'; import { getBeforeSetup } from './lib'; -const taskManager = taskManagerMock.start(); +const taskManager = taskManagerMock.createStart(); const alertTypeRegistry = alertTypeRegistryMock.create(); const unsecuredSavedObjectsClient = savedObjectsClientMock.create(); const encryptedSavedObjects = encryptedSavedObjectsMock.createClient(); diff --git a/x-pack/plugins/alerts/server/alerts_client_conflict_retries.test.ts b/x-pack/plugins/alerts/server/alerts_client_conflict_retries.test.ts index 1c5edb45c80fe..b1ac5ac4c6783 100644 --- a/x-pack/plugins/alerts/server/alerts_client_conflict_retries.test.ts +++ b/x-pack/plugins/alerts/server/alerts_client_conflict_retries.test.ts @@ -8,7 +8,7 @@ import { cloneDeep } from 'lodash'; import { AlertsClient, ConstructorOptions } from './alerts_client'; import { savedObjectsClientMock, loggingSystemMock } from '../../../../src/core/server/mocks'; -import { taskManagerMock } from '../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../task_manager/server/mocks'; import { alertTypeRegistryMock } from './alert_type_registry.mock'; import { alertsAuthorizationMock } from './authorization/alerts_authorization.mock'; import { encryptedSavedObjectsMock } from '../../encrypted_saved_objects/server/mocks'; @@ -25,7 +25,7 @@ const MockAlertId = 'alert-id'; const ConflictAfterRetries = RetryForConflictsAttempts + 1; -const taskManager = taskManagerMock.start(); +const taskManager = taskManagerMock.createStart(); const alertTypeRegistry = alertTypeRegistryMock.create(); const unsecuredSavedObjectsClient = savedObjectsClientMock.create(); diff --git a/x-pack/plugins/alerts/server/alerts_client_factory.test.ts b/x-pack/plugins/alerts/server/alerts_client_factory.test.ts index d747efbb959d8..55c2f3ddd18a4 100644 --- a/x-pack/plugins/alerts/server/alerts_client_factory.test.ts +++ b/x-pack/plugins/alerts/server/alerts_client_factory.test.ts @@ -7,7 +7,7 @@ import { Request } from 'hapi'; import { AlertsClientFactory, AlertsClientFactoryOpts } from './alerts_client_factory'; import { alertTypeRegistryMock } from './alert_type_registry.mock'; -import { taskManagerMock } from '../../task_manager/server/task_manager.mock'; +import { taskManagerMock } from '../../task_manager/server/mocks'; import { KibanaRequest } from '../../../../src/core/server'; import { savedObjectsClientMock, @@ -35,7 +35,7 @@ const features = featuresPluginMock.createStart(); const securityPluginSetup = securityMock.createSetup(); const alertsClientFactoryParams: jest.Mocked = { logger: loggingSystemMock.create().get(), - taskManager: taskManagerMock.start(), + taskManager: taskManagerMock.createStart(), alertTypeRegistry: alertTypeRegistryMock.create(), getSpaceId: jest.fn(), getSpace: jest.fn(), diff --git a/x-pack/plugins/alerts/server/usage/alerts_usage_collector.test.ts b/x-pack/plugins/alerts/server/usage/alerts_usage_collector.test.ts index b48d173ba36d9..a5f83bc393d4e 100644 --- a/x-pack/plugins/alerts/server/usage/alerts_usage_collector.test.ts +++ b/x-pack/plugins/alerts/server/usage/alerts_usage_collector.test.ts @@ -6,8 +6,8 @@ import { UsageCollectionSetup } from 'src/plugins/usage_collection/server'; import { registerAlertsUsageCollector } from './alerts_usage_collector'; -import { taskManagerMock } from '../../../task_manager/server/task_manager.mock'; -const taskManagerStart = taskManagerMock.start(); +import { taskManagerMock } from '../../../task_manager/server/mocks'; +const taskManagerStart = taskManagerMock.createStart(); beforeEach(() => jest.resetAllMocks()); diff --git a/x-pack/plugins/alerts/server/usage/task.ts b/x-pack/plugins/alerts/server/usage/task.ts index daf3ac246adad..24ac15bbea78c 100644 --- a/x-pack/plugins/alerts/server/usage/task.ts +++ b/x-pack/plugins/alerts/server/usage/task.ts @@ -42,7 +42,6 @@ function registerAlertingTelemetryTask( taskManager.registerTaskDefinitions({ [TELEMETRY_TASK_TYPE]: { title: 'Alerting usage fetch task', - type: TELEMETRY_TASK_TYPE, timeout: '5m', createTaskRunner: telemetryTaskRunner(logger, core, kibanaIndex), }, diff --git a/x-pack/plugins/apm/server/lib/apm_telemetry/index.ts b/x-pack/plugins/apm/server/lib/apm_telemetry/index.ts index c93fdfc15fe3c..62fc16fb25053 100644 --- a/x-pack/plugins/apm/server/lib/apm_telemetry/index.ts +++ b/x-pack/plugins/apm/server/lib/apm_telemetry/index.ts @@ -49,7 +49,6 @@ export async function createApmTelemetry({ taskManager.registerTaskDefinitions({ [APM_TELEMETRY_TASK_NAME]: { title: 'Collect APM usage', - type: APM_TELEMETRY_TASK_NAME, createTaskRunner: () => { return { run: async () => { diff --git a/x-pack/plugins/lens/server/usage/task.ts b/x-pack/plugins/lens/server/usage/task.ts index 9fee72b59b44c..83cdbd62f3484 100644 --- a/x-pack/plugins/lens/server/usage/task.ts +++ b/x-pack/plugins/lens/server/usage/task.ts @@ -48,7 +48,6 @@ function registerLensTelemetryTask( taskManager.registerTaskDefinitions({ [TELEMETRY_TASK_TYPE]: { title: 'Lens usage fetch task', - type: TELEMETRY_TASK_TYPE, timeout: '1m', createTaskRunner: telemetryTaskRunner(logger, core, config), }, diff --git a/x-pack/plugins/security/server/session_management/session_management_service.test.ts b/x-pack/plugins/security/server/session_management/session_management_service.test.ts index 0328455fc8379..155cc0bdd58ff 100644 --- a/x-pack/plugins/security/server/session_management/session_management_service.test.ts +++ b/x-pack/plugins/security/server/session_management/session_management_service.test.ts @@ -50,7 +50,6 @@ describe('SessionManagementService', () => { expect(mockTaskManager.registerTaskDefinitions).toHaveBeenCalledWith({ [SESSION_INDEX_CLEANUP_TASK_NAME]: { title: 'Cleanup expired or invalid user sessions', - type: SESSION_INDEX_CLEANUP_TASK_NAME, createTaskRunner: expect.any(Function), }, }); diff --git a/x-pack/plugins/security/server/session_management/session_management_service.ts b/x-pack/plugins/security/server/session_management/session_management_service.ts index 60c0f7c23e959..fc2e85d683d58 100644 --- a/x-pack/plugins/security/server/session_management/session_management_service.ts +++ b/x-pack/plugins/security/server/session_management/session_management_service.ts @@ -78,7 +78,6 @@ export class SessionManagementService { taskManager.registerTaskDefinitions({ [SESSION_INDEX_CLEANUP_TASK_NAME]: { title: 'Cleanup expired or invalid user sessions', - type: SESSION_INDEX_CLEANUP_TASK_NAME, createTaskRunner: () => ({ run: () => this.sessionIndex.cleanUp() }), }, }); diff --git a/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/task.ts b/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/task.ts index 02e57a71dcd94..0d78c90735ab3 100644 --- a/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/task.ts +++ b/x-pack/plugins/security_solution/server/endpoint/lib/artifacts/task.ts @@ -39,7 +39,6 @@ export class ManifestTask { setupContract.taskManager.registerTaskDefinitions({ [ManifestTaskConstants.TYPE]: { title: 'Security Solution Endpoint Exceptions Handler', - type: ManifestTaskConstants.TYPE, timeout: ManifestTaskConstants.TIMEOUT, createTaskRunner: ({ taskInstance }: { taskInstance: ConcreteTaskInstance }) => { return { diff --git a/x-pack/plugins/task_manager/server/integration_tests/managed_configuration.test.ts b/x-pack/plugins/task_manager/server/integration_tests/managed_configuration.test.ts index 443c811469002..11f6ccc881850 100644 --- a/x-pack/plugins/task_manager/server/integration_tests/managed_configuration.test.ts +++ b/x-pack/plugins/task_manager/server/integration_tests/managed_configuration.test.ts @@ -5,53 +5,47 @@ */ import sinon from 'sinon'; -import { mockLogger } from '../test_utils'; -import { TaskManager } from '../task_manager'; import { savedObjectsRepositoryMock } from '../../../../../src/core/server/mocks'; -import { - SavedObjectsSerializer, - SavedObjectTypeRegistry, - SavedObjectsErrorHelpers, -} from '../../../../../src/core/server'; +import { SavedObjectsErrorHelpers, Logger } from '../../../../../src/core/server'; import { ADJUST_THROUGHPUT_INTERVAL } from '../lib/create_managed_configuration'; +import { TaskManagerPlugin, TaskManagerStartContract } from '../plugin'; +import { coreMock } from '../../../../../src/core/server/mocks'; +import { TaskManagerConfig } from '../config'; describe('managed configuration', () => { - let taskManager: TaskManager; + let taskManagerStart: TaskManagerStartContract; + let logger: Logger; + let clock: sinon.SinonFakeTimers; - const callAsInternalUser = jest.fn(); - const logger = mockLogger(); - const serializer = new SavedObjectsSerializer(new SavedObjectTypeRegistry()); const savedObjectsClient = savedObjectsRepositoryMock.create(); - const config = { - enabled: true, - max_workers: 10, - index: 'foo', - max_attempts: 9, - poll_interval: 3000, - max_poll_inactivity_cycles: 10, - request_capacity: 1000, - }; - beforeEach(() => { + beforeEach(async () => { jest.resetAllMocks(); - callAsInternalUser.mockResolvedValue({ total: 0, updated: 0, version_conflicts: 0 }); clock = sinon.useFakeTimers(); - taskManager = new TaskManager({ - config, - logger, - serializer, - callAsInternalUser, - taskManagerId: 'some-uuid', - savedObjectsRepository: savedObjectsClient, + + const context = coreMock.createPluginInitializerContext({ + enabled: true, + max_workers: 10, + index: 'foo', + max_attempts: 9, + poll_interval: 3000, + max_poll_inactivity_cycles: 10, + request_capacity: 1000, }); - taskManager.registerTaskDefinitions({ + logger = context.logger.get('taskManager'); + + const taskManager = new TaskManagerPlugin(context); + (await taskManager.setup(coreMock.createSetup())).registerTaskDefinitions({ foo: { - type: 'foo', title: 'Foo', createTaskRunner: jest.fn(), }, }); - taskManager.start(); + + const coreStart = coreMock.createStart(); + coreStart.savedObjects.createInternalRepository.mockReturnValue(savedObjectsClient); + taskManagerStart = await taskManager.start(coreStart); + // force rxjs timers to fire when they are scheduled for setTimeout(0) as the // sinon fake timers cause them to stall clock.tick(0); @@ -63,15 +57,17 @@ describe('managed configuration', () => { savedObjectsClient.create.mockRejectedValueOnce( SavedObjectsErrorHelpers.createTooManyRequestsError('a', 'b') ); + // Cause "too many requests" error to be thrown await expect( - taskManager.schedule({ + taskManagerStart.schedule({ taskType: 'foo', state: {}, params: {}, }) ).rejects.toThrowErrorMatchingInlineSnapshot(`"Too Many Requests"`); clock.tick(ADJUST_THROUGHPUT_INTERVAL); + expect(logger.warn).toHaveBeenCalledWith( 'Max workers configuration is temporarily reduced after Elasticsearch returned 1 "too many request" error(s).' ); @@ -85,15 +81,17 @@ describe('managed configuration', () => { savedObjectsClient.create.mockRejectedValueOnce( SavedObjectsErrorHelpers.createTooManyRequestsError('a', 'b') ); + // Cause "too many requests" error to be thrown await expect( - taskManager.schedule({ + taskManagerStart.schedule({ taskType: 'foo', state: {}, params: {}, }) ).rejects.toThrowErrorMatchingInlineSnapshot(`"Too Many Requests"`); clock.tick(ADJUST_THROUGHPUT_INTERVAL); + expect(logger.warn).toHaveBeenCalledWith( 'Poll interval configuration is temporarily increased after Elasticsearch returned 1 "too many request" error(s).' ); diff --git a/x-pack/plugins/task_manager/server/lib/bulk_operation_buffer.test.ts b/x-pack/plugins/task_manager/server/lib/bulk_operation_buffer.test.ts index c007b32338496..d6d776f970a32 100644 --- a/x-pack/plugins/task_manager/server/lib/bulk_operation_buffer.test.ts +++ b/x-pack/plugins/task_manager/server/lib/bulk_operation_buffer.test.ts @@ -4,9 +4,10 @@ * you may not use this file except in compliance with the Elastic License. */ +import { mockLogger } from '../test_utils'; + import { createBuffer, Entity, OperationError, BulkOperation } from './bulk_operation_buffer'; import { mapErr, asOk, asErr, Ok, Err } from './result_type'; -import { mockLogger } from '../test_utils'; interface TaskInstance extends Entity { attempts: number; diff --git a/x-pack/plugins/task_manager/server/lib/bulk_operation_buffer.ts b/x-pack/plugins/task_manager/server/lib/bulk_operation_buffer.ts index 57a14c2f8a56b..6df5b064f2792 100644 --- a/x-pack/plugins/task_manager/server/lib/bulk_operation_buffer.ts +++ b/x-pack/plugins/task_manager/server/lib/bulk_operation_buffer.ts @@ -8,7 +8,7 @@ import { map } from 'lodash'; import { Subject, race, from } from 'rxjs'; import { bufferWhen, filter, bufferCount, flatMap, mapTo, first } from 'rxjs/operators'; import { either, Result, asOk, asErr, Ok, Err } from './result_type'; -import { Logger } from '../types'; +import { Logger } from '../../../../../src/core/server'; export interface BufferOptions { bufferMaxDuration?: number; diff --git a/x-pack/plugins/task_manager/server/lib/correct_deprecated_fields.test.ts b/x-pack/plugins/task_manager/server/lib/correct_deprecated_fields.test.ts index 408e8d36d3491..8c81e9b9c5b0a 100644 --- a/x-pack/plugins/task_manager/server/lib/correct_deprecated_fields.test.ts +++ b/x-pack/plugins/task_manager/server/lib/correct_deprecated_fields.test.ts @@ -4,8 +4,8 @@ * you may not use this file except in compliance with the Elastic License. */ -import { ensureDeprecatedFieldsAreCorrected } from './correct_deprecated_fields'; import { mockLogger } from '../test_utils'; +import { ensureDeprecatedFieldsAreCorrected } from './correct_deprecated_fields'; describe('ensureDeprecatedFieldsAreCorrected', () => { test('doesnt change tasks without any schedule fields', async () => { diff --git a/x-pack/plugins/task_manager/server/lib/correct_deprecated_fields.ts b/x-pack/plugins/task_manager/server/lib/correct_deprecated_fields.ts index 2de95cbb8c2fa..9e5f4b7c143a2 100644 --- a/x-pack/plugins/task_manager/server/lib/correct_deprecated_fields.ts +++ b/x-pack/plugins/task_manager/server/lib/correct_deprecated_fields.ts @@ -5,7 +5,7 @@ */ import { TaskInstance, TaskInstanceWithDeprecatedFields } from '../task'; -import { Logger } from '../types'; +import { Logger } from '../../../../../src/core/server'; export function ensureDeprecatedFieldsAreCorrected( { id, taskType, interval, schedule, ...taskInstance }: TaskInstanceWithDeprecatedFields, diff --git a/x-pack/plugins/task_manager/server/lib/create_managed_configuration.test.ts b/x-pack/plugins/task_manager/server/lib/create_managed_configuration.test.ts index b6b5cd003c5d4..6e1fc71f144a2 100644 --- a/x-pack/plugins/task_manager/server/lib/create_managed_configuration.test.ts +++ b/x-pack/plugins/task_manager/server/lib/create_managed_configuration.test.ts @@ -6,12 +6,12 @@ import sinon from 'sinon'; import { Subject } from 'rxjs'; -import { mockLogger } from '../test_utils'; import { SavedObjectsErrorHelpers } from '../../../../../src/core/server'; import { createManagedConfiguration, ADJUST_THROUGHPUT_INTERVAL, } from './create_managed_configuration'; +import { mockLogger } from '../test_utils'; describe('createManagedConfiguration()', () => { let clock: sinon.SinonFakeTimers; diff --git a/x-pack/plugins/task_manager/server/lib/create_managed_configuration.ts b/x-pack/plugins/task_manager/server/lib/create_managed_configuration.ts index 3dc5fd50d3ca4..9d093ec0c671f 100644 --- a/x-pack/plugins/task_manager/server/lib/create_managed_configuration.ts +++ b/x-pack/plugins/task_manager/server/lib/create_managed_configuration.ts @@ -7,7 +7,7 @@ import { interval, merge, of, Observable } from 'rxjs'; import { filter, mergeScan, map, scan, distinctUntilChanged, startWith } from 'rxjs/operators'; import { SavedObjectsErrorHelpers } from '../../../../../src/core/server'; -import { Logger } from '../types'; +import { Logger } from '../../../../../src/core/server'; const FLUSH_MARKER = Symbol('flush'); export const ADJUST_THROUGHPUT_INTERVAL = 10 * 1000; @@ -31,7 +31,7 @@ interface ManagedConfigurationOpts { errors$: Observable; } -interface ManagedConfiguration { +export interface ManagedConfiguration { maxWorkersConfiguration$: Observable; pollIntervalConfiguration$: Observable; } diff --git a/x-pack/plugins/task_manager/server/lib/middleware.ts b/x-pack/plugins/task_manager/server/lib/middleware.ts index d367c8ca56c09..c255ddd4775fc 100644 --- a/x-pack/plugins/task_manager/server/lib/middleware.ts +++ b/x-pack/plugins/task_manager/server/lib/middleware.ts @@ -6,49 +6,37 @@ import { RunContext, TaskInstance } from '../task'; -/* - * BeforeSaveMiddlewareParams is nearly identical to RunContext, but - * taskInstance is before save (no _id property) - * - * taskInstance property is guaranteed to exist. The params can optionally - * include fields from an "options" object passed as the 2nd parameter to - * taskManager.schedule() - */ -export interface BeforeSaveMiddlewareParams { +type Mapper = (params: T) => Promise; +interface BeforeSaveContext { taskInstance: TaskInstance; } -export type BeforeSaveFunction = ( - params: BeforeSaveMiddlewareParams -) => Promise; - -export type BeforeRunFunction = (params: RunContext) => Promise; -export type BeforeMarkRunningFunction = (params: RunContext) => Promise; +export type BeforeSaveContextFunction = Mapper; +export type BeforeRunContextFunction = Mapper; export interface Middleware { - beforeSave: BeforeSaveFunction; - beforeRun: BeforeRunFunction; - beforeMarkRunning: BeforeMarkRunningFunction; + beforeSave: BeforeSaveContextFunction; + beforeRun: BeforeRunContextFunction; + beforeMarkRunning: BeforeRunContextFunction; } -export function addMiddlewareToChain(prevMiddleware: Middleware, middleware: Middleware) { - const beforeSave = middleware.beforeSave - ? (params: BeforeSaveMiddlewareParams) => - middleware.beforeSave(params).then(prevMiddleware.beforeSave) - : prevMiddleware.beforeSave; - - const beforeRun = middleware.beforeRun - ? (params: RunContext) => middleware.beforeRun(params).then(prevMiddleware.beforeRun) - : prevMiddleware.beforeRun; +export function addMiddlewareToChain(prev: Middleware, next: Partial) { + return { + beforeSave: next.beforeSave ? chain(prev.beforeSave, next.beforeSave) : prev.beforeSave, + beforeRun: next.beforeRun ? chain(prev.beforeRun, next.beforeRun) : prev.beforeRun, + beforeMarkRunning: next.beforeMarkRunning + ? chain(prev.beforeMarkRunning, next.beforeMarkRunning) + : prev.beforeMarkRunning, + }; +} - const beforeMarkRunning = middleware.beforeMarkRunning - ? (params: RunContext) => - middleware.beforeMarkRunning(params).then(prevMiddleware.beforeMarkRunning) - : prevMiddleware.beforeMarkRunning; +const chain = (prev: Mapper, next: Mapper): Mapper => (params) => + next(params).then(prev); +export function createInitialMiddleware(): Middleware { return { - beforeSave, - beforeRun, - beforeMarkRunning, + beforeSave: async (saveOpts: BeforeSaveContext) => saveOpts, + beforeRun: async (runOpts: RunContext) => runOpts, + beforeMarkRunning: async (runOpts: RunContext) => runOpts, }; } diff --git a/x-pack/plugins/task_manager/server/lib/sanitize_task_definitions.ts b/x-pack/plugins/task_manager/server/lib/sanitize_task_definitions.ts deleted file mode 100644 index f5856aa6fac33..0000000000000 --- a/x-pack/plugins/task_manager/server/lib/sanitize_task_definitions.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* - * 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 Joi from 'joi'; -import { TaskDefinition, TaskDictionary, validateTaskDefinition } from '../task'; - -/** - * Sanitizes the system's task definitions. Task definitions have optional properties, and - * this ensures they all are given a reasonable default. - * - * @param taskDefinitions - The Kibana task definitions dictionary - */ -export function sanitizeTaskDefinitions( - taskDefinitions: TaskDictionary = {} -): TaskDictionary { - return Object.keys(taskDefinitions).reduce((acc, type) => { - const rawDefinition = taskDefinitions[type]; - rawDefinition.type = type; - acc[type] = Joi.attempt(rawDefinition, validateTaskDefinition) as TaskDefinition; - return acc; - }, {} as TaskDictionary); -} diff --git a/x-pack/plugins/task_manager/server/plugin.test.ts b/x-pack/plugins/task_manager/server/plugin.test.ts new file mode 100644 index 0000000000000..50e7e9a7aa197 --- /dev/null +++ b/x-pack/plugins/task_manager/server/plugin.test.ts @@ -0,0 +1,71 @@ +/* + * 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 { TaskManagerPlugin } from './plugin'; +import { coreMock } from '../../../../src/core/server/mocks'; +import { TaskManagerConfig } from './config'; + +describe('TaskManagerPlugin', () => { + describe('setup', () => { + test('throws if no valid UUID is available', async () => { + const pluginInitializerContext = coreMock.createPluginInitializerContext({ + enabled: true, + max_workers: 10, + index: 'foo', + max_attempts: 9, + poll_interval: 3000, + max_poll_inactivity_cycles: 10, + request_capacity: 1000, + }); + + pluginInitializerContext.env.instanceUuid = ''; + + const taskManagerPlugin = new TaskManagerPlugin(pluginInitializerContext); + expect(taskManagerPlugin.setup(coreMock.createSetup())).rejects.toEqual( + new Error(`TaskManager is unable to start as Kibana has no valid UUID assigned to it.`) + ); + }); + + test('throws if setup methods are called after start', async () => { + const pluginInitializerContext = coreMock.createPluginInitializerContext({ + enabled: true, + max_workers: 10, + index: 'foo', + max_attempts: 9, + poll_interval: 3000, + max_poll_inactivity_cycles: 10, + request_capacity: 1000, + }); + + const taskManagerPlugin = new TaskManagerPlugin(pluginInitializerContext); + + const setupApi = await taskManagerPlugin.setup(coreMock.createSetup()); + + await taskManagerPlugin.start(coreMock.createStart()); + + expect(() => + setupApi.addMiddleware({ + beforeSave: async (saveOpts) => saveOpts, + beforeRun: async (runOpts) => runOpts, + beforeMarkRunning: async (runOpts) => runOpts, + }) + ).toThrowErrorMatchingInlineSnapshot( + `"Cannot add Middleware after the task manager has started"` + ); + + expect(() => + setupApi.registerTaskDefinitions({ + lateRegisteredType: { + title: 'lateRegisteredType', + createTaskRunner: () => ({ async run() {} }), + }, + }) + ).toThrowErrorMatchingInlineSnapshot( + `"Cannot register task definitions after the task manager has started"` + ); + }); + }); +}); diff --git a/x-pack/plugins/task_manager/server/plugin.ts b/x-pack/plugins/task_manager/server/plugin.ts index d7dcf779376bf..0381698e6fb77 100644 --- a/x-pack/plugins/task_manager/server/plugin.ts +++ b/x-pack/plugins/task_manager/server/plugin.ts @@ -3,92 +3,140 @@ * or more contributor license agreements. Licensed under the Elastic License; * you may not use this file except in compliance with the Elastic License. */ -import { PluginInitializerContext, Plugin, CoreSetup, CoreStart } from 'src/core/server'; -import { Subject } from 'rxjs'; +import { PluginInitializerContext, Plugin, CoreSetup, Logger, CoreStart } from 'src/core/server'; import { first } from 'rxjs/operators'; -import { TaskDictionary, TaskDefinition } from './task'; -import { TaskManager } from './task_manager'; +import { TaskDefinition } from './task'; +import { TaskPollingLifecycle } from './polling_lifecycle'; import { TaskManagerConfig } from './config'; -import { Middleware } from './lib/middleware'; +import { createInitialMiddleware, addMiddlewareToChain, Middleware } from './lib/middleware'; import { setupSavedObjects } from './saved_objects'; +import { TaskTypeDictionary } from './task_type_dictionary'; +import { FetchResult, SearchOpts, TaskStore } from './task_store'; +import { createManagedConfiguration } from './lib/create_managed_configuration'; +import { TaskScheduling } from './task_scheduling'; -export type TaskManagerSetupContract = Pick< - TaskManager, - 'addMiddleware' | 'registerTaskDefinitions' +export type TaskManagerSetupContract = { addMiddleware: (middleware: Middleware) => void } & Pick< + TaskTypeDictionary, + 'registerTaskDefinitions' >; export type TaskManagerStartContract = Pick< - TaskManager, - 'fetch' | 'get' | 'remove' | 'schedule' | 'runNow' | 'ensureScheduled' ->; + TaskScheduling, + 'schedule' | 'runNow' | 'ensureScheduled' +> & + Pick; export class TaskManagerPlugin implements Plugin { - legacyTaskManager$: Subject = new Subject(); - taskManager: Promise = this.legacyTaskManager$.pipe(first()).toPromise(); - currentConfig: TaskManagerConfig; - taskManagerId?: string; - config?: TaskManagerConfig; + private taskPollingLifecycle?: TaskPollingLifecycle; + private taskManagerId?: string; + private config?: TaskManagerConfig; + private logger: Logger; + private definitions: TaskTypeDictionary; + private middleware: Middleware = createInitialMiddleware(); constructor(private readonly initContext: PluginInitializerContext) { this.initContext = initContext; - this.currentConfig = {} as TaskManagerConfig; + this.logger = initContext.logger.get(); + this.definitions = new TaskTypeDictionary(this.logger); } - public async setup(core: CoreSetup): Promise { + public async setup({ savedObjects }: CoreSetup): Promise { this.config = await this.initContext.config .create() .pipe(first()) .toPromise(); - setupSavedObjects(core.savedObjects, this.config); + setupSavedObjects(savedObjects, this.config); this.taskManagerId = this.initContext.env.instanceUuid; + if (!this.taskManagerId) { + this.logger.error( + `TaskManager is unable to start as there the Kibana UUID is invalid (value of the "server.uuid" configuration is ${this.taskManagerId})` + ); + throw new Error(`TaskManager is unable to start as Kibana has no valid UUID assigned to it.`); + } else { + this.logger.info(`TaskManager is identified by the Kibana UUID: ${this.taskManagerId}`); + } + return { addMiddleware: (middleware: Middleware) => { - this.taskManager.then((tm) => tm.addMiddleware(middleware)); + this.assertStillInSetup('add Middleware'); + this.middleware = addMiddlewareToChain(this.middleware, middleware); }, - registerTaskDefinitions: (taskDefinition: TaskDictionary) => { - this.taskManager.then((tm) => tm.registerTaskDefinitions(taskDefinition)); + registerTaskDefinitions: (taskDefinition: Record) => { + this.assertStillInSetup('register task definitions'); + this.definitions.registerTaskDefinitions(taskDefinition); }, }; } public start({ savedObjects, elasticsearch }: CoreStart): TaskManagerStartContract { - const logger = this.initContext.logger.get('taskManager'); const savedObjectsRepository = savedObjects.createInternalRepository(['task']); - this.legacyTaskManager$.next( - new TaskManager({ - taskManagerId: this.taskManagerId!, - config: this.config!, - savedObjectsRepository, - serializer: savedObjects.createSerializer(), - callAsInternalUser: elasticsearch.legacy.client.callAsInternalUser, - logger, - }) - ); - this.legacyTaskManager$.complete(); - - // we need to "drain" any calls made to the seup API - // before `starting` TaskManager. This is a legacy relic - // of the old API that should be resolved once we split - // Task manager into two services, setup and start, instead - // of the single instance of TaskManager - this.taskManager.then((tm) => tm.start()); + const taskStore = new TaskStore({ + serializer: savedObjects.createSerializer(), + savedObjectsRepository, + esClient: elasticsearch.createClient('taskManager').asInternalUser, + index: this.config!.index, + maxAttempts: this.config!.max_attempts, + definitions: this.definitions, + taskManagerId: `kibana:${this.taskManagerId!}`, + }); + + const { maxWorkersConfiguration$, pollIntervalConfiguration$ } = createManagedConfiguration({ + logger: this.logger, + errors$: taskStore.errors$, + startingMaxWorkers: this.config!.max_workers, + startingPollInterval: this.config!.poll_interval, + }); + + const taskPollingLifecycle = new TaskPollingLifecycle({ + config: this.config!, + definitions: this.definitions, + logger: this.logger, + taskStore, + middleware: this.middleware, + maxWorkersConfiguration$, + pollIntervalConfiguration$, + }); + this.taskPollingLifecycle = taskPollingLifecycle; + + const taskScheduling = new TaskScheduling({ + logger: this.logger, + taskStore, + middleware: this.middleware, + taskPollingLifecycle, + }); + + // start polling for work + taskPollingLifecycle.start(); return { - fetch: (...args) => this.taskManager.then((tm) => tm.fetch(...args)), - get: (...args) => this.taskManager.then((tm) => tm.get(...args)), - remove: (...args) => this.taskManager.then((tm) => tm.remove(...args)), - schedule: (...args) => this.taskManager.then((tm) => tm.schedule(...args)), - runNow: (...args) => this.taskManager.then((tm) => tm.runNow(...args)), - ensureScheduled: (...args) => this.taskManager.then((tm) => tm.ensureScheduled(...args)), + fetch: (opts: SearchOpts): Promise => taskStore.fetch(opts), + get: (id: string) => taskStore.get(id), + remove: (id: string) => taskStore.remove(id), + schedule: (...args) => taskScheduling.schedule(...args), + ensureScheduled: (...args) => taskScheduling.ensureScheduled(...args), + runNow: (...args) => taskScheduling.runNow(...args), }; } + public stop() { - this.taskManager.then((tm) => { - tm.stop(); - }); + if (this.taskPollingLifecycle) { + this.taskPollingLifecycle.stop(); + } + } + + /** + * Ensures task manager hasn't started + * + * @param {string} the name of the operation being executed + * @returns void + */ + private assertStillInSetup(operation: string) { + if (this.taskPollingLifecycle?.isStarted) { + throw new Error(`Cannot ${operation} after the task manager has started`); + } } } diff --git a/x-pack/plugins/task_manager/server/polling/task_poller.ts b/x-pack/plugins/task_manager/server/polling/task_poller.ts index 7515668a19d40..3d48453aa5a9a 100644 --- a/x-pack/plugins/task_manager/server/polling/task_poller.ts +++ b/x-pack/plugins/task_manager/server/polling/task_poller.ts @@ -15,7 +15,7 @@ import { mapTo, filter, scan, concatMap, tap, catchError, switchMap } from 'rxjs import { pipe } from 'fp-ts/lib/pipeable'; import { Option, none, map as mapOptional, getOrElse } from 'fp-ts/lib/Option'; -import { Logger } from '../types'; +import { Logger } from '../../../../../src/core/server'; import { pullFromSet } from '../lib/pull_from_set'; import { Result, diff --git a/x-pack/plugins/task_manager/server/polling_lifecycle.mock.ts b/x-pack/plugins/task_manager/server/polling_lifecycle.mock.ts new file mode 100644 index 0000000000000..9df1e06165bc6 --- /dev/null +++ b/x-pack/plugins/task_manager/server/polling_lifecycle.mock.ts @@ -0,0 +1,24 @@ +/* + * 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 { TaskPollingLifecycle, TaskLifecycleEvent } from './polling_lifecycle'; +import { of, Observable } from 'rxjs'; + +export const taskPollingLifecycleMock = { + create(opts: { isStarted?: boolean; events$?: Observable }) { + return ({ + start: jest.fn(), + attemptToRun: jest.fn(), + get isStarted() { + return opts.isStarted ?? true; + }, + get events() { + return opts.events$ ?? of(); + }, + stop: jest.fn(), + } as unknown) as jest.Mocked; + }, +}; diff --git a/x-pack/plugins/task_manager/server/polling_lifecycle.test.ts b/x-pack/plugins/task_manager/server/polling_lifecycle.test.ts new file mode 100644 index 0000000000000..29c8e836303f8 --- /dev/null +++ b/x-pack/plugins/task_manager/server/polling_lifecycle.test.ts @@ -0,0 +1,105 @@ +/* + * 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 _ from 'lodash'; +import sinon from 'sinon'; +import { of } from 'rxjs'; + +import { TaskPollingLifecycle, claimAvailableTasks } from './polling_lifecycle'; +import { createInitialMiddleware } from './lib/middleware'; +import { TaskTypeDictionary } from './task_type_dictionary'; +import { taskStoreMock } from './task_store.mock'; +import { mockLogger } from './test_utils'; + +describe('TaskPollingLifecycle', () => { + let clock: sinon.SinonFakeTimers; + + const taskManagerLogger = mockLogger(); + const mockTaskStore = taskStoreMock.create({}); + const taskManagerOpts = { + config: { + enabled: true, + max_workers: 10, + index: 'foo', + max_attempts: 9, + poll_interval: 6000000, + max_poll_inactivity_cycles: 10, + request_capacity: 1000, + }, + taskStore: mockTaskStore, + logger: taskManagerLogger, + definitions: new TaskTypeDictionary(taskManagerLogger), + middleware: createInitialMiddleware(), + maxWorkersConfiguration$: of(100), + pollIntervalConfiguration$: of(100), + }; + + beforeEach(() => { + clock = sinon.useFakeTimers(); + taskManagerOpts.definitions = new TaskTypeDictionary(taskManagerLogger); + }); + + afterEach(() => clock.restore()); + + describe('start', () => { + test('begins polling once start is called', () => { + const taskManager = new TaskPollingLifecycle(taskManagerOpts); + + clock.tick(150); + expect(mockTaskStore.claimAvailableTasks).not.toHaveBeenCalled(); + + taskManager.start(); + + clock.tick(150); + expect(mockTaskStore.claimAvailableTasks).toHaveBeenCalled(); + }); + }); + + describe('claimAvailableTasks', () => { + test('should claim Available Tasks when there are available workers', () => { + const logger = mockLogger(); + const claim = jest.fn(() => Promise.resolve({ docs: [], claimedTasks: 0 })); + + const availableWorkers = 1; + + claimAvailableTasks([], claim, availableWorkers, logger); + + expect(claim).toHaveBeenCalledTimes(1); + }); + + test('should not claim Available Tasks when there are no available workers', () => { + const logger = mockLogger(); + const claim = jest.fn(() => Promise.resolve({ docs: [], claimedTasks: 0 })); + + const availableWorkers = 0; + + claimAvailableTasks([], claim, availableWorkers, logger); + + expect(claim).not.toHaveBeenCalled(); + }); + + /** + * This handles the case in which Elasticsearch has had inline script disabled. + * This is achieved by setting the `script.allowed_types` flag on Elasticsearch to `none` + */ + test('handles failure due to inline scripts being disabled', () => { + const logger = mockLogger(); + const claim = jest.fn(() => { + throw Object.assign(new Error(), { + response: + '{"error":{"root_cause":[{"type":"illegal_argument_exception","reason":"cannot execute [inline] scripts"}],"type":"search_phase_execution_exception","reason":"all shards failed","phase":"query","grouped":true,"failed_shards":[{"shard":0,"index":".kibana_task_manager_1","node":"24A4QbjHSK6prvtopAKLKw","reason":{"type":"illegal_argument_exception","reason":"cannot execute [inline] scripts"}}],"caused_by":{"type":"illegal_argument_exception","reason":"cannot execute [inline] scripts","caused_by":{"type":"illegal_argument_exception","reason":"cannot execute [inline] scripts"}}},"status":400}', + }); + }); + + claimAvailableTasks([], claim, 10, logger); + + expect(logger.warn).toHaveBeenCalledTimes(1); + expect(logger.warn).toHaveBeenCalledWith( + `Task Manager cannot operate when inline scripts are disabled in Elasticsearch` + ); + }); + }); +}); diff --git a/x-pack/plugins/task_manager/server/polling_lifecycle.ts b/x-pack/plugins/task_manager/server/polling_lifecycle.ts new file mode 100644 index 0000000000000..8a506cca699de --- /dev/null +++ b/x-pack/plugins/task_manager/server/polling_lifecycle.ts @@ -0,0 +1,259 @@ +/* + * 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 { Subject, Observable, Subscription } from 'rxjs'; + +import { performance } from 'perf_hooks'; + +import { pipe } from 'fp-ts/lib/pipeable'; +import { Option, some, map as mapOptional } from 'fp-ts/lib/Option'; +import { Logger } from '../../../../src/core/server'; + +import { Result, asErr, mapErr } from './lib/result_type'; +import { ManagedConfiguration } from './lib/create_managed_configuration'; +import { TaskManagerConfig } from './config'; + +import { + TaskMarkRunning, + TaskRun, + TaskClaim, + TaskRunRequest, + asTaskRunRequestEvent, +} from './task_events'; +import { fillPool, FillPoolResult } from './lib/fill_pool'; +import { Middleware } from './lib/middleware'; +import { intervalFromNow } from './lib/intervals'; +import { ConcreteTaskInstance } from './task'; +import { + createTaskPoller, + PollingError, + PollingErrorType, + createObservableMonitor, +} from './polling'; +import { TaskPool } from './task_pool'; +import { TaskManagerRunner, TaskRunner } from './task_runner'; +import { TaskStore, OwnershipClaimingOpts, ClaimOwnershipResult } from './task_store'; +import { identifyEsError } from './lib/identify_es_error'; +import { BufferedTaskStore } from './buffered_task_store'; +import { TaskTypeDictionary } from './task_type_dictionary'; + +export type TaskPollingLifecycleOpts = { + logger: Logger; + definitions: TaskTypeDictionary; + taskStore: TaskStore; + config: TaskManagerConfig; + middleware: Middleware; +} & ManagedConfiguration; + +export type TaskLifecycleEvent = TaskMarkRunning | TaskRun | TaskClaim | TaskRunRequest; + +/** + * The public interface into the task manager system. + */ +export class TaskPollingLifecycle { + private definitions: TaskTypeDictionary; + + private store: TaskStore; + private bufferedStore: BufferedTaskStore; + + private logger: Logger; + private pool: TaskPool; + // all task related events (task claimed, task marked as running, etc.) are emitted through events$ + private events$ = new Subject(); + // all on-demand requests we wish to pipe into the poller + private claimRequests$ = new Subject>(); + // the task poller that polls for work on fixed intervals and on demand + private poller$: Observable>>; + // our subscription to the poller + private pollingSubscription: Subscription = Subscription.EMPTY; + + private middleware: Middleware; + + /** + * Initializes the task manager, preventing any further addition of middleware, + * enabling the task manipulation methods, and beginning the background polling + * mechanism. + */ + constructor(opts: TaskPollingLifecycleOpts) { + const { logger, middleware, maxWorkersConfiguration$, pollIntervalConfiguration$ } = opts; + this.logger = logger; + this.middleware = middleware; + + this.definitions = opts.definitions; + this.store = opts.taskStore; + // pipe store events into the lifecycle event stream + this.store.events.subscribe((event) => this.events$.next(event)); + + this.bufferedStore = new BufferedTaskStore(this.store, { + bufferMaxOperations: opts.config.max_workers, + logger: this.logger, + }); + + this.pool = new TaskPool({ + logger: this.logger, + maxWorkers$: maxWorkersConfiguration$, + }); + + const { + max_poll_inactivity_cycles: maxPollInactivityCycles, + poll_interval: pollInterval, + } = opts.config; + this.poller$ = createObservableMonitor>, Error>( + () => + createTaskPoller({ + logger: this.logger, + pollInterval$: pollIntervalConfiguration$, + bufferCapacity: opts.config.request_capacity, + getCapacity: () => this.pool.availableWorkers, + pollRequests$: this.claimRequests$, + work: this.pollForWork, + // Time out the `work` phase if it takes longer than a certain number of polling cycles + // The `work` phase includes the prework needed *before* executing a task + // (such as polling for new work, marking tasks as running etc.) but does not + // include the time of actually running the task + workTimeout: pollInterval * maxPollInactivityCycles, + }), + { + heartbeatInterval: pollInterval, + // Time out the poller itself if it has failed to complete the entire stream for a certain amount of time. + // This is different that the `work` timeout above, as the poller could enter an invalid state where + // it fails to complete a cycle even thought `work` is completing quickly. + // We grant it a single cycle longer than the time alotted to `work` so that timing out the `work` + // doesn't get short circuited by the monitor reinstantiating the poller all together (a far more expensive + // operation than just timing out the `work` internally) + inactivityTimeout: pollInterval * (maxPollInactivityCycles + 1), + onError: (error) => { + this.logger.error(`[Task Poller Monitor]: ${error.message}`); + }, + } + ); + } + + public get events(): Observable { + return this.events$; + } + + private emitEvent = (event: TaskLifecycleEvent) => { + this.events$.next(event); + }; + + public attemptToRun(task: string) { + this.claimRequests$.next(some(task)); + } + + private createTaskRunnerForTask = (instance: ConcreteTaskInstance) => { + return new TaskManagerRunner({ + logger: this.logger, + instance, + store: this.bufferedStore, + definitions: this.definitions, + beforeRun: this.middleware.beforeRun, + beforeMarkRunning: this.middleware.beforeMarkRunning, + onTaskEvent: this.emitEvent, + }); + }; + + public get isStarted() { + return !this.pollingSubscription.closed; + } + + private pollForWork = async (...tasksToClaim: string[]): Promise => { + return fillPool( + // claim available tasks + () => + claimAvailableTasks( + tasksToClaim.splice(0, this.pool.availableWorkers), + this.store.claimAvailableTasks, + this.pool.availableWorkers, + this.logger + ), + // wrap each task in a Task Runner + this.createTaskRunnerForTask, + // place tasks in the Task Pool + async (tasks: TaskRunner[]) => await this.pool.run(tasks) + ); + }; + + /** + * Starts up the task manager and starts picking up tasks. + */ + public start() { + if (!this.isStarted) { + this.pollingSubscription = this.poller$.subscribe( + mapErr((error: PollingError) => { + if (error.type === PollingErrorType.RequestCapacityReached) { + pipe( + error.data, + mapOptional((id) => this.emitEvent(asTaskRunRequestEvent(id, asErr(error)))) + ); + } + this.logger.error(error.message); + }) + ); + } + } + + /** + * Stops the task manager and cancels running tasks. + */ + public stop() { + if (this.isStarted) { + this.pollingSubscription.unsubscribe(); + this.pool.cancelRunningTasks(); + } + } +} + +export async function claimAvailableTasks( + claimTasksById: string[], + claim: (opts: OwnershipClaimingOpts) => Promise, + availableWorkers: number, + logger: Logger +) { + if (availableWorkers > 0) { + performance.mark('claimAvailableTasks_start'); + + try { + const { docs, claimedTasks } = await claim({ + size: availableWorkers, + claimOwnershipUntil: intervalFromNow('30s')!, + claimTasksById, + }); + + if (claimedTasks === 0) { + performance.mark('claimAvailableTasks.noTasks'); + } + performance.mark('claimAvailableTasks_stop'); + performance.measure( + 'claimAvailableTasks', + 'claimAvailableTasks_start', + 'claimAvailableTasks_stop' + ); + + if (docs.length !== claimedTasks) { + logger.warn( + `[Task Ownership error]: ${claimedTasks} tasks were claimed by Kibana, but ${ + docs.length + } task(s) were fetched (${docs.map((doc) => doc.id).join(', ')})` + ); + } + return docs; + } catch (ex) { + if (identifyEsError(ex).includes('cannot execute [inline] scripts')) { + logger.warn( + `Task Manager cannot operate when inline scripts are disabled in Elasticsearch` + ); + } else { + throw ex; + } + } + } else { + performance.mark('claimAvailableTasks.noAvailableWorkers'); + logger.debug( + `[Task Ownership]: Task Manager has skipped Claiming Ownership of available tasks at it has ran out Available Workers.` + ); + } + return []; +} diff --git a/x-pack/plugins/task_manager/server/queries/mark_available_tasks_as_claimed.test.ts b/x-pack/plugins/task_manager/server/queries/mark_available_tasks_as_claimed.test.ts index ac98fbbda5aa2..7cdbd8b11bb06 100644 --- a/x-pack/plugins/task_manager/server/queries/mark_available_tasks_as_claimed.test.ts +++ b/x-pack/plugins/task_manager/server/queries/mark_available_tasks_as_claimed.test.ts @@ -23,23 +23,23 @@ import { SortByRunAtAndRetryAt, } from './mark_available_tasks_as_claimed'; -import { TaskDictionary, TaskDefinition } from '../task'; +import { TaskTypeDictionary } from '../task_type_dictionary'; +import { mockLogger } from '../test_utils'; describe('mark_available_tasks_as_claimed', () => { test('generates query matching tasks to be claimed when polling for tasks', () => { - const definitions: TaskDictionary = { + const definitions = new TaskTypeDictionary(mockLogger()); + definitions.registerTaskDefinitions({ sampleTask: { - type: 'sampleTask', title: 'title', maxAttempts: 5, createTaskRunner: () => ({ run: () => Promise.resolve() }), }, otherTask: { - type: 'otherTask', title: 'title', createTaskRunner: () => ({ run: () => Promise.resolve() }), }, - }; + }); const defaultMaxAttempts = 1; const taskManagerId = '3478fg6-82374f6-83467gf5-384g6f'; const claimOwnershipUntil = '2019-02-12T21:01:22.479Z'; @@ -53,7 +53,7 @@ describe('mark_available_tasks_as_claimed', () => { // Either task has an schedule or the attempts < the maximum configured shouldBeOneOf( TaskWithSchedule, - ...Object.entries(definitions).map(([type, { maxAttempts }]) => + ...Array.from(definitions).map(([type, { maxAttempts }]) => taskWithLessThanMaxAttempts(type, maxAttempts || defaultMaxAttempts) ) ) diff --git a/x-pack/plugins/task_manager/server/task.ts b/x-pack/plugins/task_manager/server/task.ts index 4cb0802887417..6551bd47ef9e7 100644 --- a/x-pack/plugins/task_manager/server/task.ts +++ b/x-pack/plugins/task_manager/server/task.ts @@ -24,12 +24,6 @@ import Joi from 'joi'; */ type Require = Omit & Required>; -/** - * A loosely typed definition of the elasticjs wrapper. It's beyond the scope - * of this work to try to make a comprehensive type definition of this. - */ -export type ElasticJs = (action: string, args: unknown) => Promise; - /** * The run context is passed into a task's run function as its sole argument. */ @@ -154,13 +148,6 @@ export const validateTaskDefinition = Joi.object({ getRetry: Joi.func().optional(), }).default(); -/** - * A dictionary mapping task types to their definitions. - */ -export interface TaskDictionary { - [taskType: string]: T; -} - export enum TaskStatus { Idle = 'idle', Claiming = 'claiming', diff --git a/x-pack/plugins/task_manager/server/task_manager.mock.ts b/x-pack/plugins/task_manager/server/task_manager.mock.ts deleted file mode 100644 index 1fc626e7d58d6..0000000000000 --- a/x-pack/plugins/task_manager/server/task_manager.mock.ts +++ /dev/null @@ -1,30 +0,0 @@ -/* - * 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 { TaskManagerSetupContract, TaskManagerStartContract } from './plugin'; - -export const taskManagerMock = { - setup(overrides: Partial> = {}) { - const mocked: jest.Mocked = { - registerTaskDefinitions: jest.fn(), - addMiddleware: jest.fn(), - ...overrides, - }; - return mocked; - }, - start(overrides: Partial> = {}) { - const mocked: jest.Mocked = { - ensureScheduled: jest.fn(), - schedule: jest.fn(), - fetch: jest.fn(), - get: jest.fn(), - runNow: jest.fn(), - remove: jest.fn(), - ...overrides, - }; - return mocked; - }, -}; diff --git a/x-pack/plugins/task_manager/server/task_manager.test.ts b/x-pack/plugins/task_manager/server/task_manager.test.ts deleted file mode 100644 index cf7f9e2a7cff3..0000000000000 --- a/x-pack/plugins/task_manager/server/task_manager.test.ts +++ /dev/null @@ -1,499 +0,0 @@ -/* - * 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 _ from 'lodash'; -import sinon from 'sinon'; -import { Subject } from 'rxjs'; -import { none } from 'fp-ts/lib/Option'; - -import { - asTaskMarkRunningEvent, - asTaskRunEvent, - asTaskClaimEvent, - asTaskRunRequestEvent, -} from './task_events'; -import { - TaskManager, - claimAvailableTasks, - awaitTaskRunResult, - TaskLifecycleEvent, -} from './task_manager'; -import { savedObjectsRepositoryMock } from '../../../../src/core/server/mocks'; -import { SavedObjectsSerializer, SavedObjectTypeRegistry } from '../../../../src/core/server'; -import { mockLogger } from './test_utils'; -import { asErr, asOk } from './lib/result_type'; -import { ConcreteTaskInstance, TaskLifecycleResult, TaskStatus } from './task'; -import { Middleware } from './lib/middleware'; - -const savedObjectsClient = savedObjectsRepositoryMock.create(); -const serializer = new SavedObjectsSerializer(new SavedObjectTypeRegistry()); - -describe('TaskManager', () => { - let clock: sinon.SinonFakeTimers; - - const config = { - enabled: true, - max_workers: 10, - index: 'foo', - max_attempts: 9, - poll_interval: 6000000, - max_poll_inactivity_cycles: 10, - request_capacity: 1000, - }; - const taskManagerOpts = { - config, - savedObjectsRepository: savedObjectsClient, - serializer, - callAsInternalUser: jest.fn(), - logger: mockLogger(), - taskManagerId: 'some-uuid', - }; - - beforeEach(() => { - clock = sinon.useFakeTimers(); - }); - - afterEach(() => clock.restore()); - - test('throws if no valid UUID is available', async () => { - expect(() => { - new TaskManager({ - ...taskManagerOpts, - taskManagerId: '', - }); - }).toThrowErrorMatchingInlineSnapshot( - `"TaskManager is unable to start as Kibana has no valid UUID assigned to it."` - ); - }); - - test('allows and queues scheduling tasks before starting', async () => { - const client = new TaskManager(taskManagerOpts); - client.registerTaskDefinitions({ - foo: { - type: 'foo', - title: 'Foo', - createTaskRunner: jest.fn(), - }, - }); - const task = { - taskType: 'foo', - params: {}, - state: {}, - }; - savedObjectsClient.create.mockResolvedValueOnce({ - id: '1', - type: 'task', - attributes: {}, - references: [], - }); - const promise = client.schedule(task); - client.start(); - await promise; - - expect(savedObjectsClient.create).toHaveBeenCalled(); - }); - - test('allows scheduling tasks after starting', async () => { - const client = new TaskManager(taskManagerOpts); - client.registerTaskDefinitions({ - foo: { - type: 'foo', - title: 'Foo', - createTaskRunner: jest.fn(), - }, - }); - client.start(); - const task = { - taskType: 'foo', - params: {}, - state: {}, - }; - savedObjectsClient.create.mockResolvedValueOnce({ - id: '1', - type: 'task', - attributes: {}, - references: [], - }); - await client.schedule(task); - expect(savedObjectsClient.create).toHaveBeenCalled(); - }); - - test('allows scheduling existing tasks that may have already been scheduled', async () => { - const client = new TaskManager(taskManagerOpts); - client.registerTaskDefinitions({ - foo: { - type: 'foo', - title: 'Foo', - createTaskRunner: jest.fn(), - }, - }); - savedObjectsClient.create.mockRejectedValueOnce({ - statusCode: 409, - }); - - client.start(); - - const result = await client.ensureScheduled({ - id: 'my-foo-id', - taskType: 'foo', - params: {}, - state: {}, - }); - - expect(result.id).toEqual('my-foo-id'); - }); - - test('doesnt ignore failure to scheduling existing tasks for reasons other than already being scheduled', async () => { - const client = new TaskManager(taskManagerOpts); - client.registerTaskDefinitions({ - foo: { - type: 'foo', - title: 'Foo', - createTaskRunner: jest.fn(), - }, - }); - savedObjectsClient.create.mockRejectedValueOnce({ - statusCode: 500, - }); - - client.start(); - - return expect( - client.ensureScheduled({ - id: 'my-foo-id', - taskType: 'foo', - params: {}, - state: {}, - }) - ).rejects.toMatchObject({ - statusCode: 500, - }); - }); - - test('doesnt allow naively rescheduling existing tasks that have already been scheduled', async () => { - const client = new TaskManager(taskManagerOpts); - client.registerTaskDefinitions({ - foo: { - type: 'foo', - title: 'Foo', - createTaskRunner: jest.fn(), - }, - }); - savedObjectsClient.create.mockRejectedValueOnce({ - statusCode: 409, - }); - - client.start(); - - return expect( - client.schedule({ - id: 'my-foo-id', - taskType: 'foo', - params: {}, - state: {}, - }) - ).rejects.toMatchObject({ - statusCode: 409, - }); - }); - - test('allows and queues removing tasks before starting', async () => { - const client = new TaskManager(taskManagerOpts); - savedObjectsClient.delete.mockResolvedValueOnce({}); - const promise = client.remove('1'); - client.start(); - await promise; - expect(savedObjectsClient.delete).toHaveBeenCalled(); - }); - - test('allows removing tasks after starting', async () => { - const client = new TaskManager(taskManagerOpts); - client.start(); - savedObjectsClient.delete.mockResolvedValueOnce({}); - await client.remove('1'); - expect(savedObjectsClient.delete).toHaveBeenCalled(); - }); - - test('allows and queues fetching tasks before starting', async () => { - const client = new TaskManager(taskManagerOpts); - taskManagerOpts.callAsInternalUser.mockResolvedValue({ - hits: { - total: { - value: 0, - }, - hits: [], - }, - }); - const promise = client.fetch({}); - client.start(); - await promise; - expect(taskManagerOpts.callAsInternalUser).toHaveBeenCalled(); - }); - - test('allows fetching tasks after starting', async () => { - const client = new TaskManager(taskManagerOpts); - client.start(); - taskManagerOpts.callAsInternalUser.mockResolvedValue({ - hits: { - total: { - value: 0, - }, - hits: [], - }, - }); - await client.fetch({}); - expect(taskManagerOpts.callAsInternalUser).toHaveBeenCalled(); - }); - - test('allows middleware registration before starting', () => { - const client = new TaskManager(taskManagerOpts); - const middleware: Middleware = { - beforeSave: jest.fn(async (saveOpts) => saveOpts), - beforeRun: jest.fn(async (runOpts) => runOpts), - beforeMarkRunning: jest.fn(async (runOpts) => runOpts), - }; - expect(() => client.addMiddleware(middleware)).not.toThrow(); - }); - - test('disallows middleware registration after starting', async () => { - const client = new TaskManager(taskManagerOpts); - const middleware: Middleware = { - beforeSave: jest.fn(async (saveOpts) => saveOpts), - beforeRun: jest.fn(async (runOpts) => runOpts), - beforeMarkRunning: jest.fn(async (runOpts) => runOpts), - }; - - client.start(); - expect(() => client.addMiddleware(middleware)).toThrow( - /Cannot add middleware after the task manager is initialized/i - ); - }); - - describe('runNow', () => { - describe('awaitTaskRunResult', () => { - test('resolves when the task run succeeds', () => { - const events$ = new Subject(); - const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; - const getLifecycle = jest.fn(); - - const result = awaitTaskRunResult(id, events$, getLifecycle); - - const task = { id } as ConcreteTaskInstance; - events$.next(asTaskRunEvent(id, asOk(task))); - - return expect(result).resolves.toEqual({ id }); - }); - - test('rejects when the task run fails', () => { - const events$ = new Subject(); - const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; - const getLifecycle = jest.fn(); - - const result = awaitTaskRunResult(id, events$, getLifecycle); - - const task = { id } as ConcreteTaskInstance; - events$.next(asTaskClaimEvent(id, asOk(task))); - events$.next(asTaskMarkRunningEvent(id, asOk(task))); - events$.next(asTaskRunEvent(id, asErr(new Error('some thing gone wrong')))); - - return expect(result).rejects.toMatchInlineSnapshot( - `[Error: Failed to run task "01ddff11-e88a-4d13-bc4e-256164e755e2": Error: some thing gone wrong]` - ); - }); - - test('rejects when the task mark as running fails', () => { - const events$ = new Subject(); - const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; - const getLifecycle = jest.fn(); - - const result = awaitTaskRunResult(id, events$, getLifecycle); - - const task = { id } as ConcreteTaskInstance; - events$.next(asTaskClaimEvent(id, asOk(task))); - events$.next(asTaskMarkRunningEvent(id, asErr(new Error('some thing gone wrong')))); - - return expect(result).rejects.toMatchInlineSnapshot( - `[Error: Failed to run task "01ddff11-e88a-4d13-bc4e-256164e755e2": Error: some thing gone wrong]` - ); - }); - - test('when a task claim fails we ensure the task exists', async () => { - const events$ = new Subject(); - const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; - const getLifecycle = jest.fn(async () => TaskLifecycleResult.NotFound); - - const result = awaitTaskRunResult(id, events$, getLifecycle); - - events$.next(asTaskClaimEvent(id, asErr(none))); - - await expect(result).rejects.toEqual( - new Error(`Failed to run task "${id}" as it does not exist`) - ); - - expect(getLifecycle).toHaveBeenCalledWith(id); - }); - - test('when a task claim fails we ensure the task isnt already claimed', async () => { - const events$ = new Subject(); - const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; - const getLifecycle = jest.fn(async () => TaskStatus.Claiming); - - const result = awaitTaskRunResult(id, events$, getLifecycle); - - events$.next(asTaskClaimEvent(id, asErr(none))); - - await expect(result).rejects.toEqual( - new Error(`Failed to run task "${id}" as it is currently running`) - ); - - expect(getLifecycle).toHaveBeenCalledWith(id); - }); - - test('when a task claim fails we ensure the task isnt already running', async () => { - const events$ = new Subject(); - const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; - const getLifecycle = jest.fn(async () => TaskStatus.Running); - - const result = awaitTaskRunResult(id, events$, getLifecycle); - - events$.next(asTaskClaimEvent(id, asErr(none))); - - await expect(result).rejects.toEqual( - new Error(`Failed to run task "${id}" as it is currently running`) - ); - - expect(getLifecycle).toHaveBeenCalledWith(id); - }); - - test('rejects when the task run fails due to capacity', async () => { - const events$ = new Subject(); - const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; - const getLifecycle = jest.fn(async () => TaskStatus.Idle); - - const result = awaitTaskRunResult(id, events$, getLifecycle); - - events$.next(asTaskRunRequestEvent(id, asErr(new Error('failed to buffer request')))); - - await expect(result).rejects.toEqual( - new Error( - `Failed to run task "${id}" as Task Manager is at capacity, please try again later` - ) - ); - expect(getLifecycle).not.toHaveBeenCalled(); - }); - - test('when a task claim fails we return the underlying error if the task is idle', async () => { - const events$ = new Subject(); - const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; - const getLifecycle = jest.fn(async () => TaskStatus.Idle); - - const result = awaitTaskRunResult(id, events$, getLifecycle); - - events$.next(asTaskClaimEvent(id, asErr(none))); - - await expect(result).rejects.toMatchInlineSnapshot( - `[Error: Failed to run task "01ddff11-e88a-4d13-bc4e-256164e755e2" for unknown reason (Current Task Lifecycle is "idle")]` - ); - - expect(getLifecycle).toHaveBeenCalledWith(id); - }); - - test('when a task claim fails we return the underlying error if the task is failed', async () => { - const events$ = new Subject(); - const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; - const getLifecycle = jest.fn(async () => TaskStatus.Failed); - - const result = awaitTaskRunResult(id, events$, getLifecycle); - - events$.next(asTaskClaimEvent(id, asErr(none))); - - await expect(result).rejects.toMatchInlineSnapshot( - `[Error: Failed to run task "01ddff11-e88a-4d13-bc4e-256164e755e2" for unknown reason (Current Task Lifecycle is "failed")]` - ); - - expect(getLifecycle).toHaveBeenCalledWith(id); - }); - - test('ignores task run success of other tasks', () => { - const events$ = new Subject(); - const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; - const differentTask = '4bebf429-181b-4518-bb7d-b4246d8a35f0'; - const getLifecycle = jest.fn(); - - const result = awaitTaskRunResult(id, events$, getLifecycle); - - const task = { id } as ConcreteTaskInstance; - const otherTask = { id: differentTask } as ConcreteTaskInstance; - events$.next(asTaskClaimEvent(id, asOk(task))); - events$.next(asTaskClaimEvent(differentTask, asOk(otherTask))); - - events$.next(asTaskRunEvent(differentTask, asOk(task))); - - events$.next(asTaskRunEvent(id, asErr(new Error('some thing gone wrong')))); - - return expect(result).rejects.toMatchInlineSnapshot( - `[Error: Failed to run task "01ddff11-e88a-4d13-bc4e-256164e755e2": Error: some thing gone wrong]` - ); - }); - }); - }); - - describe('claimAvailableTasks', () => { - test('should claim Available Tasks when there are available workers', () => { - const logger = mockLogger(); - const claim = jest.fn(() => Promise.resolve({ docs: [], claimedTasks: 0 })); - - const availableWorkers = 1; - - claimAvailableTasks([], claim, availableWorkers, logger); - - expect(claim).toHaveBeenCalledTimes(1); - }); - - test('should not claim Available Tasks when there are no available workers', () => { - const logger = mockLogger(); - const claim = jest.fn(() => Promise.resolve({ docs: [], claimedTasks: 0 })); - - const availableWorkers = 0; - - claimAvailableTasks([], claim, availableWorkers, logger); - - expect(claim).not.toHaveBeenCalled(); - }); - - /** - * This handles the case in which Elasticsearch has had inline script disabled. - * This is achieved by setting the `script.allowed_types` flag on Elasticsearch to `none` - */ - test('handles failure due to inline scripts being disabled', () => { - const logger = mockLogger(); - const claim = jest.fn(() => { - throw Object.assign(new Error(), { - msg: '[illegal_argument_exception] cannot execute [inline] scripts', - path: '/.kibana_task_manager/_update_by_query', - query: { - ignore_unavailable: true, - refresh: true, - max_docs: 200, - conflicts: 'proceed', - }, - body: - '{"query":{"bool":{"must":[{"term":{"type":"task"}},{"bool":{"must":[{"bool":{"should":[{"bool":{"must":[{"term":{"task.status":"idle"}},{"range":{"task.runAt":{"lte":"now"}}}]}},{"bool":{"must":[{"bool":{"should":[{"term":{"task.status":"running"}},{"term":{"task.status":"claiming"}}]}},{"range":{"task.retryAt":{"lte":"now"}}}]}}]}},{"bool":{"should":[{"exists":{"field":"task.schedule"}},{"bool":{"must":[{"term":{"task.taskType":"vis_telemetry"}},{"range":{"task.attempts":{"lt":3}}}]}},{"bool":{"must":[{"term":{"task.taskType":"lens_telemetry"}},{"range":{"task.attempts":{"lt":3}}}]}},{"bool":{"must":[{"term":{"task.taskType":"actions:.server-log"}},{"range":{"task.attempts":{"lt":1}}}]}},{"bool":{"must":[{"term":{"task.taskType":"actions:.slack"}},{"range":{"task.attempts":{"lt":1}}}]}},{"bool":{"must":[{"term":{"task.taskType":"actions:.email"}},{"range":{"task.attempts":{"lt":1}}}]}},{"bool":{"must":[{"term":{"task.taskType":"actions:.index"}},{"range":{"task.attempts":{"lt":1}}}]}},{"bool":{"must":[{"term":{"task.taskType":"actions:.pagerduty"}},{"range":{"task.attempts":{"lt":1}}}]}},{"bool":{"must":[{"term":{"task.taskType":"actions:.webhook"}},{"range":{"task.attempts":{"lt":1}}}]}}]}}]}}]}},"sort":{"_script":{"type":"number","order":"asc","script":{"lang":"expression","source":"doc[\'task.retryAt\'].value || doc[\'task.runAt\'].value"}}},"seq_no_primary_term":true,"script":{"source":"ctx._source.task.ownerId=params.ownerId; ctx._source.task.status=params.status; ctx._source.task.retryAt=params.retryAt;","lang":"painless","params":{"ownerId":"kibana:5b2de169-2785-441b-ae8c-186a1936b17d","retryAt":"2019-10-31T13:35:43.579Z","status":"claiming"}}}', - statusCode: 400, - response: - '{"error":{"root_cause":[{"type":"illegal_argument_exception","reason":"cannot execute [inline] scripts"}],"type":"search_phase_execution_exception","reason":"all shards failed","phase":"query","grouped":true,"failed_shards":[{"shard":0,"index":".kibana_task_manager_1","node":"24A4QbjHSK6prvtopAKLKw","reason":{"type":"illegal_argument_exception","reason":"cannot execute [inline] scripts"}}],"caused_by":{"type":"illegal_argument_exception","reason":"cannot execute [inline] scripts","caused_by":{"type":"illegal_argument_exception","reason":"cannot execute [inline] scripts"}}},"status":400}', - }); - }); - - claimAvailableTasks([], claim, 10, logger); - - expect(logger.warn).toHaveBeenCalledTimes(1); - expect(logger.warn.mock.calls[0][0]).toMatchInlineSnapshot( - `"Task Manager cannot operate when inline scripts are disabled in Elasticsearch"` - ); - }); - }); -}); diff --git a/x-pack/plugins/task_manager/server/task_manager.ts b/x-pack/plugins/task_manager/server/task_manager.ts deleted file mode 100644 index cc611e124ea7b..0000000000000 --- a/x-pack/plugins/task_manager/server/task_manager.ts +++ /dev/null @@ -1,544 +0,0 @@ -/* - * 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 { Subject, Observable, Subscription } from 'rxjs'; -import { filter } from 'rxjs/operators'; - -import { performance } from 'perf_hooks'; - -import { pipe } from 'fp-ts/lib/pipeable'; -import { Option, some, map as mapOptional, getOrElse } from 'fp-ts/lib/Option'; - -import { - SavedObjectsSerializer, - ILegacyScopedClusterClient, - ISavedObjectsRepository, -} from '../../../../src/core/server'; -import { Result, asOk, asErr, either, map, mapErr, promiseResult } from './lib/result_type'; -import { createManagedConfiguration } from './lib/create_managed_configuration'; -import { TaskManagerConfig } from './config'; - -import { Logger } from './types'; -import { - TaskMarkRunning, - TaskRun, - TaskClaim, - TaskRunRequest, - isTaskRunEvent, - isTaskClaimEvent, - isTaskRunRequestEvent, - asTaskRunRequestEvent, -} from './task_events'; -import { fillPool, FillPoolResult } from './lib/fill_pool'; -import { addMiddlewareToChain, BeforeSaveMiddlewareParams, Middleware } from './lib/middleware'; -import { sanitizeTaskDefinitions } from './lib/sanitize_task_definitions'; -import { intervalFromNow } from './lib/intervals'; -import { - TaskDefinition, - TaskDictionary, - ConcreteTaskInstance, - RunContext, - TaskInstanceWithId, - TaskInstanceWithDeprecatedFields, - TaskLifecycle, - TaskLifecycleResult, - TaskStatus, - ElasticJs, -} from './task'; -import { - createTaskPoller, - PollingError, - PollingErrorType, - createObservableMonitor, -} from './polling'; -import { TaskPool } from './task_pool'; -import { TaskManagerRunner, TaskRunner } from './task_runner'; -import { - FetchResult, - TaskStore, - OwnershipClaimingOpts, - ClaimOwnershipResult, - SearchOpts, -} from './task_store'; -import { identifyEsError } from './lib/identify_es_error'; -import { ensureDeprecatedFieldsAreCorrected } from './lib/correct_deprecated_fields'; -import { BufferedTaskStore } from './buffered_task_store'; - -const VERSION_CONFLICT_STATUS = 409; - -export interface TaskManagerOpts { - logger: Logger; - config: TaskManagerConfig; - callAsInternalUser: ILegacyScopedClusterClient['callAsInternalUser']; - savedObjectsRepository: ISavedObjectsRepository; - serializer: SavedObjectsSerializer; - taskManagerId: string; -} - -interface RunNowResult { - id: string; -} - -export type TaskLifecycleEvent = TaskMarkRunning | TaskRun | TaskClaim | TaskRunRequest; - -/* - * The TaskManager is the public interface into the task manager system. This glues together - * all of the disparate modules in one integration point. The task manager operates in two different ways: - * - * - pre-init, it allows middleware registration, but disallows task manipulation - * - post-init, it disallows middleware registration, but allows task manipulation - * - * Due to its complexity, this is mostly tested by integration tests (see readme). - */ - -/** - * The public interface into the task manager system. - */ -export class TaskManager { - private definitions: TaskDictionary = {}; - - private store: TaskStore; - private bufferedStore: BufferedTaskStore; - - private logger: Logger; - private pool: TaskPool; - // all task related events (task claimed, task marked as running, etc.) are emitted through events$ - private events$ = new Subject(); - // all on-demand requests we wish to pipe into the poller - private claimRequests$ = new Subject>(); - // the task poller that polls for work on fixed intervals and on demand - private poller$: Observable>>; - // our subscription to the poller - private pollingSubscription: Subscription = Subscription.EMPTY; - - private startQueue: Array<() => void> = []; - private middleware = { - beforeSave: async (saveOpts: BeforeSaveMiddlewareParams) => saveOpts, - beforeRun: async (runOpts: RunContext) => runOpts, - beforeMarkRunning: async (runOpts: RunContext) => runOpts, - }; - - /** - * Initializes the task manager, preventing any further addition of middleware, - * enabling the task manipulation methods, and beginning the background polling - * mechanism. - */ - constructor(opts: TaskManagerOpts) { - this.logger = opts.logger; - - const { taskManagerId } = opts; - if (!taskManagerId) { - this.logger.error( - `TaskManager is unable to start as there the Kibana UUID is invalid (value of the "server.uuid" configuration is ${taskManagerId})` - ); - throw new Error(`TaskManager is unable to start as Kibana has no valid UUID assigned to it.`); - } else { - this.logger.info(`TaskManager is identified by the Kibana UUID: ${taskManagerId}`); - } - - this.store = new TaskStore({ - serializer: opts.serializer, - savedObjectsRepository: opts.savedObjectsRepository, - callCluster: (opts.callAsInternalUser as unknown) as ElasticJs, - index: opts.config.index, - maxAttempts: opts.config.max_attempts, - definitions: this.definitions, - taskManagerId: `kibana:${taskManagerId}`, - }); - // pipe store events into the TaskManager's event stream - this.store.events.subscribe((event) => this.events$.next(event)); - - const { maxWorkersConfiguration$, pollIntervalConfiguration$ } = createManagedConfiguration({ - logger: this.logger, - errors$: this.store.errors$, - startingMaxWorkers: opts.config.max_workers, - startingPollInterval: opts.config.poll_interval, - }); - - this.bufferedStore = new BufferedTaskStore(this.store, { - bufferMaxOperations: opts.config.max_workers, - logger: this.logger, - }); - - this.pool = new TaskPool({ - logger: this.logger, - maxWorkers$: maxWorkersConfiguration$, - }); - - const { - max_poll_inactivity_cycles: maxPollInactivityCycles, - poll_interval: pollInterval, - } = opts.config; - this.poller$ = createObservableMonitor>, Error>( - () => - createTaskPoller({ - logger: this.logger, - pollInterval$: pollIntervalConfiguration$, - bufferCapacity: opts.config.request_capacity, - getCapacity: () => this.pool.availableWorkers, - pollRequests$: this.claimRequests$, - work: this.pollForWork, - // Time out the `work` phase if it takes longer than a certain number of polling cycles - // The `work` phase includes the prework needed *before* executing a task - // (such as polling for new work, marking tasks as running etc.) but does not - // include the time of actually running the task - workTimeout: pollInterval * maxPollInactivityCycles, - }), - { - heartbeatInterval: pollInterval, - // Time out the poller itself if it has failed to complete the entire stream for a certain amount of time. - // This is different that the `work` timeout above, as the poller could enter an invalid state where - // it fails to complete a cycle even thought `work` is completing quickly. - // We grant it a single cycle longer than the time alotted to `work` so that timing out the `work` - // doesn't get short circuited by the monitor reinstantiating the poller all together (a far more expensive - // operation than just timing out the `work` internally) - inactivityTimeout: pollInterval * (maxPollInactivityCycles + 1), - onError: (error) => { - this.logger.error(`[Task Poller Monitor]: ${error.message}`); - }, - } - ); - } - - private emitEvent = (event: TaskLifecycleEvent) => { - this.events$.next(event); - }; - - private attemptToRun(task: string) { - this.claimRequests$.next(some(task)); - } - - private createTaskRunnerForTask = (instance: ConcreteTaskInstance) => { - return new TaskManagerRunner({ - logger: this.logger, - instance, - store: this.bufferedStore, - definitions: this.definitions, - beforeRun: this.middleware.beforeRun, - beforeMarkRunning: this.middleware.beforeMarkRunning, - onTaskEvent: this.emitEvent, - }); - }; - - public get isStarted() { - return !this.pollingSubscription.closed; - } - - private pollForWork = async (...tasksToClaim: string[]): Promise => { - return fillPool( - // claim available tasks - () => - claimAvailableTasks( - tasksToClaim.splice(0, this.pool.availableWorkers), - this.store.claimAvailableTasks, - this.pool.availableWorkers, - this.logger - ), - // wrap each task in a Task Runner - this.createTaskRunnerForTask, - // place tasks in the Task Pool - async (tasks: TaskRunner[]) => await this.pool.run(tasks) - ); - }; - - /** - * Starts up the task manager and starts picking up tasks. - */ - public start() { - if (!this.isStarted) { - // Some calls are waiting until task manager is started - this.startQueue.forEach((fn) => fn()); - this.startQueue = []; - - this.pollingSubscription = this.poller$.subscribe( - mapErr((error: PollingError) => { - if (error.type === PollingErrorType.RequestCapacityReached) { - pipe( - error.data, - mapOptional((id) => this.emitEvent(asTaskRunRequestEvent(id, asErr(error)))) - ); - } - this.logger.error(error.message); - }) - ); - } - } - - private async waitUntilStarted() { - if (!this.isStarted) { - await new Promise((resolve) => { - this.startQueue.push(resolve); - }); - } - } - - /** - * Stops the task manager and cancels running tasks. - */ - public stop() { - if (this.isStarted) { - this.pollingSubscription.unsubscribe(); - this.pool.cancelRunningTasks(); - } - } - - /** - * Method for allowing consumers to register task definitions into the system. - * @param taskDefinitions - The Kibana task definitions dictionary - */ - public registerTaskDefinitions(taskDefinitions: TaskDictionary) { - this.assertUninitialized('register task definitions', Object.keys(taskDefinitions).join(', ')); - const duplicate = Object.keys(taskDefinitions).find((k) => !!this.definitions[k]); - if (duplicate) { - throw new Error(`Task ${duplicate} is already defined!`); - } - - try { - const sanitized = sanitizeTaskDefinitions(taskDefinitions); - - Object.assign(this.definitions, sanitized); - } catch (e) { - this.logger.error('Could not sanitize task definitions'); - } - } - - /** - * Adds middleware to the task manager, such as adding security layers, loggers, etc. - * - * @param {Middleware} middleware - The middlware being added. - */ - public addMiddleware(middleware: Middleware) { - this.assertUninitialized('add middleware'); - const prevMiddleWare = this.middleware; - this.middleware = addMiddlewareToChain(prevMiddleWare, middleware); - } - - /** - * Schedules a task. - * - * @param task - The task being scheduled. - * @returns {Promise} - */ - public async schedule( - taskInstance: TaskInstanceWithDeprecatedFields, - options?: Record - ): Promise { - await this.waitUntilStarted(); - const { taskInstance: modifiedTask } = await this.middleware.beforeSave({ - ...options, - taskInstance: ensureDeprecatedFieldsAreCorrected(taskInstance, this.logger), - }); - return await this.store.schedule(modifiedTask); - } - - /** - * Run task. - * - * @param taskId - The task being scheduled. - * @returns {Promise} - */ - public async runNow(taskId: string): Promise { - await this.waitUntilStarted(); - return new Promise(async (resolve, reject) => { - awaitTaskRunResult(taskId, this.events$, this.store.getLifecycle.bind(this.store)) - .then(resolve) - .catch(reject); - - this.attemptToRun(taskId); - }); - } - - /** - * Schedules a task with an Id - * - * @param task - The task being scheduled. - * @returns {Promise} - */ - public async ensureScheduled( - taskInstance: TaskInstanceWithId, - options?: Record - ): Promise { - try { - return await this.schedule(taskInstance, options); - } catch (err) { - if (err.statusCode === VERSION_CONFLICT_STATUS) { - return taskInstance; - } - throw err; - } - } - - /** - * Fetches a list of scheduled tasks. - * - * @param opts - The query options used to filter tasks - * @returns {Promise} - */ - public async fetch(opts: SearchOpts): Promise { - await this.waitUntilStarted(); - return this.store.fetch(opts); - } - - /** - * Get the current state of a specified task. - * - * @param {string} id - * @returns {Promise} - */ - public async get(id: string): Promise { - await this.waitUntilStarted(); - return this.store.get(id); - } - - /** - * Removes the specified task from the index. - * - * @param {string} id - * @returns {Promise} - */ - public async remove(id: string): Promise { - await this.waitUntilStarted(); - return this.store.remove(id); - } - - /** - * Ensures task manager IS NOT already initialized - * - * @param {string} message shown if task manager is already initialized - * @returns void - */ - private assertUninitialized(message: string, context?: string) { - if (this.isStarted) { - throw new Error( - `${context ? `[${context}] ` : ''}Cannot ${message} after the task manager is initialized` - ); - } - } -} - -export async function claimAvailableTasks( - claimTasksById: string[], - claim: (opts: OwnershipClaimingOpts) => Promise, - availableWorkers: number, - logger: Logger -) { - if (availableWorkers > 0) { - performance.mark('claimAvailableTasks_start'); - - try { - const { docs, claimedTasks } = await claim({ - size: availableWorkers, - claimOwnershipUntil: intervalFromNow('30s')!, - claimTasksById, - }); - - if (claimedTasks === 0) { - performance.mark('claimAvailableTasks.noTasks'); - } - performance.mark('claimAvailableTasks_stop'); - performance.measure( - 'claimAvailableTasks', - 'claimAvailableTasks_start', - 'claimAvailableTasks_stop' - ); - - if (docs.length !== claimedTasks) { - logger.warn( - `[Task Ownership error]: ${claimedTasks} tasks were claimed by Kibana, but ${ - docs.length - } task(s) were fetched (${docs.map((doc) => doc.id).join(', ')})` - ); - } - return docs; - } catch (ex) { - if (identifyEsError(ex).includes('cannot execute [inline] scripts')) { - logger.warn( - `Task Manager cannot operate when inline scripts are disabled in Elasticsearch` - ); - } else { - throw ex; - } - } - } else { - performance.mark('claimAvailableTasks.noAvailableWorkers'); - logger.debug( - `[Task Ownership]: Task Manager has skipped Claiming Ownership of available tasks at it has ran out Available Workers.` - ); - } - return []; -} - -export async function awaitTaskRunResult( - taskId: string, - events$: Subject, - getLifecycle: (id: string) => Promise -): Promise { - return new Promise((resolve, reject) => { - const subscription = events$ - // listen for all events related to the current task - .pipe(filter(({ id }: TaskLifecycleEvent) => id === taskId)) - .subscribe((taskEvent: TaskLifecycleEvent) => { - if (isTaskClaimEvent(taskEvent)) { - mapErr(async (error: Option) => { - // reject if any error event takes place for the requested task - subscription.unsubscribe(); - return reject( - map( - await pipe( - error, - mapOptional(async (taskReturnedBySweep) => asOk(taskReturnedBySweep.status)), - getOrElse(() => - // if the error happened in the Claim phase - we try to provide better insight - // into why we failed to claim by getting the task's current lifecycle status - promiseResult(getLifecycle(taskId)) - ) - ), - (taskLifecycleStatus: TaskLifecycle) => { - if (taskLifecycleStatus === TaskLifecycleResult.NotFound) { - return new Error(`Failed to run task "${taskId}" as it does not exist`); - } else if ( - taskLifecycleStatus === TaskStatus.Running || - taskLifecycleStatus === TaskStatus.Claiming - ) { - return new Error(`Failed to run task "${taskId}" as it is currently running`); - } - return new Error( - `Failed to run task "${taskId}" for unknown reason (Current Task Lifecycle is "${taskLifecycleStatus}")` - ); - }, - (getLifecycleError: Error) => - new Error( - `Failed to run task "${taskId}" and failed to get current Status:${getLifecycleError}` - ) - ) - ); - }, taskEvent.event); - } else { - either>( - taskEvent.event, - (taskInstance: ConcreteTaskInstance) => { - // resolve if the task has run sucessfully - if (isTaskRunEvent(taskEvent)) { - subscription.unsubscribe(); - resolve({ id: taskInstance.id }); - } - }, - async (error: Error | Option) => { - // reject if any error event takes place for the requested task - subscription.unsubscribe(); - if (isTaskRunRequestEvent(taskEvent)) { - return reject( - new Error( - `Failed to run task "${taskId}" as Task Manager is at capacity, please try again later` - ) - ); - } - return reject(new Error(`Failed to run task "${taskId}": ${error}`)); - } - ); - } - }); - }); -} diff --git a/x-pack/plugins/task_manager/server/task_pool.ts b/x-pack/plugins/task_manager/server/task_pool.ts index 44f5f5648c2ac..9f7948ecad34a 100644 --- a/x-pack/plugins/task_manager/server/task_pool.ts +++ b/x-pack/plugins/task_manager/server/task_pool.ts @@ -12,7 +12,7 @@ import { Observable } from 'rxjs'; import moment, { Duration } from 'moment'; import { performance } from 'perf_hooks'; import { padStart } from 'lodash'; -import { Logger } from './types'; +import { Logger } from '../../../../src/core/server'; import { TaskRunner } from './task_runner'; import { isTaskSavedObjectNotFoundError } from './lib/is_task_not_found_error'; diff --git a/x-pack/plugins/task_manager/server/task_runner.test.ts b/x-pack/plugins/task_manager/server/task_runner.test.ts index c3191dbb349e6..8fb1df444c603 100644 --- a/x-pack/plugins/task_manager/server/task_runner.test.ts +++ b/x-pack/plugins/task_manager/server/task_runner.test.ts @@ -9,11 +9,12 @@ import sinon from 'sinon'; import { minutesFromNow } from './lib/intervals'; import { asOk, asErr } from './lib/result_type'; import { TaskEvent, asTaskRunEvent, asTaskMarkRunningEvent } from './task_events'; -import { ConcreteTaskInstance, TaskStatus, TaskDictionary, TaskDefinition } from './task'; +import { ConcreteTaskInstance, TaskStatus, TaskDefinition, RunResult } from './task'; import { TaskManagerRunner } from './task_runner'; -import { mockLogger } from './test_utils'; import { SavedObjectsErrorHelpers } from '../../../../src/core/server'; import moment from 'moment'; +import { TaskTypeDictionary } from './task_type_dictionary'; +import { mockLogger } from './test_utils'; let fakeTimer: sinon.SinonFakeTimers; @@ -67,6 +68,7 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', createTaskRunner: () => ({ async run() { throw new Error('Dangit!'); @@ -96,9 +98,10 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', createTaskRunner: () => ({ async run() { - return; + return { state: {} }; }, }), }, @@ -124,10 +127,11 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', timeout: `1m`, createTaskRunner: () => ({ async run() { - return; + return { state: {} }; }, }), }, @@ -150,10 +154,11 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', timeout: `1m`, createTaskRunner: () => ({ async run() { - return; + return { state: {} }; }, }), }, @@ -171,9 +176,10 @@ describe('TaskManagerRunner', () => { const { runner, store } = testOpts({ definitions: { bar: { + title: 'Bar!', createTaskRunner: () => ({ async run() { - return { runAt }; + return { runAt, state: {} }; }, }), }, @@ -194,9 +200,10 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', createTaskRunner: () => ({ async run() { - return { runAt }; + return { runAt, state: {} }; }, }), }, @@ -218,6 +225,7 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', createTaskRunner: () => ({ async run() { return undefined; @@ -238,6 +246,7 @@ describe('TaskManagerRunner', () => { const { runner, logger } = testOpts({ definitions: { bar: { + title: 'Bar!', createTaskRunner: () => ({ async run() { const promise = new Promise((r) => setTimeout(r, 1000)); @@ -265,6 +274,7 @@ describe('TaskManagerRunner', () => { const { runner, logger } = testOpts({ definitions: { bar: { + title: 'Bar!', createTaskRunner: () => ({ run: async () => undefined, }), @@ -291,6 +301,7 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', timeout: `${timeoutMinutes}m`, createTaskRunner: () => ({ run: async () => undefined, @@ -325,6 +336,7 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', getRetry: getRetryStub, createTaskRunner: () => ({ async run() { @@ -356,6 +368,7 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', getRetry: getRetryStub, createTaskRunner: () => ({ async run() { @@ -388,6 +401,7 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', getRetry: getRetryStub, createTaskRunner: () => ({ async run() { @@ -421,6 +435,7 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', getRetry: getRetryStub, createTaskRunner: () => ({ async run() { @@ -456,6 +471,7 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', timeout: `${timeoutMinutes}m`, getRetry: getRetryStub, createTaskRunner: () => ({ @@ -490,6 +506,7 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', timeout: `${timeoutMinutes}m`, getRetry: getRetryStub, createTaskRunner: () => ({ @@ -522,6 +539,7 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', timeout: `${timeoutMinutes}m`, getRetry: getRetryStub, createTaskRunner: () => ({ @@ -557,6 +575,7 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', timeout: `${timeoutMinutes}m`, getRetry: getRetryStub, createTaskRunner: () => ({ @@ -592,6 +611,7 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', timeout: `${timeoutMinutes}m`, getRetry: getRetryStub, createTaskRunner: () => ({ @@ -625,6 +645,7 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', timeout: `${timeoutMinutes}m`, getRetry: getRetryStub, createTaskRunner: () => ({ @@ -655,6 +676,7 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', maxAttempts: 3, createTaskRunner: () => ({ run: async () => { @@ -688,6 +710,7 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', maxAttempts: 3, createTaskRunner: () => ({ run: async () => { @@ -720,8 +743,8 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', timeout: `1m`, - getRetry: () => {}, createTaskRunner: () => ({ run: async () => undefined, }), @@ -748,8 +771,8 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', timeout: `1m`, - getRetry: () => {}, createTaskRunner: () => ({ run: async () => undefined, }), @@ -777,9 +800,10 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', createTaskRunner: () => ({ async run() { - return {}; + return { state: {} }; }, }), }, @@ -803,9 +827,10 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', createTaskRunner: () => ({ async run() { - return { runAt }; + return { runAt, state: {} }; }, }), }, @@ -828,6 +853,7 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', createTaskRunner: () => ({ async run() { throw error; @@ -855,9 +881,10 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', createTaskRunner: () => ({ async run() { - return { error }; + return { error, state: {} }; }, }), }, @@ -882,10 +909,11 @@ describe('TaskManagerRunner', () => { }, definitions: { bar: { + title: 'Bar!', getRetry: () => false, createTaskRunner: () => ({ async run() { - return { error }; + return { error, state: {} }; }, }), }, @@ -904,7 +932,7 @@ describe('TaskManagerRunner', () => { interface TestOpts { instance?: Partial; - definitions?: unknown; + definitions?: Record>; onTaskEvent?: (event: TaskEvent) => void; } @@ -942,19 +970,24 @@ describe('TaskManagerRunner', () => { store.update.returns(instance); + const definitions = new TaskTypeDictionary(logger); + definitions.registerTaskDefinitions({ + testbar: { + title: 'Bar!', + createTaskRunner, + }, + }); + if (opts.definitions) { + definitions.registerTaskDefinitions(opts.definitions); + } + const runner = new TaskManagerRunner({ beforeRun: (context) => Promise.resolve(context), beforeMarkRunning: (context) => Promise.resolve(context), logger, store, instance, - definitions: Object.assign(opts.definitions || {}, { - testbar: { - type: 'bar', - title: 'Bar!', - createTaskRunner, - }, - }) as TaskDictionary, + definitions, onTaskEvent: opts.onTaskEvent, }); @@ -972,8 +1005,9 @@ describe('TaskManagerRunner', () => { const { runner, logger } = testOpts({ definitions: { bar: { + title: 'Bar!', createTaskRunner: () => ({ - run: async () => result, + run: async () => result as RunResult, }), }, }, diff --git a/x-pack/plugins/task_manager/server/task_runner.ts b/x-pack/plugins/task_manager/server/task_runner.ts index ebf13fac2f311..24a487e366029 100644 --- a/x-pack/plugins/task_manager/server/task_runner.ts +++ b/x-pack/plugins/task_manager/server/task_runner.ts @@ -15,11 +15,11 @@ import { performance } from 'perf_hooks'; import Joi from 'joi'; import { identity, defaults, flow } from 'lodash'; +import { Logger } from '../../../../src/core/server'; import { asOk, asErr, mapErr, eitherAsync, unwrap, mapOk, Result } from './lib/result_type'; import { TaskRun, TaskMarkRunning, asTaskRunEvent, asTaskMarkRunningEvent } from './task_events'; import { intervalFromDate, intervalFromNow } from './lib/intervals'; -import { Logger } from './types'; -import { BeforeRunFunction, BeforeMarkRunningFunction } from './lib/middleware'; +import { Middleware } from './lib/middleware'; import { CancelFunction, CancellableTask, @@ -29,10 +29,10 @@ import { FailedRunResult, FailedTaskResult, TaskDefinition, - TaskDictionary, validateRunResult, TaskStatus, } from './task'; +import { TaskTypeDictionary } from './task_type_dictionary'; const defaultBackoffPerFailure = 5 * 60 * 1000; const EMPTY_RUN_RESULT: SuccessfulRunResult = {}; @@ -55,15 +55,13 @@ export interface Updatable { remove(id: string): Promise; } -interface Opts { +type Opts = { logger: Logger; - definitions: TaskDictionary; + definitions: TaskTypeDictionary; instance: ConcreteTaskInstance; store: Updatable; - beforeRun: BeforeRunFunction; - beforeMarkRunning: BeforeMarkRunningFunction; onTaskEvent?: (event: TaskRun | TaskMarkRunning) => void; -} +} & Pick; /** * Runs a background task, ensures that errors are properly handled, @@ -76,11 +74,11 @@ interface Opts { export class TaskManagerRunner implements TaskRunner { private task?: CancellableTask; private instance: ConcreteTaskInstance; - private definitions: TaskDictionary; + private definitions: TaskTypeDictionary; private logger: Logger; private bufferedTaskStore: Updatable; - private beforeRun: BeforeRunFunction; - private beforeMarkRunning: BeforeMarkRunningFunction; + private beforeRun: Middleware['beforeRun']; + private beforeMarkRunning: Middleware['beforeMarkRunning']; private onTaskEvent: (event: TaskRun | TaskMarkRunning) => void; /** @@ -129,7 +127,7 @@ export class TaskManagerRunner implements TaskRunner { * Gets the task defintion from the dictionary. */ public get definition() { - return this.definitions[this.taskType]; + return this.definitions.get(this.taskType); } /** diff --git a/x-pack/plugins/task_manager/server/task_scheduling.mock.ts b/x-pack/plugins/task_manager/server/task_scheduling.mock.ts new file mode 100644 index 0000000000000..5a6a369ad7a44 --- /dev/null +++ b/x-pack/plugins/task_manager/server/task_scheduling.mock.ts @@ -0,0 +1,19 @@ +/* + * 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 { TaskScheduling } from './task_scheduling'; + +const createTaskSchedulingMock = () => { + return ({ + ensureScheduled: jest.fn(), + schedule: jest.fn(), + runNow: jest.fn(), + } as unknown) as jest.Mocked; +}; + +export const taskSchedulingMock = { + create: createTaskSchedulingMock, +}; diff --git a/x-pack/plugins/task_manager/server/task_scheduling.test.ts b/x-pack/plugins/task_manager/server/task_scheduling.test.ts new file mode 100644 index 0000000000000..1f7f9250d9014 --- /dev/null +++ b/x-pack/plugins/task_manager/server/task_scheduling.test.ts @@ -0,0 +1,319 @@ +/* + * 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 _ from 'lodash'; +import { Subject } from 'rxjs'; +import { none } from 'fp-ts/lib/Option'; + +import { + asTaskMarkRunningEvent, + asTaskRunEvent, + asTaskClaimEvent, + asTaskRunRequestEvent, +} from './task_events'; +import { TaskLifecycleEvent } from './polling_lifecycle'; +import { taskPollingLifecycleMock } from './polling_lifecycle.mock'; +import { TaskScheduling } from './task_scheduling'; +import { asErr, asOk } from './lib/result_type'; +import { ConcreteTaskInstance, TaskLifecycleResult, TaskStatus } from './task'; +import { createInitialMiddleware } from './lib/middleware'; +import { taskStoreMock } from './task_store.mock'; +import { mockLogger } from './test_utils'; + +describe('TaskScheduling', () => { + const mockTaskStore = taskStoreMock.create({}); + const mockTaskManager = taskPollingLifecycleMock.create({}); + const taskSchedulingOpts = { + taskStore: mockTaskStore, + taskPollingLifecycle: mockTaskManager, + logger: mockLogger(), + middleware: createInitialMiddleware(), + }; + + beforeEach(() => { + jest.resetAllMocks(); + }); + + test('allows scheduling tasks', async () => { + const taskScheduling = new TaskScheduling(taskSchedulingOpts); + const task = { + taskType: 'foo', + params: {}, + state: {}, + }; + await taskScheduling.schedule(task); + expect(mockTaskStore.schedule).toHaveBeenCalled(); + }); + + test('allows scheduling existing tasks that may have already been scheduled', async () => { + const taskScheduling = new TaskScheduling(taskSchedulingOpts); + mockTaskStore.schedule.mockRejectedValueOnce({ + statusCode: 409, + }); + + const result = await taskScheduling.ensureScheduled({ + id: 'my-foo-id', + taskType: 'foo', + params: {}, + state: {}, + }); + + expect(result.id).toEqual('my-foo-id'); + }); + + test('doesnt ignore failure to scheduling existing tasks for reasons other than already being scheduled', async () => { + const taskScheduling = new TaskScheduling(taskSchedulingOpts); + mockTaskStore.schedule.mockRejectedValueOnce({ + statusCode: 500, + }); + + return expect( + taskScheduling.ensureScheduled({ + id: 'my-foo-id', + taskType: 'foo', + params: {}, + state: {}, + }) + ).rejects.toMatchObject({ + statusCode: 500, + }); + }); + + test('doesnt allow naively rescheduling existing tasks that have already been scheduled', async () => { + const taskScheduling = new TaskScheduling(taskSchedulingOpts); + mockTaskStore.schedule.mockRejectedValueOnce({ + statusCode: 409, + }); + + return expect( + taskScheduling.schedule({ + id: 'my-foo-id', + taskType: 'foo', + params: {}, + state: {}, + }) + ).rejects.toMatchObject({ + statusCode: 409, + }); + }); + + describe('runNow', () => { + test('resolves when the task run succeeds', () => { + const events$ = new Subject(); + const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; + + const taskScheduling = new TaskScheduling({ + ...taskSchedulingOpts, + taskPollingLifecycle: taskPollingLifecycleMock.create({ events$ }), + }); + + const result = taskScheduling.runNow(id); + + const task = { id } as ConcreteTaskInstance; + events$.next(asTaskRunEvent(id, asOk(task))); + + return expect(result).resolves.toEqual({ id }); + }); + + test('rejects when the task run fails', () => { + const events$ = new Subject(); + const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; + + const taskScheduling = new TaskScheduling({ + ...taskSchedulingOpts, + taskPollingLifecycle: taskPollingLifecycleMock.create({ events$ }), + }); + + const result = taskScheduling.runNow(id); + + const task = { id } as ConcreteTaskInstance; + events$.next(asTaskClaimEvent(id, asOk(task))); + events$.next(asTaskMarkRunningEvent(id, asOk(task))); + events$.next(asTaskRunEvent(id, asErr(new Error('some thing gone wrong')))); + + return expect(result).rejects.toMatchInlineSnapshot( + `[Error: Failed to run task "01ddff11-e88a-4d13-bc4e-256164e755e2": Error: some thing gone wrong]` + ); + }); + + test('rejects when the task mark as running fails', () => { + const events$ = new Subject(); + const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; + + const taskScheduling = new TaskScheduling({ + ...taskSchedulingOpts, + taskPollingLifecycle: taskPollingLifecycleMock.create({ events$ }), + }); + + const result = taskScheduling.runNow(id); + + const task = { id } as ConcreteTaskInstance; + events$.next(asTaskClaimEvent(id, asOk(task))); + events$.next(asTaskMarkRunningEvent(id, asErr(new Error('some thing gone wrong')))); + + return expect(result).rejects.toMatchInlineSnapshot( + `[Error: Failed to run task "01ddff11-e88a-4d13-bc4e-256164e755e2": Error: some thing gone wrong]` + ); + }); + + test('when a task claim fails we ensure the task exists', async () => { + const events$ = new Subject(); + const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; + + mockTaskStore.getLifecycle.mockResolvedValue(TaskLifecycleResult.NotFound); + + const taskScheduling = new TaskScheduling({ + ...taskSchedulingOpts, + taskPollingLifecycle: taskPollingLifecycleMock.create({ events$ }), + }); + + const result = taskScheduling.runNow(id); + + events$.next(asTaskClaimEvent(id, asErr(none))); + + await expect(result).rejects.toEqual( + new Error(`Failed to run task "${id}" as it does not exist`) + ); + + expect(mockTaskStore.getLifecycle).toHaveBeenCalledWith(id); + }); + + test('when a task claim fails we ensure the task isnt already claimed', async () => { + const events$ = new Subject(); + const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; + + mockTaskStore.getLifecycle.mockResolvedValue(TaskStatus.Claiming); + + const taskScheduling = new TaskScheduling({ + ...taskSchedulingOpts, + taskPollingLifecycle: taskPollingLifecycleMock.create({ events$ }), + }); + + const result = taskScheduling.runNow(id); + + events$.next(asTaskClaimEvent(id, asErr(none))); + + await expect(result).rejects.toEqual( + new Error(`Failed to run task "${id}" as it is currently running`) + ); + + expect(mockTaskStore.getLifecycle).toHaveBeenCalledWith(id); + }); + + test('when a task claim fails we ensure the task isnt already running', async () => { + const events$ = new Subject(); + const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; + + mockTaskStore.getLifecycle.mockResolvedValue(TaskStatus.Running); + + const taskScheduling = new TaskScheduling({ + ...taskSchedulingOpts, + taskPollingLifecycle: taskPollingLifecycleMock.create({ events$ }), + }); + + const result = taskScheduling.runNow(id); + + events$.next(asTaskClaimEvent(id, asErr(none))); + + await expect(result).rejects.toEqual( + new Error(`Failed to run task "${id}" as it is currently running`) + ); + + expect(mockTaskStore.getLifecycle).toHaveBeenCalledWith(id); + }); + + test('rejects when the task run fails due to capacity', async () => { + const events$ = new Subject(); + const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; + + mockTaskStore.getLifecycle.mockResolvedValue(TaskStatus.Idle); + + const taskScheduling = new TaskScheduling({ + ...taskSchedulingOpts, + taskPollingLifecycle: taskPollingLifecycleMock.create({ events$ }), + }); + + const result = taskScheduling.runNow(id); + + events$.next(asTaskRunRequestEvent(id, asErr(new Error('failed to buffer request')))); + + await expect(result).rejects.toEqual( + new Error(`Failed to run task "${id}": Task Manager is at capacity, please try again later`) + ); + expect(mockTaskStore.getLifecycle).not.toHaveBeenCalled(); + }); + + test('when a task claim fails we return the underlying error if the task is idle', async () => { + const events$ = new Subject(); + const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; + + mockTaskStore.getLifecycle.mockResolvedValue(TaskStatus.Idle); + + const taskScheduling = new TaskScheduling({ + ...taskSchedulingOpts, + taskPollingLifecycle: taskPollingLifecycleMock.create({ events$ }), + }); + + const result = taskScheduling.runNow(id); + + events$.next(asTaskClaimEvent(id, asErr(none))); + + await expect(result).rejects.toMatchInlineSnapshot( + `[Error: Failed to run task "01ddff11-e88a-4d13-bc4e-256164e755e2" for unknown reason (Current Task Lifecycle is "idle")]` + ); + + expect(mockTaskStore.getLifecycle).toHaveBeenCalledWith(id); + }); + + test('when a task claim fails we return the underlying error if the task is failed', async () => { + const events$ = new Subject(); + const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; + + mockTaskStore.getLifecycle.mockResolvedValue(TaskStatus.Failed); + + const taskScheduling = new TaskScheduling({ + ...taskSchedulingOpts, + taskPollingLifecycle: taskPollingLifecycleMock.create({ events$ }), + }); + + const result = taskScheduling.runNow(id); + + events$.next(asTaskClaimEvent(id, asErr(none))); + + await expect(result).rejects.toMatchInlineSnapshot( + `[Error: Failed to run task "01ddff11-e88a-4d13-bc4e-256164e755e2" for unknown reason (Current Task Lifecycle is "failed")]` + ); + + expect(mockTaskStore.getLifecycle).toHaveBeenCalledWith(id); + }); + + test('ignores task run success of other tasks', () => { + const events$ = new Subject(); + const id = '01ddff11-e88a-4d13-bc4e-256164e755e2'; + const differentTask = '4bebf429-181b-4518-bb7d-b4246d8a35f0'; + + const taskScheduling = new TaskScheduling({ + ...taskSchedulingOpts, + taskPollingLifecycle: taskPollingLifecycleMock.create({ events$ }), + }); + + const result = taskScheduling.runNow(id); + + const task = { id } as ConcreteTaskInstance; + const otherTask = { id: differentTask } as ConcreteTaskInstance; + events$.next(asTaskClaimEvent(id, asOk(task))); + events$.next(asTaskClaimEvent(differentTask, asOk(otherTask))); + + events$.next(asTaskRunEvent(differentTask, asOk(task))); + + events$.next(asTaskRunEvent(id, asErr(new Error('some thing gone wrong')))); + + return expect(result).rejects.toMatchInlineSnapshot( + `[Error: Failed to run task "01ddff11-e88a-4d13-bc4e-256164e755e2": Error: some thing gone wrong]` + ); + }); + }); +}); diff --git a/x-pack/plugins/task_manager/server/task_scheduling.ts b/x-pack/plugins/task_manager/server/task_scheduling.ts new file mode 100644 index 0000000000000..00f7d853d7114 --- /dev/null +++ b/x-pack/plugins/task_manager/server/task_scheduling.ts @@ -0,0 +1,179 @@ +/* + * 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 { filter } from 'rxjs/operators'; + +import { pipe } from 'fp-ts/lib/pipeable'; +import { Option, map as mapOptional, getOrElse } from 'fp-ts/lib/Option'; + +import { Logger } from '../../../../src/core/server'; +import { asOk, either, map, mapErr, promiseResult } from './lib/result_type'; +import { isTaskRunEvent, isTaskClaimEvent, isTaskRunRequestEvent } from './task_events'; +import { Middleware } from './lib/middleware'; +import { + ConcreteTaskInstance, + TaskInstanceWithId, + TaskInstanceWithDeprecatedFields, + TaskLifecycle, + TaskLifecycleResult, + TaskStatus, +} from './task'; +import { TaskStore } from './task_store'; +import { ensureDeprecatedFieldsAreCorrected } from './lib/correct_deprecated_fields'; +import { TaskLifecycleEvent, TaskPollingLifecycle } from './polling_lifecycle'; + +const VERSION_CONFLICT_STATUS = 409; + +export interface TaskSchedulingOpts { + logger: Logger; + taskStore: TaskStore; + taskPollingLifecycle: TaskPollingLifecycle; + middleware: Middleware; +} + +interface RunNowResult { + id: string; +} + +export class TaskScheduling { + private store: TaskStore; + private taskPollingLifecycle: TaskPollingLifecycle; + private logger: Logger; + private middleware: Middleware; + + /** + * Initializes the task manager, preventing any further addition of middleware, + * enabling the task manipulation methods, and beginning the background polling + * mechanism. + */ + constructor(opts: TaskSchedulingOpts) { + this.logger = opts.logger; + this.middleware = opts.middleware; + this.taskPollingLifecycle = opts.taskPollingLifecycle; + this.store = opts.taskStore; + } + + /** + * Schedules a task. + * + * @param task - The task being scheduled. + * @returns {Promise} + */ + public async schedule( + taskInstance: TaskInstanceWithDeprecatedFields, + options?: Record + ): Promise { + const { taskInstance: modifiedTask } = await this.middleware.beforeSave({ + ...options, + taskInstance: ensureDeprecatedFieldsAreCorrected(taskInstance, this.logger), + }); + return await this.store.schedule(modifiedTask); + } + + /** + * Run task. + * + * @param taskId - The task being scheduled. + * @returns {Promise} + */ + public async runNow(taskId: string): Promise { + return new Promise(async (resolve, reject) => { + this.awaitTaskRunResult(taskId).then(resolve).catch(reject); + this.taskPollingLifecycle.attemptToRun(taskId); + }); + } + + /** + * Schedules a task with an Id + * + * @param task - The task being scheduled. + * @returns {Promise} + */ + public async ensureScheduled( + taskInstance: TaskInstanceWithId, + options?: Record + ): Promise { + try { + return await this.schedule(taskInstance, options); + } catch (err) { + if (err.statusCode === VERSION_CONFLICT_STATUS) { + return taskInstance; + } + throw err; + } + } + + private async awaitTaskRunResult(taskId: string): Promise { + return new Promise((resolve, reject) => { + const subscription = this.taskPollingLifecycle.events + // listen for all events related to the current task + .pipe(filter(({ id }: TaskLifecycleEvent) => id === taskId)) + .subscribe((taskEvent: TaskLifecycleEvent) => { + if (isTaskClaimEvent(taskEvent)) { + mapErr(async (error: Option) => { + // reject if any error event takes place for the requested task + subscription.unsubscribe(); + return reject(await this.identifyTaskFailureReason(taskId, error)); + }, taskEvent.event); + } else { + either>( + taskEvent.event, + (taskInstance: ConcreteTaskInstance) => { + // resolve if the task has run sucessfully + if (isTaskRunEvent(taskEvent)) { + subscription.unsubscribe(); + resolve({ id: taskInstance.id }); + } + }, + async (error: Error | Option) => { + // reject if any error event takes place for the requested task + subscription.unsubscribe(); + return reject( + new Error( + `Failed to run task "${taskId}": ${ + isTaskRunRequestEvent(taskEvent) + ? `Task Manager is at capacity, please try again later` + : error + }` + ) + ); + } + ); + } + }); + }); + } + + private async identifyTaskFailureReason(taskId: string, error: Option) { + return map( + await pipe( + error, + mapOptional(async (taskReturnedBySweep) => asOk(taskReturnedBySweep.status)), + getOrElse(() => + // if the error happened in the Claim phase - we try to provide better insight + // into why we failed to claim by getting the task's current lifecycle status + promiseResult(this.store.getLifecycle(taskId)) + ) + ), + (taskLifecycleStatus: TaskLifecycle) => { + if (taskLifecycleStatus === TaskLifecycleResult.NotFound) { + return new Error(`Failed to run task "${taskId}" as it does not exist`); + } else if ( + taskLifecycleStatus === TaskStatus.Running || + taskLifecycleStatus === TaskStatus.Claiming + ) { + return new Error(`Failed to run task "${taskId}" as it is currently running`); + } + return new Error( + `Failed to run task "${taskId}" for unknown reason (Current Task Lifecycle is "${taskLifecycleStatus}")` + ); + }, + (getLifecycleError: Error) => + new Error( + `Failed to run task "${taskId}" and failed to get current Status:${getLifecycleError}` + ) + ); + } +} diff --git a/x-pack/plugins/task_manager/server/task_store.mock.ts b/x-pack/plugins/task_manager/server/task_store.mock.ts index 86db695bc5e2c..9b82a3e3ee7ab 100644 --- a/x-pack/plugins/task_manager/server/task_store.mock.ts +++ b/x-pack/plugins/task_manager/server/task_store.mock.ts @@ -4,15 +4,24 @@ * you may not use this file except in compliance with the Elastic License. */ +import { Observable, Subject } from 'rxjs'; +import { TaskClaim } from './task_events'; + import { TaskStore } from './task_store'; interface TaskStoreOptions { maxAttempts?: number; index?: string; taskManagerId?: string; + events?: Observable; } export const taskStoreMock = { - create({ maxAttempts = 0, index = '', taskManagerId = '' }: TaskStoreOptions) { + create({ + maxAttempts = 0, + index = '', + taskManagerId = '', + events = new Subject(), + }: TaskStoreOptions) { const mocked = ({ update: jest.fn(), remove: jest.fn(), @@ -25,6 +34,7 @@ export const taskStoreMock = { maxAttempts, index, taskManagerId, + events, } as unknown) as jest.Mocked; return mocked; }, diff --git a/x-pack/plugins/task_manager/server/task_store.test.ts b/x-pack/plugins/task_manager/server/task_store.test.ts index 5a3ee12d593c9..8d47d3dd30b82 100644 --- a/x-pack/plugins/task_manager/server/task_store.test.ts +++ b/x-pack/plugins/task_manager/server/task_store.test.ts @@ -5,20 +5,18 @@ */ import _ from 'lodash'; -import sinon from 'sinon'; import uuid from 'uuid'; import { filter, take, first } from 'rxjs/operators'; import { Option, some, none } from 'fp-ts/lib/Option'; import { - TaskDictionary, - TaskDefinition, TaskInstance, TaskStatus, TaskLifecycleResult, SerializedConcreteTaskInstance, ConcreteTaskInstance, } from './task'; +import { elasticsearchServiceMock } from '../../../../src/core/server/mocks'; import { StoreOpts, OwnershipClaimingOpts, TaskStore, SearchOpts } from './task_store'; import { savedObjectsRepositoryMock } from 'src/core/server/mocks'; import { @@ -29,24 +27,11 @@ import { } from 'src/core/server'; import { asTaskClaimEvent, TaskEvent } from './task_events'; import { asOk, asErr } from './lib/result_type'; - -const taskDefinitions: TaskDictionary = { - report: { - type: 'report', - title: '', - createTaskRunner: jest.fn(), - }, - dernstraight: { - type: 'dernstraight', - title: '', - createTaskRunner: jest.fn(), - }, - yawn: { - type: 'yawn', - title: '', - createTaskRunner: jest.fn(), - }, -}; +import { TaskTypeDictionary } from './task_type_dictionary'; +import { RequestEvent } from '@elastic/elasticsearch/lib/Transport'; +import { Search, UpdateByQuery } from '@elastic/elasticsearch/api/requestParams'; +import { BoolClauseWithAnyCondition, TermFilter } from './queries/query_clauses'; +import { mockLogger } from './test_utils'; const savedObjectsClient = savedObjectsRepositoryMock.create(); const serializer = new SavedObjectsSerializer(new SavedObjectTypeRegistry()); @@ -64,6 +49,22 @@ const mockedDate = new Date('2019-02-12T21:01:22.479Z'); } }; +const taskDefinitions = new TaskTypeDictionary(mockLogger()); +taskDefinitions.registerTaskDefinitions({ + report: { + title: 'report', + createTaskRunner: jest.fn(), + }, + dernstraight: { + title: 'dernstraight', + createTaskRunner: jest.fn(), + }, + yawn: { + title: 'yawn', + createTaskRunner: jest.fn(), + }, +}); + describe('TaskStore', () => { describe('schedule', () => { let store: TaskStore; @@ -73,7 +74,7 @@ describe('TaskStore', () => { index: 'tasky', taskManagerId: '', serializer, - callCluster: jest.fn(), + esClient: elasticsearchServiceMock.createClusterClient().asInternalUser, maxAttempts: 2, definitions: taskDefinitions, savedObjectsRepository: savedObjectsClient, @@ -198,14 +199,15 @@ describe('TaskStore', () => { describe('fetch', () => { let store: TaskStore; - const callCluster = jest.fn(); + let esClient: ReturnType['asInternalUser']; beforeAll(() => { + esClient = elasticsearchServiceMock.createClusterClient().asInternalUser; store = new TaskStore({ index: 'tasky', taskManagerId: '', serializer, - callCluster, + esClient, maxAttempts: 2, definitions: taskDefinitions, savedObjectsRepository: savedObjectsClient, @@ -213,16 +215,15 @@ describe('TaskStore', () => { }); async function testFetch(opts?: SearchOpts, hits: unknown[] = []) { - callCluster.mockResolvedValue({ hits: { hits } }); + esClient.search.mockResolvedValue(asApiResponse({ hits: { hits } })); const result = await store.fetch(opts); - expect(callCluster).toHaveBeenCalledTimes(1); - expect(callCluster).toHaveBeenCalledWith('search', expect.anything()); + expect(esClient.search).toHaveBeenCalledTimes(1); return { result, - args: callCluster.mock.calls[0][1], + args: esClient.search.mock.calls[0][0], }; } @@ -257,7 +258,7 @@ describe('TaskStore', () => { test('pushes error from call cluster to errors$', async () => { const firstErrorPromise = store.errors$.pipe(first()).toPromise(); - callCluster.mockRejectedValue(new Error('Failure')); + esClient.search.mockRejectedValue(new Error('Failure')); await expect(store.fetch()).rejects.toThrowErrorMatchingInlineSnapshot(`"Failure"`); expect(await firstErrorPromise).toMatchInlineSnapshot(`[Error: Failure]`); }); @@ -274,17 +275,18 @@ describe('TaskStore', () => { claimingOpts: OwnershipClaimingOpts; }) { const versionConflicts = 2; - const callCluster = sinon.spy(async (name: string, params?: unknown) => - name === 'updateByQuery' - ? { - total: hits.length + versionConflicts, - updated: hits.length, - version_conflicts: versionConflicts, - } - : { hits: { hits } } + const esClient = elasticsearchServiceMock.createClusterClient().asInternalUser; + esClient.search.mockResolvedValue(asApiResponse({ hits: { hits } })); + esClient.updateByQuery.mockResolvedValue( + asApiResponse({ + total: hits.length + versionConflicts, + updated: hits.length, + version_conflicts: versionConflicts, + }) ); + const store = new TaskStore({ - callCluster, + esClient, maxAttempts: 2, definitions: taskDefinitions, serializer, @@ -296,26 +298,41 @@ describe('TaskStore', () => { const result = await store.claimAvailableTasks(claimingOpts); - sinon.assert.calledTwice(callCluster); - sinon.assert.calledWithMatch(callCluster, 'updateByQuery', { max_docs: claimingOpts.size }); - sinon.assert.calledWithMatch(callCluster, 'search', { body: { size: claimingOpts.size } }); - + expect(esClient.updateByQuery.mock.calls[0][0]).toMatchObject({ + max_docs: claimingOpts.size, + }); + expect(esClient.search.mock.calls[0][0]).toMatchObject({ body: { size: claimingOpts.size } }); return { result, - args: Object.assign({}, ...callCluster.args.map(([name, args]) => ({ [name]: args }))), + args: { + search: esClient.search.mock.calls[0][0]! as Search<{ + query: BoolClauseWithAnyCondition; + size: number; + sort: string | string[]; + }>, + updateByQuery: esClient.updateByQuery.mock.calls[0][0]! as UpdateByQuery<{ + query: BoolClauseWithAnyCondition; + size: number; + sort: string | string[]; + script: object; + }>, + }, }; } test('it returns normally with no tasks when the index does not exist.', async () => { - const callCluster = sinon.spy(async (name: string, params?: unknown) => ({ - total: 0, - updated: 0, - })); + const esClient = elasticsearchServiceMock.createClusterClient().asInternalUser; + esClient.updateByQuery.mockResolvedValue( + asApiResponse({ + total: 0, + updated: 0, + }) + ); const store = new TaskStore({ index: 'tasky', taskManagerId: '', serializer, - callCluster, + esClient, definitions: taskDefinitions, maxAttempts: 2, savedObjectsRepository: savedObjectsClient, @@ -324,9 +341,8 @@ describe('TaskStore', () => { claimOwnershipUntil: new Date(), size: 10, }); - sinon.assert.calledOnce(callCluster); - sinon.assert.calledWithMatch(callCluster, 'updateByQuery', { - ignoreUnavailable: true, + expect(esClient.updateByQuery.mock.calls[0][0]).toMatchObject({ + ignore_unavailable: true, max_docs: 10, }); expect(docs.length).toBe(0); @@ -335,28 +351,28 @@ describe('TaskStore', () => { test('it filters claimed tasks down by supported types, maxAttempts, status, and runAt', async () => { const maxAttempts = _.random(2, 43); const customMaxAttempts = _.random(44, 100); + + const definitions = new TaskTypeDictionary(mockLogger()); + definitions.registerTaskDefinitions({ + foo: { + title: 'foo', + createTaskRunner: jest.fn(), + }, + bar: { + title: 'bar', + maxAttempts: customMaxAttempts, + createTaskRunner: jest.fn(), + }, + }); + const { args: { - updateByQuery: { - body: { query }, - }, + updateByQuery: { body: { query } = {} }, }, } = await testClaimAvailableTasks({ opts: { maxAttempts, - definitions: { - foo: { - type: 'foo', - title: '', - createTaskRunner: jest.fn(), - }, - bar: { - type: 'bar', - title: '', - maxAttempts: customMaxAttempts, - createTaskRunner: jest.fn(), - }, - }, + definitions, }, claimingOpts: { claimOwnershipUntil: new Date(), size: 10 }, }); @@ -465,28 +481,26 @@ describe('TaskStore', () => { test('it supports claiming specific tasks by id', async () => { const maxAttempts = _.random(2, 43); const customMaxAttempts = _.random(44, 100); + const definitions = new TaskTypeDictionary(mockLogger()); + definitions.registerTaskDefinitions({ + foo: { + title: 'foo', + createTaskRunner: jest.fn(), + }, + bar: { + title: 'bar', + maxAttempts: customMaxAttempts, + createTaskRunner: jest.fn(), + }, + }); const { args: { - updateByQuery: { - body: { query, sort }, - }, + updateByQuery: { body: { query, sort } = {} }, }, } = await testClaimAvailableTasks({ opts: { maxAttempts, - definitions: { - foo: { - type: 'foo', - title: '', - createTaskRunner: jest.fn(), - }, - bar: { - type: 'bar', - title: '', - maxAttempts: customMaxAttempts, - createTaskRunner: jest.fn(), - }, - }, + definitions, }, claimingOpts: { claimOwnershipUntil: new Date(), @@ -634,9 +648,7 @@ if (doc['task.runAt'].size()!=0) { const claimOwnershipUntil = new Date(Date.now()); const { args: { - updateByQuery: { - body: { script }, - }, + updateByQuery: { body: { script } = {} }, }, } = await testClaimAvailableTasks({ opts: { @@ -710,9 +722,7 @@ if (doc['task.runAt'].size()!=0) { const { result: { docs }, args: { - search: { - body: { query }, - }, + search: { body: { query } = {} }, }, } = await testClaimAvailableTasks({ opts: { @@ -725,7 +735,7 @@ if (doc['task.runAt'].size()!=0) { hits: tasks, }); - expect(query.bool.must).toContainEqual({ + expect(query?.bool?.must).toContainEqual({ bool: { must: [ { @@ -804,11 +814,9 @@ if (doc['task.runAt'].size()!=0) { }, ]; const { - result: { docs }, + result: { docs } = {}, args: { - search: { - body: { query }, - }, + search: { body: { query } = {} }, }, } = await testClaimAvailableTasks({ opts: { @@ -821,7 +829,7 @@ if (doc['task.runAt'].size()!=0) { hits: tasks, }); - expect(query.bool.must).toContainEqual({ + expect(query?.bool?.must).toContainEqual({ bool: { must: [ { @@ -900,11 +908,9 @@ if (doc['task.runAt'].size()!=0) { }, ]; const { - result: { docs }, + result: { docs } = {}, args: { - search: { - body: { query }, - }, + search: { body: { query } = {} }, }, } = await testClaimAvailableTasks({ opts: { @@ -917,7 +923,7 @@ if (doc['task.runAt'].size()!=0) { hits: tasks, }); - expect(query.bool.must).toContainEqual({ + expect(query?.bool?.must).toContainEqual({ bool: { must: [ { @@ -961,19 +967,19 @@ if (doc['task.runAt'].size()!=0) { }); test('pushes error from saved objects client to errors$', async () => { - const callCluster = jest.fn(); + const esClient = elasticsearchServiceMock.createClusterClient().asInternalUser; const store = new TaskStore({ index: 'tasky', taskManagerId: '', serializer, - callCluster, + esClient, definitions: taskDefinitions, maxAttempts: 2, savedObjectsRepository: savedObjectsClient, }); const firstErrorPromise = store.errors$.pipe(first()).toPromise(); - callCluster.mockRejectedValue(new Error('Failure')); + esClient.updateByQuery.mockRejectedValue(new Error('Failure')); await expect( store.claimAvailableTasks({ claimOwnershipUntil: new Date(), @@ -986,13 +992,15 @@ if (doc['task.runAt'].size()!=0) { describe('update', () => { let store: TaskStore; + let esClient: ReturnType['asInternalUser']; beforeAll(() => { + esClient = elasticsearchServiceMock.createClusterClient().asInternalUser; store = new TaskStore({ index: 'tasky', taskManagerId: '', serializer, - callCluster: jest.fn(), + esClient, maxAttempts: 2, definitions: taskDefinitions, savedObjectsRepository: savedObjectsClient, @@ -1092,7 +1100,7 @@ if (doc['task.runAt'].size()!=0) { index: 'tasky', taskManagerId: '', serializer, - callCluster: jest.fn(), + esClient: elasticsearchServiceMock.createClusterClient().asInternalUser, maxAttempts: 2, definitions: taskDefinitions, savedObjectsRepository: savedObjectsClient, @@ -1132,7 +1140,7 @@ if (doc['task.runAt'].size()!=0) { index: 'tasky', taskManagerId: '', serializer, - callCluster: jest.fn(), + esClient: elasticsearchServiceMock.createClusterClient().asInternalUser, maxAttempts: 2, definitions: taskDefinitions, savedObjectsRepository: savedObjectsClient, @@ -1140,17 +1148,18 @@ if (doc['task.runAt'].size()!=0) { }); test('removes the task with the specified id', async () => { - const id = `id-${_.random(1, 20)}`; + const id = randomId(); const result = await store.remove(id); expect(result).toBeUndefined(); expect(savedObjectsClient.delete).toHaveBeenCalledWith('task', id); }); test('pushes error from saved objects client to errors$', async () => { - const id = `id-${_.random(1, 20)}`; const firstErrorPromise = store.errors$.pipe(first()).toPromise(); savedObjectsClient.delete.mockRejectedValue(new Error('Failure')); - await expect(store.remove(id)).rejects.toThrowErrorMatchingInlineSnapshot(`"Failure"`); + await expect(store.remove(randomId())).rejects.toThrowErrorMatchingInlineSnapshot( + `"Failure"` + ); expect(await firstErrorPromise).toMatchInlineSnapshot(`[Error: Failure]`); }); }); @@ -1163,7 +1172,7 @@ if (doc['task.runAt'].size()!=0) { index: 'tasky', taskManagerId: '', serializer, - callCluster: jest.fn(), + esClient: elasticsearchServiceMock.createClusterClient().asInternalUser, maxAttempts: 2, definitions: taskDefinitions, savedObjectsRepository: savedObjectsClient, @@ -1171,13 +1180,12 @@ if (doc['task.runAt'].size()!=0) { }); test('gets the task with the specified id', async () => { - const id = `id-${_.random(1, 20)}`; const task = { runAt: mockedDate, scheduledAt: mockedDate, startedAt: null, retryAt: null, - id, + id: randomId(), params: { hello: 'world' }, state: { foo: 'bar' }, taskType: 'report', @@ -1198,18 +1206,17 @@ if (doc['task.runAt'].size()!=0) { version: '123', })); - const result = await store.get(id); + const result = await store.get(task.id); expect(result).toEqual(task); - expect(savedObjectsClient.get).toHaveBeenCalledWith('task', id); + expect(savedObjectsClient.get).toHaveBeenCalledWith('task', task.id); }); test('pushes error from saved objects client to errors$', async () => { - const id = `id-${_.random(1, 20)}`; const firstErrorPromise = store.errors$.pipe(first()).toPromise(); savedObjectsClient.get.mockRejectedValue(new Error('Failure')); - await expect(store.get(id)).rejects.toThrowErrorMatchingInlineSnapshot(`"Failure"`); + await expect(store.get(randomId())).rejects.toThrowErrorMatchingInlineSnapshot(`"Failure"`); expect(await firstErrorPromise).toMatchInlineSnapshot(`[Error: Failure]`); }); }); @@ -1219,13 +1226,12 @@ if (doc['task.runAt'].size()!=0) { expect.assertions(4); return Promise.all( Object.values(TaskStatus).map(async (status) => { - const id = `id-${_.random(1, 20)}`; const task = { runAt: mockedDate, scheduledAt: mockedDate, startedAt: null, retryAt: null, - id, + id: randomId(), params: { hello: 'world' }, state: { foo: 'bar' }, taskType: 'report', @@ -1235,7 +1241,6 @@ if (doc['task.runAt'].size()!=0) { ownerId: null, }; - const callCluster = jest.fn(); savedObjectsClient.get.mockImplementation(async (type: string, objectId: string) => ({ id: objectId, type, @@ -1251,20 +1256,18 @@ if (doc['task.runAt'].size()!=0) { index: 'tasky', taskManagerId: '', serializer, - callCluster, + esClient: elasticsearchServiceMock.createClusterClient().asInternalUser, maxAttempts: 2, definitions: taskDefinitions, savedObjectsRepository: savedObjectsClient, }); - expect(await store.getLifecycle(id)).toEqual(status); + expect(await store.getLifecycle(task.id)).toEqual(status); }) ); }); test('returns NotFound status if the task doesnt exists ', async () => { - const id = `id-${_.random(1, 20)}`; - savedObjectsClient.get.mockRejectedValueOnce( SavedObjectsErrorHelpers.createGenericNotFoundError('type', 'id') ); @@ -1273,18 +1276,16 @@ if (doc['task.runAt'].size()!=0) { index: 'tasky', taskManagerId: '', serializer, - callCluster: jest.fn(), + esClient: elasticsearchServiceMock.createClusterClient().asInternalUser, maxAttempts: 2, definitions: taskDefinitions, savedObjectsRepository: savedObjectsClient, }); - expect(await store.getLifecycle(id)).toEqual(TaskLifecycleResult.NotFound); + expect(await store.getLifecycle(randomId())).toEqual(TaskLifecycleResult.NotFound); }); test('throws if an unknown error takes place ', async () => { - const id = `id-${_.random(1, 20)}`; - savedObjectsClient.get.mockRejectedValueOnce( SavedObjectsErrorHelpers.createBadRequestError() ); @@ -1293,13 +1294,13 @@ if (doc['task.runAt'].size()!=0) { index: 'tasky', taskManagerId: '', serializer, - callCluster: jest.fn(), + esClient: elasticsearchServiceMock.createClusterClient().asInternalUser, maxAttempts: 2, definitions: taskDefinitions, savedObjectsRepository: savedObjectsClient, }); - return expect(store.getLifecycle(id)).rejects.toThrow('Bad Request'); + return expect(store.getLifecycle(randomId())).rejects.toThrow('Bad Request'); }); }); @@ -1385,18 +1386,20 @@ if (doc['task.runAt'].size()!=0) { return { taskManagerId, runAt, tasks }; } - test('emits an event when a task is succesfully claimed by id', async () => { + function instantiateStoreWithMockedApiResponses() { const { taskManagerId, runAt, tasks } = generateTasks(); - const callCluster = sinon.spy(async (name: string, params?: unknown) => - name === 'updateByQuery' - ? { - total: tasks.length, - updated: tasks.length, - } - : { hits: { hits: tasks } } + + const esClient = elasticsearchServiceMock.createClusterClient().asInternalUser; + esClient.search.mockResolvedValue(asApiResponse({ hits: { hits: tasks } })); + esClient.updateByQuery.mockResolvedValue( + asApiResponse({ + total: tasks.length, + updated: tasks.length, + }) ); + const store = new TaskStore({ - callCluster, + esClient, maxAttempts: 2, definitions: taskDefinitions, serializer, @@ -1405,6 +1408,12 @@ if (doc['task.runAt'].size()!=0) { index: '', }); + return { taskManagerId, runAt, store }; + } + + test('emits an event when a task is succesfully claimed by id', async () => { + const { taskManagerId, runAt, store } = instantiateStoreWithMockedApiResponses(); + const promise = store.events .pipe( filter( @@ -1446,24 +1455,7 @@ if (doc['task.runAt'].size()!=0) { }); test('emits an event when a task is succesfully by scheduling', async () => { - const { taskManagerId, runAt, tasks } = generateTasks(); - const callCluster = sinon.spy(async (name: string, params?: unknown) => - name === 'updateByQuery' - ? { - total: tasks.length, - updated: tasks.length, - } - : { hits: { hits: tasks } } - ); - const store = new TaskStore({ - callCluster, - maxAttempts: 2, - definitions: taskDefinitions, - serializer, - savedObjectsRepository: savedObjectsClient, - taskManagerId, - index: '', - }); + const { taskManagerId, runAt, store } = instantiateStoreWithMockedApiResponses(); const promise = store.events .pipe( @@ -1506,24 +1498,7 @@ if (doc['task.runAt'].size()!=0) { }); test('emits an event when the store fails to claim a required task by id', async () => { - const { taskManagerId, runAt, tasks } = generateTasks(); - const callCluster = sinon.spy(async (name: string, params?: unknown) => - name === 'updateByQuery' - ? { - total: tasks.length, - updated: tasks.length, - } - : { hits: { hits: tasks } } - ); - const store = new TaskStore({ - callCluster, - maxAttempts: 2, - definitions: taskDefinitions, - serializer, - savedObjectsRepository: savedObjectsClient, - taskManagerId, - index: '', - }); + const { taskManagerId, runAt, store } = instantiateStoreWithMockedApiResponses(); const promise = store.events .pipe( @@ -1568,24 +1543,7 @@ if (doc['task.runAt'].size()!=0) { }); test('emits an event when the store fails to find a task which was required by id', async () => { - const { taskManagerId, tasks } = generateTasks(); - const callCluster = sinon.spy(async (name: string, params?: unknown) => - name === 'updateByQuery' - ? { - total: tasks.length, - updated: tasks.length, - } - : { hits: { hits: tasks } } - ); - const store = new TaskStore({ - callCluster, - maxAttempts: 2, - definitions: taskDefinitions, - serializer, - savedObjectsRepository: savedObjectsClient, - taskManagerId, - index: '', - }); + const { store } = instantiateStoreWithMockedApiResponses(); const promise = store.events .pipe( @@ -1621,3 +1579,10 @@ function generateFakeTasks(count: number = 1) { sort: ['a', _.random(1, 5)], })); } + +const asApiResponse = (body: T): RequestEvent => + ({ + body, + } as RequestEvent); + +const randomId = () => `id-${_.random(1, 20)}`; diff --git a/x-pack/plugins/task_manager/server/task_store.ts b/x-pack/plugins/task_manager/server/task_store.ts index 1563305ba88c4..a819e7ce9c86c 100644 --- a/x-pack/plugins/task_manager/server/task_store.ts +++ b/x-pack/plugins/task_manager/server/task_store.ts @@ -20,15 +20,13 @@ import { SavedObjectsRawDoc, ISavedObjectsRepository, SavedObjectsUpdateResponse, + ElasticsearchClient, } from '../../../../src/core/server'; import { asOk, asErr, Result } from './lib/result_type'; import { ConcreteTaskInstance, - ElasticJs, - TaskDefinition, - TaskDictionary, TaskInstance, TaskLifecycle, TaskLifecycleResult, @@ -55,13 +53,14 @@ import { SortByRunAtAndRetryAt, tasksClaimedByOwner, } from './queries/mark_available_tasks_as_claimed'; +import { TaskTypeDictionary } from './task_type_dictionary'; export interface StoreOpts { - callCluster: ElasticJs; + esClient: ElasticsearchClient; index: string; taskManagerId: string; maxAttempts: number; - definitions: TaskDictionary; + definitions: TaskTypeDictionary; savedObjectsRepository: ISavedObjectsRepository; serializer: SavedObjectsSerializer; } @@ -118,8 +117,8 @@ export class TaskStore { public readonly taskManagerId: string; public readonly errors$ = new Subject(); - private callCluster: ElasticJs; - private definitions: TaskDictionary; + private esClient: ElasticsearchClient; + private definitions: TaskTypeDictionary; private savedObjectsRepository: ISavedObjectsRepository; private serializer: SavedObjectsSerializer; private events$: Subject; @@ -127,7 +126,7 @@ export class TaskStore { /** * Constructs a new TaskStore. * @param {StoreOpts} opts - * @prop {CallCluster} callCluster - The elastic search connection + * @prop {esClient} esClient - An elasticsearch client * @prop {string} index - The name of the task manager index * @prop {number} maxAttempts - The maximum number of attempts before a task will be abandoned * @prop {TaskDefinition} definition - The definition of the task being run @@ -135,7 +134,7 @@ export class TaskStore { * @prop {savedObjectsRepository} - An instance to the saved objects repository */ constructor(opts: StoreOpts) { - this.callCluster = opts.callCluster; + this.esClient = opts.esClient; this.index = opts.index; this.taskManagerId = opts.taskManagerId; this.maxAttempts = opts.maxAttempts; @@ -159,13 +158,7 @@ export class TaskStore { * @param task - The task being scheduled. */ public async schedule(taskInstance: TaskInstance): Promise { - if (!this.definitions[taskInstance.taskType]) { - throw new Error( - `Unsupported task type "${taskInstance.taskType}". Supported types are ${Object.keys( - this.definitions - ).join(', ')}` - ); - } + this.definitions.ensureHas(taskInstance.taskType); let savedObject; try { @@ -260,6 +253,9 @@ export class TaskStore { claimTasksById: OwnershipClaimingOpts['claimTasksById'], size: OwnershipClaimingOpts['size'] ): Promise { + const taskMaxAttempts = [...this.definitions].reduce((accumulator, [type, { maxAttempts }]) => { + return { ...accumulator, [type]: maxAttempts }; + }, {}); const queryForScheduledTasks = mustBeAllOf( // Either a task with idle status and runAt <= now or // status running or claiming with a retryAt <= now. @@ -282,9 +278,7 @@ export class TaskStore { ownerId: this.taskManagerId, retryAt: claimOwnershipUntil, }, - Object.entries(this.definitions).reduce((accumulator, [type, { maxAttempts }]) => { - return { ...accumulator, [type]: maxAttempts }; - }, {}) + taskMaxAttempts ), sort: [ // sort by score first, so the "pinned" Tasks are first @@ -465,30 +459,31 @@ export class TaskStore { private async search(opts: SearchOpts = {}): Promise { const { query } = ensureQueryOnlyReturnsTaskObjects(opts); - let result; try { - result = await this.callCluster('search', { + const { + body: { + hits: { hits: tasks }, + }, + } = await this.esClient.search>({ index: this.index, - ignoreUnavailable: true, + ignore_unavailable: true, body: { ...opts, query, }, }); + + return { + docs: tasks + .filter((doc) => this.serializer.isRawSavedObject(doc)) + .map((doc) => this.serializer.rawToSavedObject(doc)) + .map((doc) => omit(doc, 'namespace') as SavedObject) + .map(savedObjectToConcreteTaskInstance), + }; } catch (e) { this.errors$.next(e); throw e; } - - const rawDocs = (result as SearchResponse).hits.hits; - - return { - docs: (rawDocs as SavedObjectsRawDoc[]) - .filter((doc) => this.serializer.isRawSavedObject(doc)) - .map((doc) => this.serializer.rawToSavedObject(doc)) - .map((doc) => omit(doc, 'namespace') as SavedObject) - .map(savedObjectToConcreteTaskInstance), - }; } private async updateByQuery( @@ -497,11 +492,13 @@ export class TaskStore { { max_docs }: UpdateByQueryOpts = {} ): Promise { const { query } = ensureQueryOnlyReturnsTaskObjects(opts); - let result; try { - result = await this.callCluster('updateByQuery', { + const { + // eslint-disable-next-line @typescript-eslint/naming-convention + body: { total, updated, version_conflicts }, + } = await this.esClient.updateByQuery({ index: this.index, - ignoreUnavailable: true, + ignore_unavailable: true, refresh: true, max_docs, conflicts: 'proceed', @@ -510,18 +507,16 @@ export class TaskStore { query, }, }); + + return { + total, + updated, + version_conflicts, + }; } catch (e) { this.errors$.next(e); throw e; } - - // eslint-disable-next-line @typescript-eslint/naming-convention - const { total, updated, version_conflicts } = result as UpdateDocumentByQueryResponse; - return { - total, - updated, - version_conflicts, - }; } } diff --git a/x-pack/plugins/task_manager/server/lib/sanitize_task_definitions.test.ts b/x-pack/plugins/task_manager/server/task_type_dictionary.test.ts similarity index 66% rename from x-pack/plugins/task_manager/server/lib/sanitize_task_definitions.test.ts rename to x-pack/plugins/task_manager/server/task_type_dictionary.test.ts index 650eb36347c86..e1d6ef17f5f9d 100644 --- a/x-pack/plugins/task_manager/server/lib/sanitize_task_definitions.test.ts +++ b/x-pack/plugins/task_manager/server/task_type_dictionary.test.ts @@ -5,8 +5,8 @@ */ import { get } from 'lodash'; -import { RunContext, TaskDictionary, TaskDefinition } from '../task'; -import { sanitizeTaskDefinitions } from './sanitize_task_definitions'; +import { RunContext, TaskDefinition } from './task'; +import { sanitizeTaskDefinitions } from './task_type_dictionary'; interface Opts { numTasks: number; @@ -35,39 +35,40 @@ const getMockTaskDefinitions = (opts: Opts) => { }, }; } - return (tasks as unknown) as TaskDictionary; + return (tasks as unknown) as Record; }; -describe('sanitizeTaskDefinitions', () => { +describe('taskTypeDictionary', () => { + describe('sanitizeTaskDefinitions', () => {}); it('provides tasks with defaults', () => { const taskDefinitions = getMockTaskDefinitions({ numTasks: 3 }); const result = sanitizeTaskDefinitions(taskDefinitions); expect(result).toMatchInlineSnapshot(` -Object { - "test_task_type_0": Object { - "createTaskRunner": [Function], - "description": "one super cool task", - "timeout": "5m", - "title": "Test", - "type": "test_task_type_0", - }, - "test_task_type_1": Object { - "createTaskRunner": [Function], - "description": "one super cool task", - "timeout": "5m", - "title": "Test", - "type": "test_task_type_1", - }, - "test_task_type_2": Object { - "createTaskRunner": [Function], - "description": "one super cool task", - "timeout": "5m", - "title": "Test", - "type": "test_task_type_2", - }, -} -`); + Array [ + Object { + "createTaskRunner": [Function], + "description": "one super cool task", + "timeout": "5m", + "title": "Test", + "type": "test_task_type_0", + }, + Object { + "createTaskRunner": [Function], + "description": "one super cool task", + "timeout": "5m", + "title": "Test", + "type": "test_task_type_1", + }, + Object { + "createTaskRunner": [Function], + "description": "one super cool task", + "timeout": "5m", + "title": "Test", + "type": "test_task_type_2", + }, + ] + `); }); it('throws a validation exception for invalid task definition', () => { diff --git a/x-pack/plugins/task_manager/server/task_type_dictionary.ts b/x-pack/plugins/task_manager/server/task_type_dictionary.ts new file mode 100644 index 0000000000000..cb7cda6dfa845 --- /dev/null +++ b/x-pack/plugins/task_manager/server/task_type_dictionary.ts @@ -0,0 +1,86 @@ +/* + * 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 Joi from 'joi'; +import { TaskDefinition, validateTaskDefinition } from './task'; +import { Logger } from '../../../../src/core/server'; + +/* + * The TaskManager is the public interface into the task manager system. This glues together + * all of the disparate modules in one integration point. The task manager operates in two different ways: + * + * - pre-init, it allows middleware registration, but disallows task manipulation + * - post-init, it disallows middleware registration, but allows task manipulation + * + * Due to its complexity, this is mostly tested by integration tests (see readme). + */ + +/** + * The public interface into the task manager system. + */ +export class TaskTypeDictionary { + private definitions = new Map(); + private logger: Logger; + + constructor(logger: Logger) { + this.logger = logger; + } + + [Symbol.iterator]() { + return this.definitions.entries(); + } + + public has(type: string) { + return this.definitions.has(type); + } + + public get(type: string): TaskDefinition { + this.ensureHas(type); + return this.definitions.get(type)!; + } + + public ensureHas(type: string) { + if (!this.has(type)) { + throw new Error( + `Unsupported task type "${type}". Supported types are ${[...this.definitions.keys()].join( + ', ' + )}` + ); + } + } + + /** + * Method for allowing consumers to register task definitions into the system. + * @param taskDefinitions - The Kibana task definitions dictionary + */ + public registerTaskDefinitions(taskDefinitions: Record>) { + const duplicate = Object.keys(taskDefinitions).find((type) => this.definitions.has(type)); + if (duplicate) { + throw new Error(`Task ${duplicate} is already defined!`); + } + + try { + for (const definition of sanitizeTaskDefinitions(taskDefinitions)) { + this.definitions.set(definition.type, definition); + } + } catch (e) { + this.logger.error('Could not sanitize task definitions'); + } + } +} + +/** + * Sanitizes the system's task definitions. Task definitions have optional properties, and + * this ensures they all are given a reasonable default. + * + * @param taskDefinitions - The Kibana task definitions dictionary + */ +export function sanitizeTaskDefinitions( + taskDefinitions: Record> +): TaskDefinition[] { + return Object.entries(taskDefinitions).map(([type, rawDefinition]) => + Joi.attempt({ type, ...rawDefinition }, validateTaskDefinition) + ); +} diff --git a/x-pack/plugins/task_manager/server/test_utils/index.ts b/x-pack/plugins/task_manager/server/test_utils/index.ts index 6f43a60ff42d2..e882e0fd18703 100644 --- a/x-pack/plugins/task_manager/server/test_utils/index.ts +++ b/x-pack/plugins/task_manager/server/test_utils/index.ts @@ -3,6 +3,7 @@ * or more contributor license agreements. Licensed under the Elastic License; * you may not use this file except in compliance with the Elastic License. */ +import { loggingSystemMock } from 'src/core/server/mocks'; /* * A handful of helper functions for testing the task manager. @@ -11,18 +12,9 @@ // Caching this here to avoid setTimeout mocking affecting our tests. const nativeTimeout = setTimeout; -/** - * Creates a mock task manager Logger. - */ export function mockLogger() { - return { - info: jest.fn(), - debug: jest.fn(), - warn: jest.fn(), - error: jest.fn(), - }; + return loggingSystemMock.createLogger(); } - export interface Resolvable { resolve: () => void; } diff --git a/x-pack/plugins/task_manager/server/types.ts b/x-pack/plugins/task_manager/server/types.ts deleted file mode 100644 index a38730ad7f768..0000000000000 --- a/x-pack/plugins/task_manager/server/types.ts +++ /dev/null @@ -1,16 +0,0 @@ -/* - * 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 { TaskManager as TaskManagerClass } from './task_manager'; - -export type TaskManager = PublicMethodsOf; - -export interface Logger { - info(message: string): void; - debug(message: string): void; - warn(message: string): void; - error(message: string): void; -} diff --git a/x-pack/test/plugin_api_integration/plugins/sample_task_plugin/server/plugin.ts b/x-pack/test/plugin_api_integration/plugins/sample_task_plugin/server/plugin.ts index a4cabadef1656..f742a1f1b1663 100644 --- a/x-pack/test/plugin_api_integration/plugins/sample_task_plugin/server/plugin.ts +++ b/x-pack/test/plugin_api_integration/plugins/sample_task_plugin/server/plugin.ts @@ -92,13 +92,11 @@ export class SampleTaskManagerFixturePlugin taskManager.registerTaskDefinitions({ sampleTask: { ...defaultSampleTaskConfig, - type: 'sampleTask', title: 'Sample Task', description: 'A sample task for testing the task_manager.', }, singleAttemptSampleTask: { ...defaultSampleTaskConfig, - type: 'singleAttemptSampleTask', title: 'Failing Sample Task', description: 'A sample task for testing the task_manager that fails on the first attempt to run.', diff --git a/x-pack/test/plugin_api_perf/plugins/task_manager_performance/server/plugin.ts b/x-pack/test/plugin_api_perf/plugins/task_manager_performance/server/plugin.ts index ba6d7ced3c591..18449ef61d1ac 100644 --- a/x-pack/test/plugin_api_perf/plugins/task_manager_performance/server/plugin.ts +++ b/x-pack/test/plugin_api_perf/plugins/task_manager_performance/server/plugin.ts @@ -79,7 +79,6 @@ export class SampleTaskManagerFixturePlugin taskManager.registerTaskDefinitions({ performanceTestTask: { - type: 'performanceTestTask', title, description: 'A task for stress testing task_manager.', timeout: '1m',