feat: add logging middleware (#36)

* deps: add dependency for chalk package

* refractor: optimize cron status message display

* lib(middleware): add logger middleware

* feat: implement logger middleware

Author: fabio-nettis

bun.lockb

@@ -45,6 +45,7 @@
   },
   "dependencies": {
     "@prisma/client": "^5.11.0",
+    "chalk": "^5.3.0",
     "cron": "^3.1.6",
     "hono": "^4.1.0",
     "node-cache": "^5.1.2",

package.json

@@ -4,6 +4,7 @@ import "polyfills/BigInt";
 import { Hono } from "hono";
 import { cors } from "hono/cors";
 
+import logger from "middleware/logger";
 import cache from "middleware/request-cache";
 import rateLimit from "middleware/rate-limit";
 
@@ -23,6 +24,7 @@ import assignments from "routes/assignments";
 const app = new Hono().basePath("/api");
 
 // middleware for the api
+app.use(logger);
 app.use("/*", cors());
 app.use(rateLimit);
 app.use(cache);

src/index.ts

@@ -1,3 +1,4 @@
+import chalk from "chalk";
 import { CronJob } from "cron";
 
 import RequestCache from "classes/request-cache";
@@ -8,17 +9,16 @@ new CronJob(
   async () => {
     const startDate = Date.now();
     try {
-      console.log("Refreshing source data");
-
       await refreshAndStoreSourceData();
       RequestCache.flushAll();
-
-      const endDate = Date.now();
-      console.log(`Source data refreshed in ${endDate - startDate}ms`);
+      console.log(
+        `${chalk.bold(chalk.magenta("CRON"))} Refreshed source data ${`(${Date.now() - startDate}ms)`}`,
+      );
     } catch (err: any) {
-      const endDate = Date.now();
-      console.error(`Error refreshing source data in ${endDate - startDate}ms`);
-      console.error(err);
+      console.error(
+        `${chalk.bold(chalk.red("ERROR"))} Error refreshing source data ${`(${Date.now() - startDate}ms)`}`,
+        `\n${err}`,
+      );
     }
   },
   null,

src/jobs/refresh.ts

@@ -0,0 +1,71 @@
+import chalk from "chalk";
+import type { Context, Next } from "hono";
+
+const status = (code: number) => {
+  let result;
+
+  if (!result && code >= 500) {
+    result = chalk.red(code);
+  }
+
+  if (!result && code >= 400) {
+    result = chalk.yellow(code);
+  }
+
+  if (!result && code >= 300) {
+    result = chalk.green(code);
+  }
+
+  if (!result && code >= 200) {
+    result = chalk.green(code);
+  }
+
+  if (!result) {
+    result = chalk.gray(code);
+  }
+
+  return chalk.bold(result);
+};
+
+const method = (verb: string) => {
+  let result;
+  switch (verb) {
+    case "GET":
+      result = chalk.green(verb);
+      break;
+    case "POST":
+      result = chalk.yellow(verb);
+      break;
+    case "PUT":
+      result = chalk.blue(verb);
+      break;
+    case "PATCH":
+      result = chalk.blue(verb);
+      break;
+    case "DELETE":
+      result = chalk.red(verb);
+      break;
+    default:
+      result = chalk.gray(verb);
+      break;
+  }
+
+  return chalk.bold(result);
+};
+
+export default async function logger(ctx: Context, next: Next) {
+  const start = Date.now();
+  try {
+    await next();
+  } finally {
+    const durationMs = Date.now() - start;
+    const ip = ctx.req.header("X-Forwarded-For") || ctx.req.header("X-Real-IP");
+    console.log(
+      `${ip ? `${ip} | ` : ""}${method(
+        ctx.req.method,
+      )} ${ctx.req.path} ${status(ctx.res.status)} ${chalk.grey(
+        `(${durationMs}ms)`,
+      )}`,
+    );
+  }
+}