Files
OmniRoute/tests/unit/api/jobs.test.ts
Diego Rodrigues de Sa e Souza 5e5919dcc0 maint: follow-up cherry-pick fix-in-place #9631 (conflict-resolved fallback) (#9886)
* feat(db): add a job registry for scheduled background work

Background jobs each ship their own timer today, so there is no list of what
is scheduled, no history of what ran, and no way to pause one without an
environment variable and a restart. The registry gives them one home: a jobs
table holding the schedule, a job_runs table holding the outcomes, and a
loopback-only API to inspect and control both.

Cron jobs read their expression through an optional cronGetter rather than the
stored column, so an operator changing OMNIROUTE_WARMUP_CRON does not need the
row rewritten. register() is an idempotent upsert that refreshes the schedule
but never overwrites `enabled` or `created_at`, which is what lets a job be
re-registered on every boot without discarding the operator's toggle.

Run history is pruned per job rather than globally, and safeRun records a
failure for a handler that throws as well as one that returns success:false,
so a crashing job leaves a trail instead of a gap.

The API is under /api/jobs and gated to loopback in the route guard. It can
trigger a run and flip a job off, which is runtime administration and does not
belong on a remotely reachable surface.

Signed-off-by: Minxi Hou <houminxi@gmail.com>

* feat(jobs): move the budget reset and token health check onto the registry

Both jobs owned their own timer and started themselves as an import side effect,
so nothing could report whether they were running, when they last ran, or why a
run failed. They now register with the job registry and are started from it, which
also means their schedule and run history are visible through /api/jobs.

startAll() runs each interval job's first tick synchronously, so both entry points
start the registry only after initializeCloudSync() has been awaited. The old
wiring reached that ordering two different ways: the budget reset was started
after the init call, and the health check's first sweep sat behind a 10s timer.
Replacing both with one startAll() would otherwise have moved the two handlers
in front of the initialisation they run against.

Both entry points also register the same pair of jobs. Registering one and not
the other is how a background job goes missing without anything failing.

sweep() now returns how many connections it swept, so the health check can record
a real records_affected the way the budget reset does. The migration documents
that column as a per-job count, and hardcoding zero would have left one of the two
jobs reporting a number the schema promises but the code never produces. A skipped
or empty sweep reports zero. Every existing caller ignores the return value.

The token health check keeps its own disable semantics: the handler still calls
isHealthCheckDisabled() before sweeping, so OMNIROUTE_DISABLE_TOKEN_HEALTHCHECK,
the production-build phase and the automated-test guard behave as before. Its
registry adapter lives in src/lib/jobs/ next to the budget reset rather than in
tokenHealthCheck.ts, which is already above its frozen size ceiling on the base
branch and should not grow further. The adapter lets a failing sweep throw rather
than reporting it itself, matching the budget reset: safeRun records a thrown
error as a failure run with its message.

The warmup job is seeded disabled. Its handler arrives with the warmup scheduler,
and startAll() filters on enabled before it looks for a handler, so seeding it
enabled here would warn about the missing handler on every boot.

* fix: allowlist cron-parser dep and document OMNIROUTE_RUNNOW_TIMEOUT_MS env var

Co-authored-by: diegosouzapw <diegosouza.pw@gmail.com>

---------

Signed-off-by: Minxi Hou <houminxi@gmail.com>
Co-authored-by: Minxi Hou <houminxi@gmail.com>
Co-authored-by: diegosouzapw <diegosouzapw@users.noreply.github.com>
2026-08-09 09:54:47 -03:00

211 lines
7.1 KiB
TypeScript

