@terreno/jobs 57.4.0 → 57.6.0

package/dist/scheduler.js

@@ -1,178 +1,76 @@
 "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 };
-    }
-};
-var __values = (this && this.__values) || function(o) {
-    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
-    if (m) return m.call(o);
-    if (o && typeof o.length === "number") return {
-        next: function () {
-            if (o && i >= o.length) o = void 0;
-            return { value: o && o[i++], done: !o };
-        }
-    };
-    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.tickDueSchedules = exports.buildScheduleRunIdempotencyKey = void 0;
-var api_1 = require("@terreno/api");
-var luxon_1 = require("luxon");
-var dispatchError_1 = require("./dispatchError");
-var job_1 = require("./models/job");
-var jobSchedule_1 = require("./models/jobSchedule");
-var modelTypes_1 = require("./modelTypes");
-var scheduleCron_1 = require("./scheduleCron");
+const api_1 = require("@terreno/api");
+const luxon_1 = require("luxon");
+const dispatchError_1 = require("./dispatchError");
+const job_1 = require("./models/job");
+const jobSchedule_1 = require("./models/jobSchedule");
+const modelTypes_1 = require("./modelTypes");
+const scheduleCron_1 = require("./scheduleCron");
 /** @internal */
-var buildScheduleRunIdempotencyKey = function (scheduleId, dueRunAt) {
-    return "schedule:".concat(scheduleId, ":").concat(dueRunAt.toISOString());
-};
+const buildScheduleRunIdempotencyKey = (scheduleId, dueRunAt) => `schedule:${scheduleId}:${dueRunAt.toISOString()}`;
 exports.buildScheduleRunIdempotencyKey = buildScheduleRunIdempotencyKey;
-var tickOneSchedule = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
-    var dueRunAt, advancedNextRunAt, claimed, inFlight, idempotencyKey, error_1, shouldRollbackSchedule;
-    var jobsService = _b.jobsService, now = _b.now, schedule = _b.schedule;
-    return __generator(this, function (_c) {
-        switch (_c.label) {
-            case 0:
-                dueRunAt = schedule.nextRunAt;
-                advancedNextRunAt = (0, scheduleCron_1.computeNextRunAtAfter)(schedule.cron, schedule.timezone, now);
-                return [4 /*yield*/, jobSchedule_1.JobSchedule.findOneAndUpdate({
-                        _id: schedule._id,
-                        enabled: true,
-                        nextRunAt: dueRunAt,
-                    }, {
-                        $set: {
-                            nextRunAt: advancedNextRunAt,
-                        },
-                    }, { returnDocument: "before" })];
-            case 1:
-                claimed = _c.sent();
-                if (!claimed) {
-                    return [2 /*return*/];
-                }
-                return [4 /*yield*/, job_1.Job.findOneOrNone({
-                        scheduleId: claimed._id,
-                        status: { $in: modelTypes_1.IN_FLIGHT_JOB_STATUSES },
-                    })];
-            case 2:
-                inFlight = _c.sent();
-                if (inFlight) {
-                    return [2 /*return*/];
-                }
-                idempotencyKey = (0, exports.buildScheduleRunIdempotencyKey)(claimed._id.toString(), claimed.nextRunAt);
-                _c.label = 3;
-            case 3:
-                _c.trys.push([3, 5, , 9]);
-                return [4 /*yield*/, jobsService.enqueue({
-                        idempotencyKey: idempotencyKey,
-                        name: claimed.handlerName,
-                        payload: {},
-                        runAt: claimed.nextRunAt,
-                        scheduleId: claimed._id.toString(),
-                    })];
-            case 4:
-                _c.sent();
-                return [3 /*break*/, 9];
-            case 5:
-                error_1 = _c.sent();
-                shouldRollbackSchedule = !(error_1 instanceof dispatchError_1.JobDispatchError) || error_1.compensationSucceeded;
-                if (!shouldRollbackSchedule) return [3 /*break*/, 7];
-                return [4 /*yield*/, jobSchedule_1.JobSchedule.updateOne({ _id: claimed._id, nextRunAt: advancedNextRunAt }, { $set: { nextRunAt: dueRunAt } })];
-            case 6:
-                _c.sent();
-                return [3 /*break*/, 8];
-            case 7:
-                api_1.logger.error("[JobSchedule] Dispatch compensation lost race for \"".concat(claimed.name, "\" (").concat(claimed._id.toString(), "); schedule nextRunAt left advanced"));
-                _c.label = 8;
-            case 8: throw error_1;
-            case 9: return [2 /*return*/];
-        }
+const tickOneSchedule = async ({ jobsService, now, schedule, }) => {
+    const dueRunAt = schedule.nextRunAt;
+    const advancedNextRunAt = (0, scheduleCron_1.computeNextRunAtAfter)(schedule.cron, schedule.timezone, now);
+    const claimed = await jobSchedule_1.JobSchedule.findOneAndUpdate({
+        _id: schedule._id,
+        enabled: true,
+        nextRunAt: dueRunAt,
+    }, {
+        $set: {
+            nextRunAt: advancedNextRunAt,
+        },
+    }, { returnDocument: "before" });
+    if (!claimed) {
+        return;
+    }
+    const inFlight = await job_1.Job.findOneOrNone({
+        scheduleId: claimed._id,
+        status: { $in: modelTypes_1.IN_FLIGHT_JOB_STATUSES },
     });
-}); };
-var tickDueSchedules = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
-    var dueSchedules, dueSchedules_1, dueSchedules_1_1, schedule, scheduleLog, error_2, e_1_1;
-    var e_1, _c;
-    var jobsService = _b.jobsService, _d = _b.now, now = _d === void 0 ? luxon_1.DateTime.utc().toJSDate() : _d;
-    return __generator(this, function (_e) {
-        switch (_e.label) {
-            case 0: return [4 /*yield*/, jobSchedule_1.JobSchedule.find({
-                    enabled: true,
-                    nextRunAt: { $lte: now },
-                }).sort({ nextRunAt: 1 })];
-            case 1:
-                dueSchedules = _e.sent();
-                _e.label = 2;
-            case 2:
-                _e.trys.push([2, 9, 10, 11]);
-                dueSchedules_1 = __values(dueSchedules), dueSchedules_1_1 = dueSchedules_1.next();
-                _e.label = 3;
-            case 3:
-                if (!!dueSchedules_1_1.done) return [3 /*break*/, 8];
-                schedule = dueSchedules_1_1.value;
-                scheduleLog = (0, api_1.createScopedLogger)({
-                    labels: { scheduleName: schedule.name },
-                    prefix: "[JobSchedule]",
-                });
-                _e.label = 4;
-            case 4:
-                _e.trys.push([4, 6, , 7]);
-                return [4 /*yield*/, tickOneSchedule({ jobsService: jobsService, now: now, schedule: schedule })];
-            case 5:
-                _e.sent();
-                return [3 /*break*/, 7];
-            case 6:
-                error_2 = _e.sent();
-                api_1.logger.error("[JobSchedule] Tick failed for \"".concat(schedule.name, "\": ").concat(error_2 instanceof Error ? error_2.message : String(error_2)));
-                scheduleLog.error("Tick failed: ".concat(error_2 instanceof Error ? error_2.message : String(error_2)));
-                return [3 /*break*/, 7];
-            case 7:
-                dueSchedules_1_1 = dueSchedules_1.next();
-                return [3 /*break*/, 3];
-            case 8: return [3 /*break*/, 11];
-            case 9:
-                e_1_1 = _e.sent();
-                e_1 = { error: e_1_1 };
-                return [3 /*break*/, 11];
-            case 10:
-                try {
-                    if (dueSchedules_1_1 && !dueSchedules_1_1.done && (_c = dueSchedules_1.return)) _c.call(dueSchedules_1);
-                }
-                finally { if (e_1) throw e_1.error; }
-                return [7 /*endfinally*/];
-            case 11: return [2 /*return*/];
+    if (inFlight) {
+        return;
+    }
+    const idempotencyKey = (0, exports.buildScheduleRunIdempotencyKey)(claimed._id.toString(), claimed.nextRunAt);
+    try {
+        await jobsService.enqueue({
+            idempotencyKey,
+            name: claimed.handlerName,
+            payload: {},
+            runAt: claimed.nextRunAt,
+            scheduleId: claimed._id.toString(),
+        });
+    }
+    catch (error) {
+        const shouldRollbackSchedule = !(error instanceof dispatchError_1.JobDispatchError) || error.compensationSucceeded;
+        if (shouldRollbackSchedule) {
+            await jobSchedule_1.JobSchedule.updateOne({ _id: claimed._id, nextRunAt: advancedNextRunAt }, { $set: { nextRunAt: dueRunAt } });
         }
-    });
-}); };
+        else {
+            api_1.logger.error(`[JobSchedule] Dispatch compensation lost race for "${claimed.name}" (${claimed._id.toString()}); schedule nextRunAt left advanced`);
+        }
+        throw error;
+    }
+};
+const tickDueSchedules = async ({ jobsService, now = luxon_1.DateTime.utc().toJSDate(), }) => {
+    const dueSchedules = await jobSchedule_1.JobSchedule.find({
+        enabled: true,
+        nextRunAt: { $lte: now },
+    }).sort({ nextRunAt: 1 });
+    for (const schedule of dueSchedules) {
+        const scheduleLog = (0, api_1.createScopedLogger)({
+            labels: { scheduleName: schedule.name },
+            prefix: "[JobSchedule]",
+        });
+        try {
+            await tickOneSchedule({ jobsService, now, schedule });
+        }
+        catch (error) {
+            api_1.logger.error(`[JobSchedule] Tick failed for "${schedule.name}": ${error instanceof Error ? error.message : String(error)}`);
+            scheduleLog.error(`Tick failed: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+};
 exports.tickDueSchedules = tickDueSchedules;

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "Josh Gachnang",
   "bugs": {
-    "url": "https://github.com/FlourishHealth/terreno/issues"
+    "url": "https://github.com/TerrenoLabs/terreno/issues"
   },
   "dependencies": {
     "@terreno/api": "57.4.0",
@@ -35,7 +35,7 @@
       "types": "./dist/runners/vercelQueues.d.ts"
     }
   },
-  "homepage": "https://github.com/FlourishHealth/terreno#readme",
+  "homepage": "https://github.com/TerrenoLabs/terreno#readme",
   "keywords": [
     "background-jobs",
     "queue",
@@ -64,7 +64,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@github.com/FlourishHealth/terreno.git"
+    "url": "git+ssh://git@github.com/TerrenoLabs/terreno.git"
   },
   "scripts": {
     "compile": "bun tsc",
@@ -78,5 +78,5 @@
     "test:coverage": "bun run ../scripts/check-coverage.ts"
   },
   "types": "dist/index.d.ts",
-  "version": "57.4.0"
+  "version": "57.6.0"
 }

package/src/models/job.ts

@@ -80,12 +80,12 @@ const jobSchema: JobSchema = new mongoose.Schema<JobDocument, JobModel>(
     },
     retriedById: {
       description: "Follow-up job created by an admin retry action",
-      ref: "Job",
+      ref: "TerrenoJob",
       type: mongoose.Schema.Types.ObjectId,
     },
     retriedFromId: {
       description: "Original job row that this retry was created from",
-      ref: "Job",
+      ref: "TerrenoJob",
       type: mongoose.Schema.Types.ObjectId,
     },
     runAt: {
@@ -96,7 +96,7 @@ const jobSchema: JobSchema = new mongoose.Schema<JobDocument, JobModel>(
     },
     scheduleId: {
       description: "Recurring schedule that enqueued this job, when applicable",
-      ref: "JobSchedule",
+      ref: "TerrenoJobSchedule",
       type: mongoose.Schema.Types.ObjectId,
     },
     status: {
@@ -126,4 +126,4 @@ jobSchema.index(
 jobSchema.index({status: 1, runAt: 1});
 jobSchema.index({scheduleId: 1, status: 1});
 
-export const Job = mongoose.model<JobDocument, JobModel>("Job", jobSchema);
+export const Job = mongoose.model<JobDocument, JobModel>("TerrenoJob", jobSchema, "jobs");

package/src/models/jobSchedule.ts

@@ -52,6 +52,7 @@ jobScheduleSchema.plugin(findExactlyOne);
 jobScheduleSchema.index({enabled: 1, nextRunAt: 1});
 
 export const JobSchedule = mongoose.model<JobScheduleDocument, JobScheduleModel>(
-  "JobSchedule",
-  jobScheduleSchema
+  "TerrenoJobSchedule",
+  jobScheduleSchema,
+  "jobschedules"
 );

package/src/tests/packageExports.test.ts

@@ -1,5 +1,6 @@
-import {describe, it} from "bun:test";
+import {afterAll, describe, it} from "bun:test";
 import {assert} from "chai";
+import mongoose from "mongoose";
 
 import {
   getJobsService,
@@ -11,14 +12,29 @@ import {
   unregisterJobsService,
 } from "../index";
 
+afterAll(() => {
+  for (const modelName of ["Job", "JobSchedule"]) {
+    if (mongoose.models[modelName]) {
+      mongoose.deleteModel(modelName);
+    }
+  }
+});
+
 describe("package public exports", () => {
   it("re-exports JobsApp, models, MongoJobRunner, and getJobsService", (): void => {
     assert.equal(JobsApp.name, "JobsApp");
     assert.equal(MongoJobRunner.name, "MongoJobRunner");
-    assert.equal(Job.modelName, "Job");
-    assert.equal(JobSchedule.modelName, "JobSchedule");
+    assert.equal(Job.modelName, "TerrenoJob");
+    assert.equal(Job.collection.collectionName, "jobs");
+    assert.equal(JobSchedule.modelName, "TerrenoJobSchedule");
+    assert.equal(JobSchedule.collection.collectionName, "jobschedules");
     assert.equal(typeof getJobsService, "function");
     assert.equal(typeof tryGetJobsService, "function");
     assert.equal(typeof unregisterJobsService, "function");
   });
+
+  it("allows consumers to register generic job model names", (): void => {
+    assert.doesNotThrow(() => mongoose.model("Job", new mongoose.Schema({})));
+    assert.doesNotThrow(() => mongoose.model("JobSchedule", new mongoose.Schema({})));
+  });
 });

package/tsconfig.json

@@ -1,33 +1,18 @@
 {
   "compilerOptions": {
-    "allowJs": true,
-    "allowSyntheticDefaultImports": true,
-    "baseUrl": "./",
     "declaration": true,
-    "downlevelIteration": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "ignoreDeprecations": "6.0",
-    "jsx": "react",
-    "lib": ["es2017", "dom", "es2017.object"],
-    "module": "commonjs",
-    "moduleResolution": "node",
-    "noEmit": false,
+    "isolatedModules": true,
+    "lib": ["es2023"],
+    "module": "nodenext",
     "noImplicitAny": false,
     "noImplicitReturns": true,
-    "noImplicitThis": true,
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
     "outDir": "./dist",
     "rootDir": "./src",
-    "preserveConstEnums": true,
-    "removeComments": false,
     "skipLibCheck": true,
     "strict": true,
-    "strictFunctionTypes": true,
-    "strictNullChecks": true,
-    "target": "es5"
+    "target": "es2023",
+    "types": ["node"]
   },
   "exclude": ["node_modules", "src/tests", "**/*.test.ts"],
-  "include": ["src/**/*.ts*", "src/*.ts"]
+  "include": ["src"]
 }