debug/test.js at e3591285823a036b4583f5ef993f41e4305bf4d5 · debug-js/debug · GitHub

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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
/* eslint-env mocha */

const assert = require('assert');
const debug = require('./src');

describe('debug', () => {
	it('passes a basic sanity check', () => {
		const log = debug('test');
		log.enabled = true;
		log.log = () => {};

		assert.doesNotThrow(() => log('hello world'));
	});

	it('allows namespaces to be a non-string value', () => {
		const log = debug('test');
		log.enabled = true;
		log.log = () => {};

		assert.doesNotThrow(() => debug.enable(true));
	});

	it('honors global debug namespace enable calls', () => {
		assert.deepStrictEqual(debug('test:12345').enabled, false);
		assert.deepStrictEqual(debug('test:67890').enabled, false);

		debug.enable('test:12345');
		assert.deepStrictEqual(debug('test:12345').enabled, true);
		assert.deepStrictEqual(debug('test:67890').enabled, false);
	});

	it('uses custom log function', () => {
		const log = debug('test');
		log.enabled = true;

		const messages = [];
		log.log = (...args) => messages.push(args);

		log('using custom log function');
		log('using custom log function again');
		log('%O', 12345);

		assert.deepStrictEqual(messages.length, 3);
	});

	describe('extend namespace', () => {
		it('should extend namespace', () => {
			const log = debug('foo');
			log.enabled = true;
			log.log = () => {};

			const logBar = log.extend('bar');
			assert.deepStrictEqual(logBar.namespace, 'foo:bar');
		});

		it('should extend namespace with custom delimiter', () => {
			const log = debug('foo');
			log.enabled = true;
			log.log = () => {};

			const logBar = log.extend('bar', '--');
			assert.deepStrictEqual(logBar.namespace, 'foo--bar');
		});

		it('should extend namespace with empty delimiter', () => {
			const log = debug('foo');
			log.enabled = true;
			log.log = () => {};

			const logBar = log.extend('bar', '');
			assert.deepStrictEqual(logBar.namespace, 'foobar');
		});

		it('should keep the log function between extensions', () => {
			const log = debug('foo');
			log.log = () => {};

			const logBar = log.extend('bar');
			assert.deepStrictEqual(log.log, logBar.log);
		});
	});

	describe('wildcard namespace matching', () => {
		it('matches simple wildcard at end', () => {
			debug.enable('app:*');
			assert.deepStrictEqual(debug('app:server').enabled, true);
			assert.deepStrictEqual(debug('app:database').enabled, true);
			assert.deepStrictEqual(debug('app:').enabled, true);
			assert.deepStrictEqual(debug('other:server').enabled, false);
		});

		it('matches single wildcard for everything', () => {
			debug.enable('*');
			assert.deepStrictEqual(debug('anything').enabled, true);
			assert.deepStrictEqual(debug('app:server').enabled, true);
			assert.deepStrictEqual(debug('').enabled, true);
		});

		it('matches wildcard in the middle', () => {
			debug.enable('app:*:error');
			assert.deepStrictEqual(debug('app:server:error').enabled, true);
			assert.deepStrictEqual(debug('app:db:error').enabled, true);
			assert.deepStrictEqual(debug('app::error').enabled, true);
			assert.deepStrictEqual(debug('app:server:warn').enabled, false);
		});

		it('matches multiple wildcards', () => {
			debug.enable('*:*:error');
			assert.deepStrictEqual(debug('app:server:error').enabled, true);
			assert.deepStrictEqual(debug('lib:db:error').enabled, true);
			assert.deepStrictEqual(debug('app:server:warn').enabled, false);
		});

		it('handles exact match without wildcards', () => {
			debug.enable('app:server');
			assert.deepStrictEqual(debug('app:server').enabled, true);
			assert.deepStrictEqual(debug('app:server:extra').enabled, false);
			assert.deepStrictEqual(debug('app').enabled, false);
		});

		it('handles exclusion patterns', () => {
			debug.enable('app:*,-app:secret');
			assert.deepStrictEqual(debug('app:server').enabled, true);
			assert.deepStrictEqual(debug('app:database').enabled, true);
			assert.deepStrictEqual(debug('app:secret').enabled, false);
		});

		it('handles exclusion with wildcards', () => {
			debug.enable('*,-app:*');
			assert.deepStrictEqual(debug('lib:util').enabled, true);
			assert.deepStrictEqual(debug('http').enabled, true);
			assert.deepStrictEqual(debug('app:server').enabled, false);
			assert.deepStrictEqual(debug('app:db').enabled, false);
		});

		it('skips take precedence over names', () => {
			debug.enable('app:*,-app:*');
			assert.deepStrictEqual(debug('app:server').enabled, false);
		});

		it('handles multiple comma-separated namespaces', () => {
			debug.enable('app:auth,app:db,lib:cache');
			assert.deepStrictEqual(debug('app:auth').enabled, true);
			assert.deepStrictEqual(debug('app:db').enabled, true);
			assert.deepStrictEqual(debug('lib:cache').enabled, true);
			assert.deepStrictEqual(debug('app:server').enabled, false);
		});

		it('handles spaces as delimiters', () => {
			debug.enable('app:auth app:db');
			assert.deepStrictEqual(debug('app:auth').enabled, true);
			assert.deepStrictEqual(debug('app:db').enabled, true);
		});

		it('handles leading/trailing whitespace', () => {
			debug.enable('  app:server  ');
			assert.deepStrictEqual(debug('app:server').enabled, true);
		});
	});

	describe('enabled', () => {
		it('returns false when nothing is enabled', () => {
			debug.enable('');
			assert.deepStrictEqual(debug.enabled('anything'), false);
		});

		it('returns true for exact namespace match', () => {
			debug.enable('foo');
			assert.deepStrictEqual(debug.enabled('foo'), true);
			assert.deepStrictEqual(debug.enabled('bar'), false);
		});

		it('returns true for wildcard match', () => {
			debug.enable('foo:*');
			assert.deepStrictEqual(debug.enabled('foo:bar'), true);
			assert.deepStrictEqual(debug.enabled('foo:'), true);
			assert.deepStrictEqual(debug.enabled('bar:baz'), false);
		});

		it('returns false for skipped namespace', () => {
			debug.enable('*,-foo');
			assert.deepStrictEqual(debug.enabled('bar'), true);
			assert.deepStrictEqual(debug.enabled('foo'), false);
		});
	});

	describe('coerce', () => {
		it('converts Error to stack trace', () => {
			const log = debug('test');
			log.enabled = true;

			const messages = [];
			log.log = (...args) => messages.push(args);

			const err = new Error('test error');
			log(err);

			assert.deepStrictEqual(messages.length, 1);
			assert(messages[0][0].includes('test error'));
		});

		it('converts Error without stack to message', () => {
			const log = debug('test');
			log.enabled = true;

			const messages = [];
			log.log = (...args) => messages.push(args);

			const err = new Error('no stack');
			err.stack = '';
			log(err);

			assert.deepStrictEqual(messages.length, 1);
			assert(messages[0][0].includes('no stack'));
		});

		it('passes non-Error values through unchanged', () => {
			const log = debug('test');
			log.enabled = true;

			const messages = [];
			log.log = (...args) => messages.push(args);

			log('plain string');
			assert.deepStrictEqual(messages.length, 1);
		});
	});

	describe('selectColor', () => {
		it('returns consistent color for same namespace', () => {
			const color1 = debug.selectColor('test');
			const color2 = debug.selectColor('test');
			assert.deepStrictEqual(color1, color2);
		});

		it('returns a color from the available colors array', () => {
			const color = debug.selectColor('myapp');
			assert(debug.colors.includes(color));
		});
	});

	describe('formatters', () => {
		it('handles %% escape sequence', () => {
			const log = debug('test');
			log.enabled = true;

			const messages = [];
			log.log = (...args) => messages.push(args);

			log('100%% complete');
			assert.deepStrictEqual(messages.length, 1);
			assert(messages[0][0].includes('100% complete'));
		});

		it('prepends %O for non-string first argument', () => {
			const log = debug('test');
			log.enabled = true;

			const messages = [];
			log.log = (...args) => messages.push(args);

			log({key: 'value'});
			assert.deepStrictEqual(messages.length, 1);
		});

		it('supports custom formatters', () => {
			debug.formatters.z = v => v.toUpperCase();

			const log = debug('test');
			log.enabled = true;

			const messages = [];
			log.log = (...args) => messages.push(args);

			log('%z', 'hello');
			assert.deepStrictEqual(messages.length, 1);
			assert(messages[0][0].includes('HELLO'));

			delete debug.formatters.z;
		});
	});

	describe('rebuild namespaces string (disable)', () => {
		it('handle names, skips, and wildcards', () => {
			debug.enable('test,abc*,-abc');
			const namespaces = debug.disable();
			assert.deepStrictEqual(namespaces, 'test,abc*,-abc');
		});

		it('handles empty', () => {
			debug.enable('');
			const namespaces = debug.disable();
			assert.deepStrictEqual(namespaces, '');
			assert.deepStrictEqual(debug.names, []);
			assert.deepStrictEqual(debug.skips, []);
		});

		it('handles all', () => {
			debug.enable('*');
			const namespaces = debug.disable();
			assert.deepStrictEqual(namespaces, '*');
		});

		it('handles skip all', () => {
			debug.enable('-*');
			const namespaces = debug.disable();
			assert.deepStrictEqual(namespaces, '-*');
		});

		it('names+skips same with new string', () => {
			debug.enable('test,abc*,-abc');
			const oldNames = [...debug.names];
			const oldSkips = [...debug.skips];
			const namespaces = debug.disable();
			assert.deepStrictEqual(namespaces, 'test,abc*,-abc');
			debug.enable(namespaces);
			assert.deepStrictEqual(oldNames.map(String), debug.names.map(String));
			assert.deepStrictEqual(oldSkips.map(String), debug.skips.map(String));
		});

		it('handles re-enabling existing instances', () => {
			debug.disable('*');
			const inst = debug('foo');
			const messages = [];
			inst.log = msg => messages.push(msg.replace(/^[^@]*@([^@]+)@.*$/, '$1'));

			inst('@test@');
			assert.deepStrictEqual(messages, []);
			debug.enable('foo');
			assert.deepStrictEqual(messages, []);
			inst('@test2@');
			assert.deepStrictEqual(messages, ['test2']);
			inst('@test3@');
			assert.deepStrictEqual(messages, ['test2', 'test3']);
			debug.disable('*');
			inst('@test4@');
			assert.deepStrictEqual(messages, ['test2', 'test3']);
		});
	});
});