foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2025-01-21 04:52:26 -05:00
Code Issues Packages 1 Wiki Activity

fix(ext/node): Use primordials in deno/ext/node/polyfills/internal/util/debuglog.ts

Browse source
This commit is contained in:
Finley Baker 2025-01-09 08:11:22 -07:00
parent 05dc69932d
commit e817cd1c4f
1 changed files with 34 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
ext/node/polyfills/internal/util/debuglog.ts
View file

@ -1,10 +1,22 @@
// Copyright 2018-2025 the Deno authors. MIT license. // Copyright 2018-2025 the Deno authors. MIT license.
// Copyright Joyent and Node contributors. All rights reserved. MIT license. // Copyright Joyent and Node contributors. All rights reserved. MIT license.
// TODO(petamoriken): enable prefer-primordials for node polyfills
// deno-lint-ignore-file prefer-primordials
import { inspect } from "ext:deno_node/internal/util/inspect.mjs"; import { inspect } from "ext:deno_node/internal/util/inspect.mjs";
import { primordials } from "ext:core/mod.js";
const {
ArrayPrototypeJoin,
ArrayPrototypeMap,
ObjectCreate,
ObjectDefineProperty,
SafeArrayIterator,
SafeRegExp,
String,
StringPrototypeToLowerCase,
StringPrototypeReplace,
StringPrototypeReplaceAll,
StringPrototypeToUpperCase,
} = primordials;
// `debugImpls` and `testEnabled` are deliberately not initialized so any call // `debugImpls` and `testEnabled` are deliberately not initialized so any call
// to `debuglog()` before `initializeDebugEnv()` is called will throw. // to `debuglog()` before `initializeDebugEnv()` is called will throw.
@ -13,13 +25,16 @@ let testEnabled: (str: string) => boolean;
// `debugEnv` is initial value of process.env.NODE_DEBUG // `debugEnv` is initial value of process.env.NODE_DEBUG
export function initializeDebugEnv(debugEnv: string) { export function initializeDebugEnv(debugEnv: string) {
debugImpls = Object.create(null); debugImpls = ObjectCreate(null);
if (debugEnv) { if (debugEnv) {
// This is run before any user code, it's OK not to use primordials. debugEnv = StringPrototypeReplace(
debugEnv = debugEnv.replace(/[|\\{}()[\]^$+?.]/g, "\\$&") debugEnv,
.replaceAll("*", ".*") new SafeRegExp(/[|\\{}()[\]^$+?.]/g),
.replaceAll(",", "$|^"); "\\$&",
const debugEnvRegex = new RegExp(`^${debugEnv}$`, "i"); );
debugEnv = StringPrototypeReplaceAll(debugEnv, "*", ".*");
debugEnv = StringPrototypeReplaceAll(debugEnv, ",", "$|^");
const debugEnvRegex = new SafeRegExp(`^${debugEnv}$`, "i");
testEnabled = (str) => debugEnvRegex.exec(str) !== null; testEnabled = (str) => debugEnvRegex.exec(str) !== null;
} else { } else {
testEnabled = () => false; testEnabled = () => false;
@ -33,7 +48,7 @@ function emitWarningIfNeeded(set: string) {
// deno-lint-ignore no-console // deno-lint-ignore no-console
console.warn( console.warn(
"Setting the NODE_DEBUG environment variable " + "Setting the NODE_DEBUG environment variable " +
"to '" + set.toLowerCase() + "' can expose sensitive " + "to '" + StringPrototypeToLowerCase(set) + "' can expose sensitive " +
"data (such as passwords, tokens and authentication headers) " + "data (such as passwords, tokens and authentication headers) " +
"in the resulting log.", "in the resulting log.",
); );
@ -50,7 +65,10 @@ function debuglogImpl(
if (enabled) { if (enabled) {
emitWarningIfNeeded(set); emitWarningIfNeeded(set);
debugImpls[set] = function debug(...args: unknown[]) { debugImpls[set] = function debug(...args: unknown[]) {
const msg = args.map((arg) => inspect(arg)).join(" "); const msg = ArrayPrototypeJoin(
ArrayPrototypeMap(args, (arg) => inspect(arg)),
" ",
);
// deno-lint-ignore no-console // deno-lint-ignore no-console
console.error("%s %s: %s", set, String(Deno.pid), msg); console.error("%s %s: %s", set, String(Deno.pid), msg);
}; };
@ -71,7 +89,7 @@ export function debuglog(
cb?: (debug: (...args: unknown[]) => void) => void, cb?: (debug: (...args: unknown[]) => void) => void,
) { ) {
function init() { function init() {
set = set.toUpperCase(); set = StringPrototypeToUpperCase(set);
enabled = testEnabled(set); enabled = testEnabled(set);
} }
@ -85,7 +103,7 @@ export function debuglog(
cb(debug); cb(debug);
} }
return debug(...args); return debug(...new SafeArrayIterator(args));
}; };
let enabled: boolean; let enabled: boolean;
@ -95,9 +113,10 @@ export function debuglog(
return enabled; return enabled;
}; };
const logger = (...args: unknown[]) => debug(...args); const logger = (...args: unknown[]) => debug(...new SafeArrayIterator(args));
Object.defineProperty(logger, "enabled", { ObjectDefineProperty(logger, "enabled", {
__proto__: null,
get() { get() {
return test(); return test();
}, },