@webiny/api-scheduler-server 0.0.0-unstable.0d717d18dd

package/BreeSchedulerService.d.ts

@@ -0,0 +1,37 @@
+import { type ISchedulerServiceCreateParams, type ISchedulerServiceUpdateParams, SchedulerService } from "@webiny/api-scheduler/shared/abstractions.js";
+import type { Logger } from "@webiny/api-core/features/logger/abstractions.js";
+export interface IPendingAction {
+    id: string;
+    namespace: string;
+    tenant: string;
+    scheduledFor: Date;
+}
+export interface IBreeSchedulerServiceParams {
+    logger: Logger.Interface;
+    onTrigger: (id: string, namespace: string, tenant: string) => Promise<void>;
+}
+/**
+ * One-shot bree job per scheduled action — mirrors EventBridge behaviour. This is a single-process,
+ * long-lived root SINGLETON (started once at boot): it holds the live timers for ALL tenants, so each
+ * job records its own tenant and `onTrigger` is fired with it (the trigger runs outside any request,
+ * so the tenant can't be read from a request context).
+ */
+export declare class BreeSchedulerService implements SchedulerService.Interface {
+    private readonly bree;
+    private readonly jobs;
+    private readonly logger;
+    private readonly onTrigger;
+    constructor(params: IBreeSchedulerServiceParams);
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    create(params: ISchedulerServiceCreateParams): Promise<void>;
+    update(params: ISchedulerServiceUpdateParams): Promise<void>;
+    delete(params: SchedulerService.DeleteParams): Promise<void>;
+    exists(params: SchedulerService.ExistsParams): Promise<boolean>;
+    /**
+     * (Re)arm timers for a batch of persisted pending actions — called at boot (per tenant) to restore
+     * schedules after a restart. Overdue actions fire immediately.
+     */
+    recover(pendingActions: IPendingAction[]): Promise<void>;
+    private safeRemove;
+}

package/BreeSchedulerService.js

@@ -0,0 +1,105 @@
+import bree from "bree";
+import { fileURLToPath } from "node:url";
+import { WebinyError } from "@webiny/error";
+const workerPath = fileURLToPath(new URL("./jobs/pollWorker.js", import.meta.url));
+class BreeSchedulerService {
+    constructor(params){
+        this.jobs = new Map();
+        this.logger = params.logger;
+        this.onTrigger = params.onTrigger;
+        this.bree = new bree({
+            root: false,
+            jobs: [],
+            logger: false,
+            workerMessageHandler: async ({ name })=>{
+                const job = this.jobs.get(name);
+                if (!job) return;
+                this.jobs.delete(name);
+                await this.onTrigger(name, job.namespace, job.tenant);
+            }
+        });
+    }
+    async start() {
+        await this.bree.start();
+    }
+    async stop() {
+        await this.bree.stop();
+    }
+    async create(params) {
+        const { id, namespace, scheduleFor, tenant } = params;
+        if (scheduleFor <= new Date()) throw new WebinyError(`Cannot create a schedule for "${id}" with date in the past`, "INVALID_SCHEDULE_DATE", {
+            scheduleFor,
+            id
+        });
+        const exists = await this.exists({
+            id,
+            namespace,
+            tenant
+        });
+        if (exists) return this.update(params);
+        this.jobs.set(id, {
+            namespace,
+            tenant
+        });
+        await this.bree.add({
+            name: id,
+            date: scheduleFor,
+            path: workerPath
+        });
+        await this.bree.start(id);
+    }
+    async update(params) {
+        const { id, scheduleFor } = params;
+        if (scheduleFor <= new Date()) throw new WebinyError(`Cannot update an existing schedule for "${id}" with date in the past`, "INVALID_SCHEDULE_DATE", {
+            scheduleFor,
+            id
+        });
+        await this.safeRemove(id);
+        await this.create(params);
+    }
+    async delete(params) {
+        const { id } = params;
+        const exists = await this.exists(params);
+        if (!exists) throw new WebinyError(`Cannot delete schedule "${id}" because it does not exist.`);
+        await this.safeRemove(id);
+    }
+    async exists(params) {
+        const { id } = params;
+        return this.jobs.has(id);
+    }
+    async recover(pendingActions) {
+        const now = new Date();
+        for (const action of pendingActions){
+            if (action.scheduledFor <= now) {
+                await this.onTrigger(action.id, action.namespace, action.tenant);
+                continue;
+            }
+            this.jobs.set(action.id, {
+                namespace: action.namespace,
+                tenant: action.tenant
+            });
+            await this.bree.add({
+                name: action.id,
+                date: action.scheduledFor,
+                path: workerPath
+            });
+            await this.bree.start(action.id);
+        }
+    }
+    async safeRemove(id) {
+        this.jobs.delete(id);
+        try {
+            await this.bree.stop(id);
+        } catch  {
+            this.logger.debug(`Could not stop bree job "${id}" — it may have already fired.`);
+        }
+        try {
+            await this.bree.remove(id);
+        } catch  {
+            this.logger.debug(`Could not remove bree job "${id}" — it may have already been removed.`);
+        }
+    }
+}
+export { BreeSchedulerService };
+
+//# sourceMappingURL=BreeSchedulerService.js.map

