@webiny/background-tasks 0.0.0-unstable.7be00a75a9 → 0.0.0-unstable.a4f3e4ea8b

package/api/runner/TaskRunner.js

@@ -0,0 +1,55 @@
+import { Response, ResponseErrorResult } from "../response/index.js";
+import { TaskControl } from "./TaskControl.js";
+import { getErrorProperties } from "../utils/getErrorProperties.js";
+const transformMinutesIntoMilliseconds = (minutes)=>60000 * minutes;
+const DEFAULT_TASKS_TIMEOUT_CLOSE_MINUTES = 3;
+class TaskRunner {
+    constructor(context, timer, validation){
+        this.context = context;
+        this.timer = timer;
+        this.validation = validation;
+    }
+    isCloseToTimeout(seconds) {
+        const milliseconds = seconds ? 1000 * seconds : this.getIsCloseToTimeoutMilliseconds();
+        return this.timer.getRemainingMilliseconds() < milliseconds;
+    }
+    async run(rawEvent) {
+        const response = new Response({
+            ...rawEvent
+        });
+        let event;
+        try {
+            event = this.validation.validate(rawEvent);
+        } catch (ex) {
+            return response.error({
+                error: getErrorProperties(ex)
+            });
+        }
+        response.setEvent(event);
+        if (rawEvent.delay && rawEvent.delay > 0) return response.continue({
+            input: {},
+            wait: rawEvent.delay
+        });
+        const control = new TaskControl(this, response, this.context);
+        try {
+            const result = await control.run(event);
+            if (result instanceof ResponseErrorResult === false) return result;
+            console.error(result);
+            return result;
+        } catch (ex) {
+            console.error(`Failed to execute task "${event.webinyTaskId}".`);
+            console.error(ex);
+            return response.error({
+                error: getErrorProperties(ex)
+            });
+        }
+    }
+    getIsCloseToTimeoutMilliseconds() {
+        const value = parseInt(process.env["WEBINY_TASKS_TIMEOUT_CLOSE_MINUTES"] || "");
+        const result = value > 0 ? value : DEFAULT_TASKS_TIMEOUT_CLOSE_MINUTES;
+        return transformMinutesIntoMilliseconds(result);
+    }
+}
+export { TaskRunner };
+
+//# sourceMappingURL=TaskRunner.js.map

package/api/runner/TaskRunner.js.map

@@ -0,0 +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"}

package/api/runner/abstractions/TaskControl.d.ts

@@ -0,0 +1,10 @@
+import type { ITaskRunner } from "../../../api/runner/abstractions/index.js";
+import type { IResponse, IResponseResult } from "../../../api/response/abstractions/index.js";
+import type { Context } from "../../../api/types.js";
+import type { ITaskEvent } from "../../../api/handler/types.js";
+export interface ITaskControl {
+    runner: ITaskRunner;
+    response: IResponse;
+    context: Context;
+    run(event: ITaskEvent): Promise<IResponseResult>;
+}

package/api/runner/abstractions/TaskEventValidation.d.ts

@@ -0,0 +1,5 @@
+import type { ITaskEvent } from "../../../api/handler/types.js";
+export type ITaskEventValidationResult = ITaskEvent;
+export interface ITaskEventValidation {
+    validate: (event: Partial<ITaskEvent>) => ITaskEventValidationResult;
+}

package/api/runner/abstractions/TaskManager.d.ts

@@ -0,0 +1,5 @@
+import type { IResponseResult } from "../../../api/response/abstractions/index.js";
+import { TaskDefinition } from "@webiny/api-core/features/task/TaskDefinition/index.js";
+export interface ITaskManager {
+    run: (definition: TaskDefinition.Runnable) => Promise<IResponseResult>;
+}

package/api/runner/abstractions/TaskManagerStore.d.ts

