@vendure/core 3.2.4 → 3.3.1

package/dist/plugin/default-scheduler-plugin/default-scheduler-strategy.js

@@ -0,0 +1,203 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultSchedulerStrategy = void 0;
+const ms_1 = __importDefault(require("ms"));
+const utils_1 = require("../../common/utils");
+const config_service_1 = require("../../config/config.service");
+const vendure_logger_1 = require("../../config/logger/vendure-logger");
+const connection_1 = require("../../connection");
+const process_context_1 = require("../../process-context");
+const constants_1 = require("./constants");
+const scheduled_task_record_entity_1 = require("./scheduled-task-record.entity");
+/**
+ * @description
+ * The default {@link SchedulerStrategy} implementation that uses the database to
+ * execute scheduled tasks. This strategy is configured when you use the
+ * {@link DefaultSchedulerPlugin}.
+ *
+ * @since 3.3.0
+ * @docsCategory scheduled-tasks
+ */
+class DefaultSchedulerStrategy {
+    constructor() {
+        this.tasks = new Map();
+        this.runningTasks = [];
+    }
+    init(injector) {
+        this.connection = injector.get(connection_1.TransactionalConnection);
+        this.pluginOptions = injector.get(constants_1.DEFAULT_SCHEDULER_PLUGIN_OPTIONS);
+        this.injector = injector;
+        const runTriggerCheck = injector.get(config_service_1.ConfigService).schedulerOptions.runTasksInWorkerOnly === false ||
+            injector.get(process_context_1.ProcessContext).isWorker;
+        if (runTriggerCheck) {
+            this.intervalRef = setInterval(() => this.checkForManuallyTriggeredTasks(), this.pluginOptions.manualTriggerCheckInterval);
+        }
+    }
+    async destroy() {
+        if (this.intervalRef) {
+            clearInterval(this.intervalRef);
+        }
+        for (const task of this.runningTasks) {
+            await this.connection.rawConnection
+                .getRepository(scheduled_task_record_entity_1.ScheduledTaskRecord)
+                .update({ taskId: task.id }, { lockedAt: null });
+            vendure_logger_1.Logger.info(`Released lock for task "${task.id}"`);
+        }
+    }
+    registerTask(task) {
+        this.tasks.set(task.id, {
+            task,
+            isRegistered: false,
+        });
+    }
+    executeTask(task) {
+        return async (job) => {
+            var _a;
+            await this.ensureTaskIsRegistered(task);
+            const taskEntity = await this.connection.rawConnection
+                .getRepository(scheduled_task_record_entity_1.ScheduledTaskRecord)
+                .createQueryBuilder('task')
+                .update()
+                .set({ lockedAt: new Date() })
+                .where('taskId = :taskId', { taskId: task.id })
+                .andWhere('lockedAt IS NULL')
+                .andWhere('enabled = TRUE')
+                .execute();
+            if (!taskEntity.affected) {
+                return;
+            }
+            vendure_logger_1.Logger.verbose(`Executing scheduled task "${task.id}"`);
+            try {
+                this.runningTasks.push(task);
+                const timeout = (_a = task.options.timeout) !== null && _a !== void 0 ? _a : this.pluginOptions.defaultTimeout;
+                const timeoutMs = typeof timeout === 'number' ? timeout : (0, ms_1.default)(timeout);
+                let timeoutTimer;
+                const timeoutPromise = new Promise((_, reject) => {
+                    timeoutTimer = setTimeout(() => {
+                        vendure_logger_1.Logger.warn(`Scheduled task ${task.id} timed out after ${timeoutMs}ms`);
+                        reject(new Error('Task timed out'));
+                    }, timeoutMs);
+                });
+                const result = await Promise.race([task.execute(this.injector), timeoutPromise]);
+                if (timeoutTimer) {
+                    clearTimeout(timeoutTimer);
+                }
+                await this.connection.rawConnection.getRepository(scheduled_task_record_entity_1.ScheduledTaskRecord).update({
+                    taskId: task.id,
+                }, {
+                    lastExecutedAt: new Date(),
+                    lockedAt: null,
+                    lastResult: result !== null && result !== void 0 ? result : '',
+                });
+                vendure_logger_1.Logger.verbose(`Scheduled task "${task.id}" completed successfully`);
+                this.runningTasks = this.runningTasks.filter(t => t !== task);
+            }
+            catch (error) {
+                let errorMessage = 'Unknown error';
+                if (error instanceof Error) {
+                    errorMessage = error.message;
+                }
+                vendure_logger_1.Logger.error(`Scheduled task "${task.id}" failed with error: ${errorMessage}`);
+                await this.connection.rawConnection.getRepository(scheduled_task_record_entity_1.ScheduledTaskRecord).update({
+                    taskId: task.id,
+                }, {
+                    lockedAt: null,
+                    lastResult: { error: errorMessage },
+                });
+                this.runningTasks = this.runningTasks.filter(t => t !== task);
+            }
+        };
+    }
+    async getTasks() {
+        await this.ensureAllTasksAreRegistered();
+        return this.connection.rawConnection
+            .getRepository(scheduled_task_record_entity_1.ScheduledTaskRecord)
+            .createQueryBuilder('task')
+            .getMany()
+            .then(tasks => {
+            return tasks.map(task => this.entityToReport(task));
+        });
+    }
+    async getTask(id) {
+        await this.ensureTaskIsRegistered(id);
+        return this.connection.rawConnection
+            .getRepository(scheduled_task_record_entity_1.ScheduledTaskRecord)
+            .createQueryBuilder('task')
+            .where('task.taskId = :id', { id })
+            .getOne()
+            .then(task => (task ? this.entityToReport(task) : undefined));
+    }
+    async updateTask(input) {
+        await this.connection.rawConnection
+            .getRepository(scheduled_task_record_entity_1.ScheduledTaskRecord)
+            .createQueryBuilder('task')
+            .update()
+            .set({ enabled: input.enabled })
+            .where('taskId = :id', { id: input.id })
+            .execute();
+        return (0, utils_1.assertFound)(this.getTask(input.id));
+    }
+    async triggerTask(task) {
+        vendure_logger_1.Logger.info(`Triggering task: ${task.id}`);
+        await this.ensureTaskIsRegistered(task);
+        await this.connection.rawConnection
+            .getRepository(scheduled_task_record_entity_1.ScheduledTaskRecord)
+            .createQueryBuilder('task')
+            .update()
+            .set({ manuallyTriggeredAt: new Date() })
+            .where('taskId = :id', { id: task.id })
+            .execute();
+    }
+    async checkForManuallyTriggeredTasks() {
+        const taskEntities = await this.connection.rawConnection
+            .getRepository(scheduled_task_record_entity_1.ScheduledTaskRecord)
+            .createQueryBuilder('task')
+            .where('task.manuallyTriggeredAt IS NOT NULL')
+            .getMany();
+        vendure_logger_1.Logger.debug(`Checking for manually triggered tasks: ${taskEntities.length}`);
+        for (const taskEntity of taskEntities) {
+            await this.connection.rawConnection
+                .getRepository(scheduled_task_record_entity_1.ScheduledTaskRecord)
+                .update({ taskId: taskEntity.taskId }, { manuallyTriggeredAt: null });
+            const task = this.tasks.get(taskEntity.taskId);
+            if (task) {
+                vendure_logger_1.Logger.info(`Executing manually triggered task: ${task.task.id}`);
+                void this.executeTask(task.task)();
+            }
+        }
+    }
+    entityToReport(task) {
+        return {
+            id: task.taskId,
+            lastExecutedAt: task.lastExecutedAt,
+            isRunning: task.lockedAt !== null,
+            lastResult: task.lastResult,
+            enabled: task.enabled,
+        };
+    }
+    async ensureAllTasksAreRegistered() {
+        for (const task of this.tasks.values()) {
+            await this.ensureTaskIsRegistered(task.task);
+        }
+    }
+    async ensureTaskIsRegistered(taskOrId) {
+        const taskId = typeof taskOrId === 'string' ? taskOrId : taskOrId.id;
+        const task = this.tasks.get(taskId);
+        if (task && !task.isRegistered) {
+            await this.connection.rawConnection
+                .getRepository(scheduled_task_record_entity_1.ScheduledTaskRecord)
+                .createQueryBuilder()
+                .insert()
+                .into(scheduled_task_record_entity_1.ScheduledTaskRecord)
+                .values({ taskId })
+                .orIgnore()
+                .execute();
+            this.tasks.set(taskId, { task: task.task, isRegistered: true });
+        }
+    }
+}
+exports.DefaultSchedulerStrategy = DefaultSchedulerStrategy;
+//# sourceMappingURL=default-scheduler-strategy.js.map

