@unchainedshop/core-worker 4.0.0-rc.9 → 4.0.0

package/lib/module/migrations/addMigrations.js

@@ -0,0 +1,16 @@
+import { WorkQueueCollection } from '../../db/WorkQueueCollection.js';
+export default function addMigrations(repository) {
+    repository?.register({
+        id: 20240905161400,
+        name: 'Remove all autoscheduled work items so they get scheduled freshly',
+        up: async () => {
+            const WorkQueue = await WorkQueueCollection(repository.db);
+            await WorkQueue.deleteMany({
+                autoscheduled: true,
+                started: null,
+                deleted: null,
+            });
+        },
+    });
+}
+//# sourceMappingURL=addMigrations.js.map

package/lib/module/migrations/addMigrations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addMigrations.js","sourceRoot":"","sources":["../../../src/module/migrations/addMigrations.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAEtE,MAAM,CAAC,OAAO,UAAU,aAAa,CAAC,UAA0C;IAC9E,UAAU,EAAE,QAAQ,CAAC;QACnB,EAAE,EAAE,cAAc;QAClB,IAAI,EAAE,mEAAmE;QACzE,EAAE,EAAE,KAAK,IAAI,EAAE;YACb,MAAM,SAAS,GAAG,MAAM,mBAAmB,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAE3D,MAAM,SAAS,CAAC,UAAU,CAAC;gBACzB,aAAa,EAAE,IAAI;gBACnB,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;KACF,CAAC,CAAC;AACL,CAAC"}

package/lib/schedulers/FailedRescheduler.d.ts

@@ -0,0 +1,6 @@
+import { IScheduler, WorkData } from '@unchainedshop/types/worker.js';
+export interface FailedReschedulerParams {
+    retryInput?: (workData: WorkData, priorInput: Record<string, any>) => Promise<Record<string, any> | null>;
+}
+export declare const FailedRescheduler: IScheduler<FailedReschedulerParams>;
+//# sourceMappingURL=FailedRescheduler.d.ts.map

package/lib/schedulers/FailedRescheduler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FailedRescheduler.d.ts","sourceRoot":"","sources":["../../src/schedulers/FailedRescheduler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAQ,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AAK5E,MAAM,WAAW,uBAAuB;IACtC,UAAU,CAAC,EAAE,CACX,QAAQ,EAAE,QAAQ,EAClB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;CAC1C;AAED,eAAO,MAAM,iBAAiB,EAAE,UAAU,CAAC,uBAAuB,CAsDjE,CAAC"}

package/lib/schedulers/FailedRescheduler.js

@@ -0,0 +1,45 @@
+import { log } from '@unchainedshop/logger';
+import { subscribe } from '@unchainedshop/events';
+import { WorkerEventTypes } from '../director/WorkerEventTypes.js';
+export const FailedRescheduler = {
+    key: 'shop.unchained.scheduler.failed',
+    label: 'Reschedule failed works',
+    version: '1.0.0',
+    actions: ({ retryInput }, unchainedAPI) => {
+        const handleFinishedWork = async ({ payload: work }) => {
+            if (!work.success && work.retries > 0) {
+                const now = new Date();
+                const workDelayMs = work.scheduled.getTime() - work.created.getTime();
+                // In short: Double the delay of the old work or delay for 5 seconds
+                const scheduled = workDelayMs > 1000
+                    ? new Date(now.getTime() + workDelayMs * 2)
+                    : new Date(now.setSeconds(now.getSeconds() + 5));
+                log(`${FailedRescheduler.key} -> Reschedule failed work ${work._id} ${work.type} for ${scheduled.toISOString()} (in ${Math.round(workDelayMs / 1000)}). Remaining retries: ${work.retries}`);
+                const workData = {
+                    type: work.type,
+                    priority: work.priority,
+                    originalWorkId: work.originalWorkId || work._id,
+                    retries: work.retries - 1,
+                    timeout: work.timeout,
+                    scheduled,
+                };
+                if (retryInput) {
+                    workData.input = await retryInput(workData, work.input);
+                }
+                else {
+                    workData.input = work.input;
+                }
+                unchainedAPI.modules.worker.addWork(workData);
+            }
+        };
+        return {
+            start() {
+                subscribe(WorkerEventTypes.FINISHED, handleFinishedWork);
+            },
+            stop() {
+                /* */
+            },
+        };
+    },
+};
+//# sourceMappingURL=FailedRescheduler.js.map

