@webiny/background-tasks 6.4.5 → 6.6.0-alpha.0

package/api/plugins/TaskServicePlugin.d.ts

@@ -1,19 +0,0 @@
-import { Plugin } from "@webiny/plugins";
-import type { ITask } from "../../api/types.js";
-export interface ITaskServiceCreatePluginParams {
-    getTenant(): string;
-}
-export type ITaskServiceTask = Pick<ITask, "id" | "definitionId">;
-export interface ITaskService {
-    send(task: ITaskServiceTask, delay: number): Promise<unknown | null>;
-    fetch(task: ITask): Promise<unknown | null>;
-}
-export interface ITaskServicePluginParams {
-    default?: boolean;
-}
-export declare abstract class TaskServicePlugin extends Plugin {
-    static readonly type: string;
-    readonly default: boolean;
-    constructor(params?: ITaskServicePluginParams);
-    abstract createService(params: ITaskServiceCreatePluginParams): ITaskService;
-}

package/api/plugins/TaskServicePlugin.js

@@ -1,13 +0,0 @@
-import { Plugin } from "@webiny/plugins";
-class TaskServicePlugin extends Plugin {
-    static{
-        this.type = "tasks.taskService";
-    }
-    constructor(params){
-        super();
-        this.default = !!params?.default;
-    }
-}
-export { TaskServicePlugin };
-
-//# sourceMappingURL=TaskServicePlugin.js.map

package/api/plugins/TaskServicePlugin.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"api/plugins/TaskServicePlugin.js","sources":["../../../src/api/plugins/TaskServicePlugin.ts"],"sourcesContent":["import { Plugin } from \"@webiny/plugins\";\nimport type { ITask } from \"~/api/types.js\";\n\nexport interface ITaskServiceCreatePluginParams {\n    getTenant(): string;\n}\n\nexport type ITaskServiceTask = Pick<ITask, \"id\" | \"definitionId\">;\n\nexport interface ITaskService {\n    send(task: ITaskServiceTask, delay: number): Promise<unknown | null>;\n    fetch(task: ITask): Promise<unknown | null>;\n}\n\nexport interface ITaskServicePluginParams {\n    default?: boolean;\n}\n\nexport abstract class TaskServicePlugin extends Plugin {\n    public static override readonly type: string = \"tasks.taskService\";\n    public readonly default: boolean;\n\n    public constructor(params?: ITaskServicePluginParams) {\n        super();\n        this.default = !!params?.default;\n    }\n\n    public abstract createService(params: ITaskServiceCreatePluginParams): ITaskService;\n}\n"],"names":["TaskServicePlugin","Plugin","params"],"mappings":";AAkBO,MAAeA,0BAA0BC;;aACZ,IAAI,GAAW;;IAG/C,YAAmBC,MAAiC,CAAE;QAClD,KAAK;QACL,IAAI,CAAC,OAAO,GAAG,CAAC,CAACA,QAAQ;IAC7B;AAGJ"}

package/api/plugins/index.d.ts

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

package/api/plugins/index.js

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

package/api/service/EventBridgeEventTransportPlugin.d.ts

@@ -1,16 +0,0 @@
-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

@@ -1,52 +0,0 @@
-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

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

@@ -1,25 +0,0 @@
-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<{
-        name: string;
-        executionArn: string | undefined;
-        startDate: Date | undefined;
-        $metadata: import("@smithy/types").ResponseMetadata;
-    } | null>;
-    fetch(task: ITask): Promise<IStepFunctionServiceFetchResult | null>;
-}
-export declare class StepFunctionServicePlugin extends TaskServicePlugin {
-    name: string;
-    createService(params: ITaskServiceCreatePluginParams): StepFunctionService;
-}

package/api/service/StepFunctionServicePlugin.js

@@ -1,77 +0,0 @@
-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";
-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

@@ -1 +0,0 @@
-{"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\";\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/index.js.map

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