@@ -0,0 +1,92 @@
+import type { IResponseError, ITask, ITaskLogItemData, ITaskUpdateData, TaskDataStatus } from "../../../api/types.js";
+import { TaskDefinition } from "@webiny/api-core/features/task/TaskDefinition/index.js";
+export type ITaskManagerStoreUpdateTaskValues<T extends TaskDefinition.TaskInput = TaskDefinition.TaskInput> = T;
+export interface ITaskManagerStoreUpdateTaskValuesCb<T extends TaskDefinition.TaskInput = TaskDefinition.TaskInput> {
+    (input: T): T;
+}
+export interface ITaskManagerStoreUpdateTaskInputOptions {
+    save: boolean;
+}
+export type ITaskManagerStoreUpdateTaskInputParam<T extends TaskDefinition.TaskInput = TaskDefinition.TaskInput> = ITaskManagerStoreUpdateTaskValuesCb<T> | Partial<ITaskManagerStoreUpdateTaskValues<T>>;
+export interface ITaskManagerStoreUpdateTaskParamCb<T extends TaskDefinition.TaskInput = TaskDefinition.TaskInput, O extends TaskDefinition.TaskOutput = TaskDefinition.TaskOutput> {
+    (task: ITask<T, O>): ITaskUpdateData<T, O>;
+}
+export type ITaskManagerStoreUpdateTask<T extends TaskDefinition.TaskInput = TaskDefinition.TaskInput, O extends TaskDefinition.TaskOutput = TaskDefinition.TaskOutput> = ITaskUpdateData<T, O>;
+export type ITaskManagerStoreUpdateTaskParams<T extends TaskDefinition.TaskInput = TaskDefinition.TaskInput, O extends TaskDefinition.TaskOutput = TaskDefinition.TaskOutput> = ITaskManagerStoreUpdateTaskParamCb<T, O> | Partial<ITaskManagerStoreUpdateTask<T, O>>;
+export interface ITaskManagerStoreInfoLog {
+    message: string;
+    data?: ITaskLogItemData;
+}
+export interface ITaskManagerStoreErrorLog {
+    message: string;
+    data?: ITaskLogItemData;
+    error: IResponseError | Error;
+}
+export interface ITaskManagerStoreSetOutputOptions {
+    /**
+     * Default is true.
+     */
+    save?: boolean;
+}
+export interface ITaskManagerStoreUpdateTaskOptions {
+    /**
+     * Default is true.
+     */
+    save?: boolean;
+}
+export interface ITaskManagerStoreAddLogOptions {
+    /**
+     * Default is true.
+     */
+    save?: boolean;
+}
+/**
+ * Interface should not be used outside the @webiny/background-tasks package.
+ */
+export interface ITaskManagerStorePrivate<T extends TaskDefinition.TaskInput = TaskDefinition.TaskInput, O extends TaskDefinition.TaskOutput = TaskDefinition.TaskOutput> {
+    getTask: () => ITask<T, O>;
+    getStatus: () => TaskDataStatus;
+    /**
+     * @throws {Error} If task not found or something goes wrong during the database update.
+     */
+    updateTask(params: ITaskManagerStoreUpdateTaskParams<T, O>, options?: ITaskManagerStoreUpdateTaskOptions): Promise<void>;
+    /**
+     * List all child tasks of the current task.
+     * If definitionId is provided, filter by that parameter.
+     */
+    listChildTasks<T extends TaskDefinition.TaskInput = TaskDefinition.TaskInput, O extends TaskDefinition.TaskOutput = TaskDefinition.TaskOutput>(definitionId?: string): Promise<ITask<T, O>[]>;
+    /**
+     * Update the task input, which are used to store custom user data.
+     * You can send partial input, and it will be merged with the existing input.
+     *
+     * @throws {Error} If task not found or something goes wrong during the database update.
+     */
+    updateInput: (params: ITaskManagerStoreUpdateTaskInputParam<T>, options?: ITaskManagerStoreUpdateTaskInputOptions) => Promise<void>;
+    getInput: () => T;
+    /**
+     * Update the task output, which are used to store the output data.
+     * You can send partial output, and it will be merged with the existing output.
+     *
+     * Second parameter is optional options, and it contains a possibility not to store the task immediately.
+     *
+     * @throws {Error} If task not found or something goes wrong during the database update.
+     */
+    updateOutput: (values: Partial<O>, options?: ITaskManagerStoreSetOutputOptions) => Promise<void>;
+    getOutput: () => O;
+    /**
+     * @throws {Error} If task not found or something goes wrong during the database update.
+     */
+    addInfoLog: (log: ITaskManagerStoreInfoLog) => Promise<void>;
+    /**
+     * @throws {Error} If task not found or something goes wrong during the database update.
+     *
+     *
+     */
+    addErrorLog: (log: ITaskManagerStoreErrorLog) => Promise<void>;
+    /**
+     * Should store the task and logs into the database, if any.
+     * If nothing to update, it should skip calling the internal store methods.
+     */
+    save(): Promise<void>;
+}
+export type ITaskManagerStore<T extends TaskDefinition.TaskInput = TaskDefinition.TaskInput, O extends TaskDefinition.TaskOutput = TaskDefinition.TaskOutput> = Omit<ITaskManagerStorePrivate<T, O>, "save">;