package/lib/schedulers/FailedRescheduler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FailedRescheduler.js","sourceRoot":"","sources":["../../src/schedulers/FailedRescheduler.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAE,MAAM,uBAAuB,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AASnE,MAAM,CAAC,MAAM,iBAAiB,GAAwC;IACpE,GAAG,EAAE,iCAAiC;IACtC,KAAK,EAAE,yBAAyB;IAChC,OAAO,EAAE,OAAO;IAEhB,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,YAAY,EAAE,EAAE;QACxC,MAAM,kBAAkB,GAAG,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAqB,EAAE,EAAE;YACxE,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC,EAAE,CAAC;gBACtC,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;gBAEtE,oEAAoE;gBACpE,MAAM,SAAS,GACb,WAAW,GAAG,IAAI;oBAChB,CAAC,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,WAAW,GAAG,CAAC,CAAC;oBAC3C,CAAC,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;gBAErD,GAAG,CACD,GAAG,iBAAiB,CAAC,GAAG,8BAA8B,IAAI,CAAC,GAAG,IAC5D,IAAI,CAAC,IACP,QAAQ,SAAS,CAAC,WAAW,EAAE,QAAQ,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,yBACnE,IAAI,CAAC,OACP,EAAE,CACH,CAAC;gBAEF,MAAM,QAAQ,GAAa;oBACzB,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,QAAQ,EAAE,IAAI,CAAC,QAAQ;oBACvB,cAAc,EAAE,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,GAAG;oBAC/C,OAAO,EAAE,IAAI,CAAC,OAAO,GAAG,CAAC;oBACzB,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,SAAS;iBACV,CAAC;gBAEF,IAAI,UAAU,EAAE,CAAC;oBACf,QAAQ,CAAC,KAAK,GAAG,MAAM,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC1D,CAAC;qBAAM,CAAC;oBACN,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;gBAC9B,CAAC;gBAED,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAChD,CAAC;QACH,CAAC,CAAC;QAEF,OAAO;YACL,KAAK;gBACH,SAAS,CAAO,gBAAgB,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;YACjE,CAAC;YAED,IAAI;gBACF,KAAK;YACP,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC"}

package/lib/workers/BaseWorker.d.ts

@@ -0,0 +1,8 @@
+import { IWorker } from '@unchainedshop/types/worker.js';
+interface WorkerParams {
+    workerId?: string;
+    worker: IWorker<any>;
+}
+export declare const BaseWorker: IWorker<WorkerParams>;
+export {};
+//# sourceMappingURL=BaseWorker.d.ts.map

package/lib/workers/BaseWorker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseWorker.d.ts","sourceRoot":"","sources":["../../src/workers/BaseWorker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAY,MAAM,gCAAgC,CAAC;AAKnE,UAAU,YAAY;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;CACtB;AAED,eAAO,MAAM,UAAU,EAAE,OAAO,CAAC,YAAY,CAuF5C,CAAC"}

package/lib/workers/BaseWorker.js

@@ -0,0 +1,81 @@
+import later from '@breejs/later';
+import { log } from '@unchainedshop/logger';
+import { WorkerDirector } from '../director/WorkerDirector.js';
+export const BaseWorker = {
+    key: 'shop.unchained.worker.base',
+    label: 'Base worker. Do not use this directly.',
+    version: '1.0.0',
+    type: 'BASE',
+    external: false,
+    getFloorDate: (date = new Date()) => {
+        const floored = new Date(Math.floor(date.getTime() / 1000) * 1000);
+        return floored;
+    },
+    actions: ({ workerId, worker }, unchainedAPI) => {
+        log(`${worker.key} -> Initialized ${worker.type}`);
+        const workerActions = {
+            start() {
+                throw new Error(`Not implemented on ${this.constructor.key}`);
+            },
+            stop() {
+                throw new Error(`Not implemented on ${this.constructor.key}`);
+            },
+            reset: async (referenceDate = new Date()) => {
+                await unchainedAPI.modules.worker.markOldWorkAsFailed({
+                    types: WorkerDirector.getActivePluginTypes({ external: false }),
+                    worker: workerId,
+                    referenceDate,
+                });
+            },
+            autorescheduleTypes: async ({ referenceDate }) => {
+                return Promise.all(WorkerDirector.getAutoSchedules().map(async ([scheduleId, workConfig]) => {
+                    if (!workConfig.schedule) {
+                        await unchainedAPI.modules.worker.ensureNoWork({
+                            type: workConfig.type,
+                            priority: workConfig.priority || 0,
+                            scheduleId,
+                        });
+                        return null;
+                    }
+                    const fixedSchedule = { ...workConfig.schedule };
+                    fixedSchedule.schedules[0].s = [0]; // ignore seconds, always run on second 0
+                    const nextDate = later.schedule(fixedSchedule).next(1, referenceDate);
+                    nextDate.setMilliseconds(0);
+                    const workData = {
+                        type: workConfig.type,
+                        scheduleId,
+                        scheduled: nextDate,
+                        timeout: workConfig.timeout,
+                        priority: workConfig.priority || 0,
+                        retries: workConfig.retries || 0,
+                    };
+                    if (workConfig.input) {
+                        workData.input = await workConfig.input(workData);
+                        // A work input fn can skip auto scheduling a new record
+                        // when it explicitly returns a falsish input instead of a dictionary
+                        if (!workData.input)
+                            return null;
+                    }
+                    return unchainedAPI.modules.worker.ensureOneWork(workData);
+                }));
+            },
+            process: async ({ maxWorkItemCount, referenceDate }) => {
+                await workerActions.autorescheduleTypes({
+                    referenceDate,
+                });
+                const processRecursively = async (recursionCounter = 0) => {
+                    if (maxWorkItemCount && maxWorkItemCount < recursionCounter)
+                        return null;
+                    const doneWork = await unchainedAPI.modules.worker.processNextWork(unchainedAPI, workerId);
+                    if (doneWork)
+                        return processRecursively(recursionCounter + 1);
+                    return null;
+                };
+                await processRecursively();
+            },
+        };
+        workerActions.reset();
+        return workerActions;
+    },
+};
+//# sourceMappingURL=BaseWorker.js.map

