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

apps/nextjs/next.config.ts

@@ -2,7 +2,7 @@
 import "@homarr/auth/env";
 import "@homarr/db/env";
 import "@homarr/common/env";
-import "@homarr/log/env";
+import "@homarr/core/infrastructure/logs/env";
 import "@homarr/docker/env";
 
 import type { NextConfig } from "next";

apps/nextjs/package.json

@@ -36,7 +36,6 @@
     "@homarr/icons": "workspace:^0.1.0",
     "@homarr/image-proxy": "workspace:^0.1.0",
     "@homarr/integrations": "workspace:^0.1.0",
-    "@homarr/log": "workspace:^",
     "@homarr/modals": "workspace:^0.1.0",
     "@homarr/modals-collection": "workspace:^0.1.0",
     "@homarr/notifications": "workspace:^0.1.0",

apps/nextjs/src/app/[locale]/boards/(content)/_creator.tsx

@@ -11,8 +11,9 @@ import { IntegrationProvider } from "@homarr/auth/client";
 import { auth } from "@homarr/auth/next";
 import { getIntegrationsWithPermissionsAsync } from "@homarr/auth/server";
 import { isNullOrWhitespace } from "@homarr/common";
+import { createLogger } from "@homarr/core/infrastructure/logs";
+import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
 import type { WidgetKind } from "@homarr/definitions";
-import { logger } from "@homarr/log";
 import { getI18n } from "@homarr/translation/server";
 import { prefetchForKindAsync } from "@homarr/widgets/prefetch";
 
@@ -22,6 +23,8 @@ import type { Board, Item } from "../_types";
 import { DynamicClientBoard } from "./_dynamic-client";
 import { BoardContentHeaderActions } from "./_header-actions";
 
+const logger = createLogger({ module: "createBoardContentPage" });
+
 export type Params = Record<string, unknown>;
 
 interface Props<TParams extends Params> {
@@ -57,7 +60,13 @@ export const createBoardContentPage = <TParams extends Record<string, unknown>>(
 
       for (const [kind, items] of itemsMap) {
         await prefetchForKindAsync(kind, queryClient, items).catch((error) => {
-          logger.error(new Error("Failed to prefetch widget", { cause: error }));
+          logger.error(
+            new ErrorWithMetadata(
+              "Failed to prefetch widget",
+              { widgetKind: kind, itemCount: items.length },
+              { cause: error },
+            ),
+          );
         });
       }
 

apps/nextjs/src/app/[locale]/boards/_layout-creator.tsx

@@ -6,7 +6,7 @@ import { TRPCError } from "@trpc/server";
 import { auth } from "@homarr/auth/next";
 import { BoardProvider } from "@homarr/boards/context";
 import { EditModeProvider } from "@homarr/boards/edit-mode";
-import { logger } from "@homarr/log";
+import { createLogger } from "@homarr/core/infrastructure/logs";
 
 import { MainHeader } from "~/components/layout/header";
 import { BoardLogoWithTitle } from "~/components/layout/logo/board-logo";
@@ -18,6 +18,8 @@ import { CustomCss } from "./(content)/_custom-css";
 import { BoardReadyProvider } from "./(content)/_ready-context";
 import { BoardMantineProvider } from "./(content)/_theme";
 
+const logger = createLogger({ module: "createBoardLayout" });
+
 interface CreateBoardLayoutProps<TParams extends Params> {
   headerActions: JSX.Element;
   getInitialBoardAsync: (params: TParams) => Promise<Board>;

apps/nextjs/src/app/[locale]/manage/tools/logs/level-selection.tsx

@@ -2,8 +2,8 @@
 
 import { Select } from "@mantine/core";
 
-import type { LogLevel } from "@homarr/log/constants";
-import { logLevelConfiguration, logLevels } from "@homarr/log/constants";
+import type { LogLevel } from "@homarr/core/infrastructure/logs/constants";
+import { logLevelConfiguration, logLevels } from "@homarr/core/infrastructure/logs/constants";
 import { useI18n } from "@homarr/translation/client";
 
 import { useLogContext } from "./log-context";

apps/nextjs/src/app/[locale]/manage/tools/logs/log-context.tsx

@@ -3,8 +3,8 @@
 import type { PropsWithChildren } from "react";
 import { createContext, useContext, useMemo, useState } from "react";
 
-import type { LogLevel } from "@homarr/log/constants";
-import { logLevels } from "@homarr/log/constants";
+import type { LogLevel } from "@homarr/core/infrastructure/logs/constants";
+import { logLevels } from "@homarr/core/infrastructure/logs/constants";
 
 const LogContext = createContext<{
   level: LogLevel;

apps/nextjs/src/app/[locale]/manage/tools/logs/page.tsx

@@ -7,7 +7,7 @@ import "@xterm/xterm/css/xterm.css";
 import { notFound } from "next/navigation";
 
 import { auth } from "@homarr/auth/next";
-import { env } from "@homarr/log/env";
+import { logsEnv } from "@homarr/core/infrastructure/logs/env";
 
 import { DynamicBreadcrumb } from "~/components/navigation/dynamic-breadcrumb";
 import { fullHeightWithoutHeaderAndFooter } from "~/constants";
@@ -35,7 +35,7 @@ export default async function LogsManagementPage() {
   }
 
   return (
-    <LogContextProvider defaultLevel={env.LOG_LEVEL}>
+    <LogContextProvider defaultLevel={logsEnv.LEVEL}>
       <Group justify="space-between" align="center" wrap="nowrap">
         <DynamicBreadcrumb />
         <LogLevelSelection />

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 }));
     },
   });
 

