-
Notifications
You must be signed in to change notification settings - Fork 1
/
index_spec.js
318 lines (303 loc) · 16.4 KB
/
index_spec.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
const fs = require("fs");
const path = require("path");
const { createLogger } = require("./index");
describe("Logger", () => {
["app","access"].forEach(context => {
describe(`${context} logger destination`, () => {
afterEach(() => {
fs.unlinkSync(path.join(__dirname, "./logs"));
});
it("should use destination passed as logs output", () => {
spyOn(process.stdout,"write").and.callFake(log => {
const logs = fs.readFileSync(path.join(__dirname, "./logs")).toString();
expect(logs).toContain(`"type":"test","context":"${context}"`);
expect(logs).toContain('"message":"Test destination"');
});
const logger = createLogger({ type: "test", context }, { destination: "./logs" });
logger.info("Test destination");
});
});
});
["parent", "child"].forEach(type => {
describe(`${type} application logger`, () => {
const getLogger = (minLoglevel) => {
let logger = createLogger({ type: "test", context: "app"}, { minLoglevel });
if (type === "child") {
logger = logger.child({});
}
return logger;
}
it("should log the initial properties passed", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain(
'"type":"test","context":"app","test":"initial_properties","loglevel":"INFO","message":"Initial properties"'
);
done();
});
const logger = getLogger();
logger.info({"test":"initial_properties"}, "Initial properties");
});
it("should not transform fields in the whitelist", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain(
'"time":123,"pid":321'
);
done();
});
const logger = getLogger();
logger.info({"time":123,"pid":321}, "Don't transform whitelist");
});
it("should stringify objects or array and transform other types into string before log INFO", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain(
'"test":"stringify_info","object":"{\\\"b\\\":123}","string":"c","number":"321","array":"[\\\"a\\\",1,[\\\"subarray\\\"]]"'
);
done();
});
const logger = getLogger();
logger.info({"test":"stringify_info","object":{"b":123},"string":"c","number":321,"array":["a",1,["subarray"]]}, "Stringify log");
});
it("should stringify objects or array and transform other types into string before log WARN", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain(
'"test":"stringify_warn","object":"{\\\"b\\\":123}","string":"c","number":"321","array":"[\\\"a\\\",1,[\\\"subarray\\\"]]"'
);
done();
});
const logger = getLogger();
logger.warn({"test":"stringify_warn","object":{"b":123},"string":"c","number":321,"array":["a",1,["subarray"]]}, "Stringify log");
});
it("should transform null or boolean fields into string", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain(
'"test":"stringify_null","a":"null","b":"true"'
);
done();
});
const logger = getLogger();
logger.warn({"test":"stringify_null","a": null, "b": true}, "Transform null or boolean");
});
it("should stringify functions", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain(
'"test":"stringify_functions","function":"function () {return true}"'
);
done();
});
const logger = getLogger();
logger.warn({"test":"stringify_functions","function": function () {return true}}, "Stringify functions");
});
it("should add the correct loglevel string if no mergingObject is passed", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain(
'"type":"test","context":"app","loglevel":"INFO","message":"Loglevel no mergingObject"'
);
done();
});
const logger = getLogger();
logger.info("Loglevel no mergingObject");
});
it("should add the correct loglevel string if mergingObject is passed", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain(
'"type":"test","context":"app","a":"b","loglevel":"WARN","message":"Loglevel with mergingObject"'
);
done();
});
const logger = getLogger();
logger.warn({ "a": "b" }, "Loglevel with mergingObject");
});
it("should add loglevel = DEBUG for trace logs", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain(
'"type":"test","context":"app","loglevel":"DEBUG","message":"Replace trace with debug"'
);
done();
});
const logger = getLogger("trace");
logger.trace("Replace trace with debug");
});
describe(`serialize Errors`, () => {
it("should add common error fields and error_message if log message is present", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain('"message":"Error with log message"');
expect(log).toContain('"error_stack":"Error: This is an error');
expect(log).toContain('"error_code":"ERR_CODE"');
expect(log).toContain('"error_message":"This is an error');
expect(log).toContain('"error_file"');
expect(log).toContain('"error_line"');
expect(log).not.toContain('"stack"');
done();
});
const logger = getLogger();
const error = new Error("This is an error");
error.code = "ERR_CODE";
logger.error(error, "Error with log message");
});
it("should add common error fields and use Error.message as message if log message is not present", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain('"message":"Error without log message"');
expect(log).toContain('"error_stack":"Error: Error without log message');
expect(log).toContain('"error_code":"ERR_CODE"');
expect(log).toContain('"error_file"');
expect(log).toContain('"error_line"');
expect(log).not.toContain('"error_message"');
expect(log).not.toContain('"stack"');
done();
});
const logger = getLogger();
const error = new Error("Error without log message");
error.code = "ERR_CODE";
logger.error(error);
});
it("should add common error fields and use Error.message as message if log message is the Error", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain('"a":"b"');
expect(log).toContain('"message":"Error as log message"');
expect(log).toContain('"error_stack":"Error: Error as log message');
expect(log).toContain('"error_code":"ERR_CODE"');
expect(log).toContain('"error_file"');
expect(log).toContain('"error_line"');
expect(log).not.toContain('"error_message"');
expect(log).not.toContain('"stack"');
done();
});
const logger = getLogger();
const error = new Error("Error as log message");
error.code = "ERR_CODE";
logger.error({ "a": "b" }, error);
});
it("should not add error code if not present in Error instance", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain('"error_stack":"Error: Error without code');
expect(log).toContain('"error_file"');
expect(log).toContain('"error_line"');
expect(log).not.toContain('"error_message"');
expect(log).not.toContain('"error_code"');
expect(log).not.toContain('"stack"');
done();
});
const logger = getLogger();
logger.error(new Error("Error without code"));
});
});
});
});
["parent", "child"].forEach(type => {
describe(`${type} access logger`, () => {
const getLogger = () => {
let logger = createLogger({ type: "test", context: "access"});
if (type === "child") {
logger = logger.child({});
}
return logger;
}
it("should log the initial properties passed", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain(
'"type":"test","context":"access","test":"access_initial_properties"'
);
done();
});
const logger = getLogger();
logger.info({"test":"access_initial_properties"}, "Initial properties");
});
it("should not stringify objects or array and not transform other types into string before log INFO", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain(
'"test":"not_stringify_info","object":{\"b\":123},"string":"c","number":321,"array":[\"a\",1,[\"subarray\"]]'
);
done();
});
const logger = getLogger();
logger.info({"test":"not_stringify_info","object":{"b":123},"string":"c","number":321,"array":["a",1,["subarray"]]}, "Don't stringify log");
});
it("should not stringify objects or array and not transform other types into string before log WARN", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain(
'"test":"not_stringify_warn","object":{\"b\":123},"string":"c","number":321,"array":[\"a\",1,[\"subarray\"]]'
);
done();
});
const logger = getLogger();
logger.warn({"test":"not_stringify_warn","object":{"b":123},"string":"c","number":321,"array":["a",1,["subarray"]]}, "Don't stringify log");
});
it("should not add loglevel field", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain(
`"type":"test","context":"access","message":"No loglevel added"`
);
expect(log).not.toContain('"loglevel"');
done();
});
const logger = getLogger();
logger.info("No loglevel added");
});
describe(`serialize Errors`, () => {
it("should add common error fields and error_message if log message is present", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain('"message":"Error with log message"');
expect(log).toContain('"error_stack":"Error: This is an error');
expect(log).toContain('"error_code":"ERR_CODE"');
expect(log).toContain('"error_message":"This is an error');
expect(log).toContain('"error_file"');
expect(log).toContain('"error_line"');
expect(log).not.toContain('"stack"');
done();
});
const logger = getLogger();
const error = new Error("This is an error");
error.code = "ERR_CODE";
logger.error(error, "Error with log message");
});
it("should add common error fields and use Error.message as message if log message is not present", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain('"message":"Error without log message"');
expect(log).toContain('"error_stack":"Error: Error without log message');
expect(log).toContain('"error_code":"ERR_CODE"');
expect(log).toContain('"error_file"');
expect(log).toContain('"error_line"');
expect(log).not.toContain('"error_message"');
expect(log).not.toContain('"stack"');
done();
});
const logger = getLogger();
const error = new Error("Error without log message");
error.code = "ERR_CODE";
logger.error(error);
});
it("should add common error fields and use Error.message as message if log message is the Error", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain('"a":"b"');
expect(log).toContain('"message":"Error as log message"');
expect(log).toContain('"error_stack":"Error: Error as log message');
expect(log).toContain('"error_code":"ERR_CODE"');
expect(log).toContain('"error_file"');
expect(log).toContain('"error_line"');
expect(log).not.toContain('"error_message"');
expect(log).not.toContain('"stack"');
done();
});
const logger = getLogger();
const error = new Error("Error as log message");
error.code = "ERR_CODE";
logger.error({ "a": "b" }, error);
done();
});
it("should not add error code if not present in Error instance", (done) => {
spyOn(process.stdout,"write").and.callFake(log => {
expect(log).toContain('"error_stack":"Error: Error without code');
expect(log).toContain('"error_file"');
expect(log).toContain('"error_line"');
expect(log).not.toContain('"error_message"');
expect(log).not.toContain('"error_code"');
expect(log).not.toContain('"stack"');
done();
});
const logger = getLogger();
logger.error(new Error("Error without code"));
});
});
});
});
});