package/lib/workers/BaseWorker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseWorker.js","sourceRoot":"","sources":["../../src/workers/BaseWorker.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,eAAe,CAAC;AAClC,OAAO,EAAE,GAAG,EAAE,MAAM,uBAAuB,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAO/D,MAAM,CAAC,MAAM,UAAU,GAA0B;IAC/C,GAAG,EAAE,4BAA4B;IACjC,KAAK,EAAE,wCAAwC;IAC/C,OAAO,EAAE,OAAO;IAChB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,KAAK;IAEf,YAAY,EAAE,CAAC,IAAI,GAAG,IAAI,IAAI,EAAE,EAAE,EAAE;QAClC,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QACnE,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAgB,EAAE,YAAY,EAAE,EAAE;QAC5D,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,mBAAmB,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QAEnD,MAAM,aAAa,GAAG;YACpB,KAAK;gBACH,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC;YAChE,CAAC;YAED,IAAI;gBACF,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC;YAChE,CAAC;YAED,KAAK,EAAE,KAAK,EAAE,aAAa,GAAG,IAAI,IAAI,EAAE,EAAE,EAAE;gBAC1C,MAAM,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC;oBACpD,KAAK,EAAE,cAAc,CAAC,oBAAoB,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;oBAC/D,MAAM,EAAE,QAAQ;oBAChB,aAAa;iBACd,CAAC,CAAC;YACL,CAAC;YAED,mBAAmB,EAAE,KAAK,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE;gBAC/C,OAAO,OAAO,CAAC,GAAG,CAChB,cAAc,CAAC,gBAAgB,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE;oBACvE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;wBACzB,MAAM,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC;4BAC7C,IAAI,EAAE,UAAU,CAAC,IAAI;4BACrB,QAAQ,EAAE,UAAU,CAAC,QAAQ,IAAI,CAAC;4BAClC,UAAU;yBACX,CAAC,CAAC;wBACH,OAAO,IAAI,CAAC;oBACd,CAAC;oBAED,MAAM,aAAa,GAAG,EAAE,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC;oBACjD,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,yCAAyC;oBAC7E,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;oBACtE,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;oBAC5B,MAAM,QAAQ,GAAa;wBACzB,IAAI,EAAE,UAAU,CAAC,IAAI;wBACrB,UAAU;wBACV,SAAS,EAAE,QAAQ;wBACnB,OAAO,EAAE,UAAU,CAAC,OAAO;wBAC3B,QAAQ,EAAE,UAAU,CAAC,QAAQ,IAAI,CAAC;wBAClC,OAAO,EAAE,UAAU,CAAC,OAAO,IAAI,CAAC;qBACjC,CAAC;oBACF,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;wBACrB,QAAQ,CAAC,KAAK,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;wBAClD,wDAAwD;wBACxD,qEAAqE;wBACrE,IAAI,CAAC,QAAQ,CAAC,KAAK;4BAAE,OAAO,IAAI,CAAC;oBACnC,CAAC;oBACD,OAAO,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;gBAC7D,CAAC,CAAC,CACH,CAAC;YACJ,CAAC;YAED,OAAO,EAAE,KAAK,EAAE,EAAE,gBAAgB,EAAE,aAAa,EAAE,EAAE,EAAE;gBACrD,MAAM,aAAa,CAAC,mBAAmB,CAAC;oBACtC,aAAa;iBACd,CAAC,CAAC;gBAEH,MAAM,kBAAkB,GAAG,KAAK,EAAE,gBAAgB,GAAG,CAAC,EAAE,EAAE;oBACxD,IAAI,gBAAgB,IAAI,gBAAgB,GAAG,gBAAgB;wBAAE,OAAO,IAAI,CAAC;oBACzE,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;oBAC3F,IAAI,QAAQ;wBAAE,OAAO,kBAAkB,CAAC,gBAAgB,GAAG,CAAC,CAAC,CAAC;oBAC9D,OAAO,IAAI,CAAC;gBACd,CAAC,CAAC;gBAEF,MAAM,kBAAkB,EAAE,CAAC;YAC7B,CAAC;SACF,CAAC;QAEF,aAAa,CAAC,KAAK,EAAE,CAAC;QAEtB,OAAO,aAAa,CAAC;IACvB,CAAC;CACF,CAAC"}

