fix(observability): ensure pino-pretty works in built app

closes #474
akash-network · Nov 28, 2024 · d242695 · d242695
1 parent 7bd3a89
commit d242695
Show file tree

Hide file tree

Showing 7 changed files with 69 additions and 36 deletions.
diff --git a/apps/api/mvm.lock b/apps/api/mvm.lock
@@ -3,6 +3,6 @@
     "@akashnetwork/database": "1.0.0",
     "@akashnetwork/env-loader": "1.0.1",
     "@akashnetwork/http-sdk": "1.0.8",
-    "@akashnetwork/logging": "2.0.1"
+    "@akashnetwork/logging": "2.0.2"
   }
 }
diff --git a/apps/deploy-web/mvm.lock b/apps/deploy-web/mvm.lock
@@ -2,6 +2,7 @@
   "dependencies": {
     "@akashnetwork/env-loader": "1.0.1",
     "@akashnetwork/http-sdk": "1.0.8",
+    "@akashnetwork/logging": "2.0.2",
     "@akashnetwork/network-store": "1.0.1",
     "@akashnetwork/ui": "1.0.0"
   },

diff --git a/apps/deploy-web/package.json b/apps/deploy-web/package.json
@@ -21,6 +21,7 @@
     "@akashnetwork/akashjs": "^0.10.0",
     "@akashnetwork/env-loader": "*",
     "@akashnetwork/http-sdk": "*",
+    "@akashnetwork/logging": "*",
     "@akashnetwork/network-store": "*",
     "@akashnetwork/ui": "*",
     "@auth0/nextjs-auth0": "^3.5.0",

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/logging/package.json b/packages/logging/package.json
@@ -1,16 +1,16 @@
 {
   "name": "@akashnetwork/logging",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "Package containing logging tools",
+  "license": "ISC",
+  "author": "",
   "main": "src/index.ts",
   "scripts": {
     "format": "prettier --write ./*.{ts,json} **/*.{ts,json}",
     "lint": "eslint .",
-    "update-apps-local-deps": "mvm-update",
-    "test": "jest"
+    "test": "jest",
+    "update-apps-local-deps": "mvm-update"
   },
-  "author": "",
-  "license": "ISC",
   "dependencies": {
     "@types/jest": "^29.5.14",
     "dotenv": "^16.4.5",
@@ -19,14 +19,14 @@
     "pino": "^9.5.0",
     "pino-cloud-logging": "^1.0.6",
     "pino-fluentd": "^0.2.4",
-    "pino-pretty": "^11.3.0",
     "stream": "^0.0.3",
     "ts-jest": "^29.1.4",
     "zod": "^3.23.8"
   },
   "devDependencies": {
     "@b12k/mvm": "^0.0.10",
     "@types/http-errors": "^2.0.4",
-    "@types/node": "^22.8.6"
+    "@types/node": "^22.8.6",
+    "pino-pretty": "^11.3.0"
   }
 }
diff --git a/packages/logging/src/servicies/logger/logger.service.spec.ts b/packages/logging/src/servicies/logger/logger.service.spec.ts
@@ -1,5 +1,6 @@
 import createHttpError from "http-errors";
-import pino from "pino";
+import { Transform } from "node:stream";
+import pino, { LoggerOptions } from "pino";
 import { gcpLogOptions } from "pino-cloud-logging";
 
 import { config } from "../../config";
