@terreno/jobs 57.4.0

package/dist/jobsApp.js

@@ -0,0 +1,308 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobsApp = void 0;
+var api_1 = require("@terreno/api");
+var jobExecutor_1 = require("./jobExecutor");
+var jobsService_1 = require("./jobsService");
+var job_1 = require("./models/job");
+var jobSchedule_1 = require("./models/jobSchedule");
+var jobsAdmin_1 = require("./routes/jobsAdmin");
+var jobsExecute_1 = require("./routes/jobsExecute");
+var mongoRunner_1 = require("./runners/mongoRunner");
+/**
+ * TerrenoPlugin for durable background jobs.
+ *
+ * Registering `JobsApp` wires the plugin into the Express app but does **not**
+ * start a worker poll loop. Call {@link JobsApp.startWorker} explicitly from the
+ * API process or a dedicated worker entrypoint.
+ */
+var JobsApp = /** @class */ (function () {
+    function JobsApp(options) {
+        var _a, _b;
+        this.workerActive = false;
+        this.options = options !== null && options !== void 0 ? options : {};
+        this.runner = (_a = this.options.runner) !== null && _a !== void 0 ? _a : new mongoRunner_1.MongoJobRunner();
+        this.service = new jobsService_1.JobsService({
+            defaultTimezone: (_b = this.options.timezone) !== null && _b !== void 0 ? _b : "UTC",
+            lockTtlMs: this.options.lockTtlMs,
+            runner: this.runner,
+        });
+    }
+    JobsApp.prototype.define = function (name, definition) {
+        this.service.define(name, definition);
+        if (this.workerActive && definition.schedule) {
+            this.service.markSchedulesDirty();
+        }
+        return this;
+    };
+    JobsApp.prototype.getBasePath = function () {
+        var _a;
+        return (_a = this.options.basePath) !== null && _a !== void 0 ? _a : "/jobs";
+    };
+    JobsApp.prototype.getDefinition = function (name) {
+        return this.service.getDefinition(name);
+    };
+    JobsApp.prototype.getDefaultTimezone = function () {
+        return this.service.getDefaultTimezone();
+    };
+    JobsApp.prototype.getLockTtlMs = function () {
+        return this.service.getLockTtlMs();
+    };
+    /** Execute a persisted job by id from an external dispatch surface (queue consumer, execute HTTP). */
+    JobsApp.prototype.executeQueuedJob = function (jobId_1) {
+        return __awaiter(this, arguments, void 0, function (jobId, signal) {
+            if (signal === void 0) { signal = AbortSignal.timeout(30 * 60 * 1000); }
+            return __generator(this, function (_a) {
+                return [2 /*return*/, (0, jobExecutor_1.executeJobById)({
+                        host: this,
+                        jobId: jobId,
+                        signal: signal,
+                    })];
+            });
+        });
+    };
+    JobsApp.prototype.getPollIntervalMs = function () {
+        var _a;
+        return (_a = this.options.pollIntervalMs) !== null && _a !== void 0 ? _a : 1000;
+    };
+    JobsApp.prototype.reconcileSchedules = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.service.reconcileSchedules()];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    JobsApp.prototype.reconcileSchedulesIfDirty = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.service.reconcileSchedulesIfDirty()];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    JobsApp.prototype.tickSchedules = function (now) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.service.tickSchedules(now)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    JobsApp.prototype.register = function (app, openApi) {
+        (0, jobsService_1.registerJobsService)(this.service);
+        (0, jobsAdmin_1.registerJobsAdminRoutes)({
+            app: app,
+            options: {
+                accessControl: this.options.accessControl,
+                basePath: this.getBasePath(),
+                jobsService: this.service,
+                openApi: openApi,
+                redactPayload: this.options.redactPayload,
+            },
+        });
+        if (this.shouldMountExecuteRoute()) {
+            if (!this.options.executeAuth) {
+                throw new Error("JobsApp execute route is enabled but executeAuth is missing. Provide executeAuth when mountExecuteRoute is true or the runner requires the execute route.");
+            }
+            (0, jobsExecute_1.registerJobsExecuteRoute)({
+                app: app,
+                options: {
+                    basePath: this.getBasePath(),
+                    executeAuth: this.options.executeAuth,
+                    host: this.service,
+                },
+            });
+        }
+        void job_1.Job.init().catch(function (error) {
+            api_1.logger.error("[jobs] Failed to build Job indexes: ".concat(String(error)));
+        });
+        void jobSchedule_1.JobSchedule.init().catch(function (error) {
+            api_1.logger.error("[jobs] Failed to build JobSchedule indexes: ".concat(String(error)));
+        });
+    };
+    JobsApp.prototype.adminContribution = function () {
+        return {
+            customScreens: [
+                {
+                    displayName: "Jobs",
+                    icon: "clock",
+                    name: "jobs",
+                },
+            ],
+            homeWidgets: [{ displayName: "Jobs", icon: "clock", id: "jobs" }],
+        };
+    };
+    JobsApp.prototype.shouldMountExecuteRoute = function () {
+        if (this.options.mountExecuteRoute) {
+            return true;
+        }
+        return this.runner.requiresExecuteRoute === true;
+    };
+    JobsApp.prototype.isWorkerActive = function () {
+        return this.workerActive;
+    };
+    /**
+     * Starts the background worker poll loop without awaiting it.
+     *
+     * Fire-and-forget: resolves once the runner has been scheduled. Runner errors are
+     * logged and worker state is reset; they are not thrown from this method.
+     */
+    JobsApp.prototype.startWorker = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (this.workerActive) {
+                            return [2 /*return*/];
+                        }
+                        if (!(this.workerStartPromise !== undefined)) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.workerStartPromise];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                    case 2:
+                        this.workerStartPromise = this.beginWorkerStart();
+                        _a.label = 3;
+                    case 3:
+                        _a.trys.push([3, , 5, 6]);
+                        return [4 /*yield*/, this.workerStartPromise];
+                    case 4:
+                        _a.sent();
+                        return [3 /*break*/, 6];
+                    case 5:
+                        this.workerStartPromise = undefined;
+                        return [7 /*endfinally*/];
+                    case 6: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    JobsApp.prototype.stopWorker = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var stopPromise, _a;
+            var _b, _c, _d;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        if (!this.workerActive) {
+                            return [2 /*return*/];
+                        }
+                        stopPromise = (_c = (_b = this.runner).stop) === null || _c === void 0 ? void 0 : _c.call(_b);
+                        (_d = this.abortController) === null || _d === void 0 ? void 0 : _d.abort();
+                        _e.label = 1;
+                    case 1:
+                        _e.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, this.workerPromise];
+                    case 2:
+                        _e.sent();
+                        return [3 /*break*/, 4];
+                    case 3:
+                        _a = _e.sent();
+                        return [3 /*break*/, 4];
+                    case 4: return [4 /*yield*/, stopPromise];
+                    case 5:
+                        _e.sent();
+                        this.resetWorkerState();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    JobsApp.prototype.resetWorkerState = function () {
+        this.workerActive = false;
+        this.abortController = undefined;
+        this.workerPromise = undefined;
+    };
+    JobsApp.prototype.beginWorkerStart = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var error_1;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (this.workerActive) {
+                            return [2 /*return*/];
+                        }
+                        if (!this.runner.start) {
+                            throw new Error("Job runner \"".concat(this.runner.id, "\" does not support start()"));
+                        }
+                        this.workerActive = true;
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, this.service.reconcileSchedules()];
+                    case 2:
+                        _a.sent();
+                        this.abortController = new AbortController();
+                        this.workerPromise = this.runner
+                            .start({
+                            jobs: this,
+                            pollIntervalMs: this.getPollIntervalMs(),
+                            signal: this.abortController.signal,
+                        })
+                            .catch(function (error) {
+                            _this.resetWorkerState();
+                            api_1.logger.error("[jobs] Worker stopped with error: ".concat(String(error)));
+                        });
+                        return [3 /*break*/, 4];
+                    case 3:
+                        error_1 = _a.sent();
+                        this.resetWorkerState();
+                        throw error_1;
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    return JobsApp;
+}());
+exports.JobsApp = JobsApp;