package/api/runner/abstractions/TaskRunner.d.ts

@@ -0,0 +1,13 @@
+import type { Context } from "../../../api/types.js";
+import type { ITaskEvent } from "../../../api/handler/types.js";
+import type { IResponseResult } from "../../../api/response/abstractions/index.js";
+import type { ITimer } from "@webiny/handler-aws";
+export interface IIsCloseToTimeoutCallable {
+    (seconds?: number): boolean;
+}
+export interface ITaskRunner<C extends Context = Context> {
+    context: C;
+    isCloseToTimeout: IIsCloseToTimeoutCallable;
+    timer: ITimer;
+    run(event: ITaskEvent): Promise<IResponseResult>;
+}

package/api/runner/abstractions/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./TaskControl.js";
+export * from "./TaskEventValidation.js";
+export * from "./TaskManager.js";
+export * from "./TaskRunner.js";
+export * from "./TaskManagerStore.js";

package/api/runner/abstractions/index.js

@@ -0,0 +1,5 @@
+export * from "./TaskControl.js";
+export * from "./TaskEventValidation.js";
+export * from "./TaskManager.js";
+export * from "./TaskRunner.js";
+export * from "./TaskManagerStore.js";

package/api/runner/index.d.ts

@@ -0,0 +1 @@
+export * from "./TaskRunner.js";

package/api/runner/index.js

@@ -0,0 +1 @@
+export * from "./TaskRunner.js";

package/api/service/EventBridgeEventTransportPlugin.d.ts

@@ -0,0 +1,16 @@
+import type { ITaskService, ITaskServiceCreatePluginParams, ITaskServiceTask } from "../../api/plugins/index.js";
+import { TaskServicePlugin } from "../../api/plugins/index.js";
+import type { PutEventsCommandOutput } from "@webiny/aws-sdk/client-eventbridge/index.js";
+import type { GenericRecord } from "@webiny/api/types.js";
+declare class EventBridgeService implements ITaskService {
+    protected readonly getTenant: () => string;
+    private readonly client;
+    constructor(params: ITaskServiceCreatePluginParams);
+    send(task: ITaskServiceTask, delay: number): Promise<PutEventsCommandOutput>;
+    fetch(): Promise<GenericRecord>;
+}
+export declare class EventBridgeEventTransportPlugin extends TaskServicePlugin {
+    name: string;
+    createService(params: ITaskServiceCreatePluginParams): EventBridgeService;
+}
+export {};

package/api/service/EventBridgeEventTransportPlugin.js