@@ -12,6 +13,11 @@ jest.mock("pino-cloud-logging");
 
 describe("LoggerService", () => {
   const defaultLogFormat = config.STD_OUT_LOG_FORMAT;
+  const COMMON_EXPECTED_OPTIONS: LoggerOptions = {
+    level: "info",
+    mixin: undefined,
+    timestamp: expect.any(Function)
+  };
 
   afterEach(() => {
     config.STD_OUT_LOG_FORMAT = defaultLogFormat;
@@ -23,19 +29,19 @@ describe("LoggerService", () => {
       config.STD_OUT_LOG_FORMAT = "pretty";
       new LoggerService();
 
-      expect(pino).toHaveBeenCalledWith({
-        level: "info",
-        mixin: undefined,
-        transport: { target: "pino-pretty", options: { colorize: true, sync: true } }
-      });
+      expect(pino).toHaveBeenCalledWith(COMMON_EXPECTED_OPTIONS, expect.any(Transform));
       expect(gcpLogOptions).not.toHaveBeenCalled();
     });
 
     it("should initialize pino without pretty formatting for other formats", () => {
       config.STD_OUT_LOG_FORMAT = "json";
       new LoggerService();
 
-      expect(pino).toHaveBeenCalledWith({ level: "info", mixin: undefined });
+      expect(pino).toHaveBeenCalledWith({
+        level: "info",
+        mixin: undefined,
+        timestamp: expect.any(Function)
+      });
       expect(gcpLogOptions).toHaveBeenCalled();
     });
 
@@ -46,7 +52,7 @@ describe("LoggerService", () => {
       LoggerService.mixin = globalMixin;
       new LoggerService();
 
-      expect(pino).toHaveBeenCalledWith({ level: "info", mixin: globalMixin });
+      expect(pino).toHaveBeenCalledWith({ ...COMMON_EXPECTED_OPTIONS, mixin: globalMixin });
 
       LoggerService.mixin = undefined;
     });
@@ -61,15 +67,15 @@ describe("LoggerService", () => {
       LoggerService.mixin = globalMixin;
       new LoggerService({ mixin: localMixin });
 
-      expect(pino).toHaveBeenCalledWith({ level: "info", mixin: localMixin });
+      expect(pino).toHaveBeenCalledWith({ ...COMMON_EXPECTED_OPTIONS, mixin: localMixin });
 
       LoggerService.mixin = undefined;
     });
 
     it("should initialize pino with provided log level overriding global log level", () => {
       new LoggerService({ level: "debug" });
 
-      expect(pino).toHaveBeenCalledWith({ level: "debug" });
+      expect(pino).toHaveBeenCalledWith({ ...COMMON_EXPECTED_OPTIONS, level: "debug" });
 
       LoggerService.mixin = undefined;
     });

diff --git a/packages/logging/src/servicies/logger/logger.service.ts b/packages/logging/src/servicies/logger/logger.service.ts
@@ -1,6 +1,7 @@
 import { isHttpError } from "http-errors";
 import pino from "pino";
 import { gcpLogOptions } from "pino-cloud-logging";
+import type { PinoPretty } from "pino-pretty";
 
 import { config } from "../../config";
 
@@ -23,38 +24,49 @@ export class LoggerService implements Logger {
 
   protected pino: pino.Logger;
 
-  constructor(options?: LoggerOptions) {
-    this.pino = this.initPino(options);
+  constructor(private readonly options?: LoggerOptions) {
+    this.pino = this.initPino();
   }
 
-  private initPino(inputOptions: LoggerOptions = {}): pino.Logger {
-    let options: LoggerOptions = {
+  private initPino(): pino.Logger {
+    const options: LoggerOptions = {
       level: config.LOG_LEVEL,
       mixin: LoggerService.mixin,
       timestamp: () => `,"time":"${new Date().toISOString()}"`,
-      ...inputOptions
+      ...this.options
     };
 
-    if (typeof window === "undefined" && config.STD_OUT_LOG_FORMAT === "pretty") {
-      options.transport = {
-        target: "pino-pretty",
-        options: { colorize: true, sync: true }
-      };
-    } else {
-      options = gcpLogOptions(options as any) as LoggerOptions;
+    const pretty = this.getPrettyIfPresent();
+
+    if (pretty) {
+      return pino(options, pretty);
+    }
+
+    return pino(gcpLogOptions(options as any));
+  }
+
+  private getPrettyIfPresent(): PinoPretty.PrettyStream | undefined {
+    if (typeof window !== "undefined" || config.STD_OUT_LOG_FORMAT !== "pretty") {
+      return;
     }
 
-    return pino(options);
+    try {
+      // eslint-disable-next-line @typescript-eslint/no-var-requires
+      return require("pino-pretty")({ colorize: true, sync: true });
+    } catch (e) {
+      this.debug({ context: LoggerService.name, message: "Failed to load pino-pretty", error: e });
+      /* empty */
+    }
   }
 
   setContext(context: string) {
-    this.pino.setBindings({ context });
+    this.bind({ context });
 
     return this;
   }
 
   bind(bindings: pino.Bindings) {
-    this.pino.setBindings(bindings);
+    this.pino = this.pino.child(bindings);
 
     return this;
   }