@rebasepro/server 0.22.0 → 0.24.0

package/dist/cron-routes-Bc-SB0Se.js

@@ -0,0 +1,96 @@
+import { createRequire as __rebaseCreateRequire } from "module";
+import __rebaseProcess from "process";
+globalThis.process ??= __rebaseProcess;
+__rebaseCreateRequire(import.meta.url);
+import { n as __exportAll } from "./rolldown-runtime-dW7B1o5h.js";
+import { r as isAlreadyExecutingSkip } from "./cron-scheduler-CYQgco86.js";
+import { r as logger } from "./logger-D-S-hO5e.js";
+import { r as errorHandler, t as ApiError } from "./errors-D6_y86c5.js";
+import { a as resolveListLimitParam } from "./query-parser-BgiKJKvc.js";
+import { Hono } from "hono";
+//#region src/cron/cron-routes.ts
+var cron_routes_exports = /* @__PURE__ */ __exportAll({ createCronRoutes: () => createCronRoutes });
+/** Who made a change, as `cron_job_state.updated_by` records it. */
+function actorOf(c) {
+	const user = c.get("user");
+	if (typeof user === "object" && user !== null && typeof user.uid === "string") return user.uid;
+	const apiKey = c.get("apiKey");
+	return apiKey ? `api-key:${apiKey.id}` : void 0;
+}
+/**
+* Create admin REST routes for managing cron jobs.
+*
+* Routes:
+*   GET    /          → list all cron jobs
+*   GET    /:id       → get a single job's status
+*   POST   /:id/trigger → manually trigger a job
+*   GET    /:id/logs  → get execution logs for a job
+*   PUT    /:id       → update job (enable/disable, or `null` to follow the code)
+*
+* Every answer about a job's state is read from the store, not from this
+* process's memory: the process serving these routes is often not the one
+* running the jobs (the `api` role never starts its scheduler), and is only
+* ever one replica of several.
+*/
+function createCronRoutes(scheduler, skipped = 0) {
+	const router = new Hono();
+	router.onError(errorHandler);
+	router.get("/", async (c) => {
+		const jobs = await scheduler.fetchJobs();
+		const rejected = scheduler.listRejectedJobs();
+		const total = skipped + rejected.length;
+		return c.json({
+			jobs,
+			...total > 0 && {
+				skipped: total,
+				...rejected.length > 0 && { rejected },
+				note: [skipped > 0 ? `${skipped} cron file(s) failed to load` : void 0, rejected.length > 0 ? `${rejected.length} job(s) were refused` : void 0].filter(Boolean).join(" and ") + " — NOT scheduled. " + (rejected.length > 0 ? "See `rejected` for the reason; " : "") + "the server log has the rest."
+			}
+		});
+	});
+	router.get("/:id", async (c) => {
+		const id = c.req.param("id");
+		const job = await scheduler.fetchJob(id);
+		if (!job) throw ApiError.notFound(`Cron job "${id}" not found`);
+		return c.json({ job });
+	});
+	router.post("/:id/trigger", async (c) => {
+		const id = c.req.param("id");
+		if (!scheduler.getJob(id)) throw ApiError.notFound(`Cron job "${id}" not found`);
+		const log = await scheduler.triggerJob(id);
+		if (log && isAlreadyExecutingSkip(log)) throw ApiError.conflict(`Cron job "${id}" is already executing — try again when that run has finished`, "CRON_JOB_ALREADY_EXECUTING", { log });
+		return c.json({
+			log,
+			job: await scheduler.fetchJob(id)
+		});
+	});
+	router.get("/:id/logs", async (c) => {
+		const id = c.req.param("id");
+		const limit = resolveListLimitParam(c.req.query("limit") ?? null, { defaultLimit: 50 });
+		if (!scheduler.getJob(id)) throw ApiError.notFound(`Cron job "${id}" not found`);
+		const logs = await scheduler.getJobLogsFromDb(id, limit).catch((err) => {
+			logger.error(`[cron] Could not read the run history of "${id}"`, { error: err });
+			throw ApiError.serviceUnavailable(`The run history of cron job "${id}" could not be read. The server log has the reason.`);
+		});
+		return c.json({ logs });
+	});
+	router.put("/:id", async (c) => {
+		const id = c.req.param("id");
+		const body = await c.req.json().catch(() => ({}));
+		const enabled = typeof body === "object" && body !== null && "enabled" in body ? body.enabled : void 0;
+		if (typeof enabled !== "boolean" && enabled !== null) throw ApiError.badRequest("Missing 'enabled' in body: true or false to override the job's code, or null to follow it again");
+		if (!scheduler.getJob(id)) throw ApiError.notFound(`Cron job "${id}" not found`);
+		try {
+			await scheduler.persistJobEnabled(id, enabled, actorOf(c));
+		} catch (err) {
+			logger.error(`[cron] Could not save the enabled state of "${id}"`, { error: err });
+			throw ApiError.serviceUnavailable(`The change to cron job "${id}" could not be saved, so no process was changed. The server log has the reason.`);
+		}
+		return c.json({ job: await scheduler.fetchJob(id) });
+	});
+	return router;
+}
+//#endregion
+export { cron_routes_exports as n, createCronRoutes as t };
+
+//# sourceMappingURL=cron-routes-Bc-SB0Se.js.map

