@n8n/scheduler 0.1.0 → 0.2.1

package/dist/storage/scheduler.service.js

@@ -0,0 +1,70 @@
+"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.SchedulerService = void 0;
+const backend_common_1 = require("@n8n/backend-common");
+const config_1 = require("@n8n/config");
+const db_1 = require("@n8n/db");
+const di_1 = require("@n8n/di");
+const materializer_store_1 = require("./materializer-store");
+const materializer_1 = require("../core/materializer");
+const retention_1 = require("../core/retention");
+let SchedulerService = class SchedulerService {
+    constructor(store, tasks, logger, config) {
+        this.store = store;
+        this.tasks = tasks;
+        this.logger = logger;
+        this.materializerOptions = {
+            ...materializer_1.DEFAULT_MATERIALIZER_OPTIONS,
+            windowSeconds: config.materializationWindowSeconds,
+        };
+        this.retentionOptions = {
+            ...retention_1.DEFAULT_RETENTION_OPTIONS,
+            retentionSeconds: config.retentionSeconds,
+            failedRetentionSeconds: config.failedRetentionSeconds,
+        };
+        if (config.failedRetentionSeconds < config.retentionSeconds) {
+            this.logger.warn('Scheduler retention keeps failed runs shorter than succeeded ones; failure evidence will be deleted first', {
+                retentionSeconds: config.retentionSeconds,
+                failedRetentionSeconds: config.failedRetentionSeconds,
+            });
+        }
+    }
+    async materialize() {
+        return await (0, materializer_1.materialize)(this.store.runInTransaction, this.materializerOptions, (job, error) => {
+            this.logger.error('Scheduler could not plan a job schedule; deferred for retry', {
+                jobId: job.id,
+                error: error instanceof Error ? error.message : String(error),
+            });
+        });
+    }
+    async prune() {
+        const summary = await (0, retention_1.prune)(this.tasks, this.retentionOptions);
+        if (!summary.drained) {
+            this.logger.warn('Scheduler retention pass hit its batch budget; backlog remains', {
+                ...summary,
+            });
+        }
+        else if (summary.deleted > 0) {
+            this.logger.debug('Scheduler retention deleted finished tasks', { ...summary });
+        }
+        return summary;
+    }
+};
+exports.SchedulerService = SchedulerService;
+exports.SchedulerService = SchedulerService = __decorate([
+    (0, di_1.Service)(),
+    __metadata("design:paramtypes", [materializer_store_1.MaterializerStore,
+        db_1.ScheduledTaskRepository,
+        backend_common_1.Logger,
+        config_1.SchedulerConfig])
+], SchedulerService);
+//# sourceMappingURL=scheduler.service.js.map

