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

doc: classify Chrome DevTools Protocol as tier 2 #57634

Merged
merged 1 commit into from
Apr 1, 2025

Conversation

legendecas
Copy link
Member

@legendecas legendecas commented Mar 26, 2025

Chrome DevTools Protocol is the de-facto debugger protocol for
Node.js and is tested regularly in Node.js test suite / CI. It matches
the tier 2 classification but lacks proper documentation in Node.js for tier 1.

Classify the Chrome DevTools Protocol as tier 2 with a target of
tier 1 once we have proper documentation on stable protocols.

On the other hand, the Chrome DevTools Frontend is not shipped with
Node.js and not tested in Node.js CI. So keep it as tier 3.

The legacy V8 Debug Protocol is not supported.

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Mar 26, 2025
@legendecas legendecas force-pushed the doc-devtools-protocol branch 3 times, most recently from 9a7871a to ff978e1 Compare March 26, 2025 12:09
Chrome DevTools Protocol is the de-facto debugger protocol for
Node.js and is tested regularly in Node.js test suite / CI. It matches
the tier 2 classification but lacks proper documentation in Node.js.

Classify the Chrome DevTools Protocol as tier 2 with a target of
tier 1 once we have proper documentation on stable protocols.

On the other hand, the Chrome DevTools Frontend is not shipped with
Node.js and not tested in Node.js CI. So keep it as tier 3.
@legendecas legendecas force-pushed the doc-devtools-protocol branch from ff978e1 to 0bc4b11 Compare March 26, 2025 12:53
@targos
Copy link
Member

targos commented Mar 26, 2025

I don't know if it's related, but I realized recently that the files generated by --cpu-prof can no longer be opened by the Chrome DevTools frontend.

@legendecas
Copy link
Member Author

legendecas commented Mar 26, 2025

I don't know if it's related, but I realized recently that the files generated by --cpu-prof can no longer be opened by the Chrome DevTools frontend.

There is a separate entry "V8 CPU profiler" in the table. And the cpu profile file format is not part of the DevTools protocol.

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@legendecas legendecas added the commit-queue Add this label to land a pull request using GitHub Actions. label Apr 1, 2025
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Apr 1, 2025
@nodejs-github-bot nodejs-github-bot merged commit 2ff6c7e into nodejs:main Apr 1, 2025
18 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in 2ff6c7e

@legendecas legendecas deleted the doc-devtools-protocol branch April 1, 2025 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.