@@ -0,0 +1,52 @@
+import { TaskServicePlugin } from "../plugins/index.js";
+import { EventBridgeClient, PutEventsCommand } from "@webiny/aws-sdk/client-eventbridge/index.js";
+import { WebinyError } from "@webiny/error";
+class EventBridgeService {
+    constructor(params){
+        this.client = new EventBridgeClient({
+            region: process.env.AWS_REGION
+        });
+        this.getTenant = params.getTenant;
+    }
+    async send(task, delay) {
+        const event = {
+            webinyTaskId: task.id,
+            webinyTaskDefinitionId: task.definitionId,
+            tenant: this.getTenant(),
+            delay
+        };
+        const cmd = new PutEventsCommand({
+            Entries: [
+                {
+                    Source: "webiny-api-tasks",
+                    EventBusName: String(process.env.EVENT_BUS),
+                    DetailType: "WebinyBackgroundTask",
+                    Detail: JSON.stringify(event)
+                }
+            ]
+        });
+        try {
+            const result = await this.client.send(cmd);
+            return JSON.parse(JSON.stringify(result));
+        } catch (ex) {
+            throw new WebinyError(ex.message || "Could not trigger task via Event Bridge!", ex.code || "TRIGGER_TASK_ERROR", {
+                event,
+                ...ex.data || {}
+            });
+        }
+    }
+    async fetch() {
+        throw new WebinyError("Not implemented!", "NOT_IMPLEMENTED");
+    }
+}
+class EventBridgeEventTransportPlugin extends TaskServicePlugin {
+    createService(params) {
+        return new EventBridgeService(params);
+    }
+    constructor(...args){
+        super(...args), this.name = "task.eventBridgeEventTransport";
+    }
+}
+export { EventBridgeEventTransportPlugin };
+
+//# sourceMappingURL=EventBridgeEventTransportPlugin.js.map

package/api/service/EventBridgeEventTransportPlugin.js.map

@@ -0,0 +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"}

package/api/service/StepFunctionServicePlugin.d.ts

@@ -0,0 +1,25 @@
+import type { ITaskService, ITaskServiceCreatePluginParams, ITaskServiceTask } from "../../api/plugins/index.js";
+import { TaskServicePlugin } from "../../api/plugins/index.js";
+import type { DescribeExecutionCommandOutput } from "@webiny/aws-sdk/client-sfn/index.js";
+import type { ITask } from "../../api/types.js";
+export type IStepFunctionServiceFetchResult = DescribeExecutionCommandOutput;
+export interface IDetailWrapper<T> {
+    detail: T;
+}
+export declare class StepFunctionService implements ITaskService {
+    private readonly getTenant;
+    private readonly trigger;
+    private readonly get;
+    constructor(params: ITaskServiceCreatePluginParams);
+    send(task: ITaskServiceTask, delay: number): Promise<{
+        $metadata: import("@smithy/types").ResponseMetadata;
+        executionArn: string | undefined;
+        startDate: Date | undefined;
+        name: string;
+    } | null>;
+    fetch(task: ITask): Promise<IStepFunctionServiceFetchResult | null>;
+}
+export declare class StepFunctionServicePlugin extends TaskServicePlugin {
+    name: string;
+    createService(params: ITaskServiceCreatePluginParams): StepFunctionService;
+}

package/api/service/StepFunctionServicePlugin.js

@@ -0,0 +1,77 @@
+import { TaskServicePlugin } from "../plugins/index.js";
+import { createStepFunctionClient, describeExecutionFactory, triggerStepFunctionFactory } from "@webiny/aws-sdk/client-sfn/index.js";
+import { generateAlphaNumericId } from "@webiny/utils";
+import { ServiceDiscovery } from "@webiny/api-core/features/serviceDiscovery/index.js";
+class StepFunctionService {
+    constructor(params){
+        this.getTenant = params.getTenant;
+        const client = createStepFunctionClient();
+        this.trigger = triggerStepFunctionFactory(client);
+        this.get = describeExecutionFactory(client);
+    }
+    async send(task, delay) {
+        const manifest = await ServiceDiscovery.load();
+        if (!manifest) {
+            console.error("Service manifest not found.");
+            return null;
+        }
+        const { bgTaskSfn } = manifest.api || {};
+        if (!bgTaskSfn) {
+            console.error("Background task state machine not found.");
+            return null;
+        }
+        const input = {
+            webinyTaskId: task.id,
+            webinyTaskDefinitionId: task.definitionId,
+            tenant: this.getTenant(),
+            delay
+        };
+        const name = `${task.definitionId}_${task.id}_${generateAlphaNumericId(10)}`;
+        try {
+            const result = await this.trigger({
+                input: {
+                    detail: input
+                },
+                stateMachineArn: bgTaskSfn,
+                name
+            });
+            return {
+                ...result,
+                name
+            };
+        } catch (ex) {
+            console.log("Could not trigger a step function.");
+            console.error(ex);
+            return null;
+        }
+    }
+    async fetch(task) {
+        const executionArn = task.eventResponse?.executionArn;
+        if (!executionArn) {
+            console.error(`Execution ARN not found in task "${task.id}".`);
+            return null;
+        }
+        try {
+            const result = await this.get({
+                executionArn
+            });
+            if (!result) return null;
+            return JSON.parse(JSON.stringify(result));
+        } catch (ex) {
+            console.log("Could not get the execution details.");
+            console.error(ex);
+            return null;
+        }
+    }
+}
+class StepFunctionServicePlugin extends TaskServicePlugin {
+    createService(params) {
+        return new StepFunctionService(params);
+    }
+    constructor(...args){
+        super(...args), this.name = "task.stepFunctionTriggerTransport";
+    }
+}
+export { StepFunctionService, StepFunctionServicePlugin };
+
+//# sourceMappingURL=StepFunctionServicePlugin.js.map