package/dist/storage/scheduler.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduler.service.js","sourceRoot":"","sources":["../../src/storage/scheduler.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wDAA6C;AAC7C,wCAA8C;AAC9C,gCAAkD;AAClD,gCAAkC;AAElC,6DAAyD;AACzD,uDAAiF;AAEjF,iDAAqE;AAQ9D,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAK5B,YACkB,KAAwB,EACxB,KAA8B,EAC9B,MAAc,EAC/B,MAAuB;QAHN,UAAK,GAAL,KAAK,CAAmB;QACxB,UAAK,GAAL,KAAK,CAAyB;QAC9B,WAAM,GAAN,MAAM,CAAQ;QAG/B,IAAI,CAAC,mBAAmB,GAAG;YAC1B,GAAG,2CAA4B;YAC/B,aAAa,EAAE,MAAM,CAAC,4BAA4B;SAClD,CAAC;QACF,IAAI,CAAC,gBAAgB,GAAG;YACvB,GAAG,qCAAyB;YAC5B,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;YACzC,sBAAsB,EAAE,MAAM,CAAC,sBAAsB;SACrD,CAAC;QACF,IAAI,MAAM,CAAC,sBAAsB,GAAG,MAAM,CAAC,gBAAgB,EAAE,CAAC;YAC7D,IAAI,CAAC,MAAM,CAAC,IAAI,CACf,2GAA2G,EAC3G;gBACC,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;gBACzC,sBAAsB,EAAE,MAAM,CAAC,sBAAsB;aACrD,CACD,CAAC;QACH,CAAC;IACF,CAAC;IAED,KAAK,CAAC,WAAW;QAChB,OAAO,MAAM,IAAA,0BAAW,EACvB,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAC3B,IAAI,CAAC,mBAAmB,EACxB,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YACd,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6DAA6D,EAAE;gBAChF,KAAK,EAAE,GAAG,CAAC,EAAE;gBACb,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;aAC7D,CAAC,CAAC;QACJ,CAAC,CACD,CAAC;IACH,CAAC;IAKD,KAAK,CAAC,KAAK;QACV,MAAM,OAAO,GAAG,MAAM,IAAA,iBAAK,EAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC/D,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACtB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gEAAgE,EAAE;gBAClF,GAAG,OAAO;aACV,CAAC,CAAC;QACJ,CAAC;aAAM,IAAI,OAAO,CAAC,OAAO,GAAG,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4CAA4C,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;QACjF,CAAC;QACD,OAAO,OAAO,CAAC;IAChB,CAAC;CACD,CAAA;AA1DY,4CAAgB;2BAAhB,gBAAgB;IAD5B,IAAA,YAAO,GAAE;qCAOgB,sCAAiB;QACjB,4BAAuB;QACtB,uBAAM;QACvB,wBAAe;GATZ,gBAAgB,CA0D5B"}

package/package.json

@@ -1,26 +1,61 @@
 {
   "name": "@n8n/scheduler",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "main": "dist/index.js",
   "module": "src/index.ts",
   "types": "dist/index.d.ts",
   "files": [
-    "dist/**/*"
+    "dist/**/*",
+    "LICENSE.md",
+    "LICENSE_EE.md"
   ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./storage": {
+      "types": "./dist/storage/index.d.ts",
+      "default": "./dist/storage/index.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "storage": [
+        "dist/storage/index.d.ts"
+      ]
+    }
+  },
   "dependencies": {
     "cron-parser": "5.6.1",
     "luxon": "3.7.2",
-    "n8n-workflow": "2.29.0"
+    "@n8n/backend-common": "1.30.1",
+    "@n8n/constants": "0.30.0",
+    "@n8n/config": "2.28.0",
+    "@n8n/db": "1.30.1",
+    "@n8n/typeorm": "0.4.0",
+    "@n8n/utils": "1.38.1",
+    "n8n-workflow": "2.30.1",
+    "@n8n/di": "0.14.0"
   },
   "devDependencies": {
     "@types/luxon": "3.2.0",
     "@vitest/coverage-v8": "4.1.9",
     "vitest": "^4.1.9",
     "vitest-mock-extended": "^3.1.0",
-    "@n8n/typescript-config": "1.7.0",
-    "@n8n/vitest-config": "1.16.0"
+    "@n8n/vitest-config": "1.17.0",
+    "@n8n/typescript-config": "1.8.0"
+  },
+  "license": "SEE LICENSE IN LICENSE.md",
+  "homepage": "https://n8n.io",
+  "author": {
+    "name": "Jan Oberhauser",
+    "email": "jan@n8n.io"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/n8n-io/n8n.git"
   },
-  "license": "LicenseRef-n8n-sustainable-use",
   "scripts": {
     "clean": "rimraf dist .turbo",
     "dev": "pnpm watch",

package/dist/errors.d.ts

@@ -1,3 +0,0 @@
-export declare class InvalidScheduleError extends Error {
-    constructor(message: string);
-}

package/dist/errors.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidScheduleError = void 0;
-class InvalidScheduleError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = 'InvalidScheduleError';
-    }
-}
-exports.InvalidScheduleError = InvalidScheduleError;
-//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAQA,MAAa,oBAAqB,SAAQ,KAAK;IAC9C,YAAY,OAAe;QAC1B,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IACpC,CAAC;CACD;AALD,oDAKC"}

