Feat: Live Log endpoint and adjustments

Author: Its4Nik

bun.lock

@@ -3,6 +3,10 @@ import path from "path";
 import chalk, { ChalkInstance } from "chalk";
 import { dbFunctions } from "../database/repository";
 import wrapAnsi from "wrap-ansi";
+import { logToClients } from "~/routes/live-logs";
+import { logStreamData } from "~/typings/websocket";
+
+const ansiRegex = /\x1B\[[0-?9;]*[mG]/g;
 
 // Change to false here if dont want the spacing on a wrapped line
 const padNewlines: boolean = true;
@@ -80,31 +84,40 @@ export const logger = createLogger({
         message = `[ ${chalk.greenBright("Plugin")} ] ${message}`;
       }
 
+      const logStreamData: logStreamData = {
+        timestamp: timestamp as string,
+        level: level as string,
+        message: (message as string).replace(ansiRegex, ""),
+        file: file as string,
+        line: line as number,
+      };
+
+      logToClients(logStreamData);
+
       const paddedLevel = level.toUpperCase().padEnd(5);
       const coloredLevel = (levelColors[level] || chalk.white)(paddedLevel);
       const coloredContext = chalk.cyan(`${file as string}:${line as number}`);
       const coloredTimestamp = chalk.yellow(timestamp);
 
       if (process.env.NODE_ENV !== "dev") {
         return `${coloredLevel} [ ${coloredTimestamp} ] - ${chalk.gray(
-          message,
+          message
         )} - [ ${coloredContext} ]`;
       }
 
       const prefix = `${paddedLevel} [ ${timestamp} ] - `;
       const prefixLength = prefix.length;
       const formattedMessage = formatTerminalMessage(
         message as string,
-        prefixLength,
+        prefixLength
       );
-      const ansiRegex = /\x1B\[[0-?9;]*[mG]/g;
 
       try {
         dbFunctions.addLogEntry(
           (level as string).replace(ansiRegex, ""),
           (message as string).replace(ansiRegex, ""),
           (file as string).replace(ansiRegex, ""),
-          line as number,
+          line as number
         );
       } catch (error) {
         // Use console.error to avoid recursive logging
@@ -113,7 +126,7 @@ export const logger = createLogger({
       }
 
       return `${coloredLevel} [ ${coloredTimestamp} ] - ${formattedMessage} - [ ${coloredContext} ]`;
-    }),
+    })
   ),
   transports: [new transports.Console()],
 });

src/core/utils/logger.ts

@@ -16,6 +16,8 @@ import trpcRouter from "~/core/trpc";
 import { config } from "./typings/database";
 import { validateApiKey } from "./middleware/auth";
 import { monitorDockerEvents } from "./core/docker/monitor";
+import { liveLogs } from "./routes/live-logs";
+import { utilRoutes } from "./routes/utils";
 
 console.log("");
 dbFunctions.init();
@@ -66,7 +68,7 @@ const DockStatAPI = new Elysia()
           },
         ],
       },
-    }),
+    })
   )
   .onBeforeHandle(async (context) => {
     const { path, request, set } = context;
@@ -91,6 +93,8 @@ const DockStatAPI = new Elysia()
   .use(dockerWebsocketRoutes)
   .use(apiConfigRoutes)
   .use(stackRoutes)
+  .use(utilRoutes)
+  .use(liveLogs)
   .get("/health", () => ({ status: "healthy" }), { tags: ["Utils"] })
   .onError(({ code, set, path }) => {
     if (code === "NOT_FOUND") {
@@ -115,18 +119,18 @@ async function startServer() {
 
     if (apiKey === "changeme") {
       logger.warn(
-        "Default API Key of 'changeme' detected. Please change your API Key via the `/config/update` route!",
+        "Default API Key of 'changeme' detected. Please change your API Key via the `/config/update` route!"
       );
     }
 
     DockStatAPI.listen(3000, ({ hostname, port }) => {
       console.log("----- [ ############## ]");
       logger.info(`DockStatAPI is running at http://${hostname}:${port}`);
       logger.info(
-        `Swagger API Documentation available at http://${hostname}:${port}/swagger`,
+        `Swagger API Documentation available at http://${hostname}:${port}/swagger`
       );
       logger.info(
-        `tRPC Endpoint available at: http://${hostname}:${port}/trpc`,
+        `tRPC Endpoint available at: http://${hostname}:${port}/trpc`
       );
     });
   } catch (error) {

src/index.ts

@@ -16,7 +16,7 @@ export async function hashApiKey(apiKey: string): Promise<string> {
 
 async function validateApiKeyHash(
   providedKey: string,
-  storedHash: string,
+  storedHash: string
 ): Promise<boolean> {
   logger.debug("Validating API key hash");
   try {
@@ -30,7 +30,7 @@ async function validateApiKeyHash(
 }
 
 async function getApiKeyFromDb(
-  apiKey: string,
+  apiKey: string
 ): Promise<{ hash: string } | null> {
   const dbApiKey = (dbFunctions.getConfig() as config[])[0].api_key;
   logger.debug(`Querying database for API key: ${apiKey}`);
@@ -41,16 +41,20 @@ async function getApiKeyFromDb(
 
 export async function validateApiKey(request: Request, set: set) {
   const apiKey = request.headers.get("x-api-key");
-  logger.debug(`API key validation initiated`);
 
   if (process.env.NODE_ENV != "production") {
+    logger.warn(
+      "API Key validation deactivated, since running in development mode"
+    );
     return { apiKey };
   } else if (!apiKey) {
     logger.error(`API key missing from request ${request.url}`);
     set.status = 401;
     return { error: "API key required" };
   }
 
+  logger.debug(`API key validation initiated`);
+
   try {
     const dbRecord = await getApiKeyFromDb(apiKey);