@onivoro/server-pino 24.12.0 → 24.14.0

package/jest.config.ts

@@ -0,0 +1,11 @@
+/* eslint-disable */
+export default {
+  displayName: 'lib-server-pino',
+  preset: '../../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../../coverage/libs/server/pino',
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onivoro/server-pino",
-  "version": "24.12.0",
+  "version": "24.14.0",
   "type": "commonjs",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -9,18 +9,12 @@
     "url": "https://github.com/onivoro/monorepo.git"
   },
   "dependencies": {
-    "@onivoro/server-common": "24.12.0",
+    "@onivoro/server-common": "24.14.0",
     "tslib": "^2.3.0"
   },
   "peerDependencies": {
     "@nestjs/common": "~10.4.6",
     "nestjs-pino": "~4.1.0",
     "pino-http": "~10.3.0"
-  },
-  "files": [
-    "**/*.js",
-    "**/*.d.ts",
-    "**/*.js.map",
-    "README.md"
-  ]
+  }
 }

package/project.json

@@ -0,0 +1,33 @@
+{
+  "name": "lib-server-pino",
+  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/server/pino/src",
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/libs/server/pino",
+        "main": "libs/server/pino/src/index.ts",
+        "tsConfig": "libs/server/pino/tsconfig.lib.json",
+        "assets": [
+          "libs/server/pino/README.md",
+          "libs/server/pino/package.json"
+        ],
+        "declaration": true,
+        "updateBuildableProjectPackageJsonDependencies": true,
+        "rootDir": "libs/server/pino/src"
+      }
+    },
+    "publish": {
+      "executor": "@nx/js:npm",
+      "outputs": [],
+      "dependsOn": ["build"],
+      "options": {
+        "packageRoot": "dist/libs/server/pino"
+      }
+    }
+  },
+  "tags": []
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+export * from './lib/classes/server-pino-config.class';
+
+export * from './lib/functions/patch-console.function';
+
+export * from './lib/server-pino.module';

package/src/lib/classes/server-pino-config.class.ts

@@ -0,0 +1,68 @@
+import { RouteInfo, Type } from "@nestjs/common/interfaces";
+import { randomUUID } from "crypto";
+import { Params } from "nestjs-pino";
+import { IncomingMessage, ServerResponse } from "node:http";
+import { DestinationStream } from "pino";
+import { Options } from "pino-http";
+
+export const apiIdHeader = 'x-api-id';
+export const apiKeyHeader = 'x-api-key';
+
+export class ServerPinoConfig implements Params {
+  exclude?: (string | RouteInfo)[] | undefined;
+  pinoHttp?: Options<IncomingMessage, ServerResponse<IncomingMessage>, never> | DestinationStream | [Options<IncomingMessage, ServerResponse<IncomingMessage>, never>, DestinationStream] | undefined;
+  forRoutes?: (string | RouteInfo | Type<any>)[] | undefined;
+  renameContext?: string | undefined;
+  useExisting?: true | undefined;
+
+  constructor(overrides?: Partial<Params> & { excludeUrls?: (string | RegExp)[] }) {
+    const defaultValues = ServerPinoConfig.getDefaultParams(overrides?.excludeUrls);
+
+    Object.entries({ ...defaultValues, ...(overrides || {}) }).forEach(([key, value]) => {
+      (this as any)[key] = value;
+    });
+  }
+
+  static getDefaultParams(excludeUrls: (string | RegExp)[] = ['/api/health']): Params {
+    return {
+      pinoHttp: {
+        autoLogging: {
+          ignore: !!excludeUrls.length
+            ? (req) => excludeUrls.some(pattern =>
+              typeof pattern === 'string'
+                ? req.url === pattern
+                : pattern instanceof RegExp
+                  ? pattern.test((req as any).url)
+                  : false
+            )
+            : (req) => false,
+        },
+        genReqId: () => randomUUID(),
+        redact: [
+          'req.headers["accept"]',
+          'req.headers["accept-encoding"]',
+          'req.headers["accept-language"]',
+          'req.headers["authorization"]',
+          `req.headers["${apiIdHeader}"]`,
+          `req.headers["${apiKeyHeader}"]`,
+          'req.headers["cache-control"]',
+          'req.headers["connection"]',
+          'req.headers["cookie"]',
+          'req.headers["sec-ch-ua"]',
+          'req.headers["sec-ch-ua-mobile"]',
+          'req.headers["sec-ch-ua-platform"]',
+          'req.headers["sec-fetch-dest"]',
+          'req.headers["sec-fetch-mode"]',
+          'req.headers["sec-fetch-site"]',
+          'req.headers["sec-fetch-user"]',
+          'req.headers["cookie"]',
+          'res.headers["set-cookie"]',
+          'req.headers["upgrade-insecure-requests"]',
+          'req.headers["user-agent"]',
+        ],
+        useLevel: 'info',
+        transport: undefined,
+      }
+    };
+  }
+}