package/lib/workers/EventListenerWorker.d.ts

@@ -0,0 +1,6 @@
+import { IWorker } from '@unchainedshop/types/worker.js';
+export interface EventListenerWorkerParams {
+    workerId?: string;
+}
+export declare const EventListenerWorker: IWorker<EventListenerWorkerParams>;
+//# sourceMappingURL=EventListenerWorker.d.ts.map

package/lib/workers/EventListenerWorker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventListenerWorker.d.ts","sourceRoot":"","sources":["../../src/workers/EventListenerWorker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAgBzD,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,eAAO,MAAM,mBAAmB,EAAE,OAAO,CAAC,yBAAyB,CAyClE,CAAC"}

package/lib/workers/EventListenerWorker.js

@@ -0,0 +1,46 @@
+import { subscribe } from '@unchainedshop/events';
+import { WorkerEventTypes } from '../director/WorkerEventTypes.js';
+import { BaseWorker } from './BaseWorker.js';
+function debounce(func, wait) {
+    let timeout;
+    return (...args) => {
+        clearTimeout(timeout);
+        timeout = setTimeout(() => {
+            timeout = null;
+            func(...args);
+        }, wait);
+    };
+}
+export const EventListenerWorker = {
+    ...BaseWorker,
+    key: 'shop.unchained.worker.event-listener',
+    label: 'Allocates work on events. This worker does not make sense on multiple containers.',
+    version: '1.0.0',
+    type: 'EVENT_LISTENER',
+    actions: ({ workerId }, unchainedAPI) => {
+        const baseWorkerActions = BaseWorker.actions({ workerId, worker: EventListenerWorker }, unchainedAPI);
+        // Debounce in the event of many work queue events conflicting with each other
+        const processWorkQueue = debounce(async () => {
+            await baseWorkerActions.process({
+                maxWorkItemCount: 1, // only one work item at a time, else we could end up in a loop
+                referenceDate: EventListenerWorker.getFloorDate(),
+            });
+        }, 300);
+        return {
+            ...baseWorkerActions,
+            start() {
+                subscribe(WorkerEventTypes.ADDED, processWorkQueue);
+                subscribe(WorkerEventTypes.FINISHED, processWorkQueue);
+                setTimeout(async () => {
+                    await baseWorkerActions.autorescheduleTypes({
+                        referenceDate: EventListenerWorker.getFloorDate(),
+                    });
+                }, 300);
+            },
+            stop() {
+                /* */
+            },
+        };
+    },
+};
+//# sourceMappingURL=EventListenerWorker.js.map

