debugger: add more logs to probe mode

joyeecheung · aduh95 · commit 238b54ed2aea · 2026-06-18T10:09:51.000+02:00
Add more log points in the probe mode and enable the debuglog int the probe mode tests. Signed-off-by: Joyee Cheung <joyeec9h3@gmail.com> PR-URL: #63663 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Kohei Ueno <kohei.ueno119@gmail.com>
diff --git a/lib/internal/debugger/inspect_probe.js b/lib/internal/debugger/inspect_probe.js
@@ -505,13 +505,15 @@ class ProbeInspectorSession {
 
   onChildOutput(text, which) {
     if (which !== 'stderr') { return; }
+    debug('child stderr: %j', text);
 
     this.childStderr += text;
 
     const combined = this.disconnectSentinelBuffer + text;
     // Detect the disconnect sentinel.
     if (this.connected &&
         StringPrototypeIncludes(combined, kProbeDisconnectSentinel)) {
+      debug('disconnect sentinel detected, resetting client');
       this.disconnectRequested = true;
       this.client.reset();
     }
@@ -587,6 +589,7 @@ class ProbeInspectorSession {
   }
 
   onPaused(params) {
+    debug('paused: finished=%d, reason=%s hitBreakpoints=%j', this.finished, params.reason, params.hitBreakpoints);
     this.handlePaused(params).catch((error) => {
       if (error === kInspectorFailedSentinel) { return; }
       this.recordInspectorFailure({
@@ -837,6 +840,9 @@ class ProbeInspectorSession {
   }
 
   onScriptParsed(params) {
+    if (params.url && !StringPrototypeStartsWith(params.url, 'node:')) {
+      debug('scriptParsed: scriptId=%s url=%s, length=%d', params.scriptId, params.url, params.length);
+    }
     // This map grows by the number of scripts parsed, which is limited, and is just a
     // small string -> string map. The lifetime is bounded by probe timeout etc. so cleanup is overkill.
     this.scriptIdToUrl.set(params.scriptId, params.url);
@@ -879,6 +885,8 @@ class ProbeInspectorSession {
       }
 
       const result = await this.callCdp('Debugger.setBreakpointByUrl', params);
+      debug('breakpoint set: id=%s urlRegex=%s locations=%j',
+            result.breakpointId, params.urlRegex, result.locations);
       this.breakpointDefinitions.set(result.breakpointId, { probeIndices });
     }
   }
diff --git a/test/parallel/test-debugger-probe-bound-never-hit.js b/test/parallel/test-debugger-probe-bound-never-hit.js
@@ -16,7 +16,7 @@ spawnSyncAndAssert(process.execPath, [
   '--probe', 'probe-bound-never-hit.js:4',
   '--expr', '1',
   'probe-bound-never-hit.js',
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   stdout(output) {
     assertProbeJson(output, {
       v: 2,
diff --git a/test/parallel/test-debugger-probe-child-inspect-port-zero.js b/test/parallel/test-debugger-probe-child-inspect-port-zero.js
@@ -19,7 +19,7 @@ spawnSyncAndAssert(process.execPath, [
   '--',
   '--inspect-port=0',
   'probe.js',
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   stdout(output) {
     assertProbeJson(output, {
       v: 2,
diff --git a/test/parallel/test-debugger-probe-explicit-column.js b/test/parallel/test-debugger-probe-explicit-column.js
@@ -24,7 +24,7 @@ spawnSyncAndAssert(process.execPath, [
   '--probe', 'probe-multi-statement.js:5:29',
   '--expr', 'acc.length',
   'probe-multi-statement.js',
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   stdout(output) {
     assertProbeJson(output, {
       v: 2,
diff --git a/test/parallel/test-debugger-probe-expression-throws.js b/test/parallel/test-debugger-probe-expression-throws.js
@@ -23,7 +23,7 @@ spawnSyncAndExit(process.execPath, [
   '--probe', `${fixture}:16`, '--expr', probes[0].expr,
   '--probe', `${fixture}:17`, '--expr', probes[1].expr,
   fixture,
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   status: 0,
   signal: null,
   stdout(output) {
diff --git a/test/parallel/test-debugger-probe-failure-hang-during-evaluate.js b/test/parallel/test-debugger-probe-failure-hang-during-evaluate.js
@@ -24,7 +24,7 @@ spawnSyncAndExit(process.execPath, [
   '--probe', `${fixture}:10`, '--expr', probes[0].expr,
   '--probe', `${fixture}:11`, '--expr', probes[1].expr,
   fixture,
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   status: 1,
   signal: null,
   stdout(output) {
diff --git a/test/parallel/test-debugger-probe-failure-process-exit.js b/test/parallel/test-debugger-probe-failure-process-exit.js
@@ -18,7 +18,7 @@ spawnSyncAndExit(process.execPath, [
   'inspect', '--json',
   '--probe', `${fixture}:8`, '--expr', probes[0].expr,
   fixture,
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   status: 1,
   signal: null,
   stdout(output) {
diff --git a/test/parallel/test-debugger-probe-global-option-order.js b/test/parallel/test-debugger-probe-global-option-order.js
@@ -17,7 +17,7 @@ spawnSyncAndAssert(process.execPath, [
   '--expr', 'finalValue',
   '--json',
   'probe.js',
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   stdout(output) {
     assertProbeJson(output, {
       v: 2,
diff --git a/test/parallel/test-debugger-probe-json-preview.js b/test/parallel/test-debugger-probe-json-preview.js
@@ -24,7 +24,7 @@ spawnSyncAndAssert(process.execPath, [
   '--probe', probeArg,
   '--expr', 'errorValue',
   'probe-types.js',
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   stdout(output) {
     assertProbeJson(output, {
       v: 2,
diff --git a/test/parallel/test-debugger-probe-json-special-values.js b/test/parallel/test-debugger-probe-json-special-values.js
@@ -39,7 +39,7 @@ spawnSyncAndAssert(process.execPath, [
   '--probe', probeArg,
   '--expr', 'errorValue',
   'probe-types.js',
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   stdout(output) {
     assertProbeJson(output, {
       v: 2,
diff --git a/test/parallel/test-debugger-probe-json.js b/test/parallel/test-debugger-probe-json.js
@@ -23,7 +23,7 @@ spawnSyncAndAssert(process.execPath, [
   '--probe', 'probe.js:12',
   '--expr', 'finalValue',
   'probe.js',
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   stdout(output) {
     assertProbeJson(output, {
       v: 2,
diff --git a/test/parallel/test-debugger-probe-late-resolution.js b/test/parallel/test-debugger-probe-late-resolution.js
@@ -21,7 +21,7 @@ spawnSyncAndAssert(process.execPath, [
   '--probe', 'probe-late-target.cjs:5',
   '--expr', 'value',
   'probe-late-entry.js',
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   stdout(output) {
     assertProbeJson(output, {
       v: 2,
diff --git a/test/parallel/test-debugger-probe-launch.js b/test/parallel/test-debugger-probe-launch.js
@@ -17,7 +17,7 @@ spawnSyncAndExit(process.execPath, [
   '--',
   '--not-a-real-node-flag',
   'probe.js',
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   signal: null,
   status: 1,
   stderr(output) {
diff --git a/test/parallel/test-debugger-probe-miss.js b/test/parallel/test-debugger-probe-miss.js
@@ -15,7 +15,7 @@ spawnSyncAndAssert(process.execPath, [
   '--probe', 'probe-miss.js:99',
   '--expr', '42',
   'probe-miss.js',
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   stdout(output) {
     assertProbeJson(output, {
       v: 2,
diff --git a/test/parallel/test-debugger-probe-missing-expr.js b/test/parallel/test-debugger-probe-missing-expr.js
@@ -13,7 +13,7 @@ spawnSyncAndExit(process.execPath, [
   'inspect',
   '--probe', 'probe.js:12',
   'probe.js',
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   signal: null,
   status: 9,
   stderr: /Each --probe must be followed immediately by --expr/,
diff --git a/test/parallel/test-debugger-probe-multi-location.js b/test/parallel/test-debugger-probe-multi-location.js
@@ -19,7 +19,7 @@ spawnSyncAndAssert(process.execPath, [
   '--probe', 'utils.js:5',
   '--expr', 'b',
   'probe-multi-entry.js',
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   stdout(output) {
     assertProbeJson(output, {
       v: 2,
diff --git a/test/parallel/test-debugger-probe-narrow-suffix.js b/test/parallel/test-debugger-probe-narrow-suffix.js
@@ -17,7 +17,7 @@ spawnSyncAndAssert(process.execPath, [
   '--probe', 'probe-multi-a/utils.js:5',
   '--expr', 'b',
   'probe-multi-entry.js',
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   stdout(output) {
     assertProbeJson(output, {
       v: 2,
diff --git a/test/parallel/test-debugger-probe-no-column-indent.js b/test/parallel/test-debugger-probe-no-column-indent.js
@@ -17,7 +17,7 @@ spawnSyncAndAssert(process.execPath, [
   '--probe', 'probe-indented.js:6',  // No `:col`
   '--expr', 'x',
   'probe-indented.js',
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   stdout(output) {
     assertProbeJson(output, {
       v: 2,
diff --git a/test/parallel/test-debugger-probe-requires-separator.js b/test/parallel/test-debugger-probe-requires-separator.js
@@ -15,7 +15,7 @@ spawnSyncAndExit(process.execPath, [
   '--expr', 'finalValue',
   '--inspect-port=0',
   'probe.js',
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   signal: null,
   status: 9,
   stderr: /Use -- before child Node\.js flags in probe mode/,
diff --git a/test/parallel/test-debugger-probe-script-throws.js b/test/parallel/test-debugger-probe-script-throws.js
@@ -33,7 +33,7 @@ spawnSyncAndExit(process.execPath, [
   '--probe', `${fixture}:7`, '--expr', probes[0].expr,
   '--probe', `${fixture}:4`, '--expr', probes[1].expr,
   fixture,
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   // probe_target_exit: probing process exits 0 (hits trustworthy).
   status: 0,
   signal: null,
diff --git a/test/parallel/test-debugger-probe-target-syntax-error.js b/test/parallel/test-debugger-probe-target-syntax-error.js
@@ -27,7 +27,7 @@ spawnSyncAndExit(process.execPath, [
   'inspect', '--json',
   '--probe', `${fixture}:3`, '--expr', probes[0].expr,
   fixture,
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   // probe_target_exit: probing process exits 0.
   status: 0,
   signal: null,
diff --git a/test/parallel/test-debugger-probe-text-special-values.js b/test/parallel/test-debugger-probe-text-special-values.js
@@ -36,7 +36,7 @@ spawnSyncAndAssert(process.execPath, [
   '--probe', probeArg,
   '--expr', 'errorValue',
   'probe-types.js',
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   stdout(output) {
     assertProbeText(output, [
       `Hit 1 at ${hitText}`,
diff --git a/test/parallel/test-debugger-probe-text.js b/test/parallel/test-debugger-probe-text.js
@@ -15,7 +15,7 @@ spawnSyncAndAssert(process.execPath, [
   '--probe', 'probe.js:12',
   '--expr', 'finalValue',
   'probe.js',
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   stdout(output) {
     assertProbeText(output,
                     `Hit 1 at ${probeUrl}:12:1\n` +
diff --git a/test/parallel/test-debugger-probe-timeout.js b/test/parallel/test-debugger-probe-timeout.js
@@ -17,7 +17,7 @@ spawnSyncAndExit(process.execPath, [
   '--probe', 'probe-timeout.js:99',
   '--expr', '1',
   'probe-timeout.js',
-], { cwd }, {
+], { cwd, env: { ...process.env, NODE_DEBUG: 'inspect_probe' } }, {
   signal: null,
   status: 1,
   stdout(output) {

Original file line number	Diff line number	Diff line change
`@@ -505,13 +505,15 @@ class ProbeInspectorSession {`
`505`	`505`
`506`	`506`	`onChildOutput(text, which) {`
`507`	`507`	`if (which !== 'stderr') { return; }`
	`508`	`+ debug('child stderr: %j', text);`
`508`	`509`
`509`	`510`	`this.childStderr += text;`
`510`	`511`
`511`	`512`	`const combined = this.disconnectSentinelBuffer + text;`
`512`	`513`	`// Detect the disconnect sentinel.`
`513`	`514`	`if (this.connected &&`
`514`	`515`	`StringPrototypeIncludes(combined, kProbeDisconnectSentinel)) {`
	`516`	`+ debug('disconnect sentinel detected, resetting client');`
`515`	`517`	`this.disconnectRequested = true;`
`516`	`518`	`this.client.reset();`
`517`	`519`	`}`
`@@ -587,6 +589,7 @@ class ProbeInspectorSession {`
`587`	`589`	`}`
`588`	`590`
`589`	`591`	`onPaused(params) {`
	`592`	`+ debug('paused: finished=%d, reason=%s hitBreakpoints=%j', this.finished, params.reason, params.hitBreakpoints);`
`590`	`593`	`this.handlePaused(params).catch((error) => {`
`591`	`594`	`if (error === kInspectorFailedSentinel) { return; }`
`592`	`595`	`this.recordInspectorFailure({`
`@@ -837,6 +840,9 @@ class ProbeInspectorSession {`
`837`	`840`	`}`
`838`	`841`
`839`	`842`	`onScriptParsed(params) {`
	`843`	`+ if (params.url && !StringPrototypeStartsWith(params.url, 'node:')) {`
	`844`	`+ debug('scriptParsed: scriptId=%s url=%s, length=%d', params.scriptId, params.url, params.length);`
	`845`	`+ }`
`840`	`846`	`// This map grows by the number of scripts parsed, which is limited, and is just a`
`841`	`847`	`// small string -> string map. The lifetime is bounded by probe timeout etc. so cleanup is overkill.`
`842`	`848`	`this.scriptIdToUrl.set(params.scriptId, params.url);`
`@@ -879,6 +885,8 @@ class ProbeInspectorSession {`
`879`	`885`	`}`
`880`	`886`
`881`	`887`	`const result = await this.callCdp('Debugger.setBreakpointByUrl', params);`
	`888`	`+ debug('breakpoint set: id=%s urlRegex=%s locations=%j',`
	`889`	`+ result.breakpointId, params.urlRegex, result.locations);`
`882`	`890`	`this.breakpointDefinitions.set(result.breakpointId, { probeIndices });`
`883`	`891`	`}`
`884`	`892`	`}`