package/dist/plugin/default-scheduler-plugin/default-scheduler-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-scheduler-strategy.js","sourceRoot":"","sources":["../../../src/plugin/default-scheduler-plugin/default-scheduler-strategy.ts"],"names":[],"mappings":";;;;;;AAEA,4CAAoB;AAGpB,8CAAiD;AACjD,gEAA4D;AAC5D,uEAA4D;AAC5D,iDAA2D;AAC3D,2DAAuD;AAIvD,2CAA+D;AAC/D,iFAAqE;AAGrE;;;;;;;;GAQG;AACH,MAAa,wBAAwB;IAArC;QAIqB,UAAK,GAAgE,IAAI,GAAG,EAAE,CAAC;QAExF,iBAAY,GAAoB,EAAE,CAAC;IA4M/C,CAAC;IA1MG,IAAI,CAAC,QAAkB;QACnB,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,GAAG,CAAC,oCAAuB,CAAC,CAAC;QACxD,IAAI,CAAC,aAAa,GAAG,QAAQ,CAAC,GAAG,CAAC,4CAAgC,CAAC,CAAC;QACpE,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,MAAM,eAAe,GACjB,QAAQ,CAAC,GAAG,CAAC,8BAAa,CAAC,CAAC,gBAAgB,CAAC,oBAAoB,KAAK,KAAK;YAC3E,QAAQ,CAAC,GAAG,CAAC,gCAAc,CAAC,CAAC,QAAQ,CAAC;QAE1C,IAAI,eAAe,EAAE,CAAC;YAClB,IAAI,CAAC,WAAW,GAAG,WAAW,CAC1B,GAAG,EAAE,CAAC,IAAI,CAAC,8BAA8B,EAAE,EAC3C,IAAI,CAAC,aAAa,CAAC,0BAAoC,CAC1D,CAAC;QACN,CAAC;IACL,CAAC;IAED,KAAK,CAAC,OAAO;QACT,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACnB,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACpC,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACnC,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;iBAC9B,aAAa,CAAC,kDAAmB,CAAC;iBAClC,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;YACrD,uBAAM,CAAC,IAAI,CAAC,2BAA2B,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QACvD,CAAC;IACL,CAAC;IAED,YAAY,CAAC,IAAmB;QAC5B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE;YACpB,IAAI;YACJ,YAAY,EAAE,KAAK;SACtB,CAAC,CAAC;IACP,CAAC;IAED,WAAW,CAAC,IAAmB;QAC3B,OAAO,KAAK,EAAE,GAAU,EAAE,EAAE;;YACxB,MAAM,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;YACxC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;iBACjD,aAAa,CAAC,kDAAmB,CAAC;iBAClC,kBAAkB,CAAC,MAAM,CAAC;iBAC1B,MAAM,EAAE;iBACR,GAAG,CAAC,EAAE,QAAQ,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC;iBAC7B,KAAK,CAAC,kBAAkB,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;iBAC9C,QAAQ,CAAC,kBAAkB,CAAC;iBAC5B,QAAQ,CAAC,gBAAgB,CAAC;iBAC1B,OAAO,EAAE,CAAC;YACf,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;gBACvB,OAAO;YACX,CAAC;YAED,uBAAM,CAAC,OAAO,CAAC,6BAA6B,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;YACxD,IAAI,CAAC;gBACD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC7B,MAAM,OAAO,GAAG,MAAA,IAAI,CAAC,OAAO,CAAC,OAAO,mCAAK,IAAI,CAAC,aAAa,CAAC,cAAyB,CAAC;gBACtF,MAAM,SAAS,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAA,YAAE,EAAC,OAAO,CAAC,CAAC;gBAEtE,IAAI,YAAwC,CAAC;gBAC7C,MAAM,cAAc,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;oBAC7C,YAAY,GAAG,UAAU,CAAC,GAAG,EAAE;wBAC3B,uBAAM,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,EAAE,oBAAoB,SAAS,IAAI,CAAC,CAAC;wBACxE,MAAM,CAAC,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;oBACxC,CAAC,EAAE,SAAS,CAAC,CAAC;gBAClB,CAAC,CAAC,CAAC;gBAEH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC;gBAEjF,IAAI,YAAY,EAAE,CAAC;oBACf,YAAY,CAAC,YAAY,CAAC,CAAC;gBAC/B,CAAC;gBAED,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,aAAa,CAAC,kDAAmB,CAAC,CAAC,MAAM,CACzE;oBACI,MAAM,EAAE,IAAI,CAAC,EAAE;iBAClB,EACD;oBACI,cAAc,EAAE,IAAI,IAAI,EAAE;oBAC1B,QAAQ,EAAE,IAAI;oBACd,UAAU,EAAE,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE;iBAC3B,CACJ,CAAC;gBACF,uBAAM,CAAC,OAAO,CAAC,mBAAmB,IAAI,CAAC,EAAE,0BAA0B,CAAC,CAAC;gBACrE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;YAClE,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,IAAI,YAAY,GAAG,eAAe,CAAC;gBACnC,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;oBACzB,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC;gBACjC,CAAC;gBACD,uBAAM,CAAC,KAAK,CAAC,mBAAmB,IAAI,CAAC,EAAE,wBAAwB,YAAY,EAAE,CAAC,CAAC;gBAC/E,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,aAAa,CAAC,kDAAmB,CAAC,CAAC,MAAM,CACzE;oBACI,MAAM,EAAE,IAAI,CAAC,EAAE;iBAClB,EACD;oBACI,QAAQ,EAAE,IAAI;oBACd,UAAU,EAAE,EAAE,KAAK,EAAE,YAAY,EAAS;iBAC7C,CACJ,CAAC;gBACF,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;YAClE,CAAC;QACL,CAAC,CAAC;IACN,CAAC;IAED,KAAK,CAAC,QAAQ;QACV,MAAM,IAAI,CAAC,2BAA2B,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa;aAC/B,aAAa,CAAC,kDAAmB,CAAC;aAClC,kBAAkB,CAAC,MAAM,CAAC;aAC1B,OAAO,EAAE;aACT,IAAI,CAAC,KAAK,CAAC,EAAE;YACV,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;IACX,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,EAAU;QACpB,MAAM,IAAI,CAAC,sBAAsB,CAAC,EAAE,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa;aAC/B,aAAa,CAAC,kDAAmB,CAAC;aAClC,kBAAkB,CAAC,MAAM,CAAC;aAC1B,KAAK,CAAC,mBAAmB,EAAE,EAAE,EAAE,EAAE,CAAC;aAClC,MAAM,EAAE;aACR,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IACtE,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAA+B;QAC5C,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;aAC9B,aAAa,CAAC,kDAAmB,CAAC;aAClC,kBAAkB,CAAC,MAAM,CAAC;aAC1B,MAAM,EAAE;aACR,GAAG,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;aAC/B,KAAK,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;aACvC,OAAO,EAAE,CAAC;QACf,OAAO,IAAA,mBAAW,EAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAmB;QACjC,uBAAM,CAAC,IAAI,CAAC,oBAAoB,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QAC3C,MAAM,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;QACxC,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;aAC9B,aAAa,CAAC,kDAAmB,CAAC;aAClC,kBAAkB,CAAC,MAAM,CAAC;aAC1B,MAAM,EAAE;aACR,GAAG,CAAC,EAAE,mBAAmB,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC;aACxC,KAAK,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;aACtC,OAAO,EAAE,CAAC;IACnB,CAAC;IAEO,KAAK,CAAC,8BAA8B;QACxC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;aACnD,aAAa,CAAC,kDAAmB,CAAC;aAClC,kBAAkB,CAAC,MAAM,CAAC;aAC1B,KAAK,CAAC,sCAAsC,CAAC;aAC7C,OAAO,EAAE,CAAC;QAEf,uBAAM,CAAC,KAAK,CAAC,0CAA0C,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;QAE9E,KAAK,MAAM,UAAU,IAAI,YAAY,EAAE,CAAC;YACpC,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;iBAC9B,aAAa,CAAC,kDAAmB,CAAC;iBAClC,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,EAAE,EAAE,mBAAmB,EAAE,IAAI,EAAE,CAAC,CAAC;YAE1E,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC/C,IAAI,IAAI,EAAE,CAAC;gBACP,uBAAM,CAAC,IAAI,CAAC,sCAAsC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;gBAClE,KAAK,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACvC,CAAC;QACL,CAAC;IACL,CAAC;IAEO,cAAc,CAAC,IAAyB;QAC5C,OAAO;YACH,EAAE,EAAE,IAAI,CAAC,MAAM;YACf,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,SAAS,EAAE,IAAI,CAAC,QAAQ,KAAK,IAAI;YACjC,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO;SACxB,CAAC;IACN,CAAC;IAEO,KAAK,CAAC,2BAA2B;QACrC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC;YACrC,MAAM,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjD,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,sBAAsB,CAAC,QAAgC;QACjE,MAAM,MAAM,GAAG,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YAC7B,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa;iBAC9B,aAAa,CAAC,kDAAmB,CAAC;iBAClC,kBAAkB,EAAE;iBACpB,MAAM,EAAE;iBACR,IAAI,CAAC,kDAAmB,CAAC;iBACzB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;iBAClB,QAAQ,EAAE;iBACV,OAAO,EAAE,CAAC;YAEf,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;QACpE,CAAC;IACL,CAAC;CACJ;AAlND,4DAkNC"}