package/api/service/StepFunctionServicePlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api/service/StepFunctionServicePlugin.js","sources":["../../../src/api/service/StepFunctionServicePlugin.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 { DescribeExecutionCommandOutput } from \"@webiny/aws-sdk/client-sfn/index.js\";\nimport {\n    createStepFunctionClient,\n    describeExecutionFactory,\n    triggerStepFunctionFactory\n} from \"@webiny/aws-sdk/client-sfn/index.js\";\nimport type { ITaskEventInput } from \"~/api/handler/types.js\";\nimport { generateAlphaNumericId } from \"@webiny/utils\";\nimport { ServiceDiscovery } from \"@webiny/api-core/features/serviceDiscovery/index.js\";\nimport type { ITask } from \"~/api/types.js\";\n\nexport type IStepFunctionServiceFetchResult = DescribeExecutionCommandOutput;\n\nexport interface IDetailWrapper<T> {\n    detail: T;\n}\n\nexport class StepFunctionService implements ITaskService {\n    private readonly getTenant: () => string;\n    private readonly trigger: ReturnType<typeof triggerStepFunctionFactory>;\n    private readonly get: ReturnType<typeof describeExecutionFactory>;\n\n    public constructor(params: ITaskServiceCreatePluginParams) {\n        this.getTenant = params.getTenant;\n        const client = createStepFunctionClient();\n        this.trigger = triggerStepFunctionFactory(client);\n        this.get = describeExecutionFactory(client);\n    }\n    public async send(task: ITaskServiceTask, delay: number) {\n        const manifest = await ServiceDiscovery.load();\n        if (!manifest) {\n            console.error(\"Service manifest not found.\");\n            return null;\n        }\n        const { bgTaskSfn } = manifest.api || {};\n        if (!bgTaskSfn) {\n            console.error(\"Background task state machine not found.\");\n            return null;\n        }\n\n        const input: ITaskEventInput = {\n            webinyTaskId: task.id,\n            webinyTaskDefinitionId: task.definitionId,\n            tenant: this.getTenant(),\n            delay\n        };\n        const name = `${task.definitionId}_${task.id}_${generateAlphaNumericId(10)}`;\n        try {\n            const result = await this.trigger<IDetailWrapper<ITaskEventInput>>({\n                input: {\n                    detail: input\n                },\n                stateMachineArn: bgTaskSfn,\n                name\n            });\n            return {\n                ...result,\n                name\n            };\n        } catch (ex) {\n            console.log(\"Could not trigger a step function.\");\n            console.error(ex);\n            return null;\n        }\n    }\n\n    public async fetch(task: ITask): Promise<IStepFunctionServiceFetchResult | null> {\n        const executionArn = task.eventResponse?.executionArn;\n        if (!executionArn) {\n            console.error(`Execution ARN not found in task \"${task.id}\".`);\n            return null;\n        }\n        try {\n            const result = await this.get({\n                executionArn\n            });\n            if (!result) {\n                return null;\n            }\n            return JSON.parse(JSON.stringify(result));\n        } catch (ex) {\n            console.log(\"Could not get the execution details.\");\n            console.error(ex);\n            return null;\n        }\n    }\n}\n\nexport class StepFunctionServicePlugin extends TaskServicePlugin {\n    public override name = \"task.stepFunctionTriggerTransport\";\n\n    public createService(params: ITaskServiceCreatePluginParams) {\n        return new StepFunctionService(params);\n    }\n}\n"],"names":["StepFunctionService","params","client","createStepFunctionClient","triggerStepFunctionFactory","describeExecutionFactory","task","delay","manifest","ServiceDiscovery","console","bgTaskSfn","input","name","generateAlphaNumericId","result","ex","executionArn","JSON","StepFunctionServicePlugin","TaskServicePlugin"],"mappings":";;;;AAuBO,MAAMA;IAKT,YAAmBC,MAAsC,CAAE;QACvD,IAAI,CAAC,SAAS,GAAGA,OAAO,SAAS;QACjC,MAAMC,SAASC;QACf,IAAI,CAAC,OAAO,GAAGC,2BAA2BF;QAC1C,IAAI,CAAC,GAAG,GAAGG,yBAAyBH;IACxC;IACA,MAAa,KAAKI,IAAsB,EAAEC,KAAa,EAAE;QACrD,MAAMC,WAAW,MAAMC,iBAAiB,IAAI;QAC5C,IAAI,CAACD,UAAU;YACXE,QAAQ,KAAK,CAAC;YACd,OAAO;QACX;QACA,MAAM,EAAEC,SAAS,EAAE,GAAGH,SAAS,GAAG,IAAI,CAAC;QACvC,IAAI,CAACG,WAAW;YACZD,QAAQ,KAAK,CAAC;YACd,OAAO;QACX;QAEA,MAAME,QAAyB;YAC3B,cAAcN,KAAK,EAAE;YACrB,wBAAwBA,KAAK,YAAY;YACzC,QAAQ,IAAI,CAAC,SAAS;YACtBC;QACJ;QACA,MAAMM,OAAO,GAAGP,KAAK,YAAY,CAAC,CAAC,EAAEA,KAAK,EAAE,CAAC,CAAC,EAAEQ,uBAAuB,KAAK;QAC5E,IAAI;YACA,MAAMC,SAAS,MAAM,IAAI,CAAC,OAAO,CAAkC;gBAC/D,OAAO;oBACH,QAAQH;gBACZ;gBACA,iBAAiBD;gBACjBE;YACJ;YACA,OAAO;gBACH,GAAGE,MAAM;gBACTF;YACJ;QACJ,EAAE,OAAOG,IAAI;YACTN,QAAQ,GAAG,CAAC;YACZA,QAAQ,KAAK,CAACM;YACd,OAAO;QACX;IACJ;IAEA,MAAa,MAAMV,IAAW,EAAmD;QAC7E,MAAMW,eAAeX,KAAK,aAAa,EAAE;QACzC,IAAI,CAACW,cAAc;YACfP,QAAQ,KAAK,CAAC,CAAC,iCAAiC,EAAEJ,KAAK,EAAE,CAAC,EAAE,CAAC;YAC7D,OAAO;QACX;QACA,IAAI;YACA,MAAMS,SAAS,MAAM,IAAI,CAAC,GAAG,CAAC;gBAC1BE;YACJ;YACA,IAAI,CAACF,QACD,OAAO;YAEX,OAAOG,KAAK,KAAK,CAACA,KAAK,SAAS,CAACH;QACrC,EAAE,OAAOC,IAAI;YACTN,QAAQ,GAAG,CAAC;YACZA,QAAQ,KAAK,CAACM;YACd,OAAO;QACX;IACJ;AACJ;AAEO,MAAMG,kCAAkCC;IAGpC,cAAcnB,MAAsC,EAAE;QACzD,OAAO,IAAID,oBAAoBC;IACnC;;QALG,qBACa,IAAI,GAAG;;AAK3B"}

