Add notifications plugin, offering basic email service #143303
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import { compact } from 'lodash'; | ||
| import { ISavedObjectsRepository, SavedObjectsBulkResponse } from '@kbn/core/server'; | ||
| import { TaskManagerStartContract } from '@kbn/task-manager-plugin/server'; | ||
| import { | ||
| ActionTypeRegistryContract as ConnectorTypeRegistryContract, | ||
| PreConfiguredAction as PreconfiguredConnector, | ||
| } from './types'; | ||
| import { ACTION_TASK_PARAMS_SAVED_OBJECT_TYPE } from './constants/saved_objects'; | ||
| import { ExecuteOptions as ActionExecutorOptions } from './lib/action_executor'; | ||
| import { extractSavedObjectReferences, isSavedObjectExecutionSource } from './lib'; | ||
| import { RelatedSavedObjects } from './lib/related_saved_objects'; | ||
|
|
||
| const ALLOWED_CONNECTOR_TYPE_IDS = ['.email', '.slack']; | ||
| interface CreateBulkUnsecuredExecuteFunctionOptions { | ||
| taskManager: TaskManagerStartContract; | ||
| connectorTypeRegistry: ConnectorTypeRegistryContract; | ||
| preconfiguredConnectors: PreconfiguredConnector[]; | ||
| } | ||
|
|
||
| export interface ExecuteOptions extends Pick<ActionExecutorOptions, 'params' | 'source'> { | ||
| id: string; | ||
| executionId: string; | ||
| consumer?: string; | ||
| relatedSavedObjects?: RelatedSavedObjects; | ||
| } | ||
|
|
||
| export interface ActionTaskParams extends Pick<ActionExecutorOptions, 'params'> { | ||
| actionId: string; | ||
| apiKey: string | null; | ||
| executionId: string; | ||
| consumer?: string; | ||
| relatedSavedObjects?: RelatedSavedObjects; | ||
| } | ||
|
|
||
| export type BulkUnsecuredExecutionEnqueuer<T> = ( | ||
| internalSavedObjectsRepository: ISavedObjectsRepository, | ||
| actionsToExectute: ExecuteOptions[] | ||
| ) => Promise<T>; | ||
|
|
||
| export function createBulkUnsecuredExecutionEnqueuerFunction({ | ||
|
Contributor
There was a problem hiding this comment. I am curious what does
Contributor
Author
There was a problem hiding this comment. I think the idea is to highlight the fact that this API does not require any form of authentication whatsoever (apiKey or request object), so it should be used cautiously. This is part of the changes that response-ops are performing to support the case assignment email notifications.
Contributor
There was a problem hiding this comment. @Dosant Normally action execution enqueuing is secured via Kibana RBAC where the actions client checks that the user has access to the |
||
| taskManager, | ||
| connectorTypeRegistry, | ||
| preconfiguredConnectors, | ||
| }: CreateBulkUnsecuredExecuteFunctionOptions): BulkUnsecuredExecutionEnqueuer<void> { | ||
| return async function execute( | ||
| internalSavedObjectsRepository: ISavedObjectsRepository, | ||
| actionsToExecute: ExecuteOptions[] | ||
| ) { | ||
| const connectorTypeIds: Record<string, string> = {}; | ||
| const connectorIds = [...new Set(actionsToExecute.map((action) => action.id))]; | ||
|
|
||
| const notPreconfiguredConnectors = connectorIds.filter( | ||
| (connectorId) => | ||
| preconfiguredConnectors.find((connector) => connector.id === connectorId) == null | ||
| ); | ||
|
|
||
| if (notPreconfiguredConnectors.length > 0) { | ||
| throw new Error( | ||
| `${notPreconfiguredConnectors.join( | ||
| ',' | ||
| )} are not preconfigured connectors and can't be scheduled for unsecured actions execution` | ||
| ); | ||
| } | ||
|
|
||
| const connectors: PreconfiguredConnector[] = compact( | ||
ymao1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| connectorIds.map((connectorId) => | ||
| preconfiguredConnectors.find((pConnector) => pConnector.id === connectorId) | ||
| ) | ||
| ); | ||
|
|
||
| connectors.forEach((connector) => { | ||
| const { id, actionTypeId } = connector; | ||
| if (!connectorTypeRegistry.isActionExecutable(id, actionTypeId, { notifyUsage: true })) { | ||
| connectorTypeRegistry.ensureActionTypeEnabled(actionTypeId); | ||
| } | ||
|
|
||
| if (!ALLOWED_CONNECTOR_TYPE_IDS.includes(actionTypeId)) { | ||
| throw new Error( | ||
| `${actionTypeId} actions cannot be scheduled for unsecured actions execution` | ||
| ); | ||
| } | ||
|
|
||
| connectorTypeIds[id] = actionTypeId; | ||
| }); | ||
|
|
||
| const actions = await Promise.all( | ||
|
||
| actionsToExecute.map(async (actionToExecute) => { | ||
| // Get saved object references from action ID and relatedSavedObjects | ||
| const { references, relatedSavedObjectWithRefs } = extractSavedObjectReferences( | ||
| actionToExecute.id, | ||
| true, | ||
| actionToExecute.relatedSavedObjects | ||
| ); | ||
| const executionSourceReference = executionSourceAsSavedObjectReferences( | ||
| actionToExecute.source | ||
| ); | ||
|
|
||
| const taskReferences = []; | ||
| if (executionSourceReference.references) { | ||
| taskReferences.push(...executionSourceReference.references); | ||
| } | ||
| if (references) { | ||
| taskReferences.push(...references); | ||
| } | ||
|
|
||
| return { | ||
| type: ACTION_TASK_PARAMS_SAVED_OBJECT_TYPE, | ||
| attributes: { | ||
| actionId: actionToExecute.id, | ||
| params: actionToExecute.params, | ||
| apiKey: null, | ||
| executionId: actionToExecute.executionId, | ||
| consumer: actionToExecute.consumer, | ||
| relatedSavedObjects: relatedSavedObjectWithRefs, | ||
| }, | ||
| references: taskReferences, | ||
| }; | ||
| }) | ||
| ); | ||
|
|
||
| const actionTaskParamsRecords: SavedObjectsBulkResponse<ActionTaskParams> = | ||
| await internalSavedObjectsRepository.bulkCreate(actions); | ||
|
|
||
| const taskInstances = actionTaskParamsRecords.saved_objects.map((so) => { | ||
| const actionId = so.attributes.actionId; | ||
| return { | ||
| taskType: `actions:${connectorTypeIds[actionId]}`, | ||
| params: { | ||
| spaceId: 'default', | ||
| actionTaskParamsId: so.id, | ||
| }, | ||
| state: {}, | ||
| scope: ['actions'], | ||
| }; | ||
| }); | ||
| await taskManager.bulkSchedule(taskInstances); | ||
| }; | ||
| } | ||
|
|
||
| function executionSourceAsSavedObjectReferences(executionSource: ActionExecutorOptions['source']) { | ||
| return isSavedObjectExecutionSource(executionSource) | ||
| ? { | ||
| references: [ | ||
| { | ||
| name: 'source', | ||
| ...executionSource.source, | ||
| }, | ||
| ], | ||
| } | ||
| : {}; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import { ISavedObjectsRepository } from '@kbn/core/server'; | ||
| import { UnsecuredActionsClientAccessRegistry } from './unsecured_actions_client_access_registry'; | ||
| import { | ||
| BulkUnsecuredExecutionEnqueuer, | ||
| ExecuteOptions, | ||
| } from '../create_unsecured_execute_function'; | ||
|
|
||
| export interface UnsecuredActionsClientOpts { | ||
| unsecuredActionsClientAccessRegistry: UnsecuredActionsClientAccessRegistry; | ||
| internalSavedObjectsRepository: ISavedObjectsRepository; | ||
| executionEnqueuer: BulkUnsecuredExecutionEnqueuer<void>; | ||
| } | ||
|
|
||
| export class UnsecuredActionsClient { | ||
| private readonly unsecuredActionsClientAccessRegistry: UnsecuredActionsClientAccessRegistry; | ||
| private readonly internalSavedObjectsRepository: ISavedObjectsRepository; | ||
| private readonly executionEnqueuer: BulkUnsecuredExecutionEnqueuer<void>; | ||
|
|
||
| constructor(params: UnsecuredActionsClientOpts) { | ||
| this.unsecuredActionsClientAccessRegistry = params.unsecuredActionsClientAccessRegistry; | ||
| this.executionEnqueuer = params.executionEnqueuer; | ||
| this.internalSavedObjectsRepository = params.internalSavedObjectsRepository; | ||
| } | ||
|
|
||
| public async bulkEnqueueExecution( | ||
| requesterId: string, | ||
| actionsToExecute: ExecuteOptions[] | ||
| ): Promise<void> { | ||
| // Check that requesterId is allowed | ||
| if (!this.unsecuredActionsClientAccessRegistry.has(requesterId)) { | ||
| throw new Error( | ||
| `${requesterId} feature is not registered for UnsecuredActionsClient access.` | ||
| ); | ||
| } | ||
| return this.executionEnqueuer(this.internalSavedObjectsRepository, actionsToExecute); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.