Merge pull request #2 from macropygia/feature/logger

Separate logger

Author: macropygia

__test__/const.ts

@@ -1,14 +1,14 @@
 import { mock } from "bun:test";
 import type { OidcClient } from "@/core/OidcClient";
 import { defaultCookieSettings, defaultSettings } from "@/core/const";
+import { consoleLogger } from "@/loggers/consoleLogger";
 import type {
   OIDCClientActiveSession,
   OIDCClientOptions,
   OIDCClientSession,
 } from "@/types";
 import type { Cookie } from "elysia";
 import type { IdTokenClaims } from "openid-client";
-import pino from "pino";
 
 export type DeepPartial<T> = T extends object
   ? { [P in keyof T]?: DeepPartial<T[P]> }
@@ -21,6 +21,8 @@ export const lokiTempFile = "__test__/temp.db";
 export const rpPort = 57828;
 export const opPort = 57829;
 
+export const logger = consoleLogger();
+
 export const mockBaseOptions = {
   baseUrl: "https://localhost/client",
   issuerUrl: "https://localhost/issuer",
@@ -74,16 +76,6 @@ export const getInit: RequestInit = {
   },
 };
 
-export const logger = pino({
-  level: "trace",
-  transport: {
-    target: "pino-pretty",
-    options: {
-      sync: true,
-    },
-  },
-});
-
 export const mockClaims = {
   exp: 5000000000000 / 1000,
   iss: `http://localhost:${opPort}`,

__test__/general.test.ts

@@ -21,15 +21,6 @@ describe("Integration/general", async () => {
       client_secret,
     },
     authParams: {},
-    loggerOptions: {
-      level: "trace",
-      transport: {
-        target: "pino-pretty",
-        options: {
-          sync: true,
-        },
-      },
-    },
   });
   const endpoints = oidcClient.getEndpoints();
   const app = new Elysia()

core/BaseOidcClient.ts

@@ -1,11 +1,8 @@
-import {
-  defaultCookieSettings,
-  defaultLoggerOptions,
-  defaultSettings,
-} from "@/core/const";
+import { defaultCookieSettings, defaultSettings } from "@/core/const";
 import { SQLiteAdapter } from "@/dataAdapters/SQLiteAdapter";
 import { initialize } from "@/functions/initialize";
 import { validateOptions } from "@/functions/validateOptions";