package/dist/jobsService.d.ts

@@ -0,0 +1,38 @@
+import type { JobDocument, JobScheduleDocument } from "./modelTypes";
+import type { EnqueueJobParams, JobDefinition, JobRunner } from "./types";
+export declare class JobsService {
+    private readonly defaultTimezone;
+    private readonly definitions;
+    private readonly lockTtlMs;
+    private readonly runner;
+    private schedulesDirty;
+    constructor(options?: {
+        defaultTimezone?: string;
+        lockTtlMs?: number;
+        runner?: JobRunner;
+    });
+    define(name: string, definition: JobDefinition): void;
+    getDefinition(name: string): JobDefinition | undefined;
+    getDefaultTimezone(): string;
+    getLockTtlMs(): number;
+    isSchedulesDirty(): boolean;
+    markSchedulesDirty(): void;
+    reconcileSchedulesIfDirty(): Promise<void>;
+    reconcileSchedules(): Promise<void>;
+    tickSchedules(now?: Date): Promise<void>;
+    enqueue(params: EnqueueJobParams): Promise<JobDocument>;
+    adminRetryJob(jobId: string): Promise<{
+        original: JobDocument;
+        retry: JobDocument;
+    }>;
+    adminRequeueJob(jobId: string): Promise<JobDocument>;
+    adminCancelJob(jobId: string): Promise<JobDocument>;
+    pauseSchedule(name: string): Promise<JobScheduleDocument>;
+    resumeSchedule(name: string): Promise<JobScheduleDocument>;
+}
+export declare const getJobsService: () => JobsService;
+/** Returns the registered jobs service when `JobsApp` is mounted; otherwise `undefined`. */
+export declare const tryGetJobsService: () => JobsService | undefined;
+export declare const registerJobsService: (service: JobsService) => void;
+/** Clears the process-wide jobs service. Tests use this so AdminApp falls back to in-process runs. */
+export declare const unregisterJobsService: () => void;