nestjs-pino 1.1.1 → 1.3.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.
- package/.vscode/settings.json +3 -0
- package/README.md +18 -1
- package/dist/InjectPinoLogger.d.ts +2 -1
- package/dist/InjectPinoLogger.js +7 -2
- package/dist/Logger.js +1 -0
- package/dist/LoggerCoreModule.js +1 -0
- package/dist/LoggerModule.js +1 -0
- package/dist/PinoLogger.js +13 -4
- package/dist/constants.js +1 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.js +5 -4
- package/dist/params.js +1 -0
- package/package.json +12 -12
package/README.md
CHANGED
|
@@ -408,6 +408,23 @@ export class MyService {
|
|
|
408
408
|
}
|
|
409
409
|
```
|
|
410
410
|
|
|
411
|
+
#### Testing a class that uses @InjectPinoLogger
|
|
412
|
+
|
|
413
|
+
This package exposes a getLoggerToken() function that returns a prepared injection token based on the provided context.
|
|
414
|
+
Using this token, you can easily provide a mock implementation of the logger using any of the standard custom provider techniques, including useClass, useValue, and useFactory.
|
|
415
|
+
|
|
416
|
+
```ts
|
|
417
|
+
const module: TestingModule = await Test.createTestingModule({
|
|
418
|
+
providers: [
|
|
419
|
+
MyService,
|
|
420
|
+
{
|
|
421
|
+
provide: getLoggerToken(MyService.name),
|
|
422
|
+
useValue: mockLogger,
|
|
423
|
+
},
|
|
424
|
+
],
|
|
425
|
+
}).compile();
|
|
426
|
+
```
|
|
427
|
+
|
|
411
428
|
## Usage as NestJS app logger
|
|
412
429
|
|
|
413
430
|
According to [official docs](https://docs.nestjs.com/techniques/logger#dependency-injection), loggers with Dependency injection should be set via following construction:
|
|
@@ -480,7 +497,7 @@ So these property (`useExisting: true`) is not recommended and useful only for c
|
|
|
480
497
|
|
|
481
498
|
All the other cases are lead to either code duplication or unexpected behaviour.
|
|
482
499
|
|
|
483
|
-
<h2 align="center">Do you use this library?<br/>Don't be shy to give it a star! ★</
|
|
500
|
+
<h2 align="center">Do you use this library?<br/>Don't be shy to give it a star! ★</h2>
|
|
484
501
|
|
|
485
502
|
Also if you are into NestJS ecosystem you may be interested in one of my other libs:
|
|
486
503
|
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { Provider } from "@nestjs/common";
|
|
2
2
|
import { PinoLogger } from "./PinoLogger";
|
|
3
|
-
export declare function InjectPinoLogger(context?: string): (target:
|
|
3
|
+
export declare function InjectPinoLogger(context?: string): (target: object, key: string | symbol, index?: number | undefined) => void;
|
|
4
4
|
export declare function createProvidersForDecorated(): Array<Provider<PinoLogger>>;
|
|
5
|
+
export declare function getLoggerToken(context: string): string;
|
package/dist/InjectPinoLogger.js
CHANGED
|
@@ -1,17 +1,18 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getLoggerToken = exports.createProvidersForDecorated = exports.InjectPinoLogger = void 0;
|
|
3
4
|
const common_1 = require("@nestjs/common");
|
|
4
5
|
const PinoLogger_1 = require("./PinoLogger");
|
|
5
6
|
const decoratedTokenPrefix = "PinoLogger:";
|
|
6
7
|
const decoratedLoggers = new Set();
|
|
7
8
|
function InjectPinoLogger(context = "") {
|
|
8
9
|
decoratedLoggers.add(context);
|
|
9
|
-
return common_1.Inject(
|
|
10
|
+
return common_1.Inject(getLoggerToken(context));
|
|
10
11
|
}
|
|
11
12
|
exports.InjectPinoLogger = InjectPinoLogger;
|
|
12
13
|
function createDecoratedLoggerProvider(context) {
|
|
13
14
|
return {
|
|
14
|
-
provide:
|
|
15
|
+
provide: getLoggerToken(context),
|
|
15
16
|
useFactory: (logger) => {
|
|
16
17
|
logger.setContext(context);
|
|
17
18
|
return logger;
|
|
@@ -23,4 +24,8 @@ function createProvidersForDecorated() {
|
|
|
23
24
|
return [...decoratedLoggers.values()].map(context => createDecoratedLoggerProvider(context));
|
|
24
25
|
}
|
|
25
26
|
exports.createProvidersForDecorated = createProvidersForDecorated;
|
|
27
|
+
function getLoggerToken(context) {
|
|
28
|
+
return `${decoratedTokenPrefix}${context}`;
|
|
29
|
+
}
|
|
30
|
+
exports.getLoggerToken = getLoggerToken;
|
|
26
31
|
//# sourceMappingURL=InjectPinoLogger.js.map
|
package/dist/Logger.js
CHANGED
|
@@ -12,6 +12,7 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
|
|
|
12
12
|
return function (target, key) { decorator(target, key, paramIndex); }
|
|
13
13
|
};
|
|
14
14
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.Logger = void 0;
|
|
15
16
|
const common_1 = require("@nestjs/common");
|
|
16
17
|
const PinoLogger_1 = require("./PinoLogger");
|
|
17
18
|
const constants_1 = require("./constants");
|
package/dist/LoggerCoreModule.js
CHANGED
|
@@ -13,6 +13,7 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
|
|
|
13
13
|
};
|
|
14
14
|
var LoggerCoreModule_1;
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.LoggerCoreModule = void 0;
|
|
16
17
|
const common_1 = require("@nestjs/common");
|
|
17
18
|
const pinoHttp = require("pino-http");
|
|
18
19
|
const express_ctx_1 = require("express-ctx");
|
package/dist/LoggerModule.js
CHANGED
|
@@ -7,6 +7,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
|
|
|
7
7
|
};
|
|
8
8
|
var LoggerModule_1;
|
|
9
9
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
10
|
+
exports.LoggerModule = void 0;
|
|
10
11
|
const common_1 = require("@nestjs/common");
|
|
11
12
|
const LoggerCoreModule_1 = require("./LoggerCoreModule");
|
|
12
13
|
let LoggerModule = LoggerModule_1 = class LoggerModule {
|
package/dist/PinoLogger.js
CHANGED
|
@@ -12,6 +12,7 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
|
|
|
12
12
|
return function (target, key) { decorator(target, key, paramIndex); }
|
|
13
13
|
};
|
|
14
14
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.PinoLogger = exports.__resetOutOfContextForTests = void 0;
|
|
15
16
|
const common_1 = require("@nestjs/common");
|
|
16
17
|
const pino = require("pino");
|
|
17
18
|
const express_ctx_1 = require("express-ctx");
|
|
@@ -66,10 +67,18 @@ let PinoLogger = class PinoLogger {
|
|
|
66
67
|
if (context) {
|
|
67
68
|
const firstArg = args[0];
|
|
68
69
|
if (typeof firstArg === "object") {
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
70
|
+
if (firstArg instanceof Error) {
|
|
71
|
+
args = [
|
|
72
|
+
Object.assign({ [this.contextName]: context }, { err: firstArg }),
|
|
73
|
+
...args.slice(1)
|
|
74
|
+
];
|
|
75
|
+
}
|
|
76
|
+
else {
|
|
77
|
+
args = [
|
|
78
|
+
Object.assign({ [this.contextName]: context }, firstArg),
|
|
79
|
+
...args.slice(1)
|
|
80
|
+
];
|
|
81
|
+
}
|
|
73
82
|
}
|
|
74
83
|
else {
|
|
75
84
|
args = [{ [this.contextName]: context }, ...args];
|
package/dist/constants.js
CHANGED
package/dist/index.d.ts
CHANGED
|
@@ -2,4 +2,4 @@ export { LoggerModule } from "./LoggerModule";
|
|
|
2
2
|
export { Params, LoggerModuleAsyncParams } from "./params";
|
|
3
3
|
export { Logger } from "./Logger";
|
|
4
4
|
export { PinoLogger } from "./PinoLogger";
|
|
5
|
-
export { InjectPinoLogger } from "./InjectPinoLogger";
|
|
5
|
+
export { InjectPinoLogger, getLoggerToken } from "./InjectPinoLogger";
|
package/dist/index.js
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
var LoggerModule_1 = require("./LoggerModule");
|
|
4
|
-
exports
|
|
4
|
+
Object.defineProperty(exports, "LoggerModule", { enumerable: true, get: function () { return LoggerModule_1.LoggerModule; } });
|
|
5
5
|
var Logger_1 = require("./Logger");
|
|
6
|
-
exports
|
|
6
|
+
Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return Logger_1.Logger; } });
|
|
7
7
|
var PinoLogger_1 = require("./PinoLogger");
|
|
8
|
-
exports
|
|
8
|
+
Object.defineProperty(exports, "PinoLogger", { enumerable: true, get: function () { return PinoLogger_1.PinoLogger; } });
|
|
9
9
|
var InjectPinoLogger_1 = require("./InjectPinoLogger");
|
|
10
|
-
exports
|
|
10
|
+
Object.defineProperty(exports, "InjectPinoLogger", { enumerable: true, get: function () { return InjectPinoLogger_1.InjectPinoLogger; } });
|
|
11
|
+
Object.defineProperty(exports, "getLoggerToken", { enumerable: true, get: function () { return InjectPinoLogger_1.getLoggerToken; } });
|
|
11
12
|
//# sourceMappingURL=index.js.map
|
package/dist/params.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "nestjs-pino",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.3.0",
|
|
4
4
|
"description": "Pino logger for NestJS",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -31,30 +31,30 @@
|
|
|
31
31
|
},
|
|
32
32
|
"homepage": "https://github.com/iamolegga/nestjs-pino#readme",
|
|
33
33
|
"dependencies": {
|
|
34
|
-
"@types/pino-http": "^
|
|
34
|
+
"@types/pino-http": "^5.0.0",
|
|
35
35
|
"express-ctx": "^0.1.1",
|
|
36
|
-
"pino-http": "^
|
|
36
|
+
"pino-http": "^5.0.0"
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
39
|
"@nestjs/common": "^6.6.7",
|
|
40
40
|
"@nestjs/core": "^6.6.7",
|
|
41
|
-
"@nestjs/platform-express": "^
|
|
42
|
-
"@nestjs/platform-fastify": "^
|
|
43
|
-
"@nestjs/testing": "^
|
|
41
|
+
"@nestjs/platform-express": "^7.0.0",
|
|
42
|
+
"@nestjs/platform-fastify": "^7.0.0",
|
|
43
|
+
"@nestjs/testing": "^7.0.0",
|
|
44
44
|
"@types/express": "^4.17.1",
|
|
45
|
-
"@types/jest": "^
|
|
45
|
+
"@types/jest": "^26.0.0",
|
|
46
46
|
"@types/memorystream": "^0.3.0",
|
|
47
|
-
"@types/node": "^
|
|
47
|
+
"@types/node": "^14.0.1",
|
|
48
48
|
"@types/supertest": "^2.0.8",
|
|
49
49
|
"coveralls": "^3.0.6",
|
|
50
50
|
"express": "^4.17.1",
|
|
51
|
-
"jest": "^
|
|
51
|
+
"jest": "^25.1.0",
|
|
52
52
|
"memorystream": "^0.3.1",
|
|
53
53
|
"reflect-metadata": "^0.1.13",
|
|
54
54
|
"rxjs": "^6.5.3",
|
|
55
55
|
"supertest": "^4.0.2",
|
|
56
|
-
"ts-jest": "^
|
|
57
|
-
"tslint": "^
|
|
56
|
+
"ts-jest": "^25.0.0",
|
|
57
|
+
"tslint": "^6.0.0",
|
|
58
58
|
"typescript": "^3.6.2"
|
|
59
59
|
},
|
|
60
60
|
"jest": {
|
|
@@ -67,7 +67,7 @@
|
|
|
67
67
|
"^.+\\.(t|j)s$": "ts-jest"
|
|
68
68
|
},
|
|
69
69
|
"collectCoverage": true,
|
|
70
|
-
"coverageDirectory": "
|
|
70
|
+
"coverageDirectory": "./coverage",
|
|
71
71
|
"collectCoverageFrom": [
|
|
72
72
|
"src/**/*.ts"
|
|
73
73
|
],
|