feat: implement cron job oberservation routes (#48)

* refractor: replace `cron` with `croner`

* refractor: rename cron job file

* feat: add cron job observation routes

* feat: implement cron observation routes

* refractor: optimize json property names

Author: fabio-nettis

bun.lockb

@@ -50,7 +50,7 @@
     "@sentry/bun": "^7.110.1",
     "@sentry/cli": "^2.31.0",
     "chalk": "^5.3.0",
-    "cron": "^3.1.6",
+    "croner": "^8.0.2",
     "hono": "^4.1.0",
     "node-cache": "^5.1.2",
     "qs": "^6.12.0"

package.json

@@ -0,0 +1,76 @@
+import type { Cron } from "croner";
+import type { Context } from "hono";
+
+import * as crons from "jobs";
+
+function cronJSON(defaultName: string, cron: Cron) {
+  const previous = cron.currentRun()?.getTime() ?? null;
+  const current = cron.previousRun()?.getTime() ?? null;
+  const next = cron.msToNext();
+  return {
+    name: cron.name ?? defaultName,
+    pattern: cron.getPattern(),
+    status: cron.isRunning() ? "ok" : "stopped",
+    busy: cron.isBusy(),
+    runs: {
+      current,
+      previous,
+      next: next ? Date.now() + next : null,
+    },
+  };
+}
+
+export const getAllCrons = async (ctx: Context) => {
+  try {
+    const jobs = [];
+
+    for (const key in crons) {
+      const job = cronJSON(key, crons[key as keyof typeof crons] as Cron);
+      jobs.push(job);
+    }
+
+    return ctx.json({
+      data: jobs,
+      error: null,
+      pagination: {
+        page: 1,
+        pageSize: jobs.length,
+        pageCount: 1,
+        total: jobs.length,
+      },
+    });
+  } catch (error: any) {
+    ctx.get("sentry")?.captureException?.(error);
+    ctx.status(500);
+    return ctx.json({
+      data: null,
+      error: { details: [error.message] },
+    });
+  }
+};
+
+export const getCronByName = async (ctx: Context) => {
+  try {
+    const name = ctx.req.param("name");
+
+    for (const key in crons) {
+      if (key !== name) continue;
+      const job = cronJSON(name, crons[key as keyof typeof crons] as Cron);
+      ctx.status(200);
+      return ctx.json({ data: job, error: null });
+    }
+
+    ctx.status(404);
+    return ctx.json({
+      data: null,
+      error: { details: [`Cron job with name (${name}) not found`] },
+    });
+  } catch (error: any) {
+    ctx.get("sentry")?.captureException?.(error);
+    ctx.status(500);
+    return ctx.json({
+      data: null,
+      error: { details: [error.message] },
+    });
+  }
+};

src/controllers/crons.ts

@@ -1,4 +1,4 @@
-import "jobs/refresh";
+import "jobs";
 import "polyfills/BigInt";
 
 import { Hono } from "hono";
@@ -13,6 +13,7 @@ import rateLimit from "middleware/rate-limit";
 import { initSentry, sentryOptions } from "utils/sentry";
 
 import wars from "routes/war";
+import crons from "routes/crons";
 import biomes from "routes/biomes";
 import orders from "routes/orders";
 import events from "routes/events";
@@ -45,6 +46,7 @@ app.use(cache);
 // routes for the api
 const routes = [
   wars,
+  crons,
   biomes,
   events,
   orders,

src/index.ts

@@ -0,0 +1,52 @@
+import chalk from "chalk";
+import { Cron } from "croner";
+import * as Sentry from "@sentry/bun";
+
+import RequestCache from "classes/request-cache";
+import { refreshAndStoreSourceData } from "utils/refresh";
+
+export const refresh_from_source = Cron("0 */1 * * * *", async () => {
+  const startDate = Date.now();
+
+  // start a check-in with sentry
+  let checkInId = (() => {
+    if (process.env.NODE_ENV !== "production") return;
+    if (!process.env.SENTRY_DSN) return;
+    return Sentry.captureCheckIn({
+      monitorSlug: "refresh-from-source-data",
+      status: "in_progress",
+    });
+  })();
+
+  try {
+    await refreshAndStoreSourceData();
+    RequestCache.flushAll();
+
+    console.log(
+      `${chalk.bold(chalk.magenta("CRON"))} Refreshed source data ${`(${Date.now() - startDate}ms)`}`,
+    );
+
+    // send the cron check-in result to sentry
+    if (!checkInId) return;
+    Sentry.captureCheckIn({
+      checkInId,
+      status: "ok",
+      monitorSlug: "refresh-from-source-data",
+    });
+  } catch (err: any) {
+    Sentry.captureException(err);
+
+    console.error(
+      `${chalk.bold(chalk.red("ERROR"))} Error refreshing source data ${`(${Date.now() - startDate}ms)`}`,
+      `\n${err}`,
+    );
+
+    // send the cron check-in result to sentry
+    if (!checkInId) return;
+    Sentry.captureCheckIn({
+      checkInId,
+      status: "error",
+      monitorSlug: "refresh-from-source-data",
+    });
+  }
+});

src/jobs/index.ts

@@ -0,0 +1,8 @@
+import type { Hono } from "hono";
+
+import * as Cron from "controllers/crons";
+
+export default async function crons(app: Hono) {
+  app.get("/crons", Cron.getAllCrons);
+  app.get("/crons/:name", Cron.getCronByName);
+}