package/dist/recurrence/next-run.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"next-run.js","sourceRoot":"","sources":["../../src/recurrence/next-run.ts"],"names":[],"mappings":";;AAwDA,4CAsBC;AA9ED,6CAAmD;AAEnD,sCAAiD;AAEjD,yCAA8C;AAE9C,MAAM,aAAa,GAAG,IAAI,CAAC;AAU3B,SAAS,WAAW,CAAC,QAAsB,EAAE,KAAW,EAAE,QAAgB;IACzE,IAAI,CAAC;QACJ,MAAM,EAAE,GAAG,kCAAoB,CAAC,KAAK,CAAC,QAAQ,CAAC,cAAc,EAAE;YAC9D,WAAW,EAAE,KAAK;YAClB,EAAE,EAAE,QAAQ;SACZ,CAAC,CAAC;QACH,OAAO,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC;IAC3B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,MAAM,IAAI,6BAAoB,CAC7B,sCAAsC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,gBAAgB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAM,KAAe,CAAC,OAAO,EAAE,CACpJ,CAAC;IACH,CAAC;AACF,CAAC;AAOD,SAAS,eAAe,CAAC,QAA0B,EAAE,KAAW;IAC/D,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,QAAQ,CAAC,eAAe,GAAG,aAAa,CAAC,CAAC;AAC7E,CAAC;AAGD,SAAS,aAAa,CAAC,QAAwB,EAAE,KAAW;IAC3D,OAAO,KAAK,CAAC,OAAO,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AAC7E,CAAC;AAcD,SAAgB,gBAAgB,CAAC,QAAkB,EAAE,KAAW;IAC/D,IAAA,2BAAgB,EAAC,QAAQ,CAAC,CAAC;IAE3B,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAAC;QACvB,KAAK,MAAM;YACV,IAAI,QAAQ,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;gBAChC,MAAM,IAAI,6BAAoB,CAC7B,2FAA2F,CAC3F,CAAC;YACH,CAAC;YACD,OAAO,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACxD,KAAK,UAAU;YACd,OAAO,eAAe,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACzC,KAAK,SAAS;YACb,OAAO,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACvC,OAAO,CAAC,CAAC,CAAC;YACT,MAAM,UAAU,GAAU,QAAQ,CAAC;YACnC,MAAM,IAAI,6BAAoB,CAC7B,0BAA0B,IAAI,CAAC,SAAS,CAAE,UAAuB,CAAC,IAAI,CAAC,EAAE,CACzE,CAAC;QACH,CAAC;IACF,CAAC;AACF,CAAC"}

