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

packages/cron-jobs/src/jobs/docker.ts

@@ -1,14 +1,17 @@
 import SuperJSON from "superjson";
 
+import { createLogger } from "@homarr/core/infrastructure/logs";
+import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
 import { EVERY_MINUTE } from "@homarr/cron-jobs-core/expressions";
 import { db, eq } from "@homarr/db";
 import { items } from "@homarr/db/schema";
-import { logger } from "@homarr/log";
 import { dockerContainersRequestHandler } from "@homarr/request-handler/docker";
 
 import type { WidgetComponentProps } from "../../../widgets";
 import { createCronJob } from "../lib";
 
+const logger = createLogger({ module: "dockerJobs" });
+
 export const dockerContainersJob = createCronJob("dockerContainers", EVERY_MINUTE).withCallback(async () => {
   const dockerItems = await db.query.items.findMany({
     where: eq(items.kind, "dockerContainers"),
@@ -21,7 +24,7 @@ export const dockerContainersJob = createCronJob("dockerContainers", EVERY_MINUT
         const innerHandler = dockerContainersRequestHandler.handler(options);
         await innerHandler.getCachedOrUpdatedDataAsync({ forceUpdate: true });
       } catch (error) {
-        logger.error("Failed to update Docker container status", { item, error });
+        logger.error(new ErrorWithMetadata("Failed to update Docker container status", { item }, { cause: error }));
       }
     }),
   );

packages/cron-jobs/src/jobs/icons-updater.ts

@@ -1,14 +1,16 @@
 import { createId, splitToNChunks, Stopwatch } from "@homarr/common";
 import { env } from "@homarr/common/env";
+import { createLogger } from "@homarr/core/infrastructure/logs";
 import { EVERY_WEEK } from "@homarr/cron-jobs-core/expressions";
 import type { InferInsertModel } from "@homarr/db";
 import { db, handleTransactionsAsync, inArray, sql } from "@homarr/db";
 import { iconRepositories, icons } from "@homarr/db/schema";
 import { fetchIconsAsync } from "@homarr/icons";
-import { logger } from "@homarr/log";
 
 import { createCronJob } from "../lib";
 
+const logger = createLogger({ module: "iconsUpdaterJobs" });
+
 export const iconsUpdaterJob = createCronJob("iconsUpdater", EVERY_WEEK, {
   runOnStart: true,
   expectedMaximumDurationInMillis: 10 * 1000,
@@ -21,9 +23,11 @@ export const iconsUpdaterJob = createCronJob("iconsUpdater", EVERY_WEEK, {
   const countIcons = repositoryIconGroups
     .map((group) => group.icons.length)
     .reduce((partialSum, arrayLength) => partialSum + arrayLength, 0);
-  logger.info(
-    `Successfully fetched ${countIcons} icons from ${repositoryIconGroups.length} repositories within ${stopWatch.getElapsedInHumanWords()}`,
-  );
+  logger.info("Fetched icons from repositories", {
+    repositoryCount: repositoryIconGroups.length,
+    iconCount: countIcons,
+    duration: stopWatch.getElapsedInHumanWords(),
+  });
 
   const databaseIconRepositories = await db.query.iconRepositories.findMany({
     with: {
@@ -162,5 +166,9 @@ export const iconsUpdaterJob = createCronJob("iconsUpdater", EVERY_WEEK, {
     },
   });
 
-  logger.info(`Updated database within ${stopWatch.getElapsedInHumanWords()} (-${countDeleted}, +${countInserted})`);
+  logger.info("Updated icons in database", {
+    duration: stopWatch.getElapsedInHumanWords(),
+    added: countInserted,
+    deleted: countDeleted,
+  });
 });

packages/cron-jobs/src/jobs/ping.ts

@@ -1,12 +1,15 @@
+import { createLogger } from "@homarr/core/infrastructure/logs";
+import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
 import { EVERY_MINUTE } from "@homarr/cron-jobs-core/expressions";
 import { db } from "@homarr/db";
 import { getServerSettingByKeyAsync } from "@homarr/db/queries";
-import { logger } from "@homarr/log";
 import { sendPingRequestAsync } from "@homarr/ping";
 import { pingChannel, pingUrlChannel } from "@homarr/redis";
 
 import { createCronJob } from "../lib";
 
+const logger = createLogger({ module: "pingJobs" });
+
 const resetPreviousUrlsAsync = async () => {
   await pingUrlChannel.clearAsync();
   logger.info("Cleared previous ping urls");
@@ -31,9 +34,9 @@ const pingAsync = async (url: string) => {
   const pingResult = await sendPingRequestAsync(url);
 
   if ("statusCode" in pingResult) {
-    logger.debug(`executed ping for url ${url} with status code ${pingResult.statusCode}`);
+    logger.debug("Executed ping successfully", { url, statusCode: pingResult.statusCode });
   } else {
-    logger.error(`Executing ping for url ${url} failed with error: ${pingResult.error}`);
+    logger.error(new ErrorWithMetadata("Executing ping failed", { url }, { cause: pingResult.error }));
   }
 
   await pingChannel.publishAsync({

packages/cron-jobs/src/jobs/rss-feeds.ts

@@ -1,15 +1,18 @@
 import SuperJSON from "superjson";
 
+import { createLogger } from "@homarr/core/infrastructure/logs";
+import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
 import { EVERY_10_MINUTES } from "@homarr/cron-jobs-core/expressions";
 import { db, eq } from "@homarr/db";
 import { items } from "@homarr/db/schema";
-import { logger } from "@homarr/log";
 // This import is done that way to avoid circular dependencies.
 import { rssFeedsRequestHandler } from "@homarr/request-handler/rss-feeds";
 
 import type { WidgetComponentProps } from "../../../widgets";
 import { createCronJob } from "../lib";
 
+const logger = createLogger({ module: "rssFeedsJobs" });
+
 export const rssFeedsJob = createCronJob("rssFeeds", EVERY_10_MINUTES).withCallback(async () => {
   const rssItems = await db.query.items.findMany({
     where: eq(items.kind, "rssFeed"),
@@ -29,7 +32,7 @@ export const rssFeedsJob = createCronJob("rssFeeds", EVERY_10_MINUTES).withCallb
           forceUpdate: true,
         });
       } catch (error) {
-        logger.error("Failed to update RSS feed", { url, error });
+        logger.error(new ErrorWithMetadata("Failed to update RSS feed", { url }, { cause: error }));
       }
     }
   }

packages/cron-jobs/src/jobs/weather.ts

@@ -1,14 +1,17 @@
 import SuperJSON from "superjson";
 
+import { createLogger } from "@homarr/core/infrastructure/logs";
+import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
 import { EVERY_10_MINUTES } from "@homarr/cron-jobs-core/expressions";
 import { db, eq } from "@homarr/db";
 import { items } from "@homarr/db/schema";
-import { logger } from "@homarr/log";
 import { weatherRequestHandler } from "@homarr/request-handler/weather";
 
 import type { WidgetComponentProps } from "../../../widgets";
 import { createCronJob } from "../lib";
 
+const logger = createLogger({ module: "weatherJobs" });
+
 export const weatherJob = createCronJob("weather", EVERY_10_MINUTES).withCallback(async () => {
   const weatherItems = await db.query.items.findMany({
     where: eq(items.kind, "weather"),
@@ -27,7 +30,7 @@ export const weatherJob = createCronJob("weather", EVERY_10_MINUTES).withCallbac
       });
       await innerHandler.getCachedOrUpdatedDataAsync({ forceUpdate: true });
     } catch (error) {
-      logger.error("Failed to update weather", { id: item.id, error });
+      logger.error(new ErrorWithMetadata("Failed to update weather", { id: item.id }, { cause: error }));
     }
   }
 });

packages/cron-jobs/src/lib/index.ts

@@ -1,24 +1,29 @@
+import { createLogger } from "@homarr/core/infrastructure/logs";
 import { beforeCallbackAsync, onCallbackErrorAsync, onCallbackSuccessAsync } from "@homarr/cron-job-status/publisher";
 import { createCronJobFunctions } from "@homarr/cron-jobs-core";
 import type { Logger } from "@homarr/cron-jobs-core/logger";
-import { logger } from "@homarr/log";
 import type { TranslationObject } from "@homarr/translation";
 
+const logger = createLogger({ module: "cronJobs" });
+
 class WinstonCronJobLogger implements Logger {
-  logDebug(message: string) {
-    logger.debug(message);
+  logDebug(message: string, metadata?: Record<string, unknown>): void {
+    logger.debug(message, metadata);
   }
-
-  logInfo(message: string) {
-    logger.info(message);
+  logInfo(message: string, metadata?: Record<string, unknown>): void {
+    logger.info(message, metadata);
   }
-
-  logError(error: unknown) {
-    logger.error(error);
+  logError(message: string, metadata?: Record<string, unknown>): void;
+  logError(error: unknown): void;
+  logError(messageOrError: unknown, metadata?: Record<string, unknown>): void {
+    if (typeof messageOrError === "string") {
+      logger.error(messageOrError, metadata);
+      return;
+    }
+    logger.error(messageOrError);
   }
-
-  logWarning(message: string) {
-    logger.warn(message);
+  logWarning(message: string, metadata?: Record<string, unknown>): void {
+    logger.warn(message, metadata);
   }
 }