package/lib/workers/EventListenerWorker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventListenerWorker.js","sourceRoot":"","sources":["../../src/workers/EventListenerWorker.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,SAAS,QAAQ,CAAkC,IAAO,EAAE,IAAI;IAC9D,IAAI,OAAO,CAAC;IACZ,OAAO,CAAC,GAAG,IAAI,EAAE,EAAE;QACjB,YAAY,CAAC,OAAO,CAAC,CAAC;QACtB,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;YACxB,OAAO,GAAG,IAAI,CAAC;YACf,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QAChB,CAAC,EAAE,IAAI,CAAC,CAAC;IACX,CAAC,CAAC;AACJ,CAAC;AAMD,MAAM,CAAC,MAAM,mBAAmB,GAAuC;IACrE,GAAG,UAAU;IAEb,GAAG,EAAE,sCAAsC;IAC3C,KAAK,EAAE,mFAAmF;IAC1F,OAAO,EAAE,OAAO;IAChB,IAAI,EAAE,gBAAgB;IAEtB,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,EAAE;QACtC,MAAM,iBAAiB,GAAG,UAAU,CAAC,OAAO,CAC1C,EAAE,QAAQ,EAAE,MAAM,EAAE,mBAAmB,EAAE,EACzC,YAAY,CACb,CAAC;QAEF,8EAA8E;QAC9E,MAAM,gBAAgB,GAAG,QAAQ,CAAsB,KAAK,IAAI,EAAE;YAChE,MAAM,iBAAiB,CAAC,OAAO,CAAC;gBAC9B,gBAAgB,EAAE,CAAC,EAAE,+DAA+D;gBACpF,aAAa,EAAE,mBAAmB,CAAC,YAAY,EAAE;aAClD,CAAC,CAAC;QACL,CAAC,EAAE,GAAG,CAAC,CAAC;QAER,OAAO;YACL,GAAG,iBAAiB;YAEpB,KAAK;gBACH,SAAS,CAAC,gBAAgB,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;gBACpD,SAAS,CAAC,gBAAgB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;gBAEvD,UAAU,CAAC,KAAK,IAAI,EAAE;oBACpB,MAAM,iBAAiB,CAAC,mBAAmB,CAAC;wBAC1C,aAAa,EAAE,mBAAmB,CAAC,YAAY,EAAE;qBAClD,CAAC,CAAC;gBACL,CAAC,EAAE,GAAG,CAAC,CAAC;YACV,CAAC;YAED,IAAI;gBACF,KAAK;YACP,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC"}

package/lib/workers/IntervalWorker.d.ts

@@ -0,0 +1,9 @@
+import { IWorker, WorkerSchedule } from '@unchainedshop/types/worker.js';
+export interface IntervalWorkerParams {
+    workerId?: string;
+    batchCount?: number;
+    schedule?: WorkerSchedule | string;
+}
+export declare const scheduleToInterval: (scheduleRaw: WorkerSchedule | string) => number;
+export declare const IntervalWorker: IWorker<IntervalWorkerParams>;
+//# sourceMappingURL=IntervalWorker.d.ts.map

package/lib/workers/IntervalWorker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IntervalWorker.d.ts","sourceRoot":"","sources":["../../src/workers/IntervalWorker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAMzE,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC;CACpC;AAMD,eAAO,MAAM,kBAAkB,gBAAiB,cAAc,GAAG,MAAM,WAMtE,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,OAAO,CAAC,oBAAoB,CA+BxD,CAAC"}

package/lib/workers/IntervalWorker.js

@@ -0,0 +1,38 @@
+import later from '@breejs/later';
+import { BaseWorker } from './BaseWorker.js';
+const { NODE_ENV } = process.env;
+const defaultSchedule = later.parse.text(NODE_ENV !== 'production' ? 'every 2 seconds' : 'every 30 seconds');
+export const scheduleToInterval = (scheduleRaw) => {
+    const referenceDate = new Date(1000);
+    const schedule = typeof scheduleRaw === 'string' ? later.parse.text(scheduleRaw) : scheduleRaw;
+    const [one, two] = later.schedule(schedule).next(2, referenceDate);
+    const diff = new Date(two).getTime() - new Date(one).getTime();
+    return Math.min(1000 * 60 * 60, diff); // at least once every hour!
+};
+export const IntervalWorker = {
+    ...BaseWorker,
+    key: 'shop.unchained.worker.cron',
+    label: 'Allocates work on fixed intervals with native node setInterval',
+    version: '1.0.0',
+    type: 'CRON',
+    actions: ({ workerId, batchCount = 0, schedule = defaultSchedule }, unchainedAPI) => {
+        const baseWorkerActions = BaseWorker.actions({ workerId, worker: IntervalWorker }, unchainedAPI);
+        const intervalDelay = scheduleToInterval(schedule);
+        let intervalHandle;
+        return {
+            ...baseWorkerActions,
+            start() {
+                intervalHandle = setInterval(() => {
+                    baseWorkerActions.process({
+                        maxWorkItemCount: batchCount,
+                        referenceDate: IntervalWorker.getFloorDate(),
+                    });
+                }, intervalDelay);
+            },
+            stop() {
+                clearInterval(intervalHandle);
+            },
+        };
+    },
+};
+//# sourceMappingURL=IntervalWorker.js.map

