Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Cleanup action task params objects after successful execution #55227

Merged
merged 15 commits into from
Jan 27, 2020
Merged

Cleanup action task params objects after successful execution #55227

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
d7746d0
Cleanup action task params saved objects after use
mikecote Jan 17, 2020
beb9b3c
Fix jest tests
mikecote Jan 17, 2020
0cec412
Add integration test to ensure object gets cleaned up
mikecote Jan 20, 2020
23d4145
Merge branch 'master' into alerting/cleanup-action-task-params
elasticmachine Jan 20, 2020
0449299
Add unit tests
mikecote Jan 20, 2020
1e81bba
Merge branch 'alerting/cleanup-action-task-params' of github.com:mike…
mikecote Jan 20, 2020
f853354
Fix comment
mikecote Jan 20, 2020
f0a0385
Re-use updated_at instead of creating createdAt
mikecote Jan 20, 2020
ce26bcc
Consider null/undefined returned from executor as success as well
mikecote Jan 20, 2020
589d46a
Merge with master
mikecote Jan 22, 2020
5c8ecee
Merge with master
mikecote Jan 23, 2020
8b3ba8b
Merge branch 'master' into alerting/cleanup-action-task-params
elasticmachine Jan 23, 2020
c706b7f
Merge branch 'master' into alerting/cleanup-action-task-params
elasticmachine Jan 27, 2020
71ac1f5
Merge branch 'master' into alerting/cleanup-action-task-params
elasticmachine Jan 27, 2020
ced7921
Merge branch 'master' into alerting/cleanup-action-task-params
elasticmachine Jan 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions x-pack/legacy/plugins/actions/server/lib/task_runner_factory.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,15 @@ const taskRunnerFactoryInitializerParams = {
spaceIdToNamespace,
encryptedSavedObjectsPlugin: mockedEncryptedSavedObjectsPlugin,
getBasePath: jest.fn().mockReturnValue(undefined),
getScopedSavedObjectsClient: jest.fn().mockReturnValue(savedObjectsClientMock.create()),
};

beforeEach(() => {
jest.resetAllMocks();
actionExecutorInitializerParams.getServices.mockReturnValue(services);
taskRunnerFactoryInitializerParams.getScopedSavedObjectsClient.mockReturnValue(
savedObjectsClientMock.create()
);
});

test(`throws an error if factory isn't initialized`, () => {
Expand Down
7 changes: 7 additions & 0 deletions x-pack/legacy/plugins/actions/server/lib/task_runner_factory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

import { ActionExecutorContract } from './action_executor';
import { ExecutorError } from './executor_error';
import { ActionsCoreStart } from '../shim';
import { RunContext } from '../../../../../plugins/task_manager/server';
import { PluginStartContract as EncryptedSavedObjectsStartContract } from '../../../../../plugins/encrypted_saved_objects/server';
import { ActionTaskParams, GetBasePathFunction, SpaceIdToNamespaceFunction } from '../types';
Expand All @@ -14,6 +15,7 @@ export interface TaskRunnerContext {
encryptedSavedObjectsPlugin: EncryptedSavedObjectsStartContract;
spaceIdToNamespace: SpaceIdToNamespaceFunction;
getBasePath: GetBasePathFunction;
getScopedSavedObjectsClient: ActionsCoreStart['savedObjects']['getScopedSavedObjectsClient'];
}

export class TaskRunnerFactory {
Expand Down Expand Up @@ -43,6 +45,7 @@ export class TaskRunnerFactory {
encryptedSavedObjectsPlugin,
spaceIdToNamespace,
getBasePath,
getScopedSavedObjectsClient,
} = this.taskRunnerContext!;

return {
Expand Down Expand Up @@ -93,6 +96,10 @@ export class TaskRunnerFactory {
executorResult.data,
executorResult.retry == null ? false : executorResult.retry
);
} else if (executorResult.status === 'ok') {
mikecote marked this conversation as resolved.
Show resolved Hide resolved
mikecote marked this conversation as resolved.
Show resolved Hide resolved
// Cleanup action_task_params object now that we're done with it
const savedObjectsClient = getScopedSavedObjectsClient(fakeRequest);
await savedObjectsClient.delete('action_task_params', actionTaskParamsId);
mikecote marked this conversation as resolved.
Show resolved Hide resolved
}
},
};
Expand Down
1 change: 1 addition & 0 deletions x-pack/legacy/plugins/actions/server/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ export class Plugin {
encryptedSavedObjectsPlugin: plugins.encryptedSavedObjects,
getBasePath,
spaceIdToNamespace,
getScopedSavedObjectsClient: core.savedObjects.getScopedSavedObjectsClient,
});

const executeFn = createExecuteFunction({
Expand Down