Skip to content

fix: preserve existing namespaces on enable() call #1055

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
yunaremaia wants to merge 1 commit into
base: master
Choose a base branch
from
+28 −4
Open

fix: preserve existing namespaces on enable() call #1055

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
20 changes: 16 additions & 4 deletions src/common.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,12 +160,22 @@ function setup(env) {
* @api public
*/
function enable(namespaces) {
// Normalize: empty/null/undefined means "disable all" (full replace with empty).
// Non-empty string means "merge" with existing namespaces.
// See: https://github.com/debug-js/debug/issues/425
const isReset = !namespaces || (typeof namespaces === 'string' && namespaces.trim() === '');

createDebug.save(namespaces);
createDebug.namespaces = namespaces;

createDebug.names = [];
createDebug.skips = [];
if (isReset) {
createDebug.names = [];
createDebug.skips = [];
return;
}

// Merge: preserve previously enabled namespaces when enable() is called
// again (e.g., `debug.enable('bar')` after `DEBUG=foo` won't clear 'foo').
const split = (typeof namespaces === 'string' ? namespaces : '')
.trim()
.replace(/\s+/g, ',')
Expand All @@ -174,8 +184,10 @@ function setup(env) {

for (const ns of split) {
if (ns[0] === '-') {
createDebug.skips.push(ns.slice(1));
} else {
if (!createDebug.skips.includes(ns.slice(1))) {
createDebug.skips.push(ns.slice(1));
}
} else if (!createDebug.names.includes(ns)) {
createDebug.names.push(ns);
}
}
Expand Down
12 changes: 12 additions & 0 deletions test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ describe('debug', () => {
debug.enable('test:12345');
assert.deepStrictEqual(debug('test:12345').enabled, true);
assert.deepStrictEqual(debug('test:67890').enabled, false);

// Enable() should merge, not replace (issue #425)
debug.enable('test:67890');
assert.deepStrictEqual(debug('test:12345').enabled, true);
assert.deepStrictEqual(debug('test:67890').enabled, true);
debug.disable();
});

it('uses custom log function', () => {
Expand Down Expand Up @@ -82,12 +88,14 @@ describe('debug', () => {

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

it('handles empty', () => {
debug.disable();
debug.enable('');
const namespaces = debug.disable();
assert.deepStrictEqual(namespaces, '');
Expand All @@ -96,18 +104,21 @@ describe('debug', () => {
});

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

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

it('names+skips same with new string', () => {
debug.disable();
debug.enable('test,abc*,-abc');
const oldNames = [...debug.names];
const oldSkips = [...debug.skips];
Expand All @@ -119,6 +130,7 @@ describe('debug', () => {
});

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