package/api/service/createService.d.ts

@@ -0,0 +1,6 @@
+import type { Context } from "../../api/types.js";
+import type { ITaskService } from "../../api/plugins/index.js";
+export interface ICreateTransport {
+    context: Context;
+}
+export declare const createService: (params: ICreateTransport) => ITaskService;

package/api/service/createService.js

@@ -0,0 +1,16 @@
+import { TaskServicePlugin } from "../plugins/index.js";
+import { WebinyError } from "@webiny/error";
+const createService = (params)=>{
+    const plugins = params.context.plugins.byType(TaskServicePlugin.type).reverse();
+    const plugin = plugins.find((plugin)=>plugin.default) || plugins[0];
+    if (!plugin) throw new WebinyError("Missing TaskServicePlugin.", "PLUGIN_ERROR", {
+        type: TaskServicePlugin.type
+    });
+    const getTenant = ()=>params.context.tenancy.getCurrentTenant().id;
+    return plugin.createService({
+        getTenant
+    });
+};
+export { createService };
+
+//# sourceMappingURL=createService.js.map

package/api/service/createService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api/service/createService.js","sources":["../../../src/api/service/createService.ts"],"sourcesContent":["import type { Context } from \"~/api/types.js\";\nimport type { ITaskService } from \"~/api/plugins/index.js\";\nimport { TaskServicePlugin } from \"~/api/plugins/index.js\";\nimport { WebinyError } from \"@webiny/error\";\n\nexport interface ICreateTransport {\n    context: Context;\n}\n\nexport const createService = (params: ICreateTransport): ITaskService => {\n    const plugins = params.context.plugins\n        .byType<TaskServicePlugin>(TaskServicePlugin.type)\n        .reverse();\n\n    const plugin = plugins.find(plugin => plugin.default) || plugins[0];\n    if (!plugin) {\n        throw new WebinyError(\"Missing TaskServicePlugin.\", \"PLUGIN_ERROR\", {\n            type: TaskServicePlugin.type\n        });\n    }\n\n    const getTenant = (): string => {\n        return params.context.tenancy.getCurrentTenant().id;\n    };\n\n    return plugin.createService({\n        getTenant\n    });\n};\n"],"names":["createService","params","plugins","TaskServicePlugin","plugin","WebinyError","getTenant"],"mappings":";;AASO,MAAMA,gBAAgB,CAACC;IAC1B,MAAMC,UAAUD,OAAO,OAAO,CAAC,OAAO,CACjC,MAAM,CAAoBE,kBAAkB,IAAI,EAChD,OAAO;IAEZ,MAAMC,SAASF,QAAQ,IAAI,CAACE,CAAAA,SAAUA,OAAO,OAAO,KAAKF,OAAO,CAAC,EAAE;IACnE,IAAI,CAACE,QACD,MAAM,IAAIC,YAAY,8BAA8B,gBAAgB;QAChE,MAAMF,kBAAkB,IAAI;IAChC;IAGJ,MAAMG,YAAY,IACPL,OAAO,OAAO,CAAC,OAAO,CAAC,gBAAgB,GAAG,EAAE;IAGvD,OAAOG,OAAO,aAAa,CAAC;QACxBE;IACJ;AACJ"}