package/lib/workers/IntervalWorker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IntervalWorker.js","sourceRoot":"","sources":["../../src/workers/IntervalWorker.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,eAAe,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;AAQjC,MAAM,eAAe,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CACtC,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,kBAAkB,CACjD,CAAC;AAEpB,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,WAAoC,EAAE,EAAE;IACzE,MAAM,aAAa,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,QAAQ,GAAG,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;IAC/F,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;IACnE,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC;IAC/D,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,EAAE,GAAG,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,4BAA4B;AACrE,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAkC;IAC3D,GAAG,UAAU;IAEb,GAAG,EAAE,4BAA4B;IACjC,KAAK,EAAE,gEAAgE;IACvE,OAAO,EAAE,OAAO;IAChB,IAAI,EAAE,MAAM;IAEZ,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,UAAU,GAAG,CAAC,EAAE,QAAQ,GAAG,eAAe,EAAE,EAAE,YAAY,EAAE,EAAE;QAClF,MAAM,iBAAiB,GAAG,UAAU,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,EAAE,EAAE,YAAY,CAAC,CAAC;QAEjG,MAAM,aAAa,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACnD,IAAI,cAA8B,CAAC;QAEnC,OAAO;YACL,GAAG,iBAAiB;YAEpB,KAAK;gBACH,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE;oBAChC,iBAAiB,CAAC,OAAO,CAAC;wBACxB,gBAAgB,EAAE,UAAU;wBAC5B,aAAa,EAAE,cAAc,CAAC,YAAY,EAAE;qBAC7C,CAAC,CAAC;gBACL,CAAC,EAAE,aAAa,CAAC,CAAC;YACpB,CAAC;YAED,IAAI;gBACF,aAAa,CAAC,cAAc,CAAC,CAAC;YAChC,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unchainedshop/core-worker",
-  "version": "4.0.0-rc.9",
+  "version": "4.0.0",
   "main": "lib/worker-index.js",
   "types": "lib/worker-index.d.ts",
   "type": "module",