/** /api/jobs route tests . */
import test from "node:test";
import assert from "node:assert/strict";
import fs from "node:fs";
import os from "node:os";
import path from "node:path";
const TEST_DATA_DIR = fs.mkdtempSync(path.join(os.tmpdir(), "omniroute-jobs-api-"));
process.env.DATA_DIR = TEST_DATA_DIR;
process.env.DISABLE_SQLITE_AUTO_BACKUP = "true";
process.env.OMNIROUTE_WARMUP_ENABLED = "1";
const core = await import("../../../src/lib/db/core.ts");
const { getJobRegistry, __resetJobRegistry } =
await import("../../../src/lib/jobRegistry/index.ts");
const route = await import("../../../src/app/api/jobs/route.ts");
const runsRoute = await import("../../../src/app/api/jobs/[id]/runs/route.ts");
const enableRoute = await import("../../../src/app/api/jobs/[id]/enable/route.ts");
const disableRoute = await import("../../../src/app/api/jobs/[id]/disable/route.ts");
const runNowRoute = await import("../../../src/app/api/jobs/[id]/run-now/route.ts");
const { isLocalOnlyPath } = await import("../../../src/server/authz/routeGuard.ts");
function resetAll() {
try {
getJobRegistry().stopAll();
} catch {
// no singleton yet
}
__resetJobRegistry();
core.resetDbInstance();
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true });
fs.mkdirSync(TEST_DATA_DIR, { recursive: true });
}
test.beforeEach(() => {
resetAll();
});
test.after(() => {
core.resetDbInstance();
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true });
});
function params(id: string) {
return Promise.resolve({ id });
}
async function json(res: Response) {
return res.json();
}
test("GET /api/jobs -> 200 + list with lastRun, seeds present", async () => {
const reg = getJobRegistry();
// Register a custom job so listJobs reflects runtime registrations.
reg.register({
id: "custom",
type: "interval",
cron: null,
intervalMs: 1000,
enabled: true,
envFlag: null,
config: {},
createdAt: new Date().toISOString(),
updatedAt: new Date().toISOString(),
handler: async () => ({ success: true }),
});
const res = await route.GET();
assert.equal(res.status, 200);
const body = (await json(res)) as { data: Array<{ id: string; lastRun: unknown }> };
assert.ok(Array.isArray(body.data));
const ids = body.data.map((j) => j.id);
assert.ok(ids.includes("budget_reset"), "seeded budget_reset present");
assert.ok(ids.includes("warmup"), "seeded warmup present");
assert.ok(ids.includes("custom"), "runtime-registered custom present");
// DTO whitelist: no handler/timer leaked.
for (const job of body.data) {
assert.ok(!("handler" in job), "DTO must not expose handler");
assert.ok(Object.prototype.hasOwnProperty.call(job, "lastRun"), "lastRun present");
}
});
test("GET /api/jobs/:id/runs -> 200 + history", async () => {
const reg = getJobRegistry();
reg.register({
id: "custom",
type: "interval",
cron: null,
intervalMs: 1000,
enabled: true,
envFlag: null,
config: {},
createdAt: new Date().toISOString(),
updatedAt: new Date().toISOString(),
handler: async () => ({ success: true, recordsAffected: 2 }),
});
await reg.runNow("custom");
await new Promise((r) => setTimeout(r, 30));
const res = await runsRoute.GET(new Request("http://localhost/api/jobs/custom/runs"), {
params: params("custom"),
});
assert.equal(res.status, 200);
const body = (await json(res)) as { data: Array<{ status: string }> };
assert.ok(body.data.length >= 1);
assert.equal(body.data[0].status, "success");
});
test("GET /api/jobs/unknown/runs -> 404", async () => {
const res = await runsRoute.GET(new Request("http://localhost/api/jobs/nope/runs"), {
params: params("nope"),
});
assert.equal(res.status, 404);
});
test("POST /api/jobs/:id/enable -> 200 + enabled:true", async () => {
const reg = getJobRegistry();
reg.register({
id: "custom",
type: "interval",
cron: null,
intervalMs: 1000,
enabled: false,
envFlag: null,
config: {},
createdAt: new Date().toISOString(),
updatedAt: new Date().toISOString(),
handler: async () => ({ success: true }),
});
const res = await enableRoute.POST(
new Request("http://localhost/api/jobs/custom/enable", { method: "POST" }),
{ params: params("custom") }
);
assert.equal(res.status, 200);
const body = (await json(res)) as { data: { id: string; enabled: boolean } };
assert.deepEqual(body.data, { id: "custom", enabled: true });
assert.equal(reg.listJobs().find((j) => j.id === "custom")!.enabled, true);
});
test("POST /api/jobs/:id/disable -> 200 + enabled:false", async () => {
const reg = getJobRegistry();
reg.register({
id: "custom",
type: "interval",
cron: null,
intervalMs: 1000,
enabled: true,
envFlag: null,
config: {},
createdAt: new Date().toISOString(),
updatedAt: new Date().toISOString(),
handler: async () => ({ success: true }),
});
const res = await disableRoute.POST(
new Request("http://localhost/api/jobs/custom/disable", { method: "POST" }),
{ params: params("custom") }
);
assert.equal(res.status, 200);
const body = (await json(res)) as { data: { id: string; enabled: boolean } };
assert.deepEqual(body.data, { id: "custom", enabled: false });
assert.equal(reg.listJobs().find((j) => j.id === "custom")!.enabled, false);
});
test("POST /api/jobs/:id/run-now -> 200 + started:true", async () => {
const reg = getJobRegistry();
reg.register({
id: "custom",
type: "interval",
cron: null,
intervalMs: 1000,
enabled: true,
envFlag: null,
config: {},
createdAt: new Date().toISOString(),
updatedAt: new Date().toISOString(),
handler: async () => ({ success: true }),
});
const res = await runNowRoute.POST(
new Request("http://localhost/api/jobs/custom/run-now", { method: "POST" }),
{ params: params("custom") }
);
assert.equal(res.status, 200);
const body = (await json(res)) as { data: { started: boolean } };
assert.equal(body.data.started, true);
});
test("POST /api/jobs/unknown/run-now -> 404", async () => {
const res = await runNowRoute.POST(
new Request("http://localhost/api/jobs/nope/run-now", { method: "POST" }),
{ params: params("nope") }
);
assert.equal(res.status, 404);
});
test("LOCAL_ONLY guard: /api/jobs and children are loopback-only", () => {
assert.equal(isLocalOnlyPath("/api/jobs"), true, "bare /api/jobs");
assert.equal(isLocalOnlyPath("/api/jobs/"), true, "/api/jobs/");
assert.equal(isLocalOnlyPath("/api/jobs/budget_reset/runs"), true, "runs sub-path");
assert.equal(isLocalOnlyPath("/api/jobs/warmup/enable"), true, "enable sub-path");
assert.equal(isLocalOnlyPath("/api/jobs/warmup/disable"), true, "disable sub-path");
assert.equal(isLocalOnlyPath("/api/jobs/warmup/run-now"), true, "run-now sub-path");
});
test("error responses do not leak stack traces", async () => {
// 404 path - assert the error message is sanitized (no "at /" frame).
const res = await runsRoute.GET(new Request("http://localhost/api/jobs/nope/runs"), {
params: params("nope"),
});
const body = (await json(res)) as { error: { message: string } };
assert.ok(!body.error.message.includes("at /"), "error message must not leak stack path");
});