package/dist/plugin/default-scheduler-plugin/default-scheduler.plugin.d.ts

@@ -0,0 +1,31 @@
+import { DefaultSchedulerPluginOptions } from './types';
+/**
+ * @description
+ * This plugin configures a default scheduling strategy that executes scheduled
+ * tasks using the database to ensure that each task is executed exactly once
+ * at the scheduled time, even if there are multiple instances of the worker
+ * running.
+ *
+ * @example
+ * ```ts
+ * import { DefaultSchedulerPlugin, VendureConfig } from '@vendure/core';
+ *
+ * export const config: VendureConfig = {
+ *   plugins: [
+ *     DefaultSchedulerPlugin.init({
+ *       // The default is 60s, but you can override it here
+ *       defaultTimeout: '10s',
+ *     }),
+ *   ],
+ * };
+ * ```
+ *
+ * @since 3.3.0
+ * @docsCategory scheduled-tasks
+ * @docsPage DefaultSchedulerPlugin
+ * @docsWeight 0
+ */
+export declare class DefaultSchedulerPlugin {
+    static options: DefaultSchedulerPluginOptions;
+    static init(config?: DefaultSchedulerPluginOptions): typeof DefaultSchedulerPlugin;
+}

package/dist/plugin/default-scheduler-plugin/default-scheduler.plugin.js

