feat: remove dotenv library from the logger

Author: bartoszherba

packages/logger/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vue-storefront/logger",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "main": "lib/index.cjs.js",
   "module": "lib/index.es.js",
   "types": "lib/index.d.ts",
@@ -24,7 +24,6 @@
     "node": ">=18"
   },
   "dependencies": {
-    "consola": "^3",
-    "dotenv": "^16"
+    "consola": "^3"
   }
 }

packages/logger/src/ConsolaStructuredLogger.ts

@@ -1,46 +1,42 @@
-import { ConsolaOptions, createConsola } from "consola";
+import type { ConsolaOptions, LogObject } from "consola";
+import { createConsola } from "consola";
 
-import dotenv from "dotenv";
-import { LogVerbosity } from "./interfaces/LogVerbosity";
 import type {
   LogData,
   LoggerInterface,
   Metadata,
 } from "./interfaces/LoggerInterface";
 import type { LoggerOptions } from "./interfaces/LoggerOptions";
+import type { LogVerbosity } from "./interfaces/LogVerbosity";
 import type { StructuredLog } from "./interfaces/StructuredLog";
 import { jsonReporter } from "./reporters/consola/jsonReporter";
 
-// We do not want to load the .env in the browser and in the edge runtime
-if (typeof window === "undefined" && process.env.NEXT_RUNTIME !== "edge") {
-  dotenv.config();
-}
-
 interface ConsolaLoggerOptions
   extends LoggerOptions,
     Partial<Omit<ConsolaOptions, "level">> {}
 
 const createConsolaStructuredLogger = (
   structuredLog: StructuredLog,
+  environment: string,
   options: ConsolaLoggerOptions = {
-    verbosity: "info",
     includeStackTrace: true,
+    verbosity: "info",
   }
 ): LoggerInterface => {
   const levelMap: Record<LogVerbosity, number> = {
-    emergency: 0,
     alert: 0,
     critical: 0,
+    debug: 4,
+    emergency: 0,
     error: 0,
-    warning: 1,
-    notice: 2,
     info: 3,
-    debug: 4,
+    notice: 2,
+    warning: 1,
   };
 
   const buildJsonReporter = () => {
     return {
-      log: jsonReporter,
+      log: (logObject: LogObject) => jsonReporter(logObject, environment),
     };
   };
 
@@ -121,14 +117,14 @@ const createConsolaStructuredLogger = (
   const debug = logAtLevel("debug");
 
   return {
-    emergency,
     alert,
     critical,
+    debug,
+    emergency,
     error,
-    warning,
-    notice,
     info,
-    debug,
+    notice,
+    warning,
   };
 };
 

packages/logger/src/LoggerFactory.ts

@@ -1,6 +1,6 @@
-import { GCPStructuredLog } from "./structuredLog/GCPStructuredLog";
-import { LoggerOptions } from "./interfaces/LoggerOptions";
 import { createConsolaStructuredLogger } from "./ConsolaStructuredLogger";
+import type { LoggerOptions } from "./interfaces/LoggerOptions";
+import { GCPStructuredLog } from "./structuredLog/GCPStructuredLog";
 
 export enum LoggerType {
   ConsolaGcp = "consola-gcp",
@@ -13,11 +13,17 @@ export enum LoggerType {
  *
  * @param type The type of logger to create
  */
+
+// biome-ignore lint/complexity/noStaticOnlyClass: <explanation>
 export class LoggerFactory {
-  static create(type: LoggerType, options?: LoggerOptions) {
+  static create(
+    type: LoggerType,
+    options?: LoggerOptions,
+    environment = process.env.NODE_ENV ?? "production"
+  ) {
     const defaultOptions = {
-      verbosity: "info",
       includeStackTrace: false,
+      verbosity: "info",
     } satisfies LoggerOptions;
 
     const mergedOptions = {
@@ -29,6 +35,7 @@ export class LoggerFactory {
       case LoggerType.ConsolaGcp:
         return createConsolaStructuredLogger(
           new GCPStructuredLog(),
+          environment,
           mergedOptions
         );
       default:

packages/logger/src/reporters/consola/jsonReporter.ts

@@ -1,11 +1,11 @@
 import type { LogObject } from "consola";
 
-export const jsonReporter = (logObject: LogObject) => {
+export const jsonReporter = (logObject: LogObject, environment: string) => {
   const defLogType = "log";
   const logType = logObject?.type ?? defLogType;
   const logFn = console[logType] ?? console[defLogType];
 
-  if (process.env.NODE_ENV === "development" || typeof window !== "undefined") {
+  if (environment === "development" || typeof window !== "undefined") {
     logFn(logObject.args[0].structuredLog);
   } else {
     logFn(JSON.stringify(logObject.args[0].structuredLog));

packages/sdk/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vue-storefront/sdk",
   "license": "BSD-3-Clause",
-  "version": "3.4.1",
+  "version": "3.5.0",
   "main": "lib/index.cjs.js",
   "module": "lib/index.es.js",
   "types": "lib/index.d.ts",
@@ -20,7 +20,7 @@
     "changesets:publish": "yarn run build && yarn changeset publish"
   },
   "dependencies": {
-    "@vue-storefront/logger": "1.0.0"
+    "@vue-storefront/logger": "1.1.0"
   },
   "devDependencies": {
     "@types/jest": "^29.0.3",

yarn.lock

@@ -4598,11 +4598,6 @@ doctrine@^3.0.0:
   dependencies:
     esutils "^2.0.2"
 
-dotenv@^16:
-  version "16.4.5"
-  resolved "https://registrynpm.storefrontcloud.io/dotenv/-/dotenv-16.4.5.tgz#cdd3b3b604cb327e286b4762e13502f717cb099f"
-  integrity sha512-ZmdL2rui+eB2YwhsWzjInR8LldtZHGDoQ1ugH85ppHKwpUHL7j7rN0Ti9NCnGiQbhaZ11FpR+7ao1dNsmduNUg==
-
 dunder-proto@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/dunder-proto/-/dunder-proto-1.0.1.tgz#d7ae667e1dc83482f8b70fd0f6eefc50da30f58a"