package/dist/recurrence/validate.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../src/recurrence/validate.ts"],"names":[],"mappings":";;AA8DA,4CAeC;AA7ED,6CAAmD;AACnD,iCAAiC;AAEjC,sCAAiD;AAIjD,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAE3B,SAAS,YAAY,CAAC,QAAsB;IAG3C,MAAM,UAAU,GAAY,QAAQ,CAAC,cAAc,CAAC;IACpD,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QACpC,MAAM,IAAI,6BAAoB,CAC7B,6CAA6C,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CACzE,CAAC;IACH,CAAC;IAED,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC;IACzD,IAAI,UAAU,KAAK,gBAAgB,EAAE,CAAC;QACrC,MAAM,IAAI,6BAAoB,CAC7B,6BAA6B,gBAAgB,mCAAmC,UAAU,KAAK,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAC3H,CAAC;IACH,CAAC;IAGD,IAAI,QAAQ,CAAC,QAAQ,KAAK,IAAI,IAAI,CAAC,gBAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5E,MAAM,IAAI,6BAAoB,CAAC,0BAA0B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED,IAAI,CAAC;QACJ,kCAAoB,CAAC,KAAK,CAAC,UAAU,EAAE;YACtC,EAAE,EAAE,QAAQ,CAAC,QAAQ,IAAI,KAAK;SAC9B,CAAC,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,MAAM,IAAI,6BAAoB,CAC7B,2BAA2B,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,KAAM,KAAe,CAAC,OAAO,EAAE,CACpF,CAAC;IACH,CAAC;AACF,CAAC;AAED,SAAS,gBAAgB,CAAC,QAA0B;IACnD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,QAAQ,CAAC,eAAe,IAAI,CAAC,EAAE,CAAC;QAClF,MAAM,IAAI,6BAAoB,CAC7B,4DAA4D,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CACtG,CAAC;IACH,CAAC;AACF,CAAC;AAED,SAAS,cAAc,CAAC,QAAwB;IAC/C,MAAM,MAAM,GAAY,QAAQ,CAAC,MAAM,CAAC;IACxC,IAAI,CAAC,CAAC,MAAM,YAAY,IAAI,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;QACjE,MAAM,IAAI,6BAAoB,CAAC,qCAAqC,CAAC,CAAC;IACvE,CAAC;AACF,CAAC;AAOD,SAAgB,gBAAgB,CAAC,QAAkB;IAClD,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAAC;QACvB,KAAK,MAAM;YACV,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC/B,KAAK,UAAU;YACd,OAAO,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACnC,KAAK,SAAS;YACb,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC;QACjC,OAAO,CAAC,CAAC,CAAC;YACT,MAAM,UAAU,GAAU,QAAQ,CAAC;YACnC,MAAM,IAAI,6BAAoB,CAC7B,0BAA0B,IAAI,CAAC,SAAS,CAAE,UAAuB,CAAC,IAAI,CAAC,EAAE,CACzE,CAAC;QACH,CAAC;IACF,CAAC;AACF,CAAC"}

package/dist/storage/storage.d.ts

@@ -1,6 +0,0 @@
-import type { ScheduledJob, ScheduledTask } from '../types';
-export interface SchedulerStore {
-    getDueJobs(now: Date, limit: number): Promise<ScheduledJob[]>;
-    saveJob(job: ScheduledJob): Promise<void>;
-    createTask(task: ScheduledTask): Promise<void>;
-}

package/dist/storage/storage.js.map

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

package/dist/types/index.d.ts

@@ -1,2 +0,0 @@
-export * from './schedule';
-export * from './task';

package/dist/types/index.js

@@ -1,19 +0,0 @@
-"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("./schedule"), exports);
-__exportStar(require("./task"), exports);
-//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,yCAAuB"}

package/dist/types/schedule.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ScheduleKindList = void 0;
-exports.ScheduleKindList = ['cron', 'interval', 'one_off'];
-//# sourceMappingURL=schedule.js.map

package/dist/types/schedule.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"schedule.js","sourceRoot":"","sources":["../../src/types/schedule.ts"],"names":[],"mappings":";;;AAiBa,QAAA,gBAAgB,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,SAAS,CAAU,CAAC"}

package/dist/types/task.d.ts

@@ -1,13 +0,0 @@
-export declare const TaskStatusList: readonly ["pending", "running", "succeeded", "failed", "missed", "cancelled"];
-export type TaskStatus = (typeof TaskStatusList)[number];
-export interface ScheduledTask {
-    id: string;
-    jobId: string;
-    taskType: string;
-    payload: unknown;
-    scheduledFor: Date;
-    runAt: Date;
-    status: TaskStatus;
-    attempts: number;
-    maxAttempts: number;
-}

package/dist/types/task.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TaskStatusList = void 0;
-exports.TaskStatusList = [
-    'pending',
-    'running',
-    'succeeded',
-    'failed',
-    'missed',
-    'cancelled',
-];
-//# sourceMappingURL=task.js.map

package/dist/types/task.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"task.js","sourceRoot":"","sources":["../../src/types/task.ts"],"names":[],"mappings":";;;AAaa,QAAA,cAAc,GAAG;IAC7B,SAAS;IACT,SAAS;IACT,WAAW;IACX,QAAQ;IACR,QAAQ;IACR,WAAW;CACF,CAAC"}