@@ -0,0 +1,69 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultSchedulerPlugin = void 0;
+const plugin_common_module_1 = require("../../plugin/plugin-common.module");
+const vendure_plugin_1 = require("../../plugin/vendure-plugin");
+const constants_1 = require("./constants");
+const default_scheduler_strategy_1 = require("./default-scheduler-strategy");
+const scheduled_task_record_entity_1 = require("./scheduled-task-record.entity");
+/**
+ * @description
+ * This plugin configures a default scheduling strategy that executes scheduled
+ * tasks using the database to ensure that each task is executed exactly once
+ * at the scheduled time, even if there are multiple instances of the worker
+ * running.
+ *
+ * @example
+ * ```ts
+ * import { DefaultSchedulerPlugin, VendureConfig } from '@vendure/core';
+ *
+ * export const config: VendureConfig = {
+ *   plugins: [
+ *     DefaultSchedulerPlugin.init({
+ *       // The default is 60s, but you can override it here
+ *       defaultTimeout: '10s',
+ *     }),
+ *   ],
+ * };
+ * ```
+ *
+ * @since 3.3.0
+ * @docsCategory scheduled-tasks
+ * @docsPage DefaultSchedulerPlugin
+ * @docsWeight 0
+ */
+let DefaultSchedulerPlugin = class DefaultSchedulerPlugin {
+    static init(config) {
+        this.options = Object.assign(Object.assign({}, this.options), (config || {}));
+        return this;
+    }
+};
+exports.DefaultSchedulerPlugin = DefaultSchedulerPlugin;
+DefaultSchedulerPlugin.options = {
+    defaultTimeout: constants_1.DEFAULT_TIMEOUT,
+    manualTriggerCheckInterval: constants_1.DEFAULT_MANUAL_TRIGGER_CHECK_INTERVAL,
+};
+exports.DefaultSchedulerPlugin = DefaultSchedulerPlugin = __decorate([
+    (0, vendure_plugin_1.VendurePlugin)({
+        imports: [plugin_common_module_1.PluginCommonModule],
+        entities: [scheduled_task_record_entity_1.ScheduledTaskRecord],
+        configuration: config => {
+            config.schedulerOptions.schedulerStrategy = new default_scheduler_strategy_1.DefaultSchedulerStrategy();
+            return config;
+        },
+        providers: [
+            {
+                provide: constants_1.DEFAULT_SCHEDULER_PLUGIN_OPTIONS,
+                useFactory: () => DefaultSchedulerPlugin.options,
+            },
+        ],
+        compatibility: '>0.0.0',
+    })
+], DefaultSchedulerPlugin);
+//# sourceMappingURL=default-scheduler.plugin.js.map