package/src/lib/functions/patch-console.function.ts

@@ -0,0 +1,47 @@
+import { PinoLogger } from 'nestjs-pino';
+
+export function patchConsole(logger: PinoLogger) {
+    const _console = logger;
+
+    const original = {
+        debug: console.debug,
+        error: console.error,
+        info: console.info,
+        log: console.log,
+        trace: console.trace,
+        warn: console.warn,
+    };
+
+    console.debug = (...args) => {
+        _console.debug({msg: args});
+    };
+
+    console.error = (...args) => {
+        _console.error({msg: args});
+    };
+
+    console.info = (...args) => {
+        _console.info({msg: args});
+    };
+
+    console.log = (...args) => {
+        _console.info({msg: args});
+    };
+
+    console.trace = (...args) => {
+        _console.trace({msg: args});
+    };
+
+    console.warn = (...args) => {
+        _console.warn({msg: args});
+    };
+
+    return {
+        _console,
+        restore: () => {
+            Object.entries(original).forEach(([method, implementation]) => {
+                (console as any)[method] = implementation;
+            });
+        }
+    };
+}

package/src/lib/server-pino.module.ts

@@ -0,0 +1,34 @@
+import { Module } from '@nestjs/common';
+import { LoggerModule, PinoLogger } from 'nestjs-pino';
+import { ServerPinoConfig } from './classes/server-pino-config.class';
+import { moduleFactory } from '@onivoro/server-common';
+import { patchConsole } from './functions/patch-console.function';
+
+@Module({})
+export class ServerPinoModule {
+  static configure(config: ServerPinoConfig, patchConsoleInstance = false) {
+
+    if (patchConsoleInstance) {
+      patchConsole(new PinoLogger(config));
+    }
+
+    if (process.env.NODE_ENV === 'production') {
+console.log('prod')
+      return moduleFactory({
+        module: ServerPinoModule,
+        imports: [LoggerModule.forRoot(config)],
+        providers: [
+          { provide: ServerPinoConfig, useValue: config },
+        ]
+      });
+    }
+
+    return moduleFactory({
+      module: ServerPinoModule,
+      providers: [
+        { provide: ServerPinoConfig, useValue: config },
+      ]
+    });
+  }
+}
+

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "extends": "../../../tsconfig.server.json",
+  "compilerOptions": {
+    "outDir": "../../../dist/out-tsc"
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

package/tsconfig.lib.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "../../dist/libs/server/pino",
+    "declaration": true
+  },
+  "exclude": ["jest.config.ts", "**/*.spec.ts", "**/*.test.ts"],
+  "include": ["src/**/*.ts"]
+}

package/tsconfig.spec.json

@@ -0,0 +1,21 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "types": [
+      "jest",
+      "node"
+    ]
+  },
+  "include": [
+    "jest.config.ts",
+    "**/*.test.ts",
+    "**/*.spec.ts",
+    "**/*.test.tsx",
+    "**/*.spec.tsx",
+    "**/*.test.js",
+    "**/*.spec.js",
+    "**/*.test.jsx",
+    "**/*.spec.jsx",
+    "**/*.d.ts"
+  ]
+}