refactor(logs): move to core package (#4586)

apps/nextjs/src/app/api/[...trpc]/route.ts

@@ -6,9 +6,12 @@ import { appRouter, createTRPCContext } from "@homarr/api";
 import type { Session } from "@homarr/auth";
 import { hashPasswordAsync } from "@homarr/auth";
 import { createSessionAsync } from "@homarr/auth/server";
+import { createLogger } from "@homarr/core/infrastructure/logs";
+import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
 import { db, eq } from "@homarr/db";
 import { apiKeys } from "@homarr/db/schema";
-import { logger } from "@homarr/log";
+
+const logger = createLogger({ module: "trpcOpenApiRoute" });
 
 const handlerAsync = async (req: NextRequest) => {
   const apiKeyHeaderValue = req.headers.get("ApiKey");
@@ -27,7 +30,7 @@ const handlerAsync = async (req: NextRequest) => {
     router: appRouter,
     createContext: () => createTRPCContext({ session, headers: req.headers }),
     onError({ error, path, type }) {
-      logger.error(new Error(`tRPC Error with ${type} on '${path}'`, { cause: error.cause }));
+      logger.error(new ErrorWithMetadata("tRPC Error occured", { path, type }, { cause: error }));
     },
   });
 };
@@ -48,9 +51,10 @@ const getSessionOrDefaultFromHeadersAsync = async (
   const [apiKeyId, apiKey] = apiKeyHeaderValue.split(".");
 
   if (!apiKeyId || !apiKey) {
-    logger.warn(
-      `An attempt to authenticate over API has failed due to invalid API key format ip='${ipAdress}' userAgent='${userAgent}'`,
-    );
+    logger.warn("An attempt to authenticate over API has failed due to invalid API key format", {
+      ipAdress,
+      userAgent,
+    });
     return null;
   }
 
@@ -74,18 +78,21 @@ const getSessionOrDefaultFromHeadersAsync = async (
   });
 
   if (!apiKeyFromDb) {
-    logger.warn(`An attempt to authenticate over API has failed ip='${ipAdress}' userAgent='${userAgent}'`);
+    logger.warn("An attempt to authenticate over API has failed", { ipAdress, userAgent });
     return null;
   }
 
   const hashedApiKey = await hashPasswordAsync(apiKey, apiKeyFromDb.salt);
 
   if (apiKeyFromDb.apiKey !== hashedApiKey) {
-    logger.warn(`An attempt to authenticate over API has failed ip='${ipAdress}' userAgent='${userAgent}'`);
+    logger.warn("An attempt to authenticate over API has failed", { ipAdress, userAgent });
     return null;
   }
 
-  logger.info(`Read session from API request and found user ${apiKeyFromDb.user.name} (${apiKeyFromDb.user.id})`);
+  logger.info("Read session from API request and found user", {
+    name: apiKeyFromDb.user.name,
+    id: apiKeyFromDb.user.id,
+  });
   return await createSessionAsync(db, apiKeyFromDb.user);
 };
 

apps/nextjs/src/app/api/auth/[...nextauth]/route.ts

@@ -1,8 +1,10 @@
 import { NextRequest } from "next/server";
 
 import { createHandlersAsync } from "@homarr/auth";
+import { createLogger } from "@homarr/core/infrastructure/logs";
 import type { SupportedAuthProvider } from "@homarr/definitions";
-import { logger } from "@homarr/log";
+
+const logger = createLogger({ module: "nextAuthRoute" });
 
 export const GET = async (req: NextRequest) => {
   const { handlers } = await createHandlersAsync(extractProvider(req), isSecureCookieEnabled(req));

apps/nextjs/src/app/api/health/live/route.ts

@@ -1,13 +1,16 @@
 import { performance } from "perf_hooks";
 
+import { createLogger } from "@homarr/core/infrastructure/logs";
+import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
 import { db } from "@homarr/db";
-import { logger } from "@homarr/log";
 import { handshakeAsync } from "@homarr/redis";
 
+const logger = createLogger({ module: "healthLiveRoute" });
+
 export async function GET() {
   const timeBeforeHealthCheck = performance.now();
   const response = await executeAndAggregateAllHealthChecksAsync();
-  logger.info(`Completed healthcheck after ${performance.now() - timeBeforeHealthCheck}ms`);
+  logger.info("Completed healthcheck", { elapsed: `${performance.now() - timeBeforeHealthCheck}ms` });
 
   if (response.status === "healthy") {
     return new Response(JSON.stringify(response), {
@@ -73,7 +76,7 @@ const executeHealthCheckSafelyAsync = async (
     };
   } catch (error) {
     // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-    logger.error(`Healthcheck '${name}' has failed: ${error}`);
+    logger.error(new ErrorWithMetadata("Healthcheck failed", { name }, { cause: error }));
     return {
       status: "unhealthy",
       values: {

apps/nextjs/src/app/api/trpc/[trpc]/route.ts

@@ -3,7 +3,10 @@ import { fetchRequestHandler } from "@trpc/server/adapters/fetch";
 import { appRouter, createTRPCContext } from "@homarr/api";
 import { trpcPath } from "@homarr/api/shared";
 import { auth } from "@homarr/auth/next";
-import { logger } from "@homarr/log";
+import { createLogger } from "@homarr/core/infrastructure/logs";
+import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
+
+const logger = createLogger({ module: "trpcRoute" });
 
 /**
  * Configure basic CORS headers
@@ -31,7 +34,7 @@ const handler = auth(async (req) => {
     req,
     createContext: () => createTRPCContext({ session: req.auth, headers: req.headers }),
     onError({ error, path, type }) {
-      logger.error(new Error(`tRPC Error with ${type} on '${path}'`, { cause: error.cause }));
+      logger.error(new ErrorWithMetadata("tRPC Error occured", { path, type }, { cause: error }));
     },
   });