package/dist/plugin/default-scheduler-plugin/default-scheduler.plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-scheduler.plugin.js","sourceRoot":"","sources":["../../../src/plugin/default-scheduler-plugin/default-scheduler.plugin.ts"],"names":[],"mappings":";;;;;;;;;AAAA,4EAAuE;AACvE,gEAA4D;AAE5D,2CAIqB;AACrB,6EAAwE;AACxE,iFAAqE;AAGrE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAgBI,IAAM,sBAAsB,GAA5B,MAAM,sBAAsB;IAM/B,MAAM,CAAC,IAAI,CAAC,MAAsC;QAC9C,IAAI,CAAC,OAAO,mCAAQ,IAAI,CAAC,OAAO,GAAK,CAAC,MAAM,IAAI,EAAE,CAAC,CAAE,CAAC;QACtD,OAAO,IAAI,CAAC;IAChB,CAAC;;AATQ,wDAAsB;AACxB,8BAAO,GAAkC;IAC5C,cAAc,EAAE,2BAAe;IAC/B,0BAA0B,EAAE,iDAAqC;CACpE,AAHa,CAGZ;iCAJO,sBAAsB;IAflC,IAAA,8BAAa,EAAC;QACX,OAAO,EAAE,CAAC,yCAAkB,CAAC;QAC7B,QAAQ,EAAE,CAAC,kDAAmB,CAAC;QAC/B,aAAa,EAAE,MAAM,CAAC,EAAE;YACpB,MAAM,CAAC,gBAAgB,CAAC,iBAAiB,GAAG,IAAI,qDAAwB,EAAE,CAAC;YAC3E,OAAO,MAAM,CAAC;QAClB,CAAC;QACD,SAAS,EAAE;YACP;gBACI,OAAO,EAAE,4CAAgC;gBACzC,UAAU,EAAE,GAAG,EAAE,CAAC,sBAAsB,CAAC,OAAO;aACnD;SACJ;QACD,aAAa,EAAE,QAAQ;KAC1B,CAAC;GACW,sBAAsB,CAUlC"}

