util: fix debuglog.enabled not being present with callback logger · nodejs/node@6133a82 · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 119k

• Code
• Issues 632
• Pull requests 749
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 6133a82

Browse filesBrowse the repository at this point in the historyBrowse files

BridgeAR

authored and

targos

committed

util: fix debuglog.enabled not being present with callback logger

The method returned by the callback is missing the .enabled property. This is added in a consistent way that it also verifies that it's a getter. Fixes: #56676 PR-URL: #59858 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

1 parent 0f46c1c commit 6133a82
Copy full SHA for 6133a82

2 files changed

+19-3Lines changed: 19 additions & 3 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• lib/internal/util
  • debuglog.js
• test/sequential
  • test-util-debug.js

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎lib/internal/util/debuglog.js‎

Copy file name to clipboardExpand all lines: lib/internal/util/debuglog.js

+10-1Lines changed: 10 additions & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -94,8 +94,17 @@ function debuglog(set, cb) {
94	94	// Only invokes debuglogImpl() when the debug function is
95	95	// called for the first time.
96	96	debug = debuglogImpl(enabled, set);
97		- if (typeof cb === 'function')
	97	+ if (typeof cb === 'function') {
	98	+ ObjectDefineProperty(debug, 'enabled', {
	99	+ __proto__: null,
	100	+ get() {
	101	+ return enabled;
	102	+ },
	103	+ configurable: true,
	104	+ enumerable: true,
	105	+ });
98	106	cb(debug);
	107	+ }
99	108	switch (args.length) {
100	109	case 1: return debug(args[0]);
101	110	case 2: return debug(args[0], args[1]);

Collapse file

‎test/sequential/test-util-debug.js‎

Copy file name to clipboardExpand all lines: test/sequential/test-util-debug.js

+9-2Lines changed: 9 additions & 2 deletions

Original file line number	Diff line number	Diff line change
@@ -57,7 +57,7 @@ function parent() {
57	57
58	58	function test(environ, shouldWrite, section, forceColors = false) {
59	59	let expectErr = '';
60		- const expectOut = shouldWrite ? 'enabled\n' : 'disabled\n';
	60	+ const expectOut = shouldWrite ? 'outer enabled\ninner enabled\n' : 'outer disabled\ninner disabled\n';
61	61
62	62	const spawn = require('child_process').spawn;
63	63	const child = spawn(process.execPath, [__filename, 'child', section], {
@@ -117,11 +117,18 @@ function child(section) {
117	117	Object.defineProperty(process.stderr, 'hasColors', {
118	118	value: tty.WriteStream.prototype.hasColors
119	119	});
	120	+
	121	+ let innerDebug = null;
120	122	// eslint-disable-next-line no-restricted-syntax
121	123	const debug = util.debuglog(section, common.mustCall((cb) => {
122	124	assert.strictEqual(typeof cb, 'function');
	125	+ innerDebug = cb;
123	126	}));
124	127	debug('this', { is: 'a' }, /debugging/);
125	128	debug('num=%d str=%s obj=%j', 1, 'a', { foo: 'bar' });
126		- console.log(debug.enabled ? 'enabled' : 'disabled');
	129	+ console.log(debug.enabled ? 'outer enabled' : 'outer disabled');
	130	+ console.log(innerDebug.enabled ? 'inner enabled' : 'inner disabled');
	131	+
	132	+ assert.strictEqual(typeof Object.getOwnPropertyDescriptor(debug, 'enabled').get, 'function');
	133	+ assert.strictEqual(typeof Object.getOwnPropertyDescriptor(innerDebug, 'enabled').get, 'function');
127	134	}

0 commit comments

Comments

0 (0)