apps/nextjs/src/errors/trpc-catch-error.ts

@@ -3,7 +3,9 @@ import "server-only";
 import { notFound, redirect } from "next/navigation";
 import { TRPCError } from "@trpc/server";
 
-import { logger } from "@homarr/log";
+import { createLogger } from "@homarr/core/infrastructure/logs";
+
+const logger = createLogger({ module: "trpcCatchError" });
 
 export const catchTrpcNotFound = (err: unknown) => {
   if (err instanceof TRPCError && err.code === "NOT_FOUND") {

apps/tasks/package.json

@@ -23,6 +23,7 @@
     "@homarr/analytics": "workspace:^0.1.0",
     "@homarr/auth": "workspace:^0.1.0",
     "@homarr/common": "workspace:^0.1.0",
+    "@homarr/core": "workspace:^",
     "@homarr/cron-job-api": "workspace:^0.1.0",
     "@homarr/cron-jobs": "workspace:^0.1.0",
     "@homarr/cron-jobs-core": "workspace:^0.1.0",
@@ -30,7 +31,6 @@
     "@homarr/definitions": "workspace:^0.1.0",
     "@homarr/icons": "workspace:^0.1.0",
     "@homarr/integrations": "workspace:^0.1.0",
-    "@homarr/log": "workspace:^",
     "@homarr/ping": "workspace:^0.1.0",
     "@homarr/redis": "workspace:^0.1.0",
     "@homarr/request-handler": "workspace:^0.1.0",

apps/tasks/src/job-manager.ts

@@ -1,11 +1,13 @@
 import { schedule, validate as validateCron } from "node-cron";
 
+import { createLogger } from "@homarr/core/infrastructure/logs";
 import type { IJobManager } from "@homarr/cron-job-api";
 import type { jobGroup as cronJobGroup, JobGroupKeys } from "@homarr/cron-jobs";
 import type { Database, InferInsertModel } from "@homarr/db";
 import { eq } from "@homarr/db";
 import { cronJobConfigurations } from "@homarr/db/schema";
-import { logger } from "@homarr/log";
+
+const logger = createLogger({ module: "jobManager" });
 
 export class JobManager implements IJobManager {
   constructor(
@@ -23,7 +25,7 @@ export class JobManager implements IJobManager {
     await this.jobGroup.stopAsync(name);
   }
   public async updateIntervalAsync(name: JobGroupKeys, cron: string): Promise<void> {
-    logger.info(`Updating cron job interval name="${name}" expression="${cron}"`);
+    logger.info("Updating cron job interval", { name, expression: cron });
     const job = this.jobGroup.getJobRegistry().get(name);
     if (!job) throw new Error(`Job ${name} not found`);
     if (!validateCron(cron)) {
@@ -38,22 +40,22 @@ export class JobManager implements IJobManager {
         name,
       }),
     );
-    logger.info(`Cron job interval updated name="${name}" expression="${cron}"`);
+    logger.info("Cron job interval updated", { name, expression: cron });
   }
   public async disableAsync(name: JobGroupKeys): Promise<void> {
-    logger.info(`Disabling cron job name="${name}"`);
+    logger.info("Disabling cron job", { name });
     const job = this.jobGroup.getJobRegistry().get(name);
     if (!job) throw new Error(`Job ${name} not found`);
 
     await this.updateConfigurationAsync(name, { isEnabled: false });
     await this.jobGroup.stopAsync(name);
-    logger.info(`Cron job disabled name="${name}"`);
+    logger.info("Cron job disabled", { name });
   }
   public async enableAsync(name: JobGroupKeys): Promise<void> {
-    logger.info(`Enabling cron job name="${name}"`);
+    logger.info("Enabling cron job", { name });
     await this.updateConfigurationAsync(name, { isEnabled: true });
     await this.jobGroup.startAsync(name);
-    logger.info(`Cron job enabled name="${name}"`);
+    logger.info("Cron job enabled", { name });
   }
 
   private async updateConfigurationAsync(
@@ -64,9 +66,11 @@ export class JobManager implements IJobManager {
       where: (table, { eq }) => eq(table.name, name),
     });
 
-    logger.debug(
-      `Updating cron job configuration name="${name}" configuration="${JSON.stringify(configuration)}" exists="${Boolean(existingConfig)}"`,
-    );
+    logger.debug("Updating cron job configuration", {
+      name,
+      configuration: JSON.stringify(configuration),
+      exists: Boolean(existingConfig),
+    });
 
     if (existingConfig) {
       await this.db
@@ -74,7 +78,10 @@ export class JobManager implements IJobManager {
         // prevent updating the name, as it is the primary key
         .set({ ...configuration, name: undefined })
         .where(eq(cronJobConfigurations.name, name));
-      logger.debug(`Cron job configuration updated name="${name}" configuration="${JSON.stringify(configuration)}"`);
+      logger.debug("Cron job configuration updated", {
+        name,
+        configuration: JSON.stringify(configuration),
+      });
       return;
     }
 
@@ -86,7 +93,10 @@ export class JobManager implements IJobManager {
       cronExpression: configuration.cronExpression ?? job.cronExpression,
       isEnabled: configuration.isEnabled ?? true,
     });
-    logger.debug(`Cron job configuration updated name="${name}" configuration="${JSON.stringify(configuration)}"`);
+    logger.debug("Cron job configuration updated", {
+      name,
+      configuration: JSON.stringify(configuration),
+    });
   }
 
   public async getAllAsync(): Promise<

apps/tasks/src/main.ts

@@ -5,16 +5,19 @@ import type { FastifyTRPCPluginOptions } from "@trpc/server/adapters/fastify";
 import { fastifyTRPCPlugin } from "@trpc/server/adapters/fastify";
 import fastify from "fastify";
 
+import { createLogger } from "@homarr/core/infrastructure/logs";
+import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
 import type { JobRouter } from "@homarr/cron-job-api";
 import { jobRouter } from "@homarr/cron-job-api";
 import { CRON_JOB_API_KEY_HEADER, CRON_JOB_API_PATH, CRON_JOB_API_PORT } from "@homarr/cron-job-api/constants";
 import { jobGroup } from "@homarr/cron-jobs";
 import { db } from "@homarr/db";
-import { logger } from "@homarr/log";
 
 import { JobManager } from "./job-manager";
 import { onStartAsync } from "./on-start";
 
+const logger = createLogger({ module: "tasksMain" });
+
 const server = fastify({
   maxParamLength: 5000,
 });
@@ -27,7 +30,7 @@ server.register(fastifyTRPCPlugin, {
       apiKey: req.headers[CRON_JOB_API_KEY_HEADER] as string | undefined,
     }),
     onError({ path, error }) {
-      logger.error(new Error(`Error in tasks tRPC handler path="${path}"`, { cause: error }));
+      logger.error(new ErrorWithMetadata("Error in tasks tRPC handler", { path }, { cause: error }));
     },
   } satisfies FastifyTRPCPluginOptions<JobRouter>["trpcOptions"],
 });