package/dist/plugin/default-scheduler-plugin/scheduled-task-record.entity.d.ts

@@ -0,0 +1,10 @@
+import { VendureEntity } from '../../entity/base/base.entity';
+export declare class ScheduledTaskRecord extends VendureEntity {
+    constructor(input: Partial<ScheduledTaskRecord>);
+    taskId: string;
+    enabled: boolean;
+    lockedAt: Date | null;
+    lastExecutedAt: Date | null;
+    manuallyTriggeredAt: Date | null;
+    lastResult: Record<string, any> | string | number | null;
+}

package/dist/plugin/default-scheduler-plugin/scheduled-task-record.entity.js

@@ -0,0 +1,50 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScheduledTaskRecord = void 0;
+const typeorm_1 = require("typeorm");
+const base_entity_1 = require("../../entity/base/base.entity");
+let ScheduledTaskRecord = class ScheduledTaskRecord extends base_entity_1.VendureEntity {
+    constructor(input) {
+        super(input);
+    }
+};
+exports.ScheduledTaskRecord = ScheduledTaskRecord;
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], ScheduledTaskRecord.prototype, "taskId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ default: true }),
+    __metadata("design:type", Boolean)
+], ScheduledTaskRecord.prototype, "enabled", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: Date, nullable: true, precision: 3 }),
+    __metadata("design:type", Object)
+], ScheduledTaskRecord.prototype, "lockedAt", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: Date, nullable: true, precision: 3 }),
+    __metadata("design:type", Object)
+], ScheduledTaskRecord.prototype, "lastExecutedAt", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: Date, nullable: true, precision: 3 }),
+    __metadata("design:type", Object)
+], ScheduledTaskRecord.prototype, "manuallyTriggeredAt", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'json', nullable: true }),
+    __metadata("design:type", Object)
+], ScheduledTaskRecord.prototype, "lastResult", void 0);
+exports.ScheduledTaskRecord = ScheduledTaskRecord = __decorate([
+    (0, typeorm_1.Entity)(),
+    (0, typeorm_1.Unique)(['taskId']),
+    __metadata("design:paramtypes", [Object])
+], ScheduledTaskRecord);
+//# sourceMappingURL=scheduled-task-record.entity.js.map

