nestjs-pino 4.1.0 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,8 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.getLoggerToken = exports.createProvidersForDecorated = exports.InjectPinoLogger = void 0;
3
+ exports.InjectPinoLogger = InjectPinoLogger;
4
+ exports.createProvidersForDecorated = createProvidersForDecorated;
5
+ exports.getLoggerToken = getLoggerToken;
4
6
  const common_1 = require("@nestjs/common");
5
7
  const PinoLogger_1 = require("./PinoLogger");
6
8
  const decoratedTokenPrefix = 'PinoLogger:';
@@ -9,7 +11,6 @@ function InjectPinoLogger(context = '') {
9
11
  decoratedLoggers.add(context);
10
12
  return (0, common_1.Inject)(getLoggerToken(context));
11
13
  }
12
- exports.InjectPinoLogger = InjectPinoLogger;
13
14
  function createDecoratedLoggerProvider(context) {
14
15
  return {
15
16
  provide: getLoggerToken(context),
@@ -23,9 +24,7 @@ function createDecoratedLoggerProvider(context) {
23
24
  function createProvidersForDecorated() {
24
25
  return [...decoratedLoggers.values()].map(createDecoratedLoggerProvider);
25
26
  }
26
- exports.createProvidersForDecorated = createProvidersForDecorated;
27
27
  function getLoggerToken(context) {
28
28
  return `${decoratedTokenPrefix}${context}`;
29
29
  }
30
- exports.getLoggerToken = getLoggerToken;
31
30
  //# sourceMappingURL=InjectPinoLogger.js.map
package/LoggerModule.js CHANGED
@@ -61,8 +61,8 @@ let LoggerModule = LoggerModule_1 = class LoggerModule {
61
61
  this.params = params;
62
62
  }
63
63
  configure(consumer) {
64
- const { exclude, forRoutes = DEFAULT_ROUTES, pinoHttp, useExisting, } = this.params;
65
- const middlewares = createLoggerMiddlewares(pinoHttp || {}, useExisting);
64
+ const { exclude, forRoutes = DEFAULT_ROUTES, pinoHttp, useExisting, assignResponse, } = this.params;
65
+ const middlewares = createLoggerMiddlewares(pinoHttp || {}, useExisting, assignResponse);
66
66
  if (exclude) {
67
67
  consumer
68
68
  .apply(...middlewares)
@@ -81,9 +81,9 @@ exports.LoggerModule = LoggerModule = LoggerModule_1 = __decorate([
81
81
  __param(0, (0, common_1.Inject)(params_1.PARAMS_PROVIDER_TOKEN)),
82
82
  __metadata("design:paramtypes", [Object])
83
83
  ], LoggerModule);
84
- function createLoggerMiddlewares(params, useExisting = false) {
84
+ function createLoggerMiddlewares(params, useExisting = false, assignResponse = false) {
85
85
  if (useExisting) {
86
- return [bindLoggerMiddlewareFactory(useExisting)];
86
+ return [bindLoggerMiddlewareFactory(useExisting, assignResponse)];
87
87
  }
88
88
  const middleware = (0, pino_http_1.pinoHttp)(...(Array.isArray(params) ? params : [params]));
89
89
  // @ts-expect-error: root is readonly field, but this is the place where
@@ -91,18 +91,22 @@ function createLoggerMiddlewares(params, useExisting = false) {
91
91
  PinoLogger_1.PinoLogger.root = middleware.logger;
92
92
  // FIXME: params type here is pinoHttp.Options | pino.DestinationStream
93
93
  // pinoHttp has two overloads, each of them takes those types
94
- return [middleware, bindLoggerMiddlewareFactory(useExisting)];
94
+ return [middleware, bindLoggerMiddlewareFactory(useExisting, assignResponse)];
95
95
  }
96
- function bindLoggerMiddlewareFactory(useExisting) {
97
- return function bindLoggerMiddleware(req, _res, next) {
96
+ function bindLoggerMiddlewareFactory(useExisting, assignResponse) {
97
+ return function bindLoggerMiddleware(req, res, next) {
98
98
  let log = req.log;
99
+ let resLog = assignResponse ? res.log : undefined;
99
100
  if (!useExisting && req.allLogs) {
100
101
  log = req.allLogs[req.allLogs.length - 1];
101
102
  }
103
+ if (assignResponse && !useExisting && res.allLogs) {
104
+ resLog = res.allLogs[res.allLogs.length - 1];
105
+ }
102
106
  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
103
107
  // @ts-ignore: run requires arguments for next but should not because it can
104
108
  // be called without arguments
105
- storage_1.storage.run(new storage_1.Store(log), next);
109
+ storage_1.storage.run(new storage_1.Store(log, resLog), next);
106
110
  };
107
111
  }
108
112
  //# sourceMappingURL=LoggerModule.js.map
package/PinoLogger.js CHANGED
@@ -13,7 +13,8 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
13
13
  };
14
14
  var PinoLogger_1;
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.PinoLogger = exports.__resetOutOfContextForTests = void 0;
16
+ exports.PinoLogger = void 0;
17
+ exports.__resetOutOfContextForTests = __resetOutOfContextForTests;
17
18
  /* eslint-disable @typescript-eslint/no-explicit-any */
18
19
  /* eslint-disable @typescript-eslint/ban-types */
19
20
  const common_1 = require("@nestjs/common");
@@ -27,7 +28,6 @@ function __resetOutOfContextForTests() {
27
28
  // @ts-ignore reset root for tests only
28
29
  PinoLogger.root = undefined;
29
30
  }
30
- exports.__resetOutOfContextForTests = __resetOutOfContextForTests;
31
31
  let PinoLogger = PinoLogger_1 = class PinoLogger {
32
32
  constructor({ pinoHttp, renameContext }) {
33
33
  var _a;
@@ -84,11 +84,13 @@ let PinoLogger = PinoLogger_1 = class PinoLogger {
84
84
  this.context = value;
85
85
  }
86
86
  assign(fields) {
87
+ var _a;
87
88
  const store = storage_1.storage.getStore();
88
89
  if (!store) {
89
90
  throw new Error(`${PinoLogger_1.name}: unable to assign extra fields out of request scope`);
90
91
  }
91
92
  store.logger = store.logger.child(fields);
93
+ (_a = store.responseLogger) === null || _a === void 0 ? void 0 : _a.setBindings(fields);
92
94
  }
93
95
  call(method, ...args) {
94
96
  if (this.context) {
package/README.md CHANGED
@@ -437,7 +437,7 @@ class MyService {
437
437
  }
438
438
  ```
439
439
 
440
- Due to the [limitation](https://github.com/pinojs/pino-http/issues/30) of the underlying `pino-http` `PinoLogger.assign` cannot extend `Request completed` logs.
440
+ By default, this does not extend `Request completed` logs. Set the `assignResponse` parameter to `true` to also enrich response logs automatically emitted by `pino-http`.
441
441
 
442
442
  ## Change pino params at runtime
443
443
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "nestjs-pino",
3
- "version": "4.1.0",
3
+ "version": "4.2.0",
4
4
  "description": "Pino logger for NestJS",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
@@ -46,10 +46,10 @@
46
46
  "@nestjs/platform-express": "^10.2.0",
47
47
  "@nestjs/platform-fastify": "^10.2.0",
48
48
  "@nestjs/testing": "^10.2.0",
49
- "@types/express": "^4.17.17",
49
+ "@types/express": "^5.0.0",
50
50
  "@types/jest": "^29.5.3",
51
51
  "@types/memorystream": "^0.3.1",
52
- "@types/node": "^20.5.1",
52
+ "@types/node": "^22.0.0",
53
53
  "@types/supertest": "^6.0.2",
54
54
  "@typescript-eslint/eslint-plugin": "^7.0.0",
55
55
  "@typescript-eslint/parser": "^6.4.0",
@@ -60,12 +60,12 @@
60
60
  "jest": "29.7.0",
61
61
  "memorystream": "^0.3.1",
62
62
  "pino": "^9.1.0",
63
- "pino-http": "^9.0.0",
63
+ "pino-http": "^10.1.0",
64
64
  "prettier": "^3.0.2",
65
65
  "reflect-metadata": "^0.1.13",
66
- "rimraf": "^5.0.1",
66
+ "rimraf": "^6.0.0",
67
67
  "rxjs": "^7.8.1",
68
- "supertest": "^6.3.3",
68
+ "supertest": "^7.0.0",
69
69
  "ts-jest": "^29.1.1",
70
70
  "ts-loader": "^9.4.4",
71
71
  "ts-node": "^10.9.1",
package/params.d.ts CHANGED
@@ -46,6 +46,12 @@ export interface Params {
46
46
  * {"level":30, ... "RENAME_CONTEXT_VALUE_HERE":"AppController" }
47
47
  */
48
48
  renameContext?: string;
49
+ /**
50
+ * Optional parameter to also assign the response logger during calls to
51
+ * `PinoLogger.assign`. By default, `assign` does not impact response logs
52
+ * (e.g.`Request completed`).
53
+ */
54
+ assignResponse?: boolean;
49
55
  }
50
56
  export interface LoggerModuleAsyncParams extends Pick<ModuleMetadata, 'imports' | 'providers'> {
51
57
  useFactory: (...args: any[]) => Params | Promise<Params>;
package/params.js CHANGED
@@ -1,9 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.PARAMS_PROVIDER_TOKEN = exports.isPassedLogger = void 0;
3
+ exports.PARAMS_PROVIDER_TOKEN = void 0;
4
+ exports.isPassedLogger = isPassedLogger;
4
5
  function isPassedLogger(pinoHttpProp) {
5
6
  return !!pinoHttpProp && 'logger' in pinoHttpProp;
6
7
  }
7
- exports.isPassedLogger = isPassedLogger;
8
8
  exports.PARAMS_PROVIDER_TOKEN = 'pino-params';
9
9
  //# sourceMappingURL=params.js.map
package/storage.d.ts CHANGED
@@ -1,8 +1,8 @@
1
- /// <reference types="node" />
2
1
  import { AsyncLocalStorage } from 'async_hooks';
3
2
  import { Logger } from 'pino';
4
3
  export declare class Store {
5
4
  logger: Logger;
6
- constructor(logger: Logger);
5
+ responseLogger?: Logger | undefined;
6
+ constructor(logger: Logger, responseLogger?: Logger | undefined);
7
7
  }
8
8
  export declare const storage: AsyncLocalStorage<Store>;
package/storage.js CHANGED
@@ -3,8 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.storage = exports.Store = void 0;
4
4
  const async_hooks_1 = require("async_hooks");
5
5
  class Store {
6
- constructor(logger) {
6
+ constructor(logger, responseLogger) {
7
7
  this.logger = logger;
8
+ this.responseLogger = responseLogger;
8
9
  }
9
10
  }
10
11
  exports.Store = Store;