V8 Inspector is not available in --require in `node --test`
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 122k
- Forks
- 37.3k
- Avg merge
- 4d 2h
- Merged PRs (30d)
- 283
Description
Version
v20.3.0
Platform
Darwin MacBook-Pro-2.local 22.5.0 Darwin Kernel Version 22.5.0: Mon Apr 24 20:51:50 PDT 2023; root:xnu-8796.121.2~5/RELEASE_X86_64 x86_64
Subsystem
test_runner
What steps will reproduce the bug?
- Have a file start-inspect.js containing:
const inspector = require("node:inspector");
inspector.open();
- Have some other
file.test.js, which can be empty. - Run
NODE_OPTIONS="--require ./start-inspect.js" node --test ./hello.test.js
How often does it reproduce? Is there a required condition?
100%
What is the expected behavior? Why is that the expected behavior?
The inspector should open as usual, as if --test was not given in the CLI
What do you see instead?
$ NODE_OPTIONS="--require ./start-inspect.js" node --test ./hello.test.js
node:inspector:181
open(port, host);
^
This Environment was initialized without a V8::Inspector
(Use `node --trace-uncaught ...` to show where the exception was thrown)
Node.js v20.3.0
Additional information
This does not happen if --test is omitted from the command. This causes issues with the VS/Code debugger which uses this mechanism to initiate debugging. I think Jetbrains does the same thing, so Webstorm and friends probably have the same issue, though I have not tested it.
Also, if I try to open the inspector in the test file itself, it works fine, so it seems like there might be some initialization ordering that's different for --test.
Originally reported on https://github.com/microsoft/vscode-js-debug/issues/1727
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the failure with start-inspect.js, file.test.js, NODE_OPTIONS, and node --test. Trace the initialization ordering around node:inspector when --require runs, comparing it with opening the inspector in the test file. Add coverage for the command and consider the issue done when the inspector opens successfully under --test.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, nodejs
- Domain
- devtools, testing-qa
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100