package/dist/plugin/default-scheduler-plugin/scheduled-task-record.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduled-task-record.entity.js","sourceRoot":"","sources":["../../../src/plugin/default-scheduler-plugin/scheduled-task-record.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAAiD;AAEjD,+DAA8D;AAIvD,IAAM,mBAAmB,GAAzB,MAAM,mBAAoB,SAAQ,2BAAa;IAClD,YAAY,KAAmC;QAC3C,KAAK,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;CAmBJ,CAAA;AAtBY,kDAAmB;AAM5B;IADC,IAAA,gBAAM,GAAE;;mDACM;AAGf;IADC,IAAA,gBAAM,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;oDACT;AAGjB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC;;qDAC/B;AAGtB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC;;2DACzB;AAG5B;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC;;gEACpB;AAGjC;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uDACgB;8BArBhD,mBAAmB;IAF/B,IAAA,gBAAM,GAAE;IACR,IAAA,gBAAM,EAAC,CAAC,QAAQ,CAAC,CAAC;;GACN,mBAAmB,CAsB/B"}

package/dist/plugin/default-scheduler-plugin/types.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @description
+ * The options for the {@link DefaultSchedulerPlugin}.
+ *
+ * @since 3.3.0
+ * @docsCategory scheduled-tasks
+ * @docsPage DefaultSchedulerPlugin
+ */
+export interface DefaultSchedulerPluginOptions {
+    /**
+     * @description
+     * The default timeout for scheduled tasks.
+     *
+     * @default 60_000ms
+     */
+    defaultTimeout?: string | number;
+    /**
+     * @description
+     * The interval at which the plugin will check for manually triggered tasks.
+     *
+     * @default 10_000ms
+     */
+    manualTriggerCheckInterval?: string | number;
+}

package/dist/plugin/default-scheduler-plugin/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/plugin/default-scheduler-plugin/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/plugin/default-scheduler-plugin/types.ts"],"names":[],"mappings":""}

package/dist/plugin/index.d.ts

@@ -1,13 +1,15 @@
-export * from './default-search-plugin/index';
+export * from './default-cache-plugin/default-cache-plugin';
+export * from './default-cache-plugin/sql-cache-strategy';
 export * from './default-job-queue-plugin/default-job-queue-plugin';
 export * from './default-job-queue-plugin/job-record-buffer.entity';
 export * from './default-job-queue-plugin/sql-job-buffer-storage-strategy';
-export * from './default-cache-plugin/default-cache-plugin';
-export * from './default-cache-plugin/sql-cache-strategy';
+export * from './default-job-queue-plugin/types';
+export * from './default-scheduler-plugin/default-scheduler.plugin';
+export * from './default-search-plugin/index';
+export * from './plugin-common.module';
+export * from './plugin-metadata';
+export * from './plugin-utils';
 export * from './redis-cache-plugin/redis-cache-plugin';
 export * from './redis-cache-plugin/redis-cache-strategy';
 export * from './redis-cache-plugin/types';
 export * from './vendure-plugin';
-export * from './plugin-common.module';
-export * from './plugin-utils';
-export * from './plugin-metadata';

package/dist/plugin/index.js

@@ -14,17 +14,19 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./default-search-plugin/index"), exports);
+__exportStar(require("./default-cache-plugin/default-cache-plugin"), exports);
+__exportStar(require("./default-cache-plugin/sql-cache-strategy"), exports);
 __exportStar(require("./default-job-queue-plugin/default-job-queue-plugin"), exports);
 __exportStar(require("./default-job-queue-plugin/job-record-buffer.entity"), exports);
 __exportStar(require("./default-job-queue-plugin/sql-job-buffer-storage-strategy"), exports);
-__exportStar(require("./default-cache-plugin/default-cache-plugin"), exports);
-__exportStar(require("./default-cache-plugin/sql-cache-strategy"), exports);
+__exportStar(require("./default-job-queue-plugin/types"), exports);
+__exportStar(require("./default-scheduler-plugin/default-scheduler.plugin"), exports);
+__exportStar(require("./default-search-plugin/index"), exports);
+__exportStar(require("./plugin-common.module"), exports);
+__exportStar(require("./plugin-metadata"), exports);
+__exportStar(require("./plugin-utils"), exports);
 __exportStar(require("./redis-cache-plugin/redis-cache-plugin"), exports);
 __exportStar(require("./redis-cache-plugin/redis-cache-strategy"), exports);
 __exportStar(require("./redis-cache-plugin/types"), exports);
 __exportStar(require("./vendure-plugin"), exports);