package/BreeSchedulerService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BreeSchedulerService.js","sources":["../src/BreeSchedulerService.ts"],"sourcesContent":["import Bree from \"bree\";\nimport { fileURLToPath } from \"node:url\";\nimport { WebinyError } from \"@webiny/error\";\nimport {\n    type ISchedulerServiceCreateParams,\n    type ISchedulerServiceUpdateParams,\n    SchedulerService\n} from \"@webiny/api-scheduler/shared/abstractions.js\";\nimport type { Logger } from \"@webiny/api-core/features/logger/abstractions.js\";\n\n// bree loads this file at runtime via `new Worker(path)`. Referencing it through `new URL` (rather\n// than path.join) makes the app bundler emit pollWorker into build/ as an asset, resolved relative\n// to this module (the server build sets assetPrefix \"auto\"); fileURLToPath then hands bree a plain\n// path string. Un-bundled (dev), import.meta.url is real and it resolves to the dist/jobs file.\nconst workerPath = fileURLToPath(new URL(\"./jobs/pollWorker.js\", import.meta.url));\n\nexport interface IPendingAction {\n    id: string;\n    namespace: string;\n    tenant: string;\n    scheduledFor: Date;\n}\n\ninterface IScheduledJob {\n    namespace: string;\n    tenant: string;\n}\n\nexport interface IBreeSchedulerServiceParams {\n    logger: Logger.Interface;\n    onTrigger: (id: string, namespace: string, tenant: string) => Promise<void>;\n}\n\n/**\n * One-shot bree job per scheduled action — mirrors EventBridge behaviour. This is a single-process,\n * long-lived root SINGLETON (started once at boot): it holds the live timers for ALL tenants, so each\n * job records its own tenant and `onTrigger` is fired with it (the trigger runs outside any request,\n * so the tenant can't be read from a request context).\n */\nexport class BreeSchedulerService implements SchedulerService.Interface {\n    private readonly bree;\n    private readonly jobs = new Map<string, IScheduledJob>();\n    private readonly logger;\n    private readonly onTrigger;\n\n    public constructor(params: IBreeSchedulerServiceParams) {\n        this.logger = params.logger;\n        this.onTrigger = params.onTrigger;\n\n        this.bree = new Bree({\n            root: false,\n            jobs: [],\n            logger: false,\n            workerMessageHandler: async ({ name }) => {\n                const job = this.jobs.get(name);\n                if (!job) {\n                    return;\n                }\n\n                this.jobs.delete(name);\n                await this.onTrigger(name, job.namespace, job.tenant);\n            }\n        });\n    }\n\n    public async start(): Promise<void> {\n        await this.bree.start();\n    }\n\n    public async stop(): Promise<void> {\n        await this.bree.stop();\n    }\n\n    public async create(params: ISchedulerServiceCreateParams): Promise<void> {\n        const { id, namespace, scheduleFor, tenant } = params;\n\n        if (scheduleFor <= new Date()) {\n            throw new WebinyError(\n                `Cannot create a schedule for \"${id}\" with date in the past`,\n                \"INVALID_SCHEDULE_DATE\",\n                { scheduleFor, id }\n            );\n        }\n\n        const exists = await this.exists({\n            id,\n            namespace,\n            tenant\n        });\n        if (exists) {\n            return this.update(params);\n        }\n\n        this.jobs.set(id, { namespace, tenant });\n\n        await this.bree.add({\n            name: id,\n            date: scheduleFor,\n            path: workerPath\n        });\n\n        await this.bree.start(id);\n    }\n\n    public async update(params: ISchedulerServiceUpdateParams): Promise<void> {\n        const { id, scheduleFor } = params;\n\n        if (scheduleFor <= new Date()) {\n            throw new WebinyError(\n                `Cannot update an existing schedule for \"${id}\" with date in the past`,\n                \"INVALID_SCHEDULE_DATE\",\n                { scheduleFor, id }\n            );\n        }\n\n        await this.safeRemove(id);\n        await this.create(params);\n    }\n\n    public async delete(params: SchedulerService.DeleteParams): Promise<void> {\n        const { id } = params;\n        const exists = await this.exists(params);\n        if (!exists) {\n            throw new WebinyError(`Cannot delete schedule \"${id}\" because it does not exist.`);\n        }\n\n        await this.safeRemove(id);\n    }\n\n    public async exists(params: SchedulerService.ExistsParams): Promise<boolean> {\n        const { id } = params;\n        return this.jobs.has(id);\n    }\n\n    /**\n     * (Re)arm timers for a batch of persisted pending actions — called at boot (per tenant) to restore\n     * schedules after a restart. Overdue actions fire immediately.\n     */\n    public async recover(pendingActions: IPendingAction[]): Promise<void> {\n        const now = new Date();\n\n        for (const action of pendingActions) {\n            if (action.scheduledFor <= now) {\n                /* Overdue — execute immediately. */\n                await this.onTrigger(action.id, action.namespace, action.tenant);\n                continue;\n            }\n\n            this.jobs.set(action.id, { namespace: action.namespace, tenant: action.tenant });\n\n            await this.bree.add({\n                name: action.id,\n                date: action.scheduledFor,\n                path: workerPath\n            });\n\n            await this.bree.start(action.id);\n        }\n    }\n\n    private async safeRemove(id: string): Promise<void> {\n        this.jobs.delete(id);\n\n        try {\n            await this.bree.stop(id);\n        } catch {\n            this.logger.debug(`Could not stop bree job \"${id}\" — it may have already fired.`);\n        }\n\n        try {\n            await this.bree.remove(id);\n        } catch {\n            this.logger.debug(\n                `Could not remove bree job \"${id}\" — it may have already been removed.`\n            );\n        }\n    }\n}\n"],"names":["workerPath","fileURLToPath","URL","BreeSchedulerService","params","Map","Bree","name","job","id","namespace","scheduleFor","tenant","Date","WebinyError","exists","pendingActions","now","action"],"mappings":";;;AAcA,MAAMA,aAAaC,cAAc,IAAIC,IAAI,wBAAwB,YAAY,GAAG;AAyBzE,MAAMC;IAMT,YAAmBC,MAAmC,CAAE;aAJvC,IAAI,GAAG,IAAIC;QAKxB,IAAI,CAAC,MAAM,GAAGD,OAAO,MAAM;QAC3B,IAAI,CAAC,SAAS,GAAGA,OAAO,SAAS;QAEjC,IAAI,CAAC,IAAI,GAAG,IAAIE,KAAK;YACjB,MAAM;YACN,MAAM,EAAE;YACR,QAAQ;YACR,sBAAsB,OAAO,EAAEC,IAAI,EAAE;gBACjC,MAAMC,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAACD;gBAC1B,IAAI,CAACC,KACD;gBAGJ,IAAI,CAAC,IAAI,CAAC,MAAM,CAACD;gBACjB,MAAM,IAAI,CAAC,SAAS,CAACA,MAAMC,IAAI,SAAS,EAAEA,IAAI,MAAM;YACxD;QACJ;IACJ;IAEA,MAAa,QAAuB;QAChC,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK;IACzB;IAEA,MAAa,OAAsB;QAC/B,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI;IACxB;IAEA,MAAa,OAAOJ,MAAqC,EAAiB;QACtE,MAAM,EAAEK,EAAE,EAAEC,SAAS,EAAEC,WAAW,EAAEC,MAAM,EAAE,GAAGR;QAE/C,IAAIO,eAAe,IAAIE,QACnB,MAAM,IAAIC,YACN,CAAC,8BAA8B,EAAEL,GAAG,uBAAuB,CAAC,EAC5D,yBACA;YAAEE;YAAaF;QAAG;QAI1B,MAAMM,SAAS,MAAM,IAAI,CAAC,MAAM,CAAC;YAC7BN;YACAC;YACAE;QACJ;QACA,IAAIG,QACA,OAAO,IAAI,CAAC,MAAM,CAACX;QAGvB,IAAI,CAAC,IAAI,CAAC,GAAG,CAACK,IAAI;YAAEC;YAAWE;QAAO;QAEtC,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;YAChB,MAAMH;YACN,MAAME;YACN,MAAMX;QACV;QAEA,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAACS;IAC1B;IAEA,MAAa,OAAOL,MAAqC,EAAiB;QACtE,MAAM,EAAEK,EAAE,EAAEE,WAAW,EAAE,GAAGP;QAE5B,IAAIO,eAAe,IAAIE,QACnB,MAAM,IAAIC,YACN,CAAC,wCAAwC,EAAEL,GAAG,uBAAuB,CAAC,EACtE,yBACA;YAAEE;YAAaF;QAAG;QAI1B,MAAM,IAAI,CAAC,UAAU,CAACA;QACtB,MAAM,IAAI,CAAC,MAAM,CAACL;IACtB;IAEA,MAAa,OAAOA,MAAqC,EAAiB;QACtE,MAAM,EAAEK,EAAE,EAAE,GAAGL;QACf,MAAMW,SAAS,MAAM,IAAI,CAAC,MAAM,CAACX;QACjC,IAAI,CAACW,QACD,MAAM,IAAID,YAAY,CAAC,wBAAwB,EAAEL,GAAG,4BAA4B,CAAC;QAGrF,MAAM,IAAI,CAAC,UAAU,CAACA;IAC1B;IAEA,MAAa,OAAOL,MAAqC,EAAoB;QACzE,MAAM,EAAEK,EAAE,EAAE,GAAGL;QACf,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAACK;IACzB;IAMA,MAAa,QAAQO,cAAgC,EAAiB;QAClE,MAAMC,MAAM,IAAIJ;QAEhB,KAAK,MAAMK,UAAUF,eAAgB;YACjC,IAAIE,OAAO,YAAY,IAAID,KAAK;gBAE5B,MAAM,IAAI,CAAC,SAAS,CAACC,OAAO,EAAE,EAAEA,OAAO,SAAS,EAAEA,OAAO,MAAM;gBAC/D;YACJ;YAEA,IAAI,CAAC,IAAI,CAAC,GAAG,CAACA,OAAO,EAAE,EAAE;gBAAE,WAAWA,OAAO,SAAS;gBAAE,QAAQA,OAAO,MAAM;YAAC;YAE9E,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;gBAChB,MAAMA,OAAO,EAAE;gBACf,MAAMA,OAAO,YAAY;gBACzB,MAAMlB;YACV;YAEA,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAACkB,OAAO,EAAE;QACnC;IACJ;IAEA,MAAc,WAAWT,EAAU,EAAiB;QAChD,IAAI,CAAC,IAAI,CAAC,MAAM,CAACA;QAEjB,IAAI;YACA,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAACA;QACzB,EAAE,OAAM;YACJ,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,yBAAyB,EAAEA,GAAG,8BAA8B,CAAC;QACpF;QAEA,IAAI;YACA,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAACA;QAC3B,EAAE,OAAM;YACJ,IAAI,CAAC,MAAM,CAAC,KAAK,CACb,CAAC,2BAA2B,EAAEA,GAAG,qCAAqC,CAAC;QAE/E;IACJ;AACJ"}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Webiny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,11 @@
+# @webiny/api-scheduler-server
+
+> [!NOTE]
+> This package is part of the [Webiny](https://www.webiny.com) monorepo.
+> It’s **included in every Webiny project by default** and is not meant to be used as a standalone package.
+
+📘 **Documentation:** [https://www.webiny.com/docs](https://www.webiny.com/docs)
+
+---
+
+_This README file is automatically generated during the publish process._

package/index.d.ts

@@ -0,0 +1,2 @@
+export { BreeSchedulerService } from "./BreeSchedulerService.js";
+export type { IPendingAction, IBreeSchedulerServiceParams } from "./BreeSchedulerService.js";

package/index.js

@@ -0,0 +1 @@
+export { BreeSchedulerService } from "./BreeSchedulerService.js";

package/jobs/pollWorker.d.ts

@@ -0,0 +1 @@
+export {};

package/jobs/pollWorker.js

@@ -0,0 +1,4 @@
+import { parentPort } from "node:worker_threads";
+if (parentPort) parentPort.postMessage("poll");
+
+//# sourceMappingURL=pollWorker.js.map

package/jobs/pollWorker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jobs/pollWorker.js","sources":["../../src/jobs/pollWorker.js"],"sourcesContent":["import { parentPort } from \"node:worker_threads\";\n\nif (parentPort) {\n    parentPort.postMessage(\"poll\");\n}\n"],"names":["parentPort"],"mappings":";AAEA,IAAIA,YACAA,WAAW,WAAW,CAAC"}

package/package.json

@@ -0,0 +1,38 @@
+{
+	"name": "@webiny/api-scheduler-server",
+	"version": "0.0.0-unstable.0d717d18dd",
+	"type": "module",
+	"exports": {
+		".": "./index.js",
+		"./*": "./*"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git",
+		"directory": "packages/api-scheduler-server"
+	},
+	"keywords": [
+		"scheduler:server"
+	],
+	"author": "Webiny Ltd",
+	"description": "Server-side cron-based implementation for the Webiny action scheduler.",
+	"license": "MIT",
+	"dependencies": {
+		"@webiny/api-core": "0.0.0-unstable.0d717d18dd",
+		"@webiny/api-scheduler": "0.0.0-unstable.0d717d18dd",
+		"@webiny/error": "0.0.0-unstable.0d717d18dd",
+		"bree": "9.2.9"
+	},
+	"devDependencies": {
+		"@webiny/build-tools": "0.0.0-unstable.0d717d18dd",
+		"@webiny/project-utils": "0.0.0-unstable.0d717d18dd",
+		"typescript": "7.0.2",
+		"vitest": "4.1.10"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"webiny": {
+		"publishFrom": "dist"
+	}
+}