Skip to content
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.

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

Debugger docs: the expired parts ⚰🧹 #54078

Open
worstpractice opened this issue Jul 28, 2024 · 2 comments
Open

Debugger docs: the expired parts ⚰🧹 #54078

worstpractice opened this issue Jul 28, 2024 · 2 comments
Labels
debugger Issues and PRs related to the debugger subsystem. doc Issues and PRs related to the documentations.

Comments

@worstpractice
Copy link

worstpractice commented Jul 28, 2024

Affected URL(s)

https://nodejs.org/docs/latest/api/debugger.html#v8-inspector-integration-for-nodejs

Description of the problem

As of this writing, the final two sentences of the final subsection of the Debugger docs consist of the following two statements:

  1. Chrome DevTools doesn't support debugging worker threads yet.
    • Good intentions notwithstanding, time phrases tied to the present (e.g: "yet") age like milk.
    • Even if the date of writing was known, the assertion itself remains unsourced.
      • This unfortunate omission only makes the immediate next step (of Googling about to try and figure out if the purported lack of support is still the case) that much harder.
  2. ndb can be used to debug them.

How to fix (🤷‍♂️)

Deleting the final two sentences could perhaps be enough?

On a side note: making the reader aware of the existence of v8.dev (which covers many advanced use cases) could perhaps be of partial service to the goal of documenting the aforementioned advanced use cases. 💡

@worstpractice worstpractice added the doc Issues and PRs related to the documentations. label Jul 28, 2024
@rstagi
Copy link

rstagi commented Jul 28, 2024

the assertion itself remains unsourced

There would be an open issue for the Chrome DevTools, which has even been marked as Won't fix. So I agree it would be best to probably remove any reference to it.

ndb could still be of great value though, maybe it's worth keeping it and just flagging it as deprecated(?)

AFAIK, the only alternatives to debug Node.js worker threads effectively are:

  • The VSCode's debugger, which forces you to have VSCode installed
  • Something like this, which is a bit hacky and forces you to add code just to debug it

Not sure if they're worth mentioning in the docs though 😕

@joyeecheung
Copy link
Member

joyeecheung commented Jul 30, 2024

I think mentioning VSCode for debugging workers in the docs would be helpful at least. Regarding the Chromium issue it seems to get closed due to inactivity by the bot, they still seem to be open to fix it (on a side note Chromium DevTools team is currently looking into enabling the network tab for Node.js DevTools https://issues.chromium.org/issues/353924015 so supporting Node-specific domains is something they are willing to accept) , just don't have the cycles to prioritize this - if someone submits a CL or starts a design doc or just open a new issue in the Chromium issue tracker, it can get some new momentum going.

@VoltrexKeyva VoltrexKeyva added the debugger Issues and PRs related to the debugger subsystem. label Aug 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
debugger Issues and PRs related to the debugger subsystem. doc Issues and PRs related to the documentations.
Projects
None yet
Development

No branches or pull requests

4 participants