package/api/service/index.d.ts

@@ -0,0 +1,4 @@
+import { EventBridgeEventTransportPlugin } from "./EventBridgeEventTransportPlugin.js";
+import { StepFunctionServicePlugin } from "./StepFunctionServicePlugin.js";
+export declare const createServicePlugins: () => (EventBridgeEventTransportPlugin | StepFunctionServicePlugin)[];
+export * from "./createService.js";

package/api/service/index.js

@@ -0,0 +1,12 @@
+import { EventBridgeEventTransportPlugin } from "./EventBridgeEventTransportPlugin.js";
+import { StepFunctionServicePlugin } from "./StepFunctionServicePlugin.js";
+export * from "./createService.js";
+const createServicePlugins = ()=>[
+        new StepFunctionServicePlugin({
+            default: true
+        }),
+        new EventBridgeEventTransportPlugin()
+    ];
+export { createServicePlugins };
+
+//# sourceMappingURL=index.js.map

package/api/service/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api/service/index.js","sources":["../../../src/api/service/index.ts"],"sourcesContent":["import { EventBridgeEventTransportPlugin } from \"./EventBridgeEventTransportPlugin.js\";\nimport { StepFunctionServicePlugin } from \"./StepFunctionServicePlugin.js\";\n\nexport const createServicePlugins = () => {\n    return [\n        new StepFunctionServicePlugin({ default: true }),\n        new EventBridgeEventTransportPlugin()\n    ];\n};\n\nexport * from \"./createService.js\";\n"],"names":["createServicePlugins","StepFunctionServicePlugin","EventBridgeEventTransportPlugin"],"mappings":";;;AAGO,MAAMA,uBAAuB,IACzB;QACH,IAAIC,0BAA0B;YAAE,SAAS;QAAK;QAC9C,IAAIC;KACP"}