+import { consoleLogger } from "@/loggers/consoleLogger";
 import type {
   OIDCClientCookieSettings,
   OIDCClientDataAdapter,
@@ -20,7 +17,6 @@ import type {
   Issuer,
   IssuerMetadata,
 } from "openid-client";
-import pino from "pino";
 
 /**
  * OidcClient without methods for testing
@@ -47,7 +43,7 @@ export class BaseOidcClient {
   /** Plugin database */
   sessions: OIDCClientDataAdapter;
   /** Logger */
-  logger?: OIDCClientLogger;
+  logger: OIDCClientLogger | undefined;
   /** Initialized */
   initialized = false;
 
@@ -65,7 +61,7 @@ export class BaseOidcClient {
       dataAdapter,
       settings,
       cookieSettings,
-      loggerOptions,
+      logger,
     } = options;
 
     if (!issuerUrl) {
@@ -87,11 +83,8 @@ export class BaseOidcClient {
 
     this.sessions = dataAdapter || new SQLiteAdapter();
 
-    this.logger = pino(
-      loggerOptions ||
-        defaultLoggerOptions[process.env.NODE_ENV || "never"] ||
-        defaultLoggerOptions.default,
-    );
+    this.logger =
+      logger === null ? undefined : logger ? logger : consoleLogger("info");
   }
 
   /**

loggers/consoleLogger.ts

@@ -0,0 +1,29 @@
+import type { OIDCClientLogger } from "@/types";
+import type { LevelWithSilent } from "pino";
+
+/**
+ * Console logger
+ * @param level - Minimum level to be displayed
+ * @returns Logger (console)
+ */
+export const consoleLogger = (
+  level?: keyof typeof levels,
+): OIDCClientLogger => ({
+  silent: levels[level || "trace"] >= 99 ? console.debug : () => undefined,
+  trace: levels[level || "trace"] >= 10 ? console.debug : () => undefined,
+  debug: levels[level || "trace"] >= 20 ? console.debug : () => undefined,
+  info: levels[level || "trace"] >= 30 ? console.info : () => undefined,
+  warn: levels[level || "trace"] >= 40 ? console.warn : () => undefined,
+  error: levels[level || "trace"] >= 50 ? console.error : () => undefined,
+  fatal: levels[level || "trace"] >= 60 ? console.error : () => undefined,
+});
+
+const levels: Record<LevelWithSilent, number> = {
+  silent: 99,
+  fatal: 60,
+  error: 50,
+  warn: 50,
+  info: 30,
+  debug: 20,
+  trace: 10,
+};

loggers/pinoPrettyLogger.ts

@@ -0,0 +1,50 @@
+import pino, { type LoggerOptions } from "pino";
+
+/**
+ * Pino pretty logger
+ * - Requires `pino` and `pino-pretty`
+ * - If no options are provided, it will use the default options based on `process.env.NODE_ENV`.
+ * @param options - pino options (optional)
+ * @returns Logger (pino)
+ */
+export const pinoPrettyLogger = (options?: LoggerOptions) => {
+  return pino(
+    options ||
+      defaultOptions[process.env.NODE_ENV || "never"] ||
+      defaultOptions.default,
+  );
+};
+
+/**
+ * Pino Logger Options
+ * - Do not add `never`
+ */
+const defaultOptions: Record<string, LoggerOptions> = {
+  default: {
+    level: "trace",
+    transport: {
+      target: "pino-pretty",
+      options: {
+        sync: true,
+      },
+    },
+  },
+  development: {
+    level: "trace",
+    transport: {
+      target: "pino-pretty",
+      options: {
+        sync: true,
+      },
+    },
+  },
+  production: {
+    level: "info",
+    transport: {
+      target: "pino-pretty",
+      options: {
+        sync: true,
+      },
+    },
+  },
+};

package.json

@@ -36,20 +36,22 @@
     "prepare": "simple-git-hooks"
   },
   "dependencies": {
-    "openid-client": "^5.6.5",
-    "pino": "^8.20.0",
-    "pino-pretty": "^11.0.0"
+    "openid-client": "^5.6.5"
   },
   "peerDependencies": {
     "elysia": "^1.0.13",
     "ioredis": "^5.4.1",
     "lokijs": "^1.5.12",
     "lowdb": "^7.0.1",
+    "pino": "^8.20.0",
+    "pino-pretty": "^11.0.0",
     "typescript": "^5.4.5"
   },
   "peerDependenciesMeta": {
     "ioredis": { "optional": true },
     "lokijs": { "optional": true },
+    "pino": { "optional": true },
+    "pino-pretty": { "optional": true },
     "lowdb": { "optional": true }
   },
   "devDependencies": {
@@ -65,6 +67,8 @@
     "lint-staged": "^15.2.2",
     "lokijs": "^1.5.12",
     "lowdb": "^7.0.1",
+    "pino": "^8.20.0",
+    "pino-pretty": "^11.0.0",
     "set-cookie-parser": "^2.6.0",
     "simple-git-hooks": "^2.11.1",
     "tsup": "^8.0.2",

types.ts

@@ -1,5 +1,6 @@
 import type { LifeCycleType } from "elysia";
 import type { AuthorizationParameters, ClientMetadata } from "openid-client";
+import type { BaseLogger } from "pino";
 
 /** Session data */
 export interface OIDCClientSession {
@@ -100,12 +101,15 @@ export interface OIDCClientOptions {
   dataAdapter?: OIDCClientDataAdapter;
 
   /**
-   * Logger Options
-   * @see
-   * [pino document](https://github.com/pinojs/pino/)
+   * Logger
+   * - pino can be assigned directly.
+   * @example
+   * ```
+   * import pino from "pino";
+   * const rp = new OidcClient.create({ ..., logger: pino() });
+   * ```
    */
-  // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-  loggerOptions?: any;
+  logger?: OIDCClientLogger | null;
 }
 
 /** Plugin settings */
@@ -255,19 +259,16 @@ export interface OIDCClientDataAdapter {
 
 /**
  * Logger
+ * - Suitable for pino
+ * - Requies `silent` , `trace` , `debug` , `info` , `warn` , `error` and `fatal` method.
+ * @remarks
+ * - `silent`: Used to output tokens and other sensitive data. Only display explicitly if needed.
+ * - `trace`: Functions and methods executed.
+ * - `debug`: Debug info.
+ * - `warn`: Outputs for unexpected calls, tampering, and possible attacks.
+ * - `error`: Caught exceptions, etc.
+ * - `fatal`: Currently unused.
+ * @see
+ * - [Logger Instance](https://getpino.io/#/docs/api?id=logger)
  */
-export interface OIDCClientLogger {
-  /** Used when sensitive data (e.g., tokens) need to be displayed. */
-  // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-  silent: (message: any) => void;
-  // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-  trace: (message: any) => void;
-  // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-  debug: (message: any) => void;
-  // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-  info: (message: any) => void;
-  // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-  warn: (message: any) => void;
-  // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-  error: (message: any) => void;
-}
+export interface OIDCClientLogger extends Omit<BaseLogger, "level"> {}