package/dist/cron-routes-Bc-SB0Se.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cron-routes-Bc-SB0Se.js","names":[],"sources":["../src/cron/cron-routes.ts"],"sourcesContent":["import { Hono } from \"hono\";\nimport type { Context } from \"hono\";\nimport type { HonoEnv } from \"../api/types\";\nimport { isAlreadyExecutingSkip, type CronScheduler } from \"./cron-scheduler\";\nimport { ApiError, errorHandler } from \"../api/errors\";\nimport { resolveListLimitParam } from \"../api/rest/query-parser\";\nimport { logger } from \"../utils/logger.js\";\n\n/** Who made a change, as `cron_job_state.updated_by` records it. */\nfunction actorOf(c: Context<HonoEnv>): string | undefined {\n    const user = c.get(\"user\");\n    if (typeof user === \"object\" && user !== null && typeof user.uid === \"string\") return user.uid;\n    const apiKey = c.get(\"apiKey\");\n    return apiKey ? `api-key:${apiKey.id}` : undefined;\n}\n\n/**\n * Create admin REST routes for managing cron jobs.\n *\n * Routes:\n *   GET    /          → list all cron jobs\n *   GET    /:id       → get a single job's status\n *   POST   /:id/trigger → manually trigger a job\n *   GET    /:id/logs  → get execution logs for a job\n *   PUT    /:id       → update job (enable/disable, or `null` to follow the code)\n *\n * Every answer about a job's state is read from the store, not from this\n * process's memory: the process serving these routes is often not the one\n * running the jobs (the `api` role never starts its scheduler), and is only\n * ever one replica of several.\n */\nexport function createCronRoutes(scheduler: CronScheduler, skipped = 0): Hono<HonoEnv> {\n    const router = new Hono<HonoEnv>();\n    // Hono's onError does NOT propagate from parent to child routers, so this\n    // child router registers its own handler to format thrown ApiErrors.\n    router.onError(errorHandler);\n\n    // List all jobs\n    router.get(\"/\", async (c) => {\n        const jobs = await scheduler.fetchJobs();\n        // A file that failed to load is not a job, so it appears nowhere in\n        // this list — and \"my job is missing\" and \"my job is not scheduled\"\n        // look identical from here. Say how many were dropped, as the\n        // functions listing does, so the Studio panel and anyone with curl can\n        // see it without boot-log access.\n        //\n        // Two ways to be dropped, counted together and reported apart. A file\n        // the loader could not read has only a count: the failure happened\n        // before there was a job to name. A schedule the scheduler refused has a\n        // name and a reason — most often \"Expected 5 fields, got 6\", from an\n        // expression copied out of a tool that supports seconds — and quoting it\n        // here turns a job that silently never fires into a one-line fix.\n        const rejected = scheduler.listRejectedJobs();\n        const total = skipped + rejected.length;\n        return c.json({\n            jobs,\n            ...(total > 0 && {\n                skipped: total,\n                ...(rejected.length > 0 && { rejected }),\n                note: [\n                    skipped > 0 ? `${skipped} cron file(s) failed to load` : undefined,\n                    // Not \"an invalid schedule\": a job is also refused for an\n                    // unknown timezone or a timeout that is not a positive\n                    // number, and `rejected` says which.\n                    rejected.length > 0 ? `${rejected.length} job(s) were refused` : undefined\n                ].filter(Boolean).join(\" and \") +\n                    \" — NOT scheduled. \" +\n                    (rejected.length > 0\n                        ? \"See `rejected` for the reason; \"\n                        : \"\") +\n                    \"the server log has the rest.\"\n            })\n        });\n    });\n\n    // Get single job\n    router.get(\"/:id\", async (c) => {\n        const id = c.req.param(\"id\");\n        const job = await scheduler.fetchJob(id);\n        if (!job) {\n            throw ApiError.notFound(`Cron job \"${id}\" not found`);\n        }\n        return c.json({ job });\n    });\n\n    // Trigger a job manually\n    router.post(\"/:id/trigger\", async (c) => {\n        const id = c.req.param(\"id\");\n        const job = scheduler.getJob(id);\n        if (!job) {\n            throw ApiError.notFound(`Cron job \"${id}\" not found`);\n        }\n\n        const log = await scheduler.triggerJob(id);\n        // Nothing ran, so this is not a success: the job is executing already —\n        // on this process, or on whichever one holds its run lease (the worker,\n        // seen from the api role). The skip is in the run history either way;\n        // `details.log` carries it, and its line names the process.\n        if (log && isAlreadyExecutingSkip(log)) {\n            throw ApiError.conflict(\n                `Cron job \"${id}\" is already executing — try again when that run has finished`,\n                \"CRON_JOB_ALREADY_EXECUTING\",\n                { log }\n            );\n        }\n        return c.json({ log,\njob: await scheduler.fetchJob(id) });\n    });\n\n    // Get job logs\n    router.get(\"/:id/logs\", async (c) => {\n        const id = c.req.param(\"id\");\n        // Validated, not `parseInt`-ed. `?limit=abc` used to reach the store as\n        // `NaN`, where Postgres refused `LIMIT NaN`, the store swallowed the\n        // error and returned `[]` — a 200 with an empty list, which reads as\n        // \"this job has never run\". The data plane answers 400 for the same\n        // input; so does this now.\n        const limit = resolveListLimitParam(c.req.query(\"limit\") ?? null, { defaultLimit: 50 });\n\n        const job = scheduler.getJob(id);\n        if (!job) {\n            throw ApiError.notFound(`Cron job \"${id}\" not found`);\n        }\n\n        const logs = await scheduler.getJobLogsFromDb(id, limit).catch((err: unknown) => {\n            // Not an empty 200: Studio shows that as \"No executions yet\".\n            logger.error(`[cron] Could not read the run history of \"${id}\"`, { error: err });\n            throw ApiError.serviceUnavailable(\n                `The run history of cron job \"${id}\" could not be read. The server log has the reason.`\n            );\n        });\n        return c.json({ logs });\n    });\n\n    // Enable/disable a job — for every process, and across redeploys\n    router.put(\"/:id\", async (c) => {\n        const id = c.req.param(\"id\");\n        const body: unknown = await c.req.json().catch(() => ({}));\n        const enabled = typeof body === \"object\" && body !== null && \"enabled\" in body ? body.enabled : undefined;\n\n        if (typeof enabled !== \"boolean\" && enabled !== null) {\n            throw ApiError.badRequest(\n                \"Missing 'enabled' in body: true or false to override the job's code, or null to follow it again\"\n            );\n        }\n\n        if (!scheduler.getJob(id)) {\n            throw ApiError.notFound(`Cron job \"${id}\" not found`);\n        }\n\n        try {\n            await scheduler.persistJobEnabled(id, enabled, actorOf(c));\n        } catch (err) {\n            logger.error(`[cron] Could not save the enabled state of \"${id}\"`, { error: err });\n            throw ApiError.serviceUnavailable(\n                `The change to cron job \"${id}\" could not be saved, so no process was changed. ` +\n                \"The server log has the reason.\"\n            );\n        }\n\n        return c.json({ job: await scheduler.fetchJob(id) });\n    });\n\n    return router;\n}\n"],"mappings":";;;;;;;;;;;;;AASA,SAAS,QAAQ,GAAyC;CACtD,MAAM,OAAO,EAAE,IAAI,MAAM;CACzB,IAAI,OAAO,SAAS,YAAY,SAAS,QAAQ,OAAO,KAAK,QAAQ,UAAU,OAAO,KAAK;CAC3F,MAAM,SAAS,EAAE,IAAI,QAAQ;CAC7B,OAAO,SAAS,WAAW,OAAO,OAAO,KAAA;AAC7C;;;;;;;;;;;;;;;;AAiBA,SAAgB,iBAAiB,WAA0B,UAAU,GAAkB;CACnF,MAAM,SAAS,IAAI,KAAc;CAGjC,OAAO,QAAQ,YAAY;CAG3B,OAAO,IAAI,KAAK,OAAO,MAAM;EACzB,MAAM,OAAO,MAAM,UAAU,UAAU;EAavC,MAAM,WAAW,UAAU,iBAAiB;EAC5C,MAAM,QAAQ,UAAU,SAAS;EACjC,OAAO,EAAE,KAAK;GACV;GACA,GAAI,QAAQ,KAAK;IACb,SAAS;IACT,GAAI,SAAS,SAAS,KAAK,EAAE,SAAS;IACtC,MAAM,CACF,UAAU,IAAI,GAAG,QAAQ,gCAAgC,KAAA,GAIzD,SAAS,SAAS,IAAI,GAAG,SAAS,OAAO,wBAAwB,KAAA,CACrE,CAAC,CAAC,OAAO,OAAO,CAAC,CAAC,KAAK,OAAO,IAC1B,wBACC,SAAS,SAAS,IACb,oCACA,MACN;GACR;EACJ,CAAC;CACL,CAAC;CAGD,OAAO,IAAI,QAAQ,OAAO,MAAM;EAC5B,MAAM,KAAK,EAAE,IAAI,MAAM,IAAI;EAC3B,MAAM,MAAM,MAAM,UAAU,SAAS,EAAE;EACvC,IAAI,CAAC,KACD,MAAM,SAAS,SAAS,aAAa,GAAG,YAAY;EAExD,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC;CACzB,CAAC;CAGD,OAAO,KAAK,gBAAgB,OAAO,MAAM;EACrC,MAAM,KAAK,EAAE,IAAI,MAAM,IAAI;EAE3B,IAAI,CADQ,UAAU,OAAO,EACxB,GACD,MAAM,SAAS,SAAS,aAAa,GAAG,YAAY;EAGxD,MAAM,MAAM,MAAM,UAAU,WAAW,EAAE;EAKzC,IAAI,OAAO,uBAAuB,GAAG,GACjC,MAAM,SAAS,SACX,aAAa,GAAG,gEAChB,8BACA,EAAE,IAAI,CACV;EAEJ,OAAO,EAAE,KAAK;GAAE;GACxB,KAAK,MAAM,UAAU,SAAS,EAAE;EAAE,CAAC;CAC/B,CAAC;CAGD,OAAO,IAAI,aAAa,OAAO,MAAM;EACjC,MAAM,KAAK,EAAE,IAAI,MAAM,IAAI;EAM3B,MAAM,QAAQ,sBAAsB,EAAE,IAAI,MAAM,OAAO,KAAK,MAAM,EAAE,cAAc,GAAG,CAAC;EAGtF,IAAI,CADQ,UAAU,OAAO,EACxB,GACD,MAAM,SAAS,SAAS,aAAa,GAAG,YAAY;EAGxD,MAAM,OAAO,MAAM,UAAU,iBAAiB,IAAI,KAAK,CAAC,CAAC,OAAO,QAAiB;GAE7E,OAAO,MAAM,6CAA6C,GAAG,IAAI,EAAE,OAAO,IAAI,CAAC;GAC/E,MAAM,SAAS,mBACX,gCAAgC,GAAG,oDACvC;EACJ,CAAC;EACD,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC;CAC1B,CAAC;CAGD,OAAO,IAAI,QAAQ,OAAO,MAAM;EAC5B,MAAM,KAAK,EAAE,IAAI,MAAM,IAAI;EAC3B,MAAM,OAAgB,MAAM,EAAE,IAAI,KAAK,CAAC,CAAC,aAAa,CAAC,EAAE;EACzD,MAAM,UAAU,OAAO,SAAS,YAAY,SAAS,QAAQ,aAAa,OAAO,KAAK,UAAU,KAAA;EAEhG,IAAI,OAAO,YAAY,aAAa,YAAY,MAC5C,MAAM,SAAS,WACX,iGACJ;EAGJ,IAAI,CAAC,UAAU,OAAO,EAAE,GACpB,MAAM,SAAS,SAAS,aAAa,GAAG,YAAY;EAGxD,IAAI;GACA,MAAM,UAAU,kBAAkB,IAAI,SAAS,QAAQ,CAAC,CAAC;EAC7D,SAAS,KAAK;GACV,OAAO,MAAM,+CAA+C,GAAG,IAAI,EAAE,OAAO,IAAI,CAAC;GACjF,MAAM,SAAS,mBACX,2BAA2B,GAAG,gFAElC;EACJ;EAEA,OAAO,EAAE,KAAK,EAAE,KAAK,MAAM,UAAU,SAAS,EAAE,EAAE,CAAC;CACvD,CAAC;CAED,OAAO;AACX"}