@@ -39,9 +42,11 @@ void (async () => {
 
   try {
     await server.listen({ port: CRON_JOB_API_PORT });
-    logger.info(`Tasks web server started successfully port="${CRON_JOB_API_PORT}"`);
+    logger.info("Tasks web server started successfully", { port: CRON_JOB_API_PORT });
   } catch (err) {
-    logger.error(new Error(`Failed to start tasks web server port="${CRON_JOB_API_PORT}"`, { cause: err }));
+    logger.error(
+      new ErrorWithMetadata("Failed to start tasks web server", { port: CRON_JOB_API_PORT }, { cause: err }),
+    );
     process.exit(1);
   }
 })();

apps/tasks/src/on-start/invalidate-update-checker-cache.ts

@@ -1,7 +1,7 @@
-import { logger } from "@homarr/log";
+import { createLogger } from "@homarr/core/infrastructure/logs";
 import { updateCheckerRequestHandler } from "@homarr/request-handler/update-checker";
 
-const localLogger = logger.child({ module: "invalidateUpdateCheckerCache" });
+const logger = createLogger({ module: "invalidateUpdateCheckerCache" });
 
 /**
  * Invalidates the update checker cache on startup to ensure fresh data.
@@ -11,8 +11,8 @@ export async function invalidateUpdateCheckerCacheAsync() {
   try {
     const handler = updateCheckerRequestHandler.handler({});
     await handler.invalidateAsync();
-    localLogger.debug("Update checker cache invalidated");
+    logger.debug("Update checker cache invalidated");
   } catch (error) {
-    localLogger.error(new Error("Failed to invalidate update checker cache", { cause: error }));
+    logger.error(new Error("Failed to invalidate update checker cache", { cause: error }));
   }
 }

apps/tasks/src/on-start/session-cleanup.ts

@@ -1,10 +1,10 @@
 import { env } from "@homarr/auth/env";
+import { createLogger } from "@homarr/core/infrastructure/logs";
 import { db, eq, inArray } from "@homarr/db";
 import { sessions, users } from "@homarr/db/schema";
 import { supportedAuthProviders } from "@homarr/definitions";
-import { logger } from "@homarr/log";
 
-const localLogger = logger.child({ module: "sessionCleanup" });
+const logger = createLogger({ module: "sessionCleanup" });
 
 /**
  * Deletes sessions for users that have inactive auth providers.
@@ -29,11 +29,13 @@ export async function cleanupSessionsAsync() {
     await db.delete(sessions).where(inArray(sessions.userId, userIds));
 
     if (sessionsWithInactiveProviders.length > 0) {
-      localLogger.info(`Deleted sessions for inactive providers count=${userIds.length}`);
+      logger.info("Deleted sessions for inactive providers", {
+        count: userIds.length,
+      });
     } else {
-      localLogger.debug("No sessions to delete");
+      logger.debug("No sessions to delete");
     }
   } catch (error) {
-    localLogger.error(new Error("Failed to clean up sessions", { cause: error }));
+    logger.error(new Error("Failed to clean up sessions", { cause: error }));
   }
 }

apps/websocket/package.json

@@ -20,9 +20,9 @@
     "@homarr/api": "workspace:^0.1.0",
     "@homarr/auth": "workspace:^0.1.0",
     "@homarr/common": "workspace:^0.1.0",
+    "@homarr/core": "workspace:^",
     "@homarr/db": "workspace:^0.1.0",
     "@homarr/definitions": "workspace:^0.1.0",
-    "@homarr/log": "workspace:^",
     "@homarr/redis": "workspace:^0.1.0",
     "@homarr/validation": "workspace:^0.1.0",
     "dotenv": "^17.2.3",

apps/websocket/src/main.ts

@@ -4,8 +4,10 @@ import { WebSocketServer } from "ws";
 import { appRouter, createTRPCContext } from "@homarr/api/websocket";
 import { getSessionFromToken, sessionTokenCookieName } from "@homarr/auth";
 import { parseCookies } from "@homarr/common";
+import { createLogger } from "@homarr/core/infrastructure/logs";
 import { db } from "@homarr/db";
-import { logger } from "@homarr/log";
+
+const logger = createLogger({ module: "websocketMain" });
 
 const wss = new WebSocketServer({
   port: 3001,