@@ -31,8 +31,8 @@
   },
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "dependencies": {
-    "@unchainedshop/logger": "^4.0.0-rc.4",
-    "@unchainedshop/utils": "^4.0.0-rc.4"
+    "@unchainedshop/logger": "^4.0.0",
+    "@unchainedshop/utils": "^4.0.0"
   },
   "devDependencies": {
     "@types/node": "^24.0.13",

package/src/db/WorkQueueCollection.ts

@@ -12,7 +12,7 @@ export enum WorkStatus {
 }
 
 export type Work = {
-  _id?: string;
+  _id: string;
   priority: number;
   retries: number;
   scheduled: Date;
@@ -25,7 +25,7 @@ export type Work = {
   started?: Date;
   success?: boolean;
   timeout?: number;
-  worker?: string;
+  worker?: string | null;
   autoscheduled?: boolean;
   scheduleId?: string;
 } & TimestampFields;
@@ -33,6 +33,24 @@ export type Work = {
 export const WorkQueueCollection = async (db: mongodb.Db) => {
   const WorkQueue = db.collection<Work>('work_queue');
 
+  if (!isDocumentDBCompatModeEnabled()) {
+    await buildDbIndexes<Work>(WorkQueue, [
+      {
+        index: { originalWorkId: 'text', _id: 'text', worker: 'text', input: 'text', type: 'text' },
+        options: {
+          weights: {
+            _id: 8,
+            originalWorkId: 6,
+            type: 5,
+            worker: 4,
+            input: 2,
+          },
+          name: 'workqueue_fulltext_search',
+        },
+      },
+    ]);
+  }
+
   await buildDbIndexes<Work>(WorkQueue, [
     {
       index: { created: -1 },
@@ -44,19 +62,6 @@ export const WorkQueueCollection = async (db: mongodb.Db) => {
     { index: { priority: -1 } },
     { index: { type: 1 } },
     { index: { originalWorkId: 1 } },
-    !isDocumentDBCompatModeEnabled() && {
-      index: { originalWorkId: 'text', _id: 'text', worker: 'text', input: 'text', type: 'text' },
-      options: {
-        weights: {
-          _id: 8,
-          originalWorkId: 6,
-          type: 5,
-          worker: 4,
-          input: 2,
-        },
-        name: 'workqueue_fulltext_search',
-      },
-    },
   ]);
 
   return WorkQueue;

package/src/module/configureWorkerModule.ts

@@ -25,8 +25,9 @@ const logger = createLogger('unchained:core-worker');
 
 export type WorkData = Pick<
   Partial<Work>,
-  'input' | 'originalWorkId' | 'priority' | 'retries' | 'timeout' | 'scheduled' | 'worker' | 'scheduleId'
-> & { type: string };
+  'input' | 'originalWorkId' | 'priority' | 'retries' | 'timeout' | 'worker' | 'scheduleId'
+> &
+  Pick<Work, 'type' | 'scheduled'>;
 
 export interface WorkResult<Result = unknown> {
   success: boolean;
@@ -58,7 +59,7 @@ export interface WorkerReport {
 export interface WorkQueueQuery {
   created?: { end?: Date; start?: Date };
   types?: string[];
-  status: WorkStatus[];
+  status?: WorkStatus[];
   queryString?: string;
   scheduled?: { end?: Date; start?: Date };
 }
@@ -162,7 +163,7 @@ const defaultSort: { key: string; value: SortDirection }[] = [
   { key: 'created', value: SortDirection.ASC },
 ];
 
-const normalizeWorkQueueAggregateResult = (data = []): WorkerReport[] => {
+const normalizeWorkQueueAggregateResult = (data: mongodb.Document[] = []): WorkerReport[] => {
   const statusToFieldMap = {
     NEW: 'newCount',
     ALLOCATED: 'startCount',
@@ -204,7 +205,7 @@ export const configureWorkerModule = async ({ db, options }: ModuleInput<WorkerS
   }: {
     types: string[];
     worker: string;
-  }): Promise<Work> => {
+  }) => {
     // Find a work item that is scheduled for now and is not started.
     // Also:
     // - Restrict by types and worker if provided
@@ -223,10 +224,8 @@ export const configureWorkerModule = async ({ db, options }: ModuleInput<WorkerS
       { sort: buildSortOptions(defaultSort), returnDocument: 'after' },
     );
 
-    if (result) {
-      emit(WorkerEventTypes.ALLOCATED, removePrivateFields(result));
-    }
-
+    if (!result) return null;
+    emit(WorkerEventTypes.ALLOCATED, removePrivateFields(result));
     return result;
   };
 
@@ -244,7 +243,7 @@ export const configureWorkerModule = async ({ db, options }: ModuleInput<WorkerS
       started?: Date;
       worker?: string;
     },
-  ): Promise<Work> => {
+  ) => {
     const workBeforeUpdate = await WorkQueue.findOne(
       buildQuerySelector({ workId, status: [WorkStatus.ALLOCATED] }),
     );
@@ -267,7 +266,9 @@ export const configureWorkerModule = async ({ db, options }: ModuleInput<WorkerS
       { returnDocument: 'after' },
     );
 
-    const duration = new Date(work.finished).getTime() - new Date(work.started).getTime();
+    if (!work) return null;
+
+    const duration = new Date(work.finished!).getTime() - new Date(work.started!).getTime();
     if (work.success) {
       logger.debug(`${work.type} finished with success (${duration}ms)`, {
         workId,
@@ -295,14 +296,20 @@ export const configureWorkerModule = async ({ db, options }: ModuleInput<WorkerS
       return typeList.map((t) => t._id as string);
     },
 
-    findWork: async ({
-      workId,
-      originalWorkId,
-    }: {
-      workId?: string;
-      originalWorkId?: string;
-    }): Promise<Work> =>
-      WorkQueue.findOne(workId ? generateDbFilterById(workId) : { originalWorkId }, {}),
+    findWork: async (
+      params:
+        | {
+            workId: string;
+          }
+        | {
+            originalWorkId: string;
+          },
+    ) => {
+      if ('workId' in params) {
+        return WorkQueue.findOne(generateDbFilterById(params.workId), {});
+      }
+      return WorkQueue.findOne({ originalWorkId: params.originalWorkId }, {});
+    },
 
     findWorkQueue: async ({
       limit,
@@ -397,7 +404,7 @@ export const configureWorkerModule = async ({ db, options }: ModuleInput<WorkerS
     },
 
     // Mutations
-    addWork: async ({
+    async addWork({
       type,
       input,
       priority = 0,
@@ -405,13 +412,14 @@ export const configureWorkerModule = async ({ db, options }: ModuleInput<WorkerS
       originalWorkId,
       worker = null,
       retries = 20,
-    }: WorkData): Promise<Work> => {
+    }: Pick<Work, 'type' | 'originalWorkId' | 'worker'> &
+      Pick<Partial<Work>, 'scheduled' | 'priority' | 'input' | 'retries'>): Promise<Work> {
       const created = new Date();
       const { insertedId: workId } = await WorkQueue.insertOne({
         _id: generateDbObjectId(),
         created,
         type,
-        input,
+        input: input || {},
         priority,
         scheduled: scheduled || created,
         originalWorkId,
@@ -423,13 +431,13 @@ export const configureWorkerModule = async ({ db, options }: ModuleInput<WorkerS
         workId,
       });
 
-      const work = await WorkQueue.findOne(generateDbFilterById(workId), {});
+      const work = (await WorkQueue.findOne(generateDbFilterById(workId), {})) as Work;
       emit(WorkerEventTypes.ADDED, removePrivateFields(work));
 
       return work;
     },
 
-    rescheduleWork: async (currentWork: Work, scheduled: Date): Promise<Work> => {
+    rescheduleWork: async (currentWork: Work, scheduled: Date) => {
       const work = await WorkQueue.findOneAndUpdate(
         generateDbFilterById(currentWork._id),
         {
@@ -441,6 +449,7 @@ export const configureWorkerModule = async ({ db, options }: ModuleInput<WorkerS
         { returnDocument: 'after' },
       );
 
+      if (!work) return null;
       emit(WorkerEventTypes.RESCHEDULED, {
         work: removePrivateFields(work),
         oldScheduled: currentWork.scheduled,
@@ -484,7 +493,7 @@ export const configureWorkerModule = async ({ db, options }: ModuleInput<WorkerS
       originalWorkId,
       retries = 20,
       scheduleId,
-    }: WorkData): Promise<Work> => {
+    }: WorkData) => {
       const workId = `${scheduleId}:${scheduled.getTime()}`;
 
       const created = new Date();
@@ -528,7 +537,7 @@ export const configureWorkerModule = async ({ db, options }: ModuleInput<WorkerS
           },
         );
 
-        if (!result.lastErrorObject.updatedExisting) {
+        if (!result.lastErrorObject) {
           logger.debug(`${type} auto-scheduled @ ${new Date(scheduled).toISOString()}`, {
             workId,
           });
@@ -547,7 +556,7 @@ export const configureWorkerModule = async ({ db, options }: ModuleInput<WorkerS
 
     finishWork,
 
-    deleteWork: async (workId: string): Promise<Work> => {
+    deleteWork: async (workId: string) => {
       const workBeforeRemoval = await WorkQueue.findOne(
         buildQuerySelector({
           workId,
@@ -566,8 +575,8 @@ export const configureWorkerModule = async ({ db, options }: ModuleInput<WorkerS
         { returnDocument: 'after' },
       );
 
+      if (!work) return null;
       emit(WorkerEventTypes.DELETED, removePrivateFields(work));
-
       return work;
     },
 
@@ -590,21 +599,23 @@ export const configureWorkerModule = async ({ db, options }: ModuleInput<WorkerS
         { projection: { _id: true }, sort: { test: 1 } },
       ).toArray();
 
-      return Promise.all(
-        workQueue.map(({ _id }) =>
-          finishWork(_id as string, {
-            finished: new Date(),
-            result: null,
-            success: false,
-            error: {
-              name: DIRECTOR_MARKED_FAILED_ERROR,
-              message:
-                'Director marked old work as failed after restart. This work was eventually running at the moment when node.js exited.',
-            },
-            worker,
-          }),
-        ),
-      );
+      return (
+        await Promise.all(
+          workQueue.map(({ _id }) =>
+            finishWork(_id as string, {
+              finished: new Date(),
+              result: null,
+              success: false,
+              error: {
+                name: DIRECTOR_MARKED_FAILED_ERROR,
+                message:
+                  'Director marked old work as failed after restart. This work was eventually running at the moment when node.js exited.',
+              },
+              worker,
+            }),
+          ),
+        )
+      ).filter(Boolean) as Work[];
     },
 
     getReport: async ({
@@ -614,13 +625,13 @@ export const configureWorkerModule = async ({ db, options }: ModuleInput<WorkerS
       types?: string[];
       dateRange?: DateFilterInput;
     }): Promise<WorkerReport[]> => {
-      const pipeline = [];
-      const matchConditions = [];
+      const pipeline: mongodb.BSON.Document[] = [];
+      const matchConditions: any[] = [];
       // build date filter based on provided values it can be a range if both to and from is supplied
       // a upper or lowe limit if either from or to is provided
       // or all if none is provided
       if (dateRange?.start || dateRange?.end) {
-        const dateConditions = [];
+        const dateConditions: any[] = [];
         if (dateRange?.start) {
           const fromDate = new Date(dateRange?.start);
           dateConditions.push({

package/tsconfig.json

@@ -3,7 +3,8 @@
   "compilerOptions": {
     "declarationDir": "./lib",
     "rootDir": "./src",
-    "outDir": "./lib"
+    "outDir": "./lib",
+    
   },
   "exclude": ["**/*.test.ts", "**/*.test.js", "tests", "lib"]
 }