@webiny/background-tasks 0.0.0-unstable.7be00a75a9 → 6.4.0-beta.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/admin/BackgroundTaskRoutes.js +20 -13
- package/admin/BackgroundTaskRoutes.js.map +1 -1
- package/admin/BackgroundTasks.js +9 -0
- package/admin/BackgroundTasks.js.map +1 -1
- package/admin/features/getBackgroundTaskSettings/GetBackgroundTaskSettingsGateway.d.ts +12 -0
- package/admin/features/getBackgroundTaskSettings/GetBackgroundTaskSettingsGateway.js +40 -0
- package/admin/features/getBackgroundTaskSettings/GetBackgroundTaskSettingsGateway.js.map +1 -0
- package/admin/features/getBackgroundTaskSettings/GetBackgroundTaskSettingsUseCase.d.ts +11 -0
- package/admin/features/getBackgroundTaskSettings/GetBackgroundTaskSettingsUseCase.js +18 -0
- package/admin/features/getBackgroundTaskSettings/GetBackgroundTaskSettingsUseCase.js.map +1 -0
- package/admin/features/getBackgroundTaskSettings/abstractions.d.ts +15 -0
- package/admin/features/getBackgroundTaskSettings/abstractions.js +6 -0
- package/admin/features/getBackgroundTaskSettings/abstractions.js.map +1 -0
- package/admin/features/getBackgroundTaskSettings/feature.d.ts +3 -0
- package/admin/features/getBackgroundTaskSettings/feature.js +19 -0
- package/admin/features/getBackgroundTaskSettings/feature.js.map +1 -0
- package/admin/features/getBackgroundTaskSettings/index.d.ts +3 -0
- package/admin/features/getBackgroundTaskSettings/index.js +2 -0
- package/admin/features/updateBackgroundTaskSettings/UpdateBackgroundTaskSettingsGateway.d.ts +12 -0
- package/admin/features/updateBackgroundTaskSettings/UpdateBackgroundTaskSettingsGateway.js +43 -0
- package/admin/features/updateBackgroundTaskSettings/UpdateBackgroundTaskSettingsGateway.js.map +1 -0
- package/admin/features/updateBackgroundTaskSettings/UpdateBackgroundTaskSettingsUseCase.d.ts +11 -0
- package/admin/features/updateBackgroundTaskSettings/UpdateBackgroundTaskSettingsUseCase.js +18 -0
- package/admin/features/updateBackgroundTaskSettings/UpdateBackgroundTaskSettingsUseCase.js.map +1 -0
- package/admin/features/updateBackgroundTaskSettings/abstractions.d.ts +18 -0
- package/admin/features/updateBackgroundTaskSettings/abstractions.js +6 -0
- package/admin/features/updateBackgroundTaskSettings/abstractions.js.map +1 -0
- package/admin/features/updateBackgroundTaskSettings/feature.d.ts +3 -0
- package/admin/features/updateBackgroundTaskSettings/feature.js +19 -0
- package/admin/features/updateBackgroundTaskSettings/feature.js.map +1 -0
- package/admin/features/updateBackgroundTaskSettings/index.d.ts +3 -0
- package/admin/features/updateBackgroundTaskSettings/index.js +2 -0
- package/admin/presentation/BackgroundTaskSettings/BackgroundTaskSettingsPresenter.d.ts +21 -0
- package/admin/presentation/BackgroundTaskSettings/BackgroundTaskSettingsPresenter.js +86 -0
- package/admin/presentation/BackgroundTaskSettings/BackgroundTaskSettingsPresenter.js.map +1 -0
- package/admin/presentation/BackgroundTaskSettings/abstractions.d.ts +16 -0
- package/admin/presentation/BackgroundTaskSettings/abstractions.js +5 -0
- package/admin/presentation/BackgroundTaskSettings/abstractions.js.map +1 -0
- package/admin/presentation/BackgroundTaskSettings/components/BackgroundTaskSettingsView.d.ts +2 -0
- package/admin/presentation/BackgroundTaskSettings/components/BackgroundTaskSettingsView.js +56 -0
- package/admin/presentation/BackgroundTaskSettings/components/BackgroundTaskSettingsView.js.map +1 -0
- package/admin/presentation/BackgroundTaskSettings/feature.d.ts +3 -0
- package/admin/presentation/BackgroundTaskSettings/feature.js +17 -0
- package/admin/presentation/BackgroundTaskSettings/feature.js.map +1 -0
- package/admin/presentation/BackgroundTaskSettings/index.d.ts +2 -0
- package/admin/presentation/BackgroundTaskSettings/index.js +2 -0
- package/admin/presentation/TaskDefinitions/components/TaskDefinitionsView.js +2 -1
- package/admin/presentation/TaskDefinitions/components/TaskDefinitionsView.js.map +1 -1
- package/admin/presentation/TaskDefinitions/components/TaskExecutionsButton.d.ts +2 -0
- package/admin/presentation/TaskDefinitions/components/TaskExecutionsButton.js +16 -0
- package/admin/presentation/TaskDefinitions/components/TaskExecutionsButton.js.map +1 -0
- package/admin/presentation/TaskExecutions/components/TaskDefinitionsButton.d.ts +2 -0
- package/admin/presentation/TaskExecutions/components/TaskDefinitionsButton.js +16 -0
- package/admin/presentation/TaskExecutions/components/TaskDefinitionsButton.js.map +1 -0
- package/admin/presentation/TaskExecutions/components/TaskExecutionsView.js +53 -35
- package/admin/presentation/TaskExecutions/components/TaskExecutionsView.js.map +1 -1
- package/admin/routes.d.ts +1 -0
- package/admin/routes.js +4 -0
- package/admin/routes.js.map +1 -1
- package/admin/shared/types.d.ts +3 -0
- package/api/context.d.ts +2 -0
- package/api/context.js +66 -0
- package/api/context.js.map +1 -0
- package/api/crud/TaskLogPrivateModel.d.ts +9 -0
- package/api/crud/TaskLogPrivateModel.js +40 -0
- package/api/crud/TaskLogPrivateModel.js.map +1 -0
- package/api/crud/TaskPrivateModel.d.ts +9 -0
- package/api/crud/TaskPrivateModel.js +55 -0
- package/api/crud/TaskPrivateModel.js.map +1 -0
- package/api/crud/cleanupTaskSubtree.d.ts +8 -0
- package/api/crud/cleanupTaskSubtree.js +62 -0
- package/api/crud/cleanupTaskSubtree.js.map +1 -0
- package/api/crud/crud.tasks.d.ts +2 -0
- package/api/crud/crud.tasks.js +318 -0
- package/api/crud/crud.tasks.js.map +1 -0
- package/api/crud/definition.tasks.d.ts +2 -0
- package/api/crud/definition.tasks.js +17 -0
- package/api/crud/definition.tasks.js.map +1 -0
- package/api/crud/service.tasks.d.ts +2 -0
- package/api/crud/service.tasks.js +130 -0
- package/api/crud/service.tasks.js.map +1 -0
- package/api/decorators/RunnableTaskDecorator.d.ts +32 -0
- package/api/decorators/RunnableTaskDecorator.js +69 -0
- package/api/decorators/RunnableTaskDecorator.js.map +1 -0
- package/api/decorators/SelfCleaningTaskDecorator.d.ts +30 -0
- package/api/decorators/SelfCleaningTaskDecorator.js +84 -0
- package/api/decorators/SelfCleaningTaskDecorator.js.map +1 -0
- package/api/domain/BackgroundTaskSettings.d.ts +3 -0
- package/api/domain/BackgroundTaskSettings.js +0 -0
- package/api/domain/constants.d.ts +3 -0
- package/api/domain/constants.js +6 -0
- package/api/domain/constants.js.map +1 -0
- package/api/domain/errors.d.ts +57 -0
- package/api/domain/errors.js +101 -0
- package/api/domain/errors.js.map +1 -0
- package/api/events/TaskAfterCreateEvent.d.ts +6 -0
- package/api/events/TaskAfterCreateEvent.js +13 -0
- package/api/events/TaskAfterCreateEvent.js.map +1 -0
- package/api/events/TaskAfterDeleteEvent.d.ts +6 -0
- package/api/events/TaskAfterDeleteEvent.js +13 -0
- package/api/events/TaskAfterDeleteEvent.js.map +1 -0
- package/api/events/TaskAfterUpdateEvent.d.ts +6 -0
- package/api/events/TaskAfterUpdateEvent.js +13 -0
- package/api/events/TaskAfterUpdateEvent.js.map +1 -0
- package/api/events/TaskBeforeCreateEvent.d.ts +6 -0
- package/api/events/TaskBeforeCreateEvent.js +13 -0
- package/api/events/TaskBeforeCreateEvent.js.map +1 -0
- package/api/events/TaskBeforeDeleteEvent.d.ts +6 -0
- package/api/events/TaskBeforeDeleteEvent.js +13 -0
- package/api/events/TaskBeforeDeleteEvent.js.map +1 -0
- package/api/events/TaskBeforeUpdateEvent.d.ts +6 -0
- package/api/events/TaskBeforeUpdateEvent.js +13 -0
- package/api/events/TaskBeforeUpdateEvent.js.map +1 -0
- package/api/events/abstractions.d.ts +53 -0
- package/api/events/abstractions.js +10 -0
- package/api/events/abstractions.js.map +1 -0
- package/api/events/index.d.ts +7 -0
- package/api/events/index.js +7 -0
- package/api/features/AbortTask/AbortTaskUseCase.d.ts +10 -0
- package/api/features/AbortTask/AbortTaskUseCase.js +12 -0
- package/api/features/AbortTask/AbortTaskUseCase.js.map +1 -0
- package/api/features/AbortTask/abstractions.d.ts +25 -0
- package/api/features/AbortTask/abstractions.js +5 -0
- package/api/features/AbortTask/abstractions.js.map +1 -0
- package/api/features/AbortTask/feature.d.ts +5 -0
- package/api/features/AbortTask/feature.js +12 -0
- package/api/features/AbortTask/feature.js.map +1 -0
- package/api/features/AbortTask/index.d.ts +2 -0
- package/api/features/AbortTask/index.js +2 -0
- package/api/features/BackgroundTaskPermissions/abstractions.d.ts +17 -0
- package/api/features/BackgroundTaskPermissions/abstractions.js +6 -0
- package/api/features/BackgroundTaskPermissions/abstractions.js.map +1 -0
- package/api/features/BackgroundTaskPermissions/feature.d.ts +4 -0
- package/api/features/BackgroundTaskPermissions/feature.js +7 -0
- package/api/features/BackgroundTaskPermissions/feature.js.map +1 -0
- package/api/features/BackgroundTaskPermissions/index.d.ts +2 -0
- package/api/features/BackgroundTaskPermissions/index.js +2 -0
- package/api/features/CleanupTaskSubtree/CleanupTaskSubtreeUseCase.d.ts +7 -0
- package/api/features/CleanupTaskSubtree/CleanupTaskSubtreeUseCase.js +11 -0
- package/api/features/CleanupTaskSubtree/CleanupTaskSubtreeUseCase.js.map +1 -0
- package/api/features/CleanupTaskSubtree/abstractions.d.ts +7 -0
- package/api/features/CleanupTaskSubtree/abstractions.js +5 -0
- package/api/features/CleanupTaskSubtree/abstractions.js.map +1 -0
- package/api/features/CleanupTaskSubtree/index.d.ts +2 -0
- package/api/features/CleanupTaskSubtree/index.js +2 -0
- package/api/features/GetBackgroundTaskSettings/GetBackgroundTaskSettingsRepository.d.ts +21 -0
- package/api/features/GetBackgroundTaskSettings/GetBackgroundTaskSettingsRepository.js +60 -0
- package/api/features/GetBackgroundTaskSettings/GetBackgroundTaskSettingsRepository.js.map +1 -0
- package/api/features/GetBackgroundTaskSettings/abstractions.d.ts +13 -0
- package/api/features/GetBackgroundTaskSettings/abstractions.js +5 -0
- package/api/features/GetBackgroundTaskSettings/abstractions.js.map +1 -0
- package/api/features/GetBackgroundTaskSettings/feature.d.ts +4 -0
- package/api/features/GetBackgroundTaskSettings/feature.js +11 -0
- package/api/features/GetBackgroundTaskSettings/feature.js.map +1 -0
- package/api/features/GetBackgroundTaskSettings/index.d.ts +2 -0
- package/api/features/GetBackgroundTaskSettings/index.js +2 -0
- package/api/features/GetTask/GetTaskUseCase.d.ts +9 -0
- package/api/features/GetTask/GetTaskUseCase.js +11 -0
- package/api/features/GetTask/GetTaskUseCase.js.map +1 -0
- package/api/features/GetTask/abstractions.d.ts +10 -0
- package/api/features/GetTask/abstractions.js +5 -0
- package/api/features/GetTask/abstractions.js.map +1 -0
- package/api/features/GetTask/feature.d.ts +5 -0
- package/api/features/GetTask/feature.js +12 -0
- package/api/features/GetTask/feature.js.map +1 -0
- package/api/features/GetTask/index.d.ts +2 -0
- package/api/features/GetTask/index.js +2 -0
- package/api/features/GetTaskDefinition/GetTaskDefinitionUseCase.d.ts +12 -0
- package/api/features/GetTaskDefinition/GetTaskDefinitionUseCase.js +27 -0
- package/api/features/GetTaskDefinition/GetTaskDefinitionUseCase.js.map +1 -0
- package/api/features/GetTaskDefinition/abstractions.d.ts +17 -0
- package/api/features/GetTaskDefinition/abstractions.js +5 -0
- package/api/features/GetTaskDefinition/abstractions.js.map +1 -0
- package/api/features/GetTaskDefinition/feature.d.ts +4 -0
- package/api/features/GetTaskDefinition/feature.js +11 -0
- package/api/features/GetTaskDefinition/feature.js.map +1 -0
- package/api/features/GetTaskDefinition/index.d.ts +2 -0
- package/api/features/GetTaskDefinition/index.js +2 -0
- package/api/features/ListTaskDefinitions/ListTaskDefinitionsUseCase.d.ts +11 -0
- package/api/features/ListTaskDefinitions/ListTaskDefinitionsUseCase.js +24 -0
- package/api/features/ListTaskDefinitions/ListTaskDefinitionsUseCase.js.map +1 -0
- package/api/features/ListTaskDefinitions/abstractions.d.ts +9 -0
- package/api/features/ListTaskDefinitions/abstractions.js +5 -0
- package/api/features/ListTaskDefinitions/abstractions.js.map +1 -0
- package/api/features/ListTaskDefinitions/feature.d.ts +4 -0
- package/api/features/ListTaskDefinitions/feature.js +11 -0
- package/api/features/ListTaskDefinitions/feature.js.map +1 -0
- package/api/features/ListTaskDefinitions/index.d.ts +2 -0
- package/api/features/ListTaskDefinitions/index.js +2 -0
- package/api/features/ListTasks/ListTasksUseCase.d.ts +9 -0
- package/api/features/ListTasks/ListTasksUseCase.js +11 -0
- package/api/features/ListTasks/ListTasksUseCase.js.map +1 -0
- package/api/features/ListTasks/abstractions.d.ts +13 -0
- package/api/features/ListTasks/abstractions.js +5 -0
- package/api/features/ListTasks/abstractions.js.map +1 -0
- package/api/features/ListTasks/feature.d.ts +5 -0
- package/api/features/ListTasks/feature.js +12 -0
- package/api/features/ListTasks/feature.js.map +1 -0
- package/api/features/ListTasks/index.d.ts +2 -0
- package/api/features/ListTasks/index.js +2 -0
- package/api/features/TaskController/TaskController.d.ts +49 -0
- package/api/features/TaskController/TaskController.js +71 -0
- package/api/features/TaskController/TaskController.js.map +1 -0
- package/api/features/TaskController/augmentation.d.ts +60 -0
- package/api/features/TaskController/augmentation.js +0 -0
- package/api/features/TaskController/index.d.ts +2 -0
- package/api/features/TaskController/index.js +2 -0
- package/api/features/TaskExecutionContext/TaskExecutionContext.d.ts +24 -0
- package/api/features/TaskExecutionContext/TaskExecutionContext.js +43 -0
- package/api/features/TaskExecutionContext/TaskExecutionContext.js.map +1 -0
- package/api/features/TaskExecutionContext/abstractions.d.ts +26 -0
- package/api/features/TaskExecutionContext/abstractions.js +5 -0
- package/api/features/TaskExecutionContext/abstractions.js.map +1 -0
- package/api/features/TaskExecutionContext/feature.d.ts +4 -0
- package/api/features/TaskExecutionContext/feature.js +11 -0
- package/api/features/TaskExecutionContext/feature.js.map +1 -0
- package/api/features/TaskExecutionContext/index.d.ts +1 -0
- package/api/features/TaskExecutionContext/index.js +1 -0
- package/api/features/TriggerTask/TriggerTaskUseCase.d.ts +10 -0
- package/api/features/TriggerTask/TriggerTaskUseCase.js +12 -0
- package/api/features/TriggerTask/TriggerTaskUseCase.js.map +1 -0
- package/api/features/TriggerTask/abstractions.d.ts +28 -0
- package/api/features/TriggerTask/abstractions.js +5 -0
- package/api/features/TriggerTask/abstractions.js.map +1 -0
- package/api/features/TriggerTask/feature.d.ts +5 -0
- package/api/features/TriggerTask/feature.js +12 -0
- package/api/features/TriggerTask/feature.js.map +1 -0
- package/api/features/TriggerTask/index.d.ts +2 -0
- package/api/features/TriggerTask/index.js +2 -0
- package/api/features/UpdateBackgroundTaskSettings/UpdateBackgroundTaskSettingsRepository.d.ts +23 -0
- package/api/features/UpdateBackgroundTaskSettings/UpdateBackgroundTaskSettingsRepository.js +64 -0
- package/api/features/UpdateBackgroundTaskSettings/UpdateBackgroundTaskSettingsRepository.js.map +1 -0
- package/api/features/UpdateBackgroundTaskSettings/UpdateBackgroundTaskSettingsUseCase.d.ts +14 -0
- package/api/features/UpdateBackgroundTaskSettings/UpdateBackgroundTaskSettingsUseCase.js +27 -0
- package/api/features/UpdateBackgroundTaskSettings/UpdateBackgroundTaskSettingsUseCase.js.map +1 -0
- package/api/features/UpdateBackgroundTaskSettings/abstractions.d.ts +26 -0
- package/api/features/UpdateBackgroundTaskSettings/abstractions.js +6 -0
- package/api/features/UpdateBackgroundTaskSettings/abstractions.js.map +1 -0
- package/api/features/UpdateBackgroundTaskSettings/feature.d.ts +4 -0
- package/api/features/UpdateBackgroundTaskSettings/feature.js +13 -0
- package/api/features/UpdateBackgroundTaskSettings/feature.js.map +1 -0
- package/api/features/UpdateBackgroundTaskSettings/index.d.ts +2 -0
- package/api/features/UpdateBackgroundTaskSettings/index.js +2 -0
- package/api/features/UpdateBackgroundTaskSettings/schema.d.ts +4 -0
- package/api/features/UpdateBackgroundTaskSettings/schema.js +8 -0
- package/api/features/UpdateBackgroundTaskSettings/schema.js.map +1 -0
- package/api/global.d.ts +1 -0
- package/api/global.js +1 -0
- package/api/graphql/BackgroundTaskSettingsSchema.d.ts +2 -0
- package/api/graphql/BackgroundTaskSettingsSchema.js +84 -0
- package/api/graphql/BackgroundTaskSettingsSchema.js.map +1 -0
- package/api/graphql/checkPermissions.d.ts +7 -0
- package/api/graphql/checkPermissions.js +21 -0
- package/api/graphql/checkPermissions.js.map +1 -0
- package/api/graphql/index.d.ts +2 -0
- package/api/graphql/index.js +302 -0
- package/api/graphql/index.js.map +1 -0
- package/api/graphql/utils.d.ts +9 -0
- package/api/graphql/utils.js +20 -0
- package/api/graphql/utils.js.map +1 -0
- package/api/handler/index.d.ts +6 -0
- package/api/handler/index.js +55 -0
- package/api/handler/index.js.map +1 -0
- package/api/handler/register.d.ts +1 -0
- package/api/handler/register.js +15 -0
- package/api/handler/register.js.map +1 -0
- package/api/handler/types.d.ts +23 -0
- package/api/handler/types.js +0 -0
- package/api/index.d.ts +5 -0
- package/api/index.js +5 -0
- package/api/models/BackgroundTaskSettingsModel.d.ts +8 -0
- package/api/models/BackgroundTaskSettingsModel.js +27 -0
- package/api/models/BackgroundTaskSettingsModel.js.map +1 -0
- package/api/permissions.d.ts +12 -0
- package/api/permissions.js +22 -0
- package/api/permissions.js.map +1 -0
- package/api/plugins/TaskServicePlugin.d.ts +19 -0
- package/api/plugins/TaskServicePlugin.js +13 -0
- package/api/plugins/TaskServicePlugin.js.map +1 -0
- package/api/plugins/index.d.ts +1 -0
- package/api/plugins/index.js +1 -0
- package/api/response/DatabaseResponse.d.ts +12 -0
- package/api/response/DatabaseResponse.js +127 -0
- package/api/response/DatabaseResponse.js.map +1 -0
- package/api/response/Response.d.ts +14 -0
- package/api/response/Response.js +91 -0
- package/api/response/Response.js.map +1 -0
- package/api/response/ResponseAbortedResult.d.ts +9 -0
- package/api/response/ResponseAbortedResult.js +12 -0
- package/api/response/ResponseAbortedResult.js.map +1 -0
- package/api/response/ResponseContinueResult.d.ts +17 -0
- package/api/response/ResponseContinueResult.js +16 -0
- package/api/response/ResponseContinueResult.js.map +1 -0
- package/api/response/ResponseDoneResult.d.ts +11 -0
- package/api/response/ResponseDoneResult.js +14 -0
- package/api/response/ResponseDoneResult.js.map +1 -0
- package/api/response/ResponseErrorResult.d.ts +10 -0
- package/api/response/ResponseErrorResult.js +13 -0
- package/api/response/ResponseErrorResult.js.map +1 -0
- package/api/response/TaskResponse.d.ts +12 -0
- package/api/response/TaskResponse.js +53 -0
- package/api/response/TaskResponse.js.map +1 -0
- package/api/response/abstractions/Response.d.ts +25 -0
- package/api/response/abstractions/Response.js +0 -0
- package/api/response/abstractions/ResponseAbortedResult.d.ts +5 -0
- package/api/response/abstractions/ResponseAbortedResult.js +0 -0
- package/api/response/abstractions/ResponseBaseResult.d.ts +7 -0
- package/api/response/abstractions/ResponseBaseResult.js +0 -0
- package/api/response/abstractions/ResponseContinueResult.d.ts +21 -0
- package/api/response/abstractions/ResponseContinueResult.js +0 -0
- package/api/response/abstractions/ResponseDoneResult.d.ts +13 -0
- package/api/response/abstractions/ResponseDoneResult.js +0 -0
- package/api/response/abstractions/ResponseErrorResult.d.ts +18 -0
- package/api/response/abstractions/ResponseErrorResult.js +0 -0
- package/api/response/abstractions/TaskResponse.d.ts +16 -0
- package/api/response/abstractions/TaskResponse.js +0 -0
- package/api/response/abstractions/index.d.ts +7 -0
- package/api/response/abstractions/index.js +7 -0
- package/api/response/index.d.ts +7 -0
- package/api/response/index.js +7 -0
- package/api/runner/TaskControl.d.ts +14 -0
- package/api/runner/TaskControl.js +173 -0
- package/api/runner/TaskControl.js.map +1 -0
- package/api/runner/TaskEventValidation.d.ts +5 -0
- package/api/runner/TaskEventValidation.js +20 -0
- package/api/runner/TaskEventValidation.js.map +1 -0
- package/api/runner/TaskManager.d.ts +11 -0
- package/api/runner/TaskManager.js +81 -0
- package/api/runner/TaskManager.js.map +1 -0
- package/api/runner/TaskManagerStore.d.ts +40 -0
- package/api/runner/TaskManagerStore.js +109 -0
- package/api/runner/TaskManagerStore.js.map +1 -0
- package/api/runner/TaskRunner.d.ts +25 -0
- package/api/runner/TaskRunner.js +55 -0
- package/api/runner/TaskRunner.js.map +1 -0
- package/api/runner/abstractions/TaskControl.d.ts +10 -0
- package/api/runner/abstractions/TaskControl.js +0 -0
- package/api/runner/abstractions/TaskEventValidation.d.ts +5 -0
- package/api/runner/abstractions/TaskEventValidation.js +0 -0
- package/api/runner/abstractions/TaskManager.d.ts +5 -0
- package/api/runner/abstractions/TaskManager.js +0 -0
- package/api/runner/abstractions/TaskManagerStore.d.ts +92 -0
- package/api/runner/abstractions/TaskManagerStore.js +0 -0
- package/api/runner/abstractions/TaskRunner.d.ts +13 -0
- package/api/runner/abstractions/TaskRunner.js +0 -0
- package/api/runner/abstractions/index.d.ts +5 -0
- package/api/runner/abstractions/index.js +5 -0
- package/api/runner/index.d.ts +1 -0
- package/api/runner/index.js +1 -0
- package/api/service/EventBridgeEventTransportPlugin.d.ts +16 -0
- package/api/service/EventBridgeEventTransportPlugin.js +52 -0
- package/api/service/EventBridgeEventTransportPlugin.js.map +1 -0
- package/api/service/StepFunctionServicePlugin.d.ts +25 -0
- package/api/service/StepFunctionServicePlugin.js +77 -0
- package/api/service/StepFunctionServicePlugin.js.map +1 -0
- package/api/service/createService.d.ts +6 -0
- package/api/service/createService.js +16 -0
- package/api/service/createService.js.map +1 -0
- package/api/service/index.d.ts +4 -0
- package/api/service/index.js +12 -0
- package/api/service/index.js.map +1 -0
- package/api/tasks/testingRunTask.d.ts +11 -0
- package/api/tasks/testingRunTask.js +18 -0
- package/api/tasks/testingRunTask.js.map +1 -0
- package/api/types.d.ts +167 -0
- package/api/types.js +20 -0
- package/api/types.js.map +1 -0
- package/api/utils/ObjectUpdater.d.ts +8 -0
- package/api/utils/ObjectUpdater.js +33 -0
- package/api/utils/ObjectUpdater.js.map +1 -0
- package/api/utils/getErrorProperties.d.ts +2 -0
- package/api/utils/getErrorProperties.js +9 -0
- package/api/utils/getErrorProperties.js.map +1 -0
- package/api/utils/getObjectProperties.d.ts +8 -0
- package/api/utils/getObjectProperties.js +11 -0
- package/api/utils/getObjectProperties.js.map +1 -0
- package/api/utils/index.d.ts +3 -0
- package/api/utils/index.js +3 -0
- package/api/utils/normalizeSelfCleanup.d.ts +2 -0
- package/api/utils/normalizeSelfCleanup.js +16 -0
- package/api/utils/normalizeSelfCleanup.js.map +1 -0
- package/index.d.ts +1 -0
- package/index.js +1 -0
- package/package.json +28 -11
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import { TaskDataStatus } from "../types.js";
|
|
2
|
+
import { getErrorProperties } from "../utils/getErrorProperties.js";
|
|
3
|
+
import { TaskResultStatus } from "@webiny/api-core/features/task/TaskDefinition/index.js";
|
|
4
|
+
import { TaskController } from "@webiny/api-core/features/task/TaskController/abstractions.js";
|
|
5
|
+
class TaskManager {
|
|
6
|
+
constructor(context, response, store){
|
|
7
|
+
this.context = context;
|
|
8
|
+
this.response = response;
|
|
9
|
+
this.store = store;
|
|
10
|
+
}
|
|
11
|
+
async run(definition) {
|
|
12
|
+
if (this.store.getStatus() === TaskDataStatus.ABORTED) return this.response.aborted();
|
|
13
|
+
if (this.store.getStatus() === TaskDataStatus.PENDING) try {
|
|
14
|
+
await this.store.updateTask({
|
|
15
|
+
taskStatus: TaskDataStatus.RUNNING,
|
|
16
|
+
startedOn: new Date().toISOString(),
|
|
17
|
+
executionName: this.response.event.executionName,
|
|
18
|
+
iterations: 1
|
|
19
|
+
});
|
|
20
|
+
await this.store.save();
|
|
21
|
+
} catch (error) {
|
|
22
|
+
return this.response.error({
|
|
23
|
+
error
|
|
24
|
+
});
|
|
25
|
+
}
|
|
26
|
+
else if (this.store.getTask().iterations >= definition.maxIterations) try {
|
|
27
|
+
if (definition.onMaxIterations) await definition.onMaxIterations({
|
|
28
|
+
task: this.store.getTask()
|
|
29
|
+
});
|
|
30
|
+
return this.response.error({
|
|
31
|
+
error: {
|
|
32
|
+
message: "Task reached max iterations."
|
|
33
|
+
}
|
|
34
|
+
});
|
|
35
|
+
} catch (ex) {
|
|
36
|
+
return this.response.error({
|
|
37
|
+
error: {
|
|
38
|
+
message: "Failed to execute onMaxIterations handler.",
|
|
39
|
+
data: getErrorProperties(ex)
|
|
40
|
+
}
|
|
41
|
+
});
|
|
42
|
+
}
|
|
43
|
+
else try {
|
|
44
|
+
await this.store.updateTask((task)=>({
|
|
45
|
+
iterations: task.iterations + 1
|
|
46
|
+
}));
|
|
47
|
+
} catch (error) {
|
|
48
|
+
return this.response.error({
|
|
49
|
+
error
|
|
50
|
+
});
|
|
51
|
+
}
|
|
52
|
+
let result;
|
|
53
|
+
try {
|
|
54
|
+
const input = structuredClone(this.store.getInput());
|
|
55
|
+
const controller = this.context.container.resolve(TaskController);
|
|
56
|
+
result = await this.context.security.withoutAuthorization(async ()=>await definition.run({
|
|
57
|
+
input,
|
|
58
|
+
controller
|
|
59
|
+
}));
|
|
60
|
+
} catch (ex) {
|
|
61
|
+
return this.response.error({
|
|
62
|
+
error: getErrorProperties(ex)
|
|
63
|
+
});
|
|
64
|
+
}
|
|
65
|
+
if (result.status === TaskResultStatus.CONTINUE) return this.response.continue({
|
|
66
|
+
input: result.input,
|
|
67
|
+
wait: result.wait
|
|
68
|
+
});
|
|
69
|
+
if (result.status === TaskResultStatus.ERROR) return this.response.error({
|
|
70
|
+
error: result.error
|
|
71
|
+
});
|
|
72
|
+
if (result.status === TaskResultStatus.ABORTED) return this.response.aborted();
|
|
73
|
+
return this.response.done({
|
|
74
|
+
message: result.message,
|
|
75
|
+
output: result.output
|
|
76
|
+
});
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
export { TaskManager };
|
|
80
|
+
|
|
81
|
+
//# sourceMappingURL=TaskManager.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api/runner/TaskManager.js","sources":["../../../src/api/runner/TaskManager.ts"],"sourcesContent":["import type { ITaskManager, ITaskManagerStorePrivate } from \"./abstractions/index.js\";\nimport type { Context } from \"~/api/types.js\";\nimport { TaskDataStatus } from \"~/api/types.js\";\nimport type { IResponse, IResponseResult } from \"~/api/response/abstractions/index.js\";\nimport { getErrorProperties } from \"~/api/utils/getErrorProperties.js\";\nimport {\n TaskDefinition,\n TaskResultStatus\n} from \"@webiny/api-core/features/task/TaskDefinition/index.js\";\nimport { TaskController } from \"@webiny/api-core/features/task/TaskController/abstractions.js\";\n\nexport class TaskManager implements ITaskManager {\n private readonly context: Context;\n private readonly response: IResponse;\n private readonly store: ITaskManagerStorePrivate;\n\n public constructor(context: Context, response: IResponse, store: ITaskManagerStorePrivate) {\n this.context = context;\n this.response = response;\n this.store = store;\n }\n\n public async run(definition: TaskDefinition.Runnable): Promise<IResponseResult> {\n /**\n * If task was aborted, do not run it again, return as it was done.\n */\n if (this.store.getStatus() === TaskDataStatus.ABORTED) {\n return this.response.aborted();\n }\n /**\n * If the task status is pending, update it to running and add a log.\n */\n //\n else if (this.store.getStatus() === TaskDataStatus.PENDING) {\n try {\n await this.store.updateTask({\n taskStatus: TaskDataStatus.RUNNING,\n startedOn: new Date().toISOString(),\n executionName: this.response.event.executionName,\n iterations: 1\n });\n await this.store.save();\n } catch (error) {\n return this.response.error({\n error\n });\n }\n }\n /**\n * We do not want to run the task indefinitely.\n * If the task has reached the max iterations, we will stop it and execute the onMaxIterations handler, if any.\n */\n //\n else if (this.store.getTask().iterations >= definition.maxIterations) {\n try {\n if (definition.onMaxIterations) {\n await definition.onMaxIterations({\n task: this.store.getTask()\n });\n }\n return this.response.error({\n error: {\n message: \"Task reached max iterations.\"\n }\n });\n } catch (ex) {\n return this.response.error({\n error: {\n message: \"Failed to execute onMaxIterations handler.\",\n data: getErrorProperties(ex)\n }\n });\n }\n }\n /**\n * Always update the task iteration.\n */\n //\n else {\n try {\n await this.store.updateTask(task => {\n return {\n iterations: task.iterations + 1\n };\n });\n } catch (error) {\n return this.response.error({\n error\n });\n }\n }\n\n let result: TaskDefinition.Result;\n\n try {\n const input = structuredClone(this.store.getInput());\n const controller = this.context.container.resolve(TaskController);\n /**\n * We always run the task without authorization because we are running a task without a user - nothing to authorize against.\n */\n result = await this.context.security.withoutAuthorization(async () => {\n return await definition.run({\n input,\n controller\n });\n });\n } catch (ex) {\n return this.response.error({\n error: getErrorProperties(ex)\n });\n }\n\n // Convert TaskDefinition.Result to IResponseResult\n if (result.status === TaskResultStatus.CONTINUE) {\n return this.response.continue({\n input: result.input,\n wait: result.wait\n });\n } else if (result.status === TaskResultStatus.ERROR) {\n return this.response.error({\n error: result.error\n });\n } else if (result.status === TaskResultStatus.ABORTED) {\n return this.response.aborted();\n }\n return this.response.done({\n message: result.message,\n output: result.output\n });\n }\n}\n"],"names":["TaskManager","context","response","store","definition","TaskDataStatus","Date","error","ex","getErrorProperties","task","result","input","structuredClone","controller","TaskController","TaskResultStatus"],"mappings":";;;;AAWO,MAAMA;IAKT,YAAmBC,OAAgB,EAAEC,QAAmB,EAAEC,KAA+B,CAAE;QACvF,IAAI,CAAC,OAAO,GAAGF;QACf,IAAI,CAAC,QAAQ,GAAGC;QAChB,IAAI,CAAC,KAAK,GAAGC;IACjB;IAEA,MAAa,IAAIC,UAAmC,EAA4B;QAI5E,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,OAAOC,eAAe,OAAO,EACjD,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO;QAM3B,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,OAAOA,eAAe,OAAO,EACtD,IAAI;YACA,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;gBACxB,YAAYA,eAAe,OAAO;gBAClC,WAAW,IAAIC,OAAO,WAAW;gBACjC,eAAe,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,aAAa;gBAChD,YAAY;YAChB;YACA,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI;QACzB,EAAE,OAAOC,OAAO;YACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACvBA;YACJ;QACJ;aAOC,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,UAAU,IAAIH,WAAW,aAAa,EAChE,IAAI;YACA,IAAIA,WAAW,eAAe,EAC1B,MAAMA,WAAW,eAAe,CAAC;gBAC7B,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO;YAC5B;YAEJ,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACvB,OAAO;oBACH,SAAS;gBACb;YACJ;QACJ,EAAE,OAAOI,IAAI;YACT,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACvB,OAAO;oBACH,SAAS;oBACT,MAAMC,mBAAmBD;gBAC7B;YACJ;QACJ;aAOA,IAAI;YACA,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,CAACE,CAAAA,OACjB;oBACH,YAAYA,KAAK,UAAU,GAAG;gBAClC;QAER,EAAE,OAAOH,OAAO;YACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACvBA;YACJ;QACJ;QAGJ,IAAII;QAEJ,IAAI;YACA,MAAMC,QAAQC,gBAAgB,IAAI,CAAC,KAAK,CAAC,QAAQ;YACjD,MAAMC,aAAa,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAACC;YAIlDJ,SAAS,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,UAC/C,MAAMP,WAAW,GAAG,CAAC;oBACxBQ;oBACAE;gBACJ;QAER,EAAE,OAAON,IAAI;YACT,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACvB,OAAOC,mBAAmBD;YAC9B;QACJ;QAGA,IAAIG,OAAO,MAAM,KAAKK,iBAAiB,QAAQ,EAC3C,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAC1B,OAAOL,OAAO,KAAK;YACnB,MAAMA,OAAO,IAAI;QACrB;QACG,IAAIA,OAAO,MAAM,KAAKK,iBAAiB,KAAK,EAC/C,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;YACvB,OAAOL,OAAO,KAAK;QACvB;QACG,IAAIA,OAAO,MAAM,KAAKK,iBAAiB,OAAO,EACjD,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO;QAEhC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YACtB,SAASL,OAAO,OAAO;YACvB,QAAQA,OAAO,MAAM;QACzB;IACJ;AACJ"}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import type { ITask, ITaskDataInput, ITaskLog, ITaskManagerStoreInfoLog, ITaskManagerStorePrivate, ITaskManagerStoreSetOutputOptions, ITaskManagerStoreUpdateTaskInputOptions, ITaskManagerStoreUpdateTaskOptions, ITasksContextObject, TaskDataStatus } from "../../api/types.js";
|
|
2
|
+
import type { ITaskManagerStoreAddLogOptions, ITaskManagerStoreErrorLog, ITaskManagerStoreUpdateTaskInputParam, ITaskManagerStoreUpdateTaskParams } from "./abstractions/index.js";
|
|
3
|
+
import { TaskDefinition } from "@webiny/api-core/features/task/TaskDefinition/index.js";
|
|
4
|
+
export interface TaskManagerStoreContext {
|
|
5
|
+
tasks: Pick<ITasksContextObject, "updateTask" | "updateLog" | "listTasks">;
|
|
6
|
+
}
|
|
7
|
+
export interface ITaskManagerStoreParams {
|
|
8
|
+
context: TaskManagerStoreContext;
|
|
9
|
+
task: ITask;
|
|
10
|
+
log: ITaskLog;
|
|
11
|
+
databaseLogs: boolean;
|
|
12
|
+
}
|
|
13
|
+
export declare class TaskManagerStore<T extends ITaskDataInput = ITaskDataInput, O extends TaskDefinition.TaskOutput = TaskDefinition.TaskOutput> implements ITaskManagerStorePrivate<T, O> {
|
|
14
|
+
private readonly context;
|
|
15
|
+
private task;
|
|
16
|
+
private taskLog;
|
|
17
|
+
private readonly databaseLogs;
|
|
18
|
+
private readonly taskUpdater;
|
|
19
|
+
private readonly taskLogUpdater;
|
|
20
|
+
constructor(params: ITaskManagerStoreParams);
|
|
21
|
+
getStatus(): TaskDataStatus;
|
|
22
|
+
getTask(): ITask<T, O>;
|
|
23
|
+
listChildTasks<I extends TaskDefinition.TaskInput = TaskDefinition.TaskInput, O extends TaskDefinition.TaskOutput = TaskDefinition.TaskOutput>(definitionId?: string): Promise<ITask<I, O>[]>;
|
|
24
|
+
updateTask(param: ITaskManagerStoreUpdateTaskParams<T, O>, options?: ITaskManagerStoreUpdateTaskOptions): Promise<void>;
|
|
25
|
+
updateInput(param: ITaskManagerStoreUpdateTaskInputParam<T>, options?: ITaskManagerStoreUpdateTaskInputOptions): Promise<void>;
|
|
26
|
+
getInput(): T;
|
|
27
|
+
updateOutput(values: Partial<O>, options?: ITaskManagerStoreSetOutputOptions): Promise<void>;
|
|
28
|
+
getOutput(): O;
|
|
29
|
+
/**
|
|
30
|
+
* Currently the methods throws an error if something goes wrong during the database update.
|
|
31
|
+
* TODO: Maybe we should wrap it into try/catch and return error if any?
|
|
32
|
+
*/
|
|
33
|
+
addInfoLog(log: ITaskManagerStoreInfoLog, options?: ITaskManagerStoreAddLogOptions): Promise<void>;
|
|
34
|
+
/**
|
|
35
|
+
* Currently the methods throws an error if something goes wrong during the database update.
|
|
36
|
+
* TODO: Maybe we should wrap it into try/catch and return error if any?
|
|
37
|
+
*/
|
|
38
|
+
addErrorLog(log: ITaskManagerStoreErrorLog, options?: ITaskManagerStoreAddLogOptions): Promise<void>;
|
|
39
|
+
save(): Promise<void>;
|
|
40
|
+
}
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import { TaskLogItemType } from "../types.js";
|
|
2
|
+
import deep_equal from "deep-equal";
|
|
3
|
+
import { getObjectProperties } from "../utils/getObjectProperties.js";
|
|
4
|
+
import { ObjectUpdater } from "../utils/ObjectUpdater.js";
|
|
5
|
+
const getInput = (originalInput, input)=>{
|
|
6
|
+
if ("function" == typeof input) return input(originalInput);
|
|
7
|
+
return {
|
|
8
|
+
...originalInput,
|
|
9
|
+
...input
|
|
10
|
+
};
|
|
11
|
+
};
|
|
12
|
+
class TaskManagerStore {
|
|
13
|
+
constructor(params){
|
|
14
|
+
this.taskUpdater = new ObjectUpdater();
|
|
15
|
+
this.taskLogUpdater = new ObjectUpdater();
|
|
16
|
+
this.context = params.context;
|
|
17
|
+
this.task = params.task;
|
|
18
|
+
this.taskLog = params.log;
|
|
19
|
+
this.databaseLogs = true === params.databaseLogs;
|
|
20
|
+
}
|
|
21
|
+
getStatus() {
|
|
22
|
+
return this.task.taskStatus;
|
|
23
|
+
}
|
|
24
|
+
getTask() {
|
|
25
|
+
return this.task;
|
|
26
|
+
}
|
|
27
|
+
async listChildTasks(definitionId) {
|
|
28
|
+
const where = {
|
|
29
|
+
parentId: this.task.id
|
|
30
|
+
};
|
|
31
|
+
if (definitionId) where.definitionId = definitionId;
|
|
32
|
+
const result = await this.context.tasks.listTasks({
|
|
33
|
+
where,
|
|
34
|
+
sort: [
|
|
35
|
+
"createdOn_ASC"
|
|
36
|
+
],
|
|
37
|
+
limit: 1000000
|
|
38
|
+
});
|
|
39
|
+
return result.items;
|
|
40
|
+
}
|
|
41
|
+
async updateTask(param, options) {
|
|
42
|
+
const data = "function" == typeof param ? param(this.task) : param;
|
|
43
|
+
if (deep_equal(data, this.task)) return;
|
|
44
|
+
this.taskUpdater.update(data);
|
|
45
|
+
if (options?.save === false) return;
|
|
46
|
+
await this.save();
|
|
47
|
+
}
|
|
48
|
+
async updateInput(param, options) {
|
|
49
|
+
const input = getInput(this.task.input, param);
|
|
50
|
+
if (deep_equal(input, this.task.input)) return;
|
|
51
|
+
this.taskUpdater.update({
|
|
52
|
+
input: input
|
|
53
|
+
});
|
|
54
|
+
if (options?.save === false) return;
|
|
55
|
+
await this.save();
|
|
56
|
+
}
|
|
57
|
+
getInput() {
|
|
58
|
+
return this.task.input;
|
|
59
|
+
}
|
|
60
|
+
async updateOutput(values, options = {}) {
|
|
61
|
+
this.taskUpdater.update({
|
|
62
|
+
output: values
|
|
63
|
+
});
|
|
64
|
+
if (options?.save === false) return;
|
|
65
|
+
await this.save();
|
|
66
|
+
}
|
|
67
|
+
getOutput() {
|
|
68
|
+
return this.task.output;
|
|
69
|
+
}
|
|
70
|
+
async addInfoLog(log, options) {
|
|
71
|
+
if (!this.databaseLogs) return;
|
|
72
|
+
this.taskLogUpdater.update({
|
|
73
|
+
items: [
|
|
74
|
+
{
|
|
75
|
+
message: log.message,
|
|
76
|
+
data: log.data,
|
|
77
|
+
type: TaskLogItemType.INFO,
|
|
78
|
+
createdOn: new Date().toISOString()
|
|
79
|
+
}
|
|
80
|
+
]
|
|
81
|
+
});
|
|
82
|
+
if (options?.save === false) return;
|
|
83
|
+
await this.save();
|
|
84
|
+
}
|
|
85
|
+
async addErrorLog(log, options) {
|
|
86
|
+
if (!this.databaseLogs) return;
|
|
87
|
+
console.error(log.error);
|
|
88
|
+
this.taskLogUpdater.update({
|
|
89
|
+
items: [
|
|
90
|
+
{
|
|
91
|
+
message: log.message,
|
|
92
|
+
error: log.error instanceof Error ? getObjectProperties(log.error) : log.error,
|
|
93
|
+
type: TaskLogItemType.ERROR,
|
|
94
|
+
createdOn: new Date().toISOString()
|
|
95
|
+
}
|
|
96
|
+
]
|
|
97
|
+
});
|
|
98
|
+
if (options?.save === false) return;
|
|
99
|
+
await this.save();
|
|
100
|
+
}
|
|
101
|
+
async save() {
|
|
102
|
+
if (this.taskUpdater.isDirty()) this.task = await this.context.tasks.updateTask(this.task.id, this.taskUpdater.fetch());
|
|
103
|
+
if (!this.databaseLogs) return;
|
|
104
|
+
if (this.taskLogUpdater.isDirty()) this.taskLog = await this.context.tasks.updateLog(this.taskLog.id, this.taskLogUpdater.fetch());
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
export { TaskManagerStore };
|
|
108
|
+
|
|
109
|
+
//# sourceMappingURL=TaskManagerStore.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api/runner/TaskManagerStore.js","sources":["../../../src/api/runner/TaskManagerStore.ts"],"sourcesContent":["import type {\n IListTaskParamsWhere,\n ITask,\n ITaskDataInput,\n ITaskLog,\n ITaskManagerStoreInfoLog,\n ITaskManagerStorePrivate,\n ITaskManagerStoreSetOutputOptions,\n ITaskManagerStoreUpdateTaskInputOptions,\n ITaskManagerStoreUpdateTaskOptions,\n ITasksContextObject,\n TaskDataStatus\n} from \"~/api/types.js\";\nimport { TaskLogItemType } from \"~/api/types.js\";\nimport type {\n ITaskManagerStoreAddLogOptions,\n ITaskManagerStoreErrorLog,\n ITaskManagerStoreUpdateTaskInputParam,\n ITaskManagerStoreUpdateTaskParams\n} from \"./abstractions/index.js\";\n/**\n * Package deep-equal does not have types.\n */\nimport deepEqual from \"deep-equal\";\nimport { getObjectProperties } from \"~/api/utils/getObjectProperties.js\";\nimport { ObjectUpdater } from \"~/api/utils/ObjectUpdater.js\";\nimport { TaskDefinition } from \"@webiny/api-core/features/task/TaskDefinition/index.js\";\n\nconst getInput = <T extends ITaskDataInput = ITaskDataInput>(\n originalInput: T,\n input: ITaskManagerStoreUpdateTaskInputParam<T>\n): T => {\n if (typeof input === \"function\") {\n return input(originalInput);\n }\n return {\n ...originalInput,\n ...input\n };\n};\n\nexport interface TaskManagerStoreContext {\n tasks: Pick<ITasksContextObject, \"updateTask\" | \"updateLog\" | \"listTasks\">;\n}\n\nexport interface ITaskManagerStoreParams {\n context: TaskManagerStoreContext;\n task: ITask;\n log: ITaskLog;\n databaseLogs: boolean;\n}\n\nexport class TaskManagerStore<\n T extends ITaskDataInput = ITaskDataInput,\n O extends TaskDefinition.TaskOutput = TaskDefinition.TaskOutput\n> implements ITaskManagerStorePrivate<T, O> {\n private readonly context: TaskManagerStoreContext;\n private task: ITask<T, O>;\n private taskLog: ITaskLog;\n private readonly databaseLogs: boolean;\n\n private readonly taskUpdater = new ObjectUpdater<ITask<T, O>>();\n private readonly taskLogUpdater = new ObjectUpdater<ITaskLog>();\n\n public constructor(params: ITaskManagerStoreParams) {\n this.context = params.context;\n this.task = params.task as ITask<T, O>;\n this.taskLog = params.log;\n this.databaseLogs = params.databaseLogs === true;\n }\n\n public getStatus(): TaskDataStatus {\n return this.task.taskStatus;\n }\n\n public getTask(): ITask<T, O> {\n return this.task as ITask<T, O>;\n }\n\n public async listChildTasks<\n I extends TaskDefinition.TaskInput = TaskDefinition.TaskInput,\n O extends TaskDefinition.TaskOutput = TaskDefinition.TaskOutput\n >(definitionId?: string): Promise<ITask<I, O>[]> {\n const where: IListTaskParamsWhere = {\n parentId: this.task.id\n };\n if (definitionId) {\n where.definitionId = definitionId;\n }\n const result = await this.context.tasks.listTasks<I, O>({\n where,\n sort: [\"createdOn_ASC\"],\n limit: 1000000\n });\n return result.items;\n }\n\n public async updateTask(\n param: ITaskManagerStoreUpdateTaskParams<T, O>,\n options?: ITaskManagerStoreUpdateTaskOptions\n ): Promise<void> {\n const data = typeof param === \"function\" ? param(this.task) : param;\n\n /**\n * No need to update if nothing changed.\n */\n if (deepEqual(data, this.task)) {\n return;\n }\n\n this.taskUpdater.update(data);\n\n if (options?.save === false) {\n return;\n }\n await this.save();\n }\n\n public async updateInput(\n param: ITaskManagerStoreUpdateTaskInputParam<T>,\n options?: ITaskManagerStoreUpdateTaskInputOptions\n ): Promise<void> {\n const input = getInput<T>(this.task.input, param);\n\n /**\n * No need to update if nothing changed.\n */\n if (deepEqual(input, this.task.input)) {\n return;\n }\n this.taskUpdater.update({\n input: input as T\n });\n if (options?.save === false) {\n return;\n }\n await this.save();\n }\n\n public getInput(): T {\n return this.task.input as T;\n }\n\n public async updateOutput(\n values: Partial<O>,\n options: ITaskManagerStoreSetOutputOptions = {}\n ): Promise<void> {\n this.taskUpdater.update({\n output: values as O\n });\n if (options?.save === false) {\n return;\n }\n await this.save();\n }\n\n public getOutput(): O {\n return this.task.output as O;\n }\n /**\n * Currently the methods throws an error if something goes wrong during the database update.\n * TODO: Maybe we should wrap it into try/catch and return error if any?\n */\n public async addInfoLog(\n log: ITaskManagerStoreInfoLog,\n options?: ITaskManagerStoreAddLogOptions\n ): Promise<void> {\n if (!this.databaseLogs) {\n return;\n }\n this.taskLogUpdater.update({\n items: [\n {\n message: log.message,\n data: log.data,\n type: TaskLogItemType.INFO,\n createdOn: new Date().toISOString()\n }\n ]\n });\n if (options?.save === false) {\n return;\n }\n\n await this.save();\n }\n /**\n * Currently the methods throws an error if something goes wrong during the database update.\n * TODO: Maybe we should wrap it into try/catch and return error if any?\n */\n public async addErrorLog(\n log: ITaskManagerStoreErrorLog,\n options?: ITaskManagerStoreAddLogOptions\n ): Promise<void> {\n if (!this.databaseLogs) {\n return;\n }\n /**\n * Let's log the error to the console as well.\n */\n console.error(log.error);\n /**\n * Then update the log object.\n */\n this.taskLogUpdater.update({\n items: [\n {\n message: log.message,\n error: log.error instanceof Error ? getObjectProperties(log.error) : log.error,\n type: TaskLogItemType.ERROR,\n createdOn: new Date().toISOString()\n }\n ]\n });\n if (options?.save === false) {\n return;\n }\n await this.save();\n }\n\n public async save(): Promise<void> {\n /**\n * Update both task and the log, if anything to update.\n */\n if (this.taskUpdater.isDirty()) {\n this.task = await this.context.tasks.updateTask<T, O>(\n this.task.id,\n this.taskUpdater.fetch()\n );\n }\n if (!this.databaseLogs) {\n return;\n }\n if (this.taskLogUpdater.isDirty()) {\n this.taskLog = await this.context.tasks.updateLog(\n this.taskLog.id,\n this.taskLogUpdater.fetch()\n );\n }\n }\n}\n"],"names":["getInput","originalInput","input","TaskManagerStore","params","ObjectUpdater","definitionId","where","result","param","options","data","deepEqual","values","log","TaskLogItemType","Date","console","Error","getObjectProperties"],"mappings":";;;;AA4BA,MAAMA,WAAW,CACbC,eACAC;IAEA,IAAI,AAAiB,cAAjB,OAAOA,OACP,OAAOA,MAAMD;IAEjB,OAAO;QACH,GAAGA,aAAa;QAChB,GAAGC,KAAK;IACZ;AACJ;AAaO,MAAMC;IAYT,YAAmBC,MAA+B,CAAE;aAHnC,WAAW,GAAG,IAAIC;aAClB,cAAc,GAAG,IAAIA;QAGlC,IAAI,CAAC,OAAO,GAAGD,OAAO,OAAO;QAC7B,IAAI,CAAC,IAAI,GAAGA,OAAO,IAAI;QACvB,IAAI,CAAC,OAAO,GAAGA,OAAO,GAAG;QACzB,IAAI,CAAC,YAAY,GAAGA,AAAwB,SAAxBA,OAAO,YAAY;IAC3C;IAEO,YAA4B;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU;IAC/B;IAEO,UAAuB;QAC1B,OAAO,IAAI,CAAC,IAAI;IACpB;IAEA,MAAa,eAGXE,YAAqB,EAA0B;QAC7C,MAAMC,QAA8B;YAChC,UAAU,IAAI,CAAC,IAAI,CAAC,EAAE;QAC1B;QACA,IAAID,cACAC,MAAM,YAAY,GAAGD;QAEzB,MAAME,SAAS,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAO;YACpDD;YACA,MAAM;gBAAC;aAAgB;YACvB,OAAO;QACX;QACA,OAAOC,OAAO,KAAK;IACvB;IAEA,MAAa,WACTC,KAA8C,EAC9CC,OAA4C,EAC/B;QACb,MAAMC,OAAO,AAAiB,cAAjB,OAAOF,QAAuBA,MAAM,IAAI,CAAC,IAAI,IAAIA;QAK9D,IAAIG,WAAUD,MAAM,IAAI,CAAC,IAAI,GACzB;QAGJ,IAAI,CAAC,WAAW,CAAC,MAAM,CAACA;QAExB,IAAID,SAAS,SAAS,OAClB;QAEJ,MAAM,IAAI,CAAC,IAAI;IACnB;IAEA,MAAa,YACTD,KAA+C,EAC/CC,OAAiD,EACpC;QACb,MAAMR,QAAQF,SAAY,IAAI,CAAC,IAAI,CAAC,KAAK,EAAES;QAK3C,IAAIG,WAAUV,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,GAChC;QAEJ,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC;YACpB,OAAOA;QACX;QACA,IAAIQ,SAAS,SAAS,OAClB;QAEJ,MAAM,IAAI,CAAC,IAAI;IACnB;IAEO,WAAc;QACjB,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK;IAC1B;IAEA,MAAa,aACTG,MAAkB,EAClBH,UAA6C,CAAC,CAAC,EAClC;QACb,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC;YACpB,QAAQG;QACZ;QACA,IAAIH,SAAS,SAAS,OAClB;QAEJ,MAAM,IAAI,CAAC,IAAI;IACnB;IAEO,YAAe;QAClB,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM;IAC3B;IAKA,MAAa,WACTI,GAA6B,EAC7BJ,OAAwC,EAC3B;QACb,IAAI,CAAC,IAAI,CAAC,YAAY,EAClB;QAEJ,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;YACvB,OAAO;gBACH;oBACI,SAASI,IAAI,OAAO;oBACpB,MAAMA,IAAI,IAAI;oBACd,MAAMC,gBAAgB,IAAI;oBAC1B,WAAW,IAAIC,OAAO,WAAW;gBACrC;aACH;QACL;QACA,IAAIN,SAAS,SAAS,OAClB;QAGJ,MAAM,IAAI,CAAC,IAAI;IACnB;IAKA,MAAa,YACTI,GAA8B,EAC9BJ,OAAwC,EAC3B;QACb,IAAI,CAAC,IAAI,CAAC,YAAY,EAClB;QAKJO,QAAQ,KAAK,CAACH,IAAI,KAAK;QAIvB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;YACvB,OAAO;gBACH;oBACI,SAASA,IAAI,OAAO;oBACpB,OAAOA,IAAI,KAAK,YAAYI,QAAQC,oBAAoBL,IAAI,KAAK,IAAIA,IAAI,KAAK;oBAC9E,MAAMC,gBAAgB,KAAK;oBAC3B,WAAW,IAAIC,OAAO,WAAW;gBACrC;aACH;QACL;QACA,IAAIN,SAAS,SAAS,OAClB;QAEJ,MAAM,IAAI,CAAC,IAAI;IACnB;IAEA,MAAa,OAAsB;QAI/B,IAAI,IAAI,CAAC,WAAW,CAAC,OAAO,IACxB,IAAI,CAAC,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAC3C,IAAI,CAAC,IAAI,CAAC,EAAE,EACZ,IAAI,CAAC,WAAW,CAAC,KAAK;QAG9B,IAAI,CAAC,IAAI,CAAC,YAAY,EAClB;QAEJ,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,IAC3B,IAAI,CAAC,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAC7C,IAAI,CAAC,OAAO,CAAC,EAAE,EACf,IAAI,CAAC,cAAc,CAAC,KAAK;IAGrC;AACJ"}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type { ITaskRawEvent } from "../../api/handler/types.js";
|
|
2
|
+
import type { ITaskEventValidation, ITaskRunner } from "./abstractions/index.js";
|
|
3
|
+
import type { Context } from "../../api/types.js";
|
|
4
|
+
import type { IResponseResult } from "../../api/response/abstractions/index.js";
|
|
5
|
+
import type { ITimer } from "@webiny/handler-aws/utils/index.js";
|
|
6
|
+
export declare class TaskRunner<C extends Context = Context> implements ITaskRunner<C> {
|
|
7
|
+
/**
|
|
8
|
+
* When DI is introduced, these will get injected.
|
|
9
|
+
*
|
|
10
|
+
* container.bind<Request>("Request").toConstantValue(request);
|
|
11
|
+
* @inject("Request") public readonly request: Request;
|
|
12
|
+
*
|
|
13
|
+
* Follow the same example for the rest of the properties.
|
|
14
|
+
*/
|
|
15
|
+
readonly context: C;
|
|
16
|
+
readonly timer: ITimer;
|
|
17
|
+
private readonly validation;
|
|
18
|
+
/**
|
|
19
|
+
* We take all required variables separately because they will get injected via DI - so less refactoring is required in the future.
|
|
20
|
+
*/
|
|
21
|
+
constructor(context: C, timer: ITimer, validation: ITaskEventValidation);
|
|
22
|
+
isCloseToTimeout(seconds?: number): boolean;
|
|
23
|
+
run(rawEvent: ITaskRawEvent): Promise<IResponseResult>;
|
|
24
|
+
private getIsCloseToTimeoutMilliseconds;
|
|
25
|
+
}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { Response, ResponseErrorResult } from "../response/index.js";
|
|
2
|
+
import { TaskControl } from "./TaskControl.js";
|
|
3
|
+
import { getErrorProperties } from "../utils/getErrorProperties.js";
|
|
4
|
+
const transformMinutesIntoMilliseconds = (minutes)=>60000 * minutes;
|
|
5
|
+
const DEFAULT_TASKS_TIMEOUT_CLOSE_MINUTES = 3;
|
|
6
|
+
class TaskRunner {
|
|
7
|
+
constructor(context, timer, validation){
|
|
8
|
+
this.context = context;
|
|
9
|
+
this.timer = timer;
|
|
10
|
+
this.validation = validation;
|
|
11
|
+
}
|
|
12
|
+
isCloseToTimeout(seconds) {
|
|
13
|
+
const milliseconds = seconds ? 1000 * seconds : this.getIsCloseToTimeoutMilliseconds();
|
|
14
|
+
return this.timer.getRemainingMilliseconds() < milliseconds;
|
|
15
|
+
}
|
|
16
|
+
async run(rawEvent) {
|
|
17
|
+
const response = new Response({
|
|
18
|
+
...rawEvent
|
|
19
|
+
});
|
|
20
|
+
let event;
|
|
21
|
+
try {
|
|
22
|
+
event = this.validation.validate(rawEvent);
|
|
23
|
+
} catch (ex) {
|
|
24
|
+
return response.error({
|
|
25
|
+
error: getErrorProperties(ex)
|
|
26
|
+
});
|
|
27
|
+
}
|
|
28
|
+
response.setEvent(event);
|
|
29
|
+
if (rawEvent.delay && rawEvent.delay > 0) return response.continue({
|
|
30
|
+
input: {},
|
|
31
|
+
wait: rawEvent.delay
|
|
32
|
+
});
|
|
33
|
+
const control = new TaskControl(this, response, this.context);
|
|
34
|
+
try {
|
|
35
|
+
const result = await control.run(event);
|
|
36
|
+
if (result instanceof ResponseErrorResult === false) return result;
|
|
37
|
+
console.error(result);
|
|
38
|
+
return result;
|
|
39
|
+
} catch (ex) {
|
|
40
|
+
console.error(`Failed to execute task "${event.webinyTaskId}".`);
|
|
41
|
+
console.error(ex);
|
|
42
|
+
return response.error({
|
|
43
|
+
error: getErrorProperties(ex)
|
|
44
|
+
});
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
getIsCloseToTimeoutMilliseconds() {
|
|
48
|
+
const value = parseInt(process.env["WEBINY_TASKS_TIMEOUT_CLOSE_MINUTES"] || "");
|
|
49
|
+
const result = value > 0 ? value : DEFAULT_TASKS_TIMEOUT_CLOSE_MINUTES;
|
|
50
|
+
return transformMinutesIntoMilliseconds(result);
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
export { TaskRunner };
|
|
54
|
+
|
|
55
|
+
//# sourceMappingURL=TaskRunner.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api/runner/TaskRunner.js","sources":["../../../src/api/runner/TaskRunner.ts"],"sourcesContent":["import type { ITaskEvent, ITaskRawEvent } from \"~/api/handler/types.js\";\nimport type { ITaskEventValidation, ITaskRunner } from \"./abstractions/index.js\";\nimport type { Context } from \"~/api/types.js\";\nimport { Response, ResponseErrorResult } from \"~/api/response/index.js\";\nimport { TaskControl } from \"./TaskControl.js\";\nimport type { IResponseResult } from \"~/api/response/abstractions/index.js\";\nimport { getErrorProperties } from \"~/api/utils/getErrorProperties.js\";\nimport type { ITimer } from \"@webiny/handler-aws/utils/index.js\";\n\nconst transformMinutesIntoMilliseconds = (minutes: number) => {\n return minutes * 60000;\n};\n\nconst DEFAULT_TASKS_TIMEOUT_CLOSE_MINUTES = 3;\n\nexport class TaskRunner<C extends Context = Context> implements ITaskRunner<C> {\n /**\n * When DI is introduced, these will get injected.\n *\n * container.bind<Request>(\"Request\").toConstantValue(request);\n * @inject(\"Request\") public readonly request: Request;\n *\n * Follow the same example for the rest of the properties.\n */\n public readonly context: C;\n public readonly timer: ITimer;\n private readonly validation: ITaskEventValidation;\n\n /**\n * We take all required variables separately because they will get injected via DI - so less refactoring is required in the future.\n */\n public constructor(context: C, timer: ITimer, validation: ITaskEventValidation) {\n this.context = context;\n this.timer = timer;\n this.validation = validation;\n }\n\n public isCloseToTimeout(seconds?: number) {\n const milliseconds = seconds ? seconds * 1000 : this.getIsCloseToTimeoutMilliseconds();\n return this.timer.getRemainingMilliseconds() < milliseconds;\n }\n\n public async run(rawEvent: ITaskRawEvent): Promise<IResponseResult> {\n const response = new Response({\n ...rawEvent\n });\n\n let event: ITaskEvent;\n try {\n event = this.validation.validate(rawEvent);\n } catch (ex) {\n return response.error({\n error: getErrorProperties(ex)\n });\n }\n response.setEvent(event);\n /**\n * If we received a delay when initiating the task, we need to send the continue response immediately.\n */\n if (rawEvent.delay && rawEvent.delay > 0) {\n return response.continue({\n input: {},\n wait: rawEvent.delay\n });\n }\n\n const control = new TaskControl(this, response, this.context);\n\n try {\n const result = await control.run(event);\n if (result instanceof ResponseErrorResult === false) {\n return result;\n }\n console.error(result);\n return result;\n } catch (ex) {\n console.error(`Failed to execute task \"${event.webinyTaskId}\".`);\n console.error(ex);\n return response.error({\n error: getErrorProperties(ex)\n });\n }\n }\n\n private getIsCloseToTimeoutMilliseconds() {\n const value = parseInt(process.env[\"WEBINY_TASKS_TIMEOUT_CLOSE_MINUTES\"] || \"\");\n const result = value > 0 ? value : DEFAULT_TASKS_TIMEOUT_CLOSE_MINUTES;\n return transformMinutesIntoMilliseconds(result);\n }\n}\n"],"names":["transformMinutesIntoMilliseconds","minutes","DEFAULT_TASKS_TIMEOUT_CLOSE_MINUTES","TaskRunner","context","timer","validation","seconds","milliseconds","rawEvent","response","Response","event","ex","getErrorProperties","control","TaskControl","result","ResponseErrorResult","console","value","parseInt","process"],"mappings":";;;AASA,MAAMA,mCAAmC,CAACC,UAC/BA,AAAU,QAAVA;AAGX,MAAMC,sCAAsC;AAErC,MAAMC;IAgBT,YAAmBC,OAAU,EAAEC,KAAa,EAAEC,UAAgC,CAAE;QAC5E,IAAI,CAAC,OAAO,GAAGF;QACf,IAAI,CAAC,KAAK,GAAGC;QACb,IAAI,CAAC,UAAU,GAAGC;IACtB;IAEO,iBAAiBC,OAAgB,EAAE;QACtC,MAAMC,eAAeD,UAAUA,AAAU,OAAVA,UAAiB,IAAI,CAAC,+BAA+B;QACpF,OAAO,IAAI,CAAC,KAAK,CAAC,wBAAwB,KAAKC;IACnD;IAEA,MAAa,IAAIC,QAAuB,EAA4B;QAChE,MAAMC,WAAW,IAAIC,SAAS;YAC1B,GAAGF,QAAQ;QACf;QAEA,IAAIG;QACJ,IAAI;YACAA,QAAQ,IAAI,CAAC,UAAU,CAAC,QAAQ,CAACH;QACrC,EAAE,OAAOI,IAAI;YACT,OAAOH,SAAS,KAAK,CAAC;gBAClB,OAAOI,mBAAmBD;YAC9B;QACJ;QACAH,SAAS,QAAQ,CAACE;QAIlB,IAAIH,SAAS,KAAK,IAAIA,SAAS,KAAK,GAAG,GACnC,OAAOC,SAAS,QAAQ,CAAC;YACrB,OAAO,CAAC;YACR,MAAMD,SAAS,KAAK;QACxB;QAGJ,MAAMM,UAAU,IAAIC,YAAY,IAAI,EAAEN,UAAU,IAAI,CAAC,OAAO;QAE5D,IAAI;YACA,MAAMO,SAAS,MAAMF,QAAQ,GAAG,CAACH;YACjC,IAAIK,kBAAkBC,wBAAwB,OAC1C,OAAOD;YAEXE,QAAQ,KAAK,CAACF;YACd,OAAOA;QACX,EAAE,OAAOJ,IAAI;YACTM,QAAQ,KAAK,CAAC,CAAC,wBAAwB,EAAEP,MAAM,YAAY,CAAC,EAAE,CAAC;YAC/DO,QAAQ,KAAK,CAACN;YACd,OAAOH,SAAS,KAAK,CAAC;gBAClB,OAAOI,mBAAmBD;YAC9B;QACJ;IACJ;IAEQ,kCAAkC;QACtC,MAAMO,QAAQC,SAASC,QAAQ,GAAG,CAAC,qCAAqC,IAAI;QAC5E,MAAML,SAASG,QAAQ,IAAIA,QAAQlB;QACnC,OAAOF,iCAAiCiB;IAC5C;AACJ"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { ITaskRunner } from "../../../api/runner/abstractions/index.js";
|
|
2
|
+
import type { IResponse, IResponseResult } from "../../../api/response/abstractions/index.js";
|
|
3
|
+
import type { Context } from "../../../api/types.js";
|
|
4
|
+
import type { ITaskEvent } from "../../../api/handler/types.js";
|
|
5
|
+
export interface ITaskControl {
|
|
6
|
+
runner: ITaskRunner;
|
|
7
|
+
response: IResponse;
|
|
8
|
+
context: Context;
|
|
9
|
+
run(event: ITaskEvent): Promise<IResponseResult>;
|
|
10
|
+
}
|
|
File without changes
|
|
File without changes
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { IResponseResult } from "../../../api/response/abstractions/index.js";
|
|
2
|
+
import { TaskDefinition } from "@webiny/api-core/features/task/TaskDefinition/index.js";
|
|
3
|
+
export interface ITaskManager {
|
|
4
|
+
run: (definition: TaskDefinition.Runnable) => Promise<IResponseResult>;
|
|
5
|
+
}
|
|
File without changes
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import type { IResponseError, ITask, ITaskLogItemData, ITaskUpdateData, TaskDataStatus } from "../../../api/types.js";
|
|
2
|
+
import { TaskDefinition } from "@webiny/api-core/features/task/TaskDefinition/index.js";
|
|
3
|
+
export type ITaskManagerStoreUpdateTaskValues<T extends TaskDefinition.TaskInput = TaskDefinition.TaskInput> = T;
|
|
4
|
+
export interface ITaskManagerStoreUpdateTaskValuesCb<T extends TaskDefinition.TaskInput = TaskDefinition.TaskInput> {
|
|
5
|
+
(input: T): T;
|
|
6
|
+
}
|
|
7
|
+
export interface ITaskManagerStoreUpdateTaskInputOptions {
|
|
8
|
+
save: boolean;
|
|
9
|
+
}
|
|
10
|
+
export type ITaskManagerStoreUpdateTaskInputParam<T extends TaskDefinition.TaskInput = TaskDefinition.TaskInput> = ITaskManagerStoreUpdateTaskValuesCb<T> | Partial<ITaskManagerStoreUpdateTaskValues<T>>;
|
|
11
|
+
export interface ITaskManagerStoreUpdateTaskParamCb<T extends TaskDefinition.TaskInput = TaskDefinition.TaskInput, O extends TaskDefinition.TaskOutput = TaskDefinition.TaskOutput> {
|
|
12
|
+
(task: ITask<T, O>): ITaskUpdateData<T, O>;
|
|
13
|
+
}
|
|
14
|
+
export type ITaskManagerStoreUpdateTask<T extends TaskDefinition.TaskInput = TaskDefinition.TaskInput, O extends TaskDefinition.TaskOutput = TaskDefinition.TaskOutput> = ITaskUpdateData<T, O>;
|
|
15
|
+
export type ITaskManagerStoreUpdateTaskParams<T extends TaskDefinition.TaskInput = TaskDefinition.TaskInput, O extends TaskDefinition.TaskOutput = TaskDefinition.TaskOutput> = ITaskManagerStoreUpdateTaskParamCb<T, O> | Partial<ITaskManagerStoreUpdateTask<T, O>>;
|
|
16
|
+
export interface ITaskManagerStoreInfoLog {
|
|
17
|
+
message: string;
|
|
18
|
+
data?: ITaskLogItemData;
|
|
19
|
+
}
|
|
20
|
+
export interface ITaskManagerStoreErrorLog {
|
|
21
|
+
message: string;
|
|
22
|
+
data?: ITaskLogItemData;
|
|
23
|
+
error: IResponseError | Error;
|
|
24
|
+
}
|
|
25
|
+
export interface ITaskManagerStoreSetOutputOptions {
|
|
26
|
+
/**
|
|
27
|
+
* Default is true.
|
|
28
|
+
*/
|
|
29
|
+
save?: boolean;
|
|
30
|
+
}
|
|
31
|
+
export interface ITaskManagerStoreUpdateTaskOptions {
|
|
32
|
+
/**
|
|
33
|
+
* Default is true.
|
|
34
|
+
*/
|
|
35
|
+
save?: boolean;
|
|
36
|
+
}
|
|
37
|
+
export interface ITaskManagerStoreAddLogOptions {
|
|
38
|
+
/**
|
|
39
|
+
* Default is true.
|
|
40
|
+
*/
|
|
41
|
+
save?: boolean;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Interface should not be used outside the @webiny/background-tasks package.
|
|
45
|
+
*/
|
|
46
|
+
export interface ITaskManagerStorePrivate<T extends TaskDefinition.TaskInput = TaskDefinition.TaskInput, O extends TaskDefinition.TaskOutput = TaskDefinition.TaskOutput> {
|
|
47
|
+
getTask: () => ITask<T, O>;
|
|
48
|
+
getStatus: () => TaskDataStatus;
|
|
49
|
+
/**
|
|
50
|
+
* @throws {Error} If task not found or something goes wrong during the database update.
|
|
51
|
+
*/
|
|
52
|
+
updateTask(params: ITaskManagerStoreUpdateTaskParams<T, O>, options?: ITaskManagerStoreUpdateTaskOptions): Promise<void>;
|
|
53
|
+
/**
|
|
54
|
+
* List all child tasks of the current task.
|
|
55
|
+
* If definitionId is provided, filter by that parameter.
|
|
56
|
+
*/
|
|
57
|
+
listChildTasks<T extends TaskDefinition.TaskInput = TaskDefinition.TaskInput, O extends TaskDefinition.TaskOutput = TaskDefinition.TaskOutput>(definitionId?: string): Promise<ITask<T, O>[]>;
|
|
58
|
+
/**
|
|
59
|
+
* Update the task input, which are used to store custom user data.
|
|
60
|
+
* You can send partial input, and it will be merged with the existing input.
|
|
61
|
+
*
|
|
62
|
+
* @throws {Error} If task not found or something goes wrong during the database update.
|
|
63
|
+
*/
|
|
64
|
+
updateInput: (params: ITaskManagerStoreUpdateTaskInputParam<T>, options?: ITaskManagerStoreUpdateTaskInputOptions) => Promise<void>;
|
|
65
|
+
getInput: () => T;
|
|
66
|
+
/**
|
|
67
|
+
* Update the task output, which are used to store the output data.
|
|
68
|
+
* You can send partial output, and it will be merged with the existing output.
|
|
69
|
+
*
|
|
70
|
+
* Second parameter is optional options, and it contains a possibility not to store the task immediately.
|
|
71
|
+
*
|
|
72
|
+
* @throws {Error} If task not found or something goes wrong during the database update.
|
|
73
|
+
*/
|
|
74
|
+
updateOutput: (values: Partial<O>, options?: ITaskManagerStoreSetOutputOptions) => Promise<void>;
|
|
75
|
+
getOutput: () => O;
|
|
76
|
+
/**
|
|
77
|
+
* @throws {Error} If task not found or something goes wrong during the database update.
|
|
78
|
+
*/
|
|
79
|
+
addInfoLog: (log: ITaskManagerStoreInfoLog) => Promise<void>;
|
|
80
|
+
/**
|
|
81
|
+
* @throws {Error} If task not found or something goes wrong during the database update.
|
|
82
|
+
*
|
|
83
|
+
*
|
|
84
|
+
*/
|
|
85
|
+
addErrorLog: (log: ITaskManagerStoreErrorLog) => Promise<void>;
|
|
86
|
+
/**
|
|
87
|
+
* Should store the task and logs into the database, if any.
|
|
88
|
+
* If nothing to update, it should skip calling the internal store methods.
|
|
89
|
+
*/
|
|
90
|
+
save(): Promise<void>;
|
|
91
|
+
}
|
|
92
|
+
export type ITaskManagerStore<T extends TaskDefinition.TaskInput = TaskDefinition.TaskInput, O extends TaskDefinition.TaskOutput = TaskDefinition.TaskOutput> = Omit<ITaskManagerStorePrivate<T, O>, "save">;
|
|
File without changes
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { Context } from "../../../api/types.js";
|
|
2
|
+
import type { ITaskEvent } from "../../../api/handler/types.js";
|
|
3
|
+
import type { IResponseResult } from "../../../api/response/abstractions/index.js";
|
|
4
|
+
import type { ITimer } from "@webiny/handler-aws";
|
|
5
|
+
export interface IIsCloseToTimeoutCallable {
|
|
6
|
+
(seconds?: number): boolean;
|
|
7
|
+
}
|
|
8
|
+
export interface ITaskRunner<C extends Context = Context> {
|
|
9
|
+
context: C;
|
|
10
|
+
isCloseToTimeout: IIsCloseToTimeoutCallable;
|
|
11
|
+
timer: ITimer;
|
|
12
|
+
run(event: ITaskEvent): Promise<IResponseResult>;
|
|
13
|
+
}
|
|
File without changes
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./TaskRunner.js";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./TaskRunner.js";
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { ITaskService, ITaskServiceCreatePluginParams, ITaskServiceTask } from "../../api/plugins/index.js";
|
|
2
|
+
import { TaskServicePlugin } from "../../api/plugins/index.js";
|
|
3
|
+
import type { PutEventsCommandOutput } from "@webiny/aws-sdk/client-eventbridge/index.js";
|
|
4
|
+
import type { GenericRecord } from "@webiny/api/types.js";
|
|
5
|
+
declare class EventBridgeService implements ITaskService {
|
|
6
|
+
protected readonly getTenant: () => string;
|
|
7
|
+
private readonly client;
|
|
8
|
+
constructor(params: ITaskServiceCreatePluginParams);
|
|
9
|
+
send(task: ITaskServiceTask, delay: number): Promise<PutEventsCommandOutput>;
|
|
10
|
+
fetch(): Promise<GenericRecord>;
|
|
11
|
+
}
|
|
12
|
+
export declare class EventBridgeEventTransportPlugin extends TaskServicePlugin {
|
|
13
|
+
name: string;
|
|
14
|
+
createService(params: ITaskServiceCreatePluginParams): EventBridgeService;
|
|
15
|
+
}
|
|
16
|
+
export {};
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import { TaskServicePlugin } from "../plugins/index.js";
|
|
2
|
+
import { EventBridgeClient, PutEventsCommand } from "@webiny/aws-sdk/client-eventbridge/index.js";
|
|
3
|
+
import { WebinyError } from "@webiny/error";
|
|
4
|
+
class EventBridgeService {
|
|
5
|
+
constructor(params){
|
|
6
|
+
this.client = new EventBridgeClient({
|
|
7
|
+
region: process.env.AWS_REGION
|
|
8
|
+
});
|
|
9
|
+
this.getTenant = params.getTenant;
|
|
10
|
+
}
|
|
11
|
+
async send(task, delay) {
|
|
12
|
+
const event = {
|
|
13
|
+
webinyTaskId: task.id,
|
|
14
|
+
webinyTaskDefinitionId: task.definitionId,
|
|
15
|
+
tenant: this.getTenant(),
|
|
16
|
+
delay
|
|
17
|
+
};
|
|
18
|
+
const cmd = new PutEventsCommand({
|
|
19
|
+
Entries: [
|
|
20
|
+
{
|
|
21
|
+
Source: "webiny-api-tasks",
|
|
22
|
+
EventBusName: String(process.env.EVENT_BUS),
|
|
23
|
+
DetailType: "WebinyBackgroundTask",
|
|
24
|
+
Detail: JSON.stringify(event)
|
|
25
|
+
}
|
|
26
|
+
]
|
|
27
|
+
});
|
|
28
|
+
try {
|
|
29
|
+
const result = await this.client.send(cmd);
|
|
30
|
+
return JSON.parse(JSON.stringify(result));
|
|
31
|
+
} catch (ex) {
|
|
32
|
+
throw new WebinyError(ex.message || "Could not trigger task via Event Bridge!", ex.code || "TRIGGER_TASK_ERROR", {
|
|
33
|
+
event,
|
|
34
|
+
...ex.data || {}
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
async fetch() {
|
|
39
|
+
throw new WebinyError("Not implemented!", "NOT_IMPLEMENTED");
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
class EventBridgeEventTransportPlugin extends TaskServicePlugin {
|
|
43
|
+
createService(params) {
|
|
44
|
+
return new EventBridgeService(params);
|
|
45
|
+
}
|
|
46
|
+
constructor(...args){
|
|
47
|
+
super(...args), this.name = "task.eventBridgeEventTransport";
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
export { EventBridgeEventTransportPlugin };
|
|
51
|
+
|
|
52
|
+
//# sourceMappingURL=EventBridgeEventTransportPlugin.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api/service/EventBridgeEventTransportPlugin.js","sources":["../../../src/api/service/EventBridgeEventTransportPlugin.ts"],"sourcesContent":["import type {\n ITaskService,\n ITaskServiceCreatePluginParams,\n ITaskServiceTask\n} from \"~/api/plugins/index.js\";\nimport { TaskServicePlugin } from \"~/api/plugins/index.js\";\nimport type { ITaskEventInput } from \"~/api/types.js\";\nimport type { PutEventsCommandOutput } from \"@webiny/aws-sdk/client-eventbridge/index.js\";\nimport { EventBridgeClient, PutEventsCommand } from \"@webiny/aws-sdk/client-eventbridge/index.js\";\nimport { WebinyError } from \"@webiny/error\";\nimport type { GenericRecord } from \"@webiny/api/types.js\";\n\nclass EventBridgeService implements ITaskService {\n protected readonly getTenant: () => string;\n private readonly client: EventBridgeClient;\n\n public constructor(params: ITaskServiceCreatePluginParams) {\n this.client = new EventBridgeClient({\n region: process.env.AWS_REGION\n });\n this.getTenant = params.getTenant;\n }\n\n public async send(task: ITaskServiceTask, delay: number): Promise<PutEventsCommandOutput> {\n /**\n * The ITaskEvent is what our handler expect to get.\n * Endpoint and stateMachineId are added by the step function.\n */\n const event: ITaskEventInput = {\n webinyTaskId: task.id,\n webinyTaskDefinitionId: task.definitionId,\n tenant: this.getTenant(),\n delay\n };\n\n const cmd = new PutEventsCommand({\n Entries: [\n {\n Source: \"webiny-api-tasks\",\n EventBusName: String(process.env.EVENT_BUS),\n DetailType: \"WebinyBackgroundTask\",\n Detail: JSON.stringify(event)\n }\n ]\n });\n try {\n const result = await this.client.send(cmd);\n\n return JSON.parse(JSON.stringify(result));\n } catch (ex) {\n throw new WebinyError(\n ex.message || \"Could not trigger task via Event Bridge!\",\n ex.code || \"TRIGGER_TASK_ERROR\",\n {\n event,\n ...(ex.data || {})\n }\n );\n }\n }\n\n public async fetch(): Promise<GenericRecord> {\n throw new WebinyError(\"Not implemented!\", \"NOT_IMPLEMENTED\");\n }\n}\n\nexport class EventBridgeEventTransportPlugin extends TaskServicePlugin {\n public override name = \"task.eventBridgeEventTransport\";\n public createService(params: ITaskServiceCreatePluginParams) {\n return new EventBridgeService(params);\n }\n}\n"],"names":["EventBridgeService","params","EventBridgeClient","process","task","delay","event","cmd","PutEventsCommand","String","JSON","result","ex","WebinyError","EventBridgeEventTransportPlugin","TaskServicePlugin"],"mappings":";;;AAYA,MAAMA;IAIF,YAAmBC,MAAsC,CAAE;QACvD,IAAI,CAAC,MAAM,GAAG,IAAIC,kBAAkB;YAChC,QAAQC,QAAQ,GAAG,CAAC,UAAU;QAClC;QACA,IAAI,CAAC,SAAS,GAAGF,OAAO,SAAS;IACrC;IAEA,MAAa,KAAKG,IAAsB,EAAEC,KAAa,EAAmC;QAKtF,MAAMC,QAAyB;YAC3B,cAAcF,KAAK,EAAE;YACrB,wBAAwBA,KAAK,YAAY;YACzC,QAAQ,IAAI,CAAC,SAAS;YACtBC;QACJ;QAEA,MAAME,MAAM,IAAIC,iBAAiB;YAC7B,SAAS;gBACL;oBACI,QAAQ;oBACR,cAAcC,OAAON,QAAQ,GAAG,CAAC,SAAS;oBAC1C,YAAY;oBACZ,QAAQO,KAAK,SAAS,CAACJ;gBAC3B;aACH;QACL;QACA,IAAI;YACA,MAAMK,SAAS,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAACJ;YAEtC,OAAOG,KAAK,KAAK,CAACA,KAAK,SAAS,CAACC;QACrC,EAAE,OAAOC,IAAI;YACT,MAAM,IAAIC,YACND,GAAG,OAAO,IAAI,4CACdA,GAAG,IAAI,IAAI,sBACX;gBACIN;gBACA,GAAIM,GAAG,IAAI,IAAI,CAAC,CAAC;YACrB;QAER;IACJ;IAEA,MAAa,QAAgC;QACzC,MAAM,IAAIC,YAAY,oBAAoB;IAC9C;AACJ;AAEO,MAAMC,wCAAwCC;IAE1C,cAAcd,MAAsC,EAAE;QACzD,OAAO,IAAID,mBAAmBC;IAClC;;QAJG,qBACa,IAAI,GAAG;;AAI3B"}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type { ITaskService, ITaskServiceCreatePluginParams, ITaskServiceTask } from "../../api/plugins/index.js";
|
|
2
|
+
import { TaskServicePlugin } from "../../api/plugins/index.js";
|
|
3
|
+
import type { DescribeExecutionCommandOutput } from "@webiny/aws-sdk/client-sfn/index.js";
|
|
4
|
+
import type { ITask } from "../../api/types.js";
|
|
5
|
+
export type IStepFunctionServiceFetchResult = DescribeExecutionCommandOutput;
|
|
6
|
+
export interface IDetailWrapper<T> {
|
|
7
|
+
detail: T;
|
|
8
|
+
}
|
|
9
|
+
export declare class StepFunctionService implements ITaskService {
|
|
10
|
+
private readonly getTenant;
|
|
11
|
+
private readonly trigger;
|
|
12
|
+
private readonly get;
|
|
13
|
+
constructor(params: ITaskServiceCreatePluginParams);
|
|
14
|
+
send(task: ITaskServiceTask, delay: number): Promise<{
|
|
15
|
+
name: string;
|
|
16
|
+
executionArn: string | undefined;
|
|
17
|
+
startDate: Date | undefined;
|
|
18
|
+
$metadata: import("@smithy/types").ResponseMetadata;
|
|
19
|
+
} | null>;
|
|
20
|
+
fetch(task: ITask): Promise<IStepFunctionServiceFetchResult | null>;
|
|
21
|
+
}
|
|
22
|
+
export declare class StepFunctionServicePlugin extends TaskServicePlugin {
|
|
23
|
+
name: string;
|
|
24
|
+
createService(params: ITaskServiceCreatePluginParams): StepFunctionService;
|
|
25
|
+
}
|