Skip to content

fix: make disable() namespaces round-trip through enable() #1051

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
arronKler wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: make disable() namespaces round-trip through enable() #1051

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions src/common.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,13 +174,21 @@ function setup(env) {

for (const ns of split) {
if (ns[0] === '-') {
createDebug.skips.push(ns.slice(1));
createDebug.skips.push(toNamespace(ns.slice(1)));
} else {
createDebug.names.push(ns);
createDebug.names.push(toNamespace(ns));
}
}
}

// Invert historic '*' → '.*?' encoding so disable()/enable() can round-trip.
function toNamespace(namespace) {
const value = namespace instanceof RegExp ?
namespace.source.replace(/^\^/, '').replace(/\$$/, '') :
String(namespace);
return value.replace(/\.\*\?/g, '*');
}

/**
* Checks if the given string matches a namespace template, honoring
* asterisks as wildcards.
Expand Down Expand Up @@ -232,8 +240,8 @@ function setup(env) {
*/
function disable() {
const namespaces = [
...createDebug.names,
...createDebug.skips.map(namespace => '-' + namespace)
...createDebug.names.map(toNamespace),
...createDebug.skips.map(namespace => '-' + toNamespace(namespace))
].join(',');
createDebug.enable('');
return namespaces;
Expand Down
19 changes: 19 additions & 0 deletions test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,25 @@ describe('debug', () => {
assert.deepStrictEqual(oldSkips.map(String), debug.skips.map(String));
});

it('round-trips wildcard namespaces including skips', () => {
debug.enable('*:error:*,-*:error:ignore');
const namespaces = debug.disable();
assert.deepStrictEqual(namespaces, '*:error:*,-*:error:ignore');
assert.doesNotThrow(() => debug.enable(namespaces));
assert.deepStrictEqual(debug.enabled('api:error:db'), true);
assert.deepStrictEqual(debug.enabled('api:error:ignore'), false);
assert.deepStrictEqual(debug.enabled('api:warn:db'), false);
});

it('accepts historic disable() wildcard encoding', () => {
debug.enable('.*?:error:*,-.*?:verbose');
const namespaces = debug.disable();
assert.deepStrictEqual(namespaces, '*:error:*,-*:verbose');
assert.doesNotThrow(() => debug.enable(namespaces));
assert.deepStrictEqual(debug.enabled('api:error:db'), true);
assert.deepStrictEqual(debug.enabled('api:verbose'), false);
});

it('handles re-enabling existing instances', () => {
debug.disable('*');
const inst = debug('foo');
Expand Down