package/api/tasks/testingRunTask.d.ts

@@ -0,0 +1,11 @@
+import { TaskDefinition } from "@webiny/api-core/features/task/TaskDefinition/index.js";
+declare class TestingRunTask implements TaskDefinition.Interface {
+    id: string;
+    title: string;
+    description: string;
+    run({ controller }: TaskDefinition.RunParams): Promise<TaskDefinition.ResultDone<import("@webiny/api-core/features/task/TaskDefinition/abstractions").ITaskOutput>>;
+}
+export declare const TestingRunTaskDefinition: typeof TestingRunTask & {
+    __abstraction: import("@webiny/di").Abstraction<import("@webiny/api-core/features/task/TaskDefinition/abstractions").ITaskDefinition<import("@webiny/api-core/features/task/TaskDefinition/abstractions").ITaskInput, import("@webiny/api-core/features/task/TaskDefinition/abstractions").ITaskOutput>>;
+};
+export {};

package/api/tasks/testingRunTask.js

@@ -0,0 +1,18 @@
+import { TaskDefinition } from "@webiny/api-core/features/task/TaskDefinition/index.js";
+class TestingRunTask {
+    async run({ controller }) {
+        return controller.response.done("Task successfully finished.");
+    }
+    constructor(){
+        this.id = "testingRun";
+        this.title = "Test Step Function Permissions";
+        this.description = "A task to test the step function permissions.";
+    }
+}
+const TestingRunTaskDefinition = TaskDefinition.createImplementation({
+    implementation: TestingRunTask,
+    dependencies: []
+});
+export { TestingRunTaskDefinition };
+
+//# sourceMappingURL=testingRunTask.js.map

package/api/tasks/testingRunTask.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api/tasks/testingRunTask.js","sources":["../../../src/api/tasks/testingRunTask.ts"],"sourcesContent":["import { TaskDefinition } from \"@webiny/api-core/features/task/TaskDefinition/index.js\";\n\nclass TestingRunTask implements TaskDefinition.Interface {\n    id = \"testingRun\";\n    title = \"Test Step Function Permissions\";\n    description = \"A task to test the step function permissions.\";\n\n    async run({ controller }: TaskDefinition.RunParams) {\n        return controller.response.done(\"Task successfully finished.\");\n    }\n}\n\nexport const TestingRunTaskDefinition = TaskDefinition.createImplementation({\n    implementation: TestingRunTask,\n    dependencies: []\n});\n"],"names":["TestingRunTask","controller","TestingRunTaskDefinition","TaskDefinition"],"mappings":";AAEA,MAAMA;IAKF,MAAM,IAAI,EAAEC,UAAU,EAA4B,EAAE;QAChD,OAAOA,WAAW,QAAQ,CAAC,IAAI,CAAC;IACpC;;aANA,EAAE,GAAG;aACL,KAAK,GAAG;aACR,WAAW,GAAG;;AAKlB;AAEO,MAAMC,2BAA2BC,eAAe,oBAAoB,CAAC;IACxE,gBAAgBH;IAChB,cAAc,EAAE;AACpB"}