Skip to content

debugger: surface inspector failures in probe mode #63437

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
joyeecheung wants to merge 1 commit into
base: main
Choose a base branch
from
Open

debugger: surface inspector failures in probe mode #63437

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
39 changes: 31 additions & 8 deletions doc/api/debugger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,10 @@ debug>
added:
- v26.1.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/63437
description: Add `probe_failure` terminal `error` event for inspector-side mid-session
failures, and `error.details` for additional context on per-hit and terminal errors.
- version: v26.2.0
pr-url: https://github.com/nodejs/node/pull/63286
description: JSON report schema bumped to v2. Probe `target` is now
Expand Down Expand Up @@ -382,7 +386,10 @@ $ node inspect --json --probe cli.js:5 --expr 'rss' cli.js
"value": 55443456,
"description": "55443456"
}
// If the expression throws, "error" is present instead of "result".
// If the probe expression throws, fails, or never completes, the entry
// carries an `error` field instead of `result` with the shape
// `{ message: string, details?: object }`. The `message` and `details`
// content is informational only and may change between releases.
},
{
"probe": 0,
Expand Down Expand Up @@ -414,24 +421,40 @@ $ node inspect --json --probe cli.js:5 --expr 'rss' cli.js
// "error": {
// "code": "probe_target_exit",
// "exitCode": 1,
// "stderr": "[Error: boom]",
// "stderr": "Error: boom",
// "message": "Target exited with code 1 before probes: app.js:10"
// }
// }
// 5. {
// "event": "error",
// "pending": [1],
// "error": {
// "code": "probe_failure",
// "probe": 0,
// "stderr": "...",
// "message": "Target process exited during probe evaluation before probes: app.js:12. If the failure repeats, review the probe expression.",
// "details": { "lastCdpMethod": "Debugger.evaluateOnCallFrame" }
// }
// }
}
]
}
```

### Output and exit codes from the probed process
### Output and exit codes

Probe mode only prints the final probe report to stdout, and otherwise silences
stdout/stderr from the child process. When the probing session ends,
`node inspect` typically exits with code `0` and prints a final report to
stdout. If the child process exits with a non-zero code before the
probe session ends, the final report records a terminal `error` event along
with the exit code and captured child stderr. The probing process itself
still exits with code `0` in this case.
the probing process typically exits with code `0` and prints a final report to
stdout. If the child process exits with a non-zero code before the probe
session ends, or the probe session cannot complete for another reason, the
final report records a terminal `error` event.

When `error.code` is `'probe_failure'` or `'probe_timeout'`, the probing process
exits with a non-zero code, indicating recorded hits may be incomplete.
In this case, `error.message` will contain recovery hints, and `error.probe`,
when present, is an index into the report's `probes` array that identifies
the possible culprit probe on a best-effort basis to help guide debugging.

Invalid arguments and fatal launch or connect failures may cause the
probing process to exit with a non-zero code and print an error message
Expand Down
Loading
Loading