-__exportStar(require("./plugin-common.module"), exports);
-__exportStar(require("./plugin-utils"), exports);
-__exportStar(require("./plugin-metadata"), exports);
 //# sourceMappingURL=index.js.map

package/dist/plugin/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/plugin/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gEAA8C;AAC9C,sFAAoE;AACpE,sFAAoE;AACpE,6FAA2E;AAC3E,8EAA4D;AAC5D,4EAA0D;AAC1D,0EAAwD;AACxD,4EAA0D;AAC1D,6DAA2C;AAC3C,mDAAiC;AACjC,yDAAuC;AACvC,iDAA+B;AAC/B,oDAAkC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/plugin/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8EAA4D;AAC5D,4EAA0D;AAC1D,sFAAoE;AACpE,sFAAoE;AACpE,6FAA2E;AAC3E,mEAAiD;AACjD,sFAAoE;AACpE,gEAA8C;AAC9C,yDAAuC;AACvC,oDAAkC;AAClC,iDAA+B;AAC/B,0EAAwD;AACxD,4EAA0D;AAC1D,6DAA2C;AAC3C,mDAAiC"}

package/dist/scheduler/index.d.ts

@@ -0,0 +1,4 @@
+export * from './scheduled-task';
+export * from './scheduler-strategy';
+export * from './scheduler.service';
+export * from './tasks/clean-sessions-task';

package/dist/scheduler/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./scheduled-task"), exports);
+__exportStar(require("./scheduler-strategy"), exports);
+__exportStar(require("./scheduler.service"), exports);
+__exportStar(require("./tasks/clean-sessions-task"), exports);
+//# sourceMappingURL=index.js.map

package/dist/scheduler/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/scheduler/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,uDAAqC;AACrC,sDAAoC;AACpC,8DAA4C"}

package/dist/scheduler/noop-scheduler-strategy.d.ts

@@ -0,0 +1,10 @@
+import { UpdateScheduledTaskInput } from '@vendure/common/lib/generated-types';
+import { ScheduledTask } from './scheduled-task';
+import { SchedulerStrategy, TaskReport } from './scheduler-strategy';
+export declare class NoopSchedulerStrategy implements SchedulerStrategy {
+    getTasks(): Promise<TaskReport[]>;
+    getTask(id: string): Promise<TaskReport | undefined>;
+    executeTask(task: ScheduledTask): () => Promise<void>;
+    updateTask(input: UpdateScheduledTaskInput): Promise<TaskReport>;
+    triggerTask(task: ScheduledTask): Promise<void>;
+}

package/dist/scheduler/noop-scheduler-strategy.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoopSchedulerStrategy = void 0;
+const vendure_logger_1 = require("../config/logger/vendure-logger");
+class NoopSchedulerStrategy {
+    getTasks() {
+        return Promise.resolve([]);
+    }
+    getTask(id) {
+        return Promise.resolve(undefined);
+    }
+    executeTask(task) {
+        vendure_logger_1.Logger.warn(`No task scheduler is configured! The task ${task.id} will not be executed.`);
+        return () => Promise.resolve();
+    }
+    updateTask(input) {
+        throw new Error(`Not implemented`);
+    }
+    triggerTask(task) {
+        throw new Error(`Not implemented`);
+    }
+}
+exports.NoopSchedulerStrategy = NoopSchedulerStrategy;
+//# sourceMappingURL=noop-scheduler-strategy.js.map

package/dist/scheduler/noop-scheduler-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"noop-scheduler-strategy.js","sourceRoot":"","sources":["../../src/scheduler/noop-scheduler-strategy.ts"],"names":[],"mappings":";;;AAEA,oEAAyD;AAKzD,MAAa,qBAAqB;IAC9B,QAAQ;QACJ,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO,CAAC,EAAU;QACd,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;IAED,WAAW,CAAC,IAAmB;QAC3B,uBAAM,CAAC,IAAI,CAAC,6CAA6C,IAAI,CAAC,EAAE,wBAAwB,CAAC,CAAC;QAC1F,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IACnC,CAAC;IAED,UAAU,CAAC,KAA+B;QACtC,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;IAED,WAAW,CAAC,IAAmB;QAC3B,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;CACJ;AArBD,sDAqBC"}