tabletcommand-logger 3.2.6 → 4.0.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/.cspell/project-words.txt +28 -0
- package/CLAUDE.md +150 -0
- package/README.md +111 -1
- package/build/index.js +15 -3
- package/build/index.js.map +1 -1
- package/build/logger-types.js +3 -0
- package/build/logger-types.js.map +1 -0
- package/build/middleware/logger.js +94 -33
- package/build/middleware/logger.js.map +1 -1
- package/build/middleware/status-logger.js +4 -9
- package/build/middleware/status-logger.js.map +1 -1
- package/build/otel.js +54 -0
- package/build/otel.js.map +1 -0
- package/build/pino-logger.js +97 -0
- package/build/pino-logger.js.map +1 -0
- package/build/redaction.js +351 -0
- package/build/redaction.js.map +1 -0
- package/build/test/logger-factory.js +207 -0
- package/build/test/logger-factory.js.map +1 -0
- package/build/test/middleware-logger.js +535 -2
- package/build/test/middleware-logger.js.map +1 -1
- package/build/test/middleware-status-logger.js +58 -0
- package/build/test/middleware-status-logger.js.map +1 -0
- package/build/test/otel-mixin.js +139 -0
- package/build/test/otel-mixin.js.map +1 -0
- package/build/test/redaction.js +293 -0
- package/build/test/redaction.js.map +1 -0
- package/build/test/signature.js +111 -0
- package/build/test/signature.js.map +1 -0
- package/build/winston-logger.js +18 -47
- package/build/winston-logger.js.map +1 -1
- package/definitions/index.d.ts +6 -2
- package/definitions/index.d.ts.map +1 -1
- package/definitions/logger-types.d.ts +38 -0
- package/definitions/logger-types.d.ts.map +1 -0
- package/definitions/middleware/logger.d.ts +4 -3
- package/definitions/middleware/logger.d.ts.map +1 -1
- package/definitions/middleware/status-logger.d.ts +4 -4
- package/definitions/middleware/status-logger.d.ts.map +1 -1
- package/definitions/otel.d.ts +8 -0
- package/definitions/otel.d.ts.map +1 -0
- package/definitions/pino-logger.d.ts +6 -0
- package/definitions/pino-logger.d.ts.map +1 -0
- package/definitions/redaction.d.ts +25 -0
- package/definitions/redaction.d.ts.map +1 -0
- package/definitions/test/logger-factory.d.ts +2 -0
- package/definitions/test/logger-factory.d.ts.map +1 -0
- package/definitions/test/middleware-status-logger.d.ts +2 -0
- package/definitions/test/middleware-status-logger.d.ts.map +1 -0
- package/definitions/test/otel-mixin.d.ts +2 -0
- package/definitions/test/otel-mixin.d.ts.map +1 -0
- package/definitions/test/redaction.d.ts +2 -0
- package/definitions/test/redaction.d.ts.map +1 -0
- package/definitions/test/signature.d.ts +2 -0
- package/definitions/test/signature.d.ts.map +1 -0
- package/definitions/winston-logger.d.ts +2 -13
- package/definitions/winston-logger.d.ts.map +1 -1
- package/eslint.config.mjs +1 -0
- package/package.json +17 -5
- package/src/index.ts +7 -3
- package/src/logger-types.ts +50 -0
- package/src/middleware/logger.ts +105 -37
- package/src/middleware/status-logger.ts +6 -15
- package/src/otel.ts +57 -0
- package/src/pino-logger.ts +110 -0
- package/src/redaction.ts +368 -0
- package/src/test/logger-factory.ts +216 -0
- package/src/test/middleware-logger.ts +582 -2
- package/src/test/middleware-status-logger.ts +61 -0
- package/src/test/otel-mixin.ts +119 -0
- package/src/test/redaction.ts +409 -0
- package/src/test/signature.ts +126 -0
- package/src/winston-logger.ts +2 -72
- package/tabletcommand-logger-4.0.0.tgz +0 -0
|
@@ -0,0 +1,216 @@
|
|
|
1
|
+
import { assert } from "chai";
|
|
2
|
+
import { describe, it } from "node:test";
|
|
3
|
+
import { Writable } from "node:stream";
|
|
4
|
+
import logger, { isPinoPrettyAvailable } from "../pino-logger";
|
|
5
|
+
|
|
6
|
+
describe("Logger Factory", () => {
|
|
7
|
+
function createCaptureStream(lines: Record<string, unknown>[]) {
|
|
8
|
+
return new Writable({
|
|
9
|
+
write(chunk: Buffer | string, _encoding: string, callback: (error?: Error | null) => void) {
|
|
10
|
+
try {
|
|
11
|
+
const str = chunk.toString();
|
|
12
|
+
const parsed = JSON.parse(str) as Record<string, unknown>;
|
|
13
|
+
lines.push(parsed);
|
|
14
|
+
} catch {
|
|
15
|
+
// ignore
|
|
16
|
+
}
|
|
17
|
+
callback();
|
|
18
|
+
},
|
|
19
|
+
});
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
it("creates a logger that outputs valid JSON with base service name", () => {
|
|
23
|
+
const lines: Record<string, unknown>[] = [];
|
|
24
|
+
const log = logger(
|
|
25
|
+
{
|
|
26
|
+
name: "test-service",
|
|
27
|
+
logToConsole: true,
|
|
28
|
+
},
|
|
29
|
+
createCaptureStream(lines)
|
|
30
|
+
);
|
|
31
|
+
|
|
32
|
+
assert.isNotNull(log);
|
|
33
|
+
log?.info({ action: "login" }, "user logged in");
|
|
34
|
+
|
|
35
|
+
assert.equal(lines.length, 1);
|
|
36
|
+
const line = lines[0];
|
|
37
|
+
assert.equal(line.service, "test-service");
|
|
38
|
+
assert.equal(line.level, "info");
|
|
39
|
+
assert.equal(line.msg, "user logged in");
|
|
40
|
+
assert.equal(line.action, "login");
|
|
41
|
+
assert.isString(line.time);
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
it("formats level as string label", () => {
|
|
45
|
+
const lines: Record<string, unknown>[] = [];
|
|
46
|
+
const log = logger(
|
|
47
|
+
{
|
|
48
|
+
name: "test-service",
|
|
49
|
+
logToConsole: true,
|
|
50
|
+
},
|
|
51
|
+
createCaptureStream(lines)
|
|
52
|
+
);
|
|
53
|
+
|
|
54
|
+
assert.isNotNull(log);
|
|
55
|
+
log?.warn({ count: 5 }, "threshold warning");
|
|
56
|
+
log?.error(new Error("disk full"), "failure");
|
|
57
|
+
|
|
58
|
+
assert.equal(lines.length, 2);
|
|
59
|
+
assert.equal(lines[0].level, "warn");
|
|
60
|
+
assert.equal(lines[1].level, "error");
|
|
61
|
+
});
|
|
62
|
+
|
|
63
|
+
it("includes extraMeta in the base fields", () => {
|
|
64
|
+
const lines: Record<string, unknown>[] = [];
|
|
65
|
+
const log = logger(
|
|
66
|
+
{
|
|
67
|
+
name: "test-service",
|
|
68
|
+
logToConsole: true,
|
|
69
|
+
extraMeta: {
|
|
70
|
+
environment: "qa",
|
|
71
|
+
cluster: "us-west-2",
|
|
72
|
+
},
|
|
73
|
+
},
|
|
74
|
+
createCaptureStream(lines)
|
|
75
|
+
);
|
|
76
|
+
|
|
77
|
+
assert.isNotNull(log);
|
|
78
|
+
log?.info("started");
|
|
79
|
+
|
|
80
|
+
assert.equal(lines.length, 1);
|
|
81
|
+
assert.equal(lines[0].environment, "qa");
|
|
82
|
+
assert.equal(lines[0].cluster, "us-west-2");
|
|
83
|
+
assert.equal(lines[0].service, "test-service");
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
it("respects custom log level override", () => {
|
|
87
|
+
const lines: Record<string, unknown>[] = [];
|
|
88
|
+
const log = logger(
|
|
89
|
+
{
|
|
90
|
+
name: "test-service",
|
|
91
|
+
logToConsole: true,
|
|
92
|
+
level: "warn",
|
|
93
|
+
},
|
|
94
|
+
createCaptureStream(lines)
|
|
95
|
+
);
|
|
96
|
+
|
|
97
|
+
assert.isNotNull(log);
|
|
98
|
+
log?.info("this should be filtered out");
|
|
99
|
+
log?.warn("this should be logged");
|
|
100
|
+
|
|
101
|
+
assert.equal(lines.length, 1);
|
|
102
|
+
assert.equal(lines[0].msg, "this should be logged");
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
it("supports disabling pretty-printing via config.pretty: false", () => {
|
|
106
|
+
const lines: Record<string, unknown>[] = [];
|
|
107
|
+
const log = logger(
|
|
108
|
+
{
|
|
109
|
+
name: "test-service",
|
|
110
|
+
logToConsole: true,
|
|
111
|
+
pretty: false,
|
|
112
|
+
},
|
|
113
|
+
createCaptureStream(lines)
|
|
114
|
+
);
|
|
115
|
+
|
|
116
|
+
assert.isNotNull(log);
|
|
117
|
+
log?.info("ndjson output test");
|
|
118
|
+
assert.equal(lines.length, 1);
|
|
119
|
+
assert.equal(lines[0].msg, "ndjson output test");
|
|
120
|
+
});
|
|
121
|
+
|
|
122
|
+
it("supports disabling pretty-printing via PINO_PRETTY=false env variable", () => {
|
|
123
|
+
const origEnv = process.env.PINO_PRETTY;
|
|
124
|
+
process.env.PINO_PRETTY = "false";
|
|
125
|
+
try {
|
|
126
|
+
const lines: Record<string, unknown>[] = [];
|
|
127
|
+
const log = logger(
|
|
128
|
+
{
|
|
129
|
+
name: "test-service",
|
|
130
|
+
logToConsole: true,
|
|
131
|
+
},
|
|
132
|
+
createCaptureStream(lines)
|
|
133
|
+
);
|
|
134
|
+
|
|
135
|
+
assert.isNotNull(log);
|
|
136
|
+
log?.info("ndjson env test");
|
|
137
|
+
assert.equal(lines.length, 1);
|
|
138
|
+
assert.equal(lines[0].msg, "ndjson env test");
|
|
139
|
+
} finally {
|
|
140
|
+
if (origEnv !== undefined) {
|
|
141
|
+
process.env.PINO_PRETTY = origEnv;
|
|
142
|
+
} else {
|
|
143
|
+
delete process.env.PINO_PRETTY;
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
});
|
|
147
|
+
|
|
148
|
+
it("exports isPinoPrettyAvailable helper and reports boolean", () => {
|
|
149
|
+
assert.isBoolean(isPinoPrettyAvailable());
|
|
150
|
+
});
|
|
151
|
+
|
|
152
|
+
it("handles config.pretty: true gracefully and returns a valid logger instance", () => {
|
|
153
|
+
const log = logger({
|
|
154
|
+
name: "pretty-test-service",
|
|
155
|
+
pretty: true,
|
|
156
|
+
});
|
|
157
|
+
assert.isNotNull(log);
|
|
158
|
+
assert.isFunction(log?.info);
|
|
159
|
+
});
|
|
160
|
+
|
|
161
|
+
it("correctly enables logger or returns null based on transport config", () => {
|
|
162
|
+
// {logToConsole: true} -> logger
|
|
163
|
+
assert.isNotNull(logger({
|
|
164
|
+
name: "test-service",
|
|
165
|
+
logToConsole: true,
|
|
166
|
+
}));
|
|
167
|
+
|
|
168
|
+
// {logToConsole: false, logToFile: true} -> logger (regression guard)
|
|
169
|
+
assert.isNotNull(logger({
|
|
170
|
+
name: "test-service",
|
|
171
|
+
logToConsole: false,
|
|
172
|
+
logToFile: true,
|
|
173
|
+
}));
|
|
174
|
+
|
|
175
|
+
// {logToConsole: false, logToDatadog: true} -> logger (regression guard)
|
|
176
|
+
assert.isNotNull(logger({
|
|
177
|
+
name: "test-service",
|
|
178
|
+
logToConsole: false,
|
|
179
|
+
logToDatadog: true,
|
|
180
|
+
}));
|
|
181
|
+
|
|
182
|
+
// {name only} -> logger
|
|
183
|
+
assert.isNotNull(logger({
|
|
184
|
+
name: "test-service",
|
|
185
|
+
}));
|
|
186
|
+
|
|
187
|
+
// {logToConsole: false, logToFile: false, logToDatadog: false} -> null
|
|
188
|
+
assert.isNull(logger({
|
|
189
|
+
name: "test-service",
|
|
190
|
+
logToConsole: false,
|
|
191
|
+
logToFile: false,
|
|
192
|
+
logToDatadog: false,
|
|
193
|
+
}));
|
|
194
|
+
});
|
|
195
|
+
|
|
196
|
+
it("child logger inherits service name and attaches child bindings", () => {
|
|
197
|
+
const lines: Record<string, unknown>[] = [];
|
|
198
|
+
const parent = logger(
|
|
199
|
+
{
|
|
200
|
+
name: "parent-service",
|
|
201
|
+
logToConsole: true,
|
|
202
|
+
},
|
|
203
|
+
createCaptureStream(lines)
|
|
204
|
+
);
|
|
205
|
+
|
|
206
|
+
assert.isNotNull(parent);
|
|
207
|
+
const child = parent?.child({ requestId: "req-123" });
|
|
208
|
+
child?.info({ data: 42 }, "processing request");
|
|
209
|
+
|
|
210
|
+
assert.equal(lines.length, 1);
|
|
211
|
+
assert.equal(lines[0].service, "parent-service");
|
|
212
|
+
assert.equal(lines[0].requestId, "req-123");
|
|
213
|
+
assert.equal(lines[0].data, 42);
|
|
214
|
+
assert.equal(lines[0].msg, "processing request");
|
|
215
|
+
});
|
|
216
|
+
});
|