Inspecting Node.js with Chrome DevTools

yury-s commented 9 years ago

Objective

We’ve been thinking about providing unified debugger support across various v8 embedders. One natural approach to that is to reuse Chrome DevTools and provide its JS debugger, performance and memory profiler functionality to Node.js users. What we aim for Node is what we have for Chrome for Android. You basically go to chrome://inspect on a stable version of Chrome and it debugs your running Node instance. You might need to override / specify ports to both if you want them to be non-default. The rest is behind the scenes.

Internal design

DevTools is comprised of the two major components: Frontend providing UI and Backend that instruments inspected application. Frontend is essentially a web application that communicates to the Backend via remote debugging protocol and nothing prevents it from connecting to Node.js instead of Chrome. To support that we’ll need to extract parts of debugger and profiler functionality from Blink into a separate project that would implement DevTools remote debugging protocol. Let’s call the project v8-inspector. Node.js could then expose the protocol to the Frontend over a WebSocket connection.

Proof of concept

I’ve created a prototype demonstrating this approach:

https://github.com/yury-s/v8-inspector - implementation of DevTools protocol for debugger, performance and memory profilers. I started with forking Blink and then removed dependencies that wouldn’t make sense in Node.js. There is definitely more work to be done but I believe this is good enough as a proof of concept. https://github.com/yury-s/io.js/tree/remote-debugger - io.js clone that uses the project decribed above and ws module to allow using DevTools Frontend for debugging/profiling.

Local Node debugging scenario with custom ports would look like this:

Start Node with --remote-debugging-port=9222 command-line flag
Start Chrome with --remote-debugging-targets=localhost:9222 command-line flag
Navigate Chrome to chrome:inspect to see list of inspectable Node.js targets
Longer term

Long-term solution would be to have both Blink and Node.js use the same native v8-inspector library linked against v8. DevTools Frontend development would continue in Blink. For each version of v8-inspector there is a compatible version of DevTools Frontend served from the cloud. This is how it works with Android debugging at the moment: when the user opens DevTools for Chrome running on Android, the desktop browser loads a version of DevTools UI corresponding to the version of Chrome running on Android and forwards all traffic from the device to that Frontend.

Open questions

Before moving forward with this approach and investing into Blink refactorings necessary for extracting common code into its own library we’d like to collect some feedback on whether Node.js community would be interested in that. In particular, is there an interest in integrating such debugger library into Node.js core?

This will require compiling Node with the v8-inspector library and providing Node.js-specific implementation of interfaces required by the debugger.
Remote debugging protocol will be exposed to third party Node.js modules as a simple API similar to what is available for Chrome extensions (https://developer.chrome.com/extensions/debugger). Client of such API should run on a separate thread not to interfere with JavaScript in the inspected Node application. In the prototype all debugger events are forwarded from the main thread to a node instance running on a separate thread.
Implementing transport for the protocol. It can be a module that would use the debug API described above and send protocol commands over WebSocket. E.g. in the prototype it is a simple web server based on ‘ws’ module: https://github.com/yury-s/io.js/blob/remote-debugger/lib/remote_debugging_server.js. Bundling this module with the core would enable zero-conf rich devtools experience (on par with Chrome’s DevTools).
As the project evolves it will require adding new instrumentation to use some new features such as asynchronous call stacks. On the DevTools side we’ll be providing generic API that would work for both Blink and Node.js
There is some maintenance cost related to the debugger if Node.js decides to ship with it but I don’t expect it to be much higher than for the current debugger that includes debugger-agent.cc. Ideally, v8-inspector would be included as part of the v8 checkout and the obsolete debugging protocol implemented by v8 would be removed, but that is not a done deal yet.

ofrobots commented 9 years ago

/cc @trevnorris, @bmeck

bmeck commented 9 years ago

/cc @thlorenz @3y3 @bajtos

Qard commented 9 years ago

/cc @nodejs/tracing

thlorenz commented 9 years ago

I did some related work a while ago: https://github.com/thlorenz/debugium

Implementing the protocol is the easy part. However trying to reuse code from chromium that communicates with v8 turned out to be non-trivial. Things are quite coupled in there as I realized when I tried to unfuddle things.

For anyone working on this https://github.com/thlorenz/chromium-remote-debugging-proxy may come in useful as it allows watching the messages sent between chrome DevTools and the debugged instance which helps in understanding the protocol used.

paulirish commented 9 years ago

To add a few items…

This project brings all of the DevTools's JS features to Node. That includes:

the sampling profiler with flame chart, top-down and bottom-up tree views
memory heap snapshot capture and viewing
memory allocation profiler
JS debugger with breakpoints, step-out/in/over. Asynchronous stacks
Experimental efforts around Step into Async, Promises view, etc.

Moving forward with this would make the current node-inspector codebase somewhat redundant, but we'd like to work with @bajtos, @3y3 and friends on making sure the experience of launching a debugging/profiling session with these tools is smooth and enjoyable.

@thlorenz

At one point I was told that the chrome team was going to take that on, but afaik that never materialized.

This ticket is the materialization of that work. ;) @yury-s is an engineer on Chrome and owns the JS debugging tools and how they interface with V8.

thlorenz commented 9 years ago

@paulirish Awesome! Happy this is finally happening :)

trevnorris commented 9 years ago

Does --remote-debugging-port=9222 bind to localhost or 0.0.0.0? Could it be made configurable? Much usage will come from debugging remote processes.

Will we have to integrate the same type of code into our JS, along with our C++, like in v8/src/promise.js:

  if (DEBUG_IS_ACTIVE) {
    %DebugPromiseEvent({ promise: promise, status: status, value: value });
  }

Having this w/o LTS support reduces its utility in node. As such it will become a maintenance burden across 4 or 5 active branches. Is it even possible that this API is integrated in a V8 release that's 1-2 years old?

Also in regards to LTS support, I assume that there isn't indefinite support of Chrome to debugger API support. Or am I wrong?

yury-s commented 9 years ago

Does --remote-debugging-port=9222 bind to localhost or 0.0.0.0? Could it be made configurable? Much usage will come from debugging remote processes.

It can be bound to any interface that we want, I don't see any issues with that (except security). Chrome already accepts both host and port as values of --remote-debugging-targets and the host may well be remote one.

It makes sense to differentiate between transport and the debugger backend implementing the remote debugging protocol. Same debugger implementation can be used with different types of connections similar to how it works in Chrome at the moment where various transports are used to transfer DevTools traffic depending on the inspected target:

Chrome IPC in case of Chrome embedded DevTools.
Web Socket when connecting to remote Chrome instance.
Adb when connecting to Chrome and WebView running on Android devices.

Will we have to integrate the same type of code into our JS, along with our C++, like in v8/src/promise.js:

If Node uses alternative implementation of Promises and wants to leverage debugging capabilities provided by v8-inspector then yes, you will need to provide corresponding instrumentation that way or another. v8-inspector is going to have C++ API so you'll need at least one binding to notify the debugger. The call will go through the v8-inspector C++ API not through some internal v8 API.

Is it even possible that this API is integrated in a V8 release that's 1-2 years old?

I'm afraid not, as it would require making v8-inspector work with such old releases of v8. This is a non-goal for the project. As I mentioned, the idea is to have particular version of v8-inspector compatible with particular version of v8 API. If v8 is updated, v8-inspector will likely need to be updated as well.

Also in regards to LTS support, I assume that there isn't indefinite support of Chrome to debugger API support. Or am I wrong?

At the moment, there is no official v8 debugger API which would be well-supported. There is a set of C++ methods in v8-debug.h as well as debug context which provides access to the debugger internals. This is one of the issues we'd like to address with v8-inspector. It should become a recommended way to debug v8. Eventually we'd like to drop most of v8/src/debug/debug.js and prohibit using the debug context directly.

Such approach would leave us the freedom of changing remote debugging protocol without committing to its backward compatibility as there will always be a version of Chrome DevTools compatible with given version of the backend. There are already two types of protocol commands: public and hidden. Public ones are those for which we commit to backward compatibility. We're hesitant on adding more public commands as it limits our development pace.

In terms of LTS, similar to v8 we don't want to commit to keeping the API stable as it would be too restrictive. What we can do is to follow the same public API compatibility as v8 does (or at least declares): https://code.google.com/p/v8-wiki/wiki/Source#V8_public_API_compatibility

Since Blink is going to use v8-inspector too, we'll have to keep it up to date with latest v8 API changes. Should we make any breaking changes they will be easy to detect in nightly builds and can be reverted. On our side we'll have to make sure that changes to v8-inspector API would be made in a non-breaking manner, follow the same public API deprecation policy as v8 does and the new APIs would work for Node too, not only for Chrome.

Will this work for you?

3y3 commented 9 years ago

@thlorenz ,

Implementing the protocol is the easy part. However trying to reuse code from chromium that communicates with v8 turned out to be non-trivial.

At current iteration node-inspector tries to inject some parts of Chrome debugger API to app. There exists some outdated experiments with InjectedScriptSource.js and DebuggerScript.js from blink source.

v8-debug has experimental method enableWebkitProtocol (but work in progress)

Main problem of this experiments - compatibility:

Compatibility of js codebase - chrome debugger uses all latest js features implemented in v8 (generators, arrow functions, for of) (I say here about InjectedScriptSource.js and DebuggerScript.js)
Compatibility of features (c++ codebase) - async call stack, workers, network debugging etc. This is also described in issue open questions

As the project evolves it will require adding new instrumentation to use some new features such as asynchronous call stacks. On the DevTools side we’ll be providing generic API that would work for both Blink and Node.js

For this reason I also worried about @trevnorris questions:

Is it even possible that this API is integrated in a V8 release that's 1-2 years old?

@paulirish ,

Moving forward with this would make the current node-inspector codebase somewhat redundant

I will be happy, if node-inspector will change his main target from "supporting compatibility with DevTools" to something like "extended debugging environment for nodejs"

@yury-s , are you want to backport async call stack from chrome to node? And some other features?

I'd like to think about v8-inspector.h like about current v8-debug.h in v8. His provide main api to implement debugger into nodejs, but also provides entry points for external developers. In context of v8-debug.h main entry point is getDebugContext. So I'd like to see more api for external developers =)

3y3 commented 9 years ago

/cc @auchenberg

trevnorris commented 9 years ago

@yury-s Thank you for the comprehensive response.

If Node uses alternative implementation of Promises and wants to leverage debugging capabilities provided by v8-inspector then yes

Our process.nextTick() emulates the micro task queue. This and our handling of timers would most likely require insertion.

Is it even possible that this API is integrated in a V8 release that's 1-2 years old?

I'm afraid not, as it would require making v8-inspector work with such old releases of v8. This is a non-goal for the project.

While I understand, it's also unfortunate. Our main stable release is 6 month. Taking into account V8's rapid release cycle I will make the assumption that the same API could break before that is over. If we can't guarantee support for at least the 6 months of latest stable then I'm afraid that it won't do us any good.

Beyond that, saying it would be available for the 6 months of stable but not for the 18 months of LTS would need to have serious discussion as to whether bringing it is still viable. For the time I'm ignoring the additional 12 months a release will be in maintenance. Which brings full support to 3 years.

I do hope we can work out these issues, as having this available would be very helpful.

yury-s commented 9 years ago

For this reason I also worried about @trevnorris questions:

Is it even possible that this API is integrated in a V8 release that's 1-2 years old?

No. See my reply above.

@yury-s , are you want to backport async call stack from chrome to node? And some other features?

As Paul Irish wrote above the project will come with all debugging features available in Chromium. Async call stacks is not an exception. There is a generic API resembling the one described in this MSDN article which needs to be called from appropriate places where we'd like to capture async call stacks. I can help with adding such instrumentation to Node but we'll need some person knowledgeable better than me to identify places where the hooks should be added.

I'd like to think about v8-inspector.h like about current v8-debug.h in v8. His provide main api to implement debugger into nodejs, but also provides entry points for external developers. In context of v8-debug.h main entry point is getDebugContext.

This is a good way to think about v8-inspector. Ideally, we should be able to drop v8-debug.h in favor of v8-inspector. This would make the API more explicit and allow to provide better support for it.

yury-s commented 9 years ago

While I understand, it's also unfortunate. Our main stable release is 6 month. Taking into account V8's rapid release cycle I will make the assumption that the same API could break before that is over. If we can't guarantee support for at least the 6 months of latest stable then I'm afraid that it won't do us any good.

How does this work with v8 at the moment? There may be 4 or 5 major v8 releases in 6 months which means there may be a lot of breaking changes. Assuming that v8-inspector is shipped as part of v8 and its API is defined in /include/v8-inspector.h (which would be ideal case for us long-term) how would that work with Node?

I do hope we can work out these issues, as having this available would be very helpful.

I hope so too.

trevnorris commented 9 years ago

How does this work with v8 at the moment? There may be 4 or 5 major v8 releases in 6 months which means there may be a lot of breaking changes.

Once a major release branch is cut from master the V8 minor is no longer updated on that branch.

Assuming that v8-inspector is shipped as part of v8 and its API is defined in /include/v8-inspector.h (which would be ideal case for us long-term) how would that work with Node?

From what I've read, it wouldn't. It doesn't make sense for us to integrate an API that will break so quickly. It's an added disadvantage since Google is insistent that no one have older versions of Chrome installed. If we were allowed to do that then it might be possible to simply use the corresponding Chrome version with a given node release.

benjamingr commented 9 years ago

I think it is very important that the debugger ships with node as a standalone (rather than connected via chrome://somename for compatibility issues, I still want to be able to easily debug io.js 3.0 when Chrome gets 5 versions ahead. Something like an atom/electron wrapper over a specific version of Chromium would be ideal and it would also solve the compatibility issues.

I think it would also be very important that all the instrumentation hooks we need for async are there - and that integration when running non js modules in node works (reasonably) well. Of course, userland hooks might also be interesting (so people can signal to the debugger things they want it to ignore, for instance - C# has this and it's very useful).

Huge +1 for the idea by the way.

auchenberg commented 9 years ago

This is great! Glad to see this is moving forward.

I think it is very important that the debugger ships with node as a standalone (rather than connected via chrome://somename for compatibility issues, I still want to be able to easily debug io.js 3.0 when Chrome gets 5 versions ahead. Something like an atom/electron wrapper over a specific version of Chromium would be ideal and it would also solve the compatibility issues.

As I understand it, the debugger back-end is separate from the core via v8-inspector, and since it would implement the Chrome Remote Debugging Protocol over WebSocket and HTTP, the debugger back-end would be compatible with external front-ends like Chrome DevTools App (based upon Electron)

By having a runtime/protocol version we will be able to match the front-end with the back-end. Eventually this would need to use some kind of feature detection, but that's further out in the future, as I see it.

Qard commented 9 years ago

Yeah, the only way I see this working is shipping the UI as an electron app with each release, or ensuring backwards compatibility in the protocol long enough to support the LTS releases.

I think backwards compatibility for the dev tools should, in theory, be easier than V8 itself. It's only the protocol that is important here. I don't expect anyone should be touching the API outside of core, so node core doesn't need to worry about API compatibility.

trevnorris commented 9 years ago

@yury-s Meant to ask, how much do you think the actual debugging API that connect client to process would change? If that itself doesn't change much, or can be fixed more easily over time, then we'd be much closer to having a workable solution.

targos commented 9 years ago

@benjamingr @Qard from the OP:

For each version of v8-inspector there is a compatible version of DevTools Frontend served from the cloud. This is how it works with Android debugging at the moment: when the user opens DevTools for Chrome running on Android, the desktop browser loads a version of DevTools UI corresponding to the version of Chrome running on Android and forwards all traffic from the device to that Frontend.

Doesn't it mean that one could use the latest Chrome and still be able to debug any version of Node.js using an old API ?

benjamingr commented 9 years ago

@targos I'd much prefer it if it was possible to run the debugger without accessing code served from the cloud live. Node would have no control over which versions are supported and how - nor would it be able to easily edit the code (unless node starts serving it). I think it would be preferable to have a standalone app.

trevnorris commented 9 years ago

Node isn't going to control what tools are used to communicate with the debugger API regardless. I'm not sure how some companies would feel about needing an internet connection to debug processes on their local network, but I'd say that sounds like a promising solution.

Qard commented 9 years ago

Yeah, not sure how I feel about a service out on the net somewhere having direct access to the VM my code is running in. I'd definitely prefer the standalone app. On Aug 26, 2015 12:22 AM, "Benjamin Gruenbaum" notifications@github.com wrote:

@targos https://github.com/targos I'd much prefer it if it was possible to run the debugger without accessing code served from the cloud live. Node would have no control over which versions are supported and how - nor would it be able to easily edit the code (unless node starts serving it). I think it would be preferable to have a standalone app.

— Reply to this email directly or view it on GitHub https://github.com/nodejs/node/issues/2546#issuecomment-134874574.

jkrems commented 9 years ago

Would the scope include things like PageAgent.reload to restart a node process from inside the devtools or the NetworkAgent/ConsoleAgent/...? If not, then there's definitely still a lot of value in node-inspector & friends.

armandabric commented 9 years ago

This feature could also lead to use the Firefox devtools with node thought the valence project :+1: :+1: :+1:

yury-s commented 9 years ago

@trevnorris :

@yury-s Meant to ask, how much do you think the actual debugging API that connect client to process would change? If that itself doesn't change much, or can be fixed more easily over time, then we'd be much closer to having a workable solution.

This one is stable. For basic debugging support it is as simple as this:

class FrontendChannel {
    virtual void sendToFrontend(const String& message) = 0;
}
class Backend {
    void connectFrontend(FrontendChannel* channel);
    void disconnectFrontend();
    void dispatchMessageFromFrontend(const String& message);
}

See https://github.com/yury-s/v8-inspector/blob/embedded-in-io/Source/v8inspector/V8Inspector.h#L33 and https://github.com/yury-s/v8-inspector/blob/embedded-in-io/Source/core/inspector/InspectorFrontendChannel.h

The messages are strings that are opaque to Node, all parsing and dispatching of the protocol messages is performed by v8-inspector itself.

Once a major release branch is cut from master the V8 minor is no longer updated on that branch.

At that point v8-inspector is also branched along with v8. Also we know exact revision of the front-end that is compatible with that v8-inspector and can use it for debugging this particular release of v8 (embedded in Node, Chrome or something else). At the moment v8 branching is consistent with Chrome so we should always have good front-end that is capable of debugging that v8 version. More details below.

@trevnorris

Assuming that v8-inspector is shipped as part of v8 and its API is defined in /include/v8-inspector.h (which would be ideal case for us long-term) how would that work with Node?

From what I've read, it wouldn't. It doesn't make sense for us to integrate an API that will break so quickly. It's an added disadvantage since Google is insistent that no one have older versions of Chrome installed. If we were allowed to do that then it might be possible to simply use the corresponding Chrome version with a given node release.

@benjamingr

I think it is very important that the debugger ships with node as a standalone (rather than connected via chrome://somename for compatibility issues, I still want to be able to easily debug io.js 3.0 when Chrome gets 5 versions ahead. Something like an atom/electron wrapper over a specific version of Chromium would be ideal and it would also solve the compatibility issues.

@targos

Doesn't it mean that one could use the latest Chrome and still be able to debug any version of Node.js using an old API ?

@targos exactly. We already allow debugging Chrome 38 that can be found on many Android devices by connecting to it with Chrome 46. The way it works is for each Blink revision we have a copy of the front-end sources served from the cloud. After that we ask inspected target which front-end revision should be used for debugging and load it from the cloud into devtools window. E.g. to connect to chrome 44.0.2403.133 we use this link https://chrome-devtools-frontend.appspot.com/serve_rev/@199588/inspector.html

In case of Android remote debugging we load the front-end into a browser window that has special devtools bindings providing connection to the browser on the device over USB. This API is backwards compatible so that we could load old front-ends.

In case of Node we don't even have to do this since we can connect via plain WebSocket . The front-end can be loaded as a normal page and remote target url can be passed as 'ws' param: https://chrome-devtools-frontend.appspot.com/serve_rev/@199588/inspector.html?ws=localhost:9222/node This will work except for some features that require more privileges than regular web page can have, e.g. access to local file system. Loading as a privileged DevTools front-end provides better user experience.

yury-s commented 9 years ago

@benjamingr :

I'd much prefer it if it was possible to run the debugger without accessing code served from the cloud live. Node would have no control over which versions are supported and how - nor would it be able to easily edit the code (unless node starts serving it). I think it would be preferable to have a standalone app.

The front-end code can be deployed in a different manner, e.g. it could be provided as a .deb package. I just described how it is implemented in Chrome at the moment and it has been working pretty well for providing zero-conf Android debugging experience across all platforms. Being able to see Node instances as another type of inspectable target in chrome:inspect looks natural to me but this doesn't have to be the only way to debug Node.

yury-s commented 9 years ago

@jkrems :

Would the scope include things like PageAgent.reload to restart a node process from inside the devtools or the NetworkAgent/ConsoleAgent/...?

At the moment it includes Debugger, Runtime, Profiler and HeapProfiler agents which make sense for all v8 embedders. Console could be added to the list later. On the other hand, PageAgent doesn't make much sense for Node so we'd rather keep it in Blink. If we need "reload" functionality, the method could be moved to e.g. to Runtime domain or Node can have its own domain "Node" providing functionality specific to Node.js The front-end can either support this in the core or we can have it as a third-party module. This is definitely not something for v.1 and deserves separate discussion.

yury-s commented 9 years ago

@auchenberg :

As I understand it, the debugger back-end is separate from the core via v8-inspector, and since it would implement the Chrome Remote Debugging Protocol over WebSocket and HTTP, the debugger back-end would be compatible with external front-ends like Chrome DevTools App (based upon Electron)

Correct. Other front-ends should be able to connect using the same transport. Note though that we don't want to commit to backward compatibility of the whole protocol. It would be up to the front-end authors to make sure that their front-end is compatible with given back-end. We only promise to provide compatible version of DevTools front-end.

By having a runtime/protocol version we will be able to match the front-end with the back-end. Eventually this would need to use some kind of feature detection, but that's further out in the future, as I see it.

Note that this version only relates to the subset of public commands in the protocol. We have been reluctant to making more commands public so the protocol version hasn't changed for a while. Majority of the commands in the protocol are non-public and they have been changing quite often. To ensure full compatibility with the protocol discovery page returns exact version (198849) of the front-end that should be used.

yunong commented 9 years ago

This looks great. I'd love to be able to get the ability to walk the JS objects on the heap that is currently provided by mdb and v8.so https://www.joyent.com/blog/debugging-enhancements-in-node-0-12

Specifically, to be able to walk an object reference all the way back to the root object would be incredibly helpful in debugging memory leaks.

e.g. given a particular object's address, find references to all other objects that refer to this object, similar to what findjsobjects -r does.

trevnorris commented 9 years ago

Summary points:

While the integration API is unstable, that doesn't matter much. What needs a certain amount of stability is the debugger protocol. It seems the debugger/profiler API have stabilized for the most part, but are still prone to breakage. How this will be handled over the course of an LTS needs to be solidified.
The protocol requires web sockets. Does this mean node will have to natively support them as well?
Discovery still needs to be done on all the injection points the API will need into core code.

mscdex commented 9 years ago

Is it possible to expose enough bits to make it transport-agnostic? This would allow core to avoid having to bundle a particular module for this to work.

yury-s commented 9 years ago

Is it possible to expose enough bits to make it transport-agnostic?

See second item in the "Open questions" section above and this comment above. There is a clear separation between v8-inspector and the transport provider. In the prototype remote_debugging_server.js requires three methods on node_debugger:

    node_debugger.connectToInspectorBackend(channel);
    node_debugger.dispatchOnInspectorBackend(message);
    node_debugger.disconnectFromInspectorBackend();

And provides single callback method:

   channel.sendMessageToFrontend = function(message) {...}

On top of that there can be a third-party WebSocket server or module providing another transport.

yury-s commented 9 years ago

@trevnorris :

While the integration API is unstable, that doesn't matter much. What needs a certain amount of stability is the debugger protocol. It seems the debugger/profiler API have stabilized for the most part, but are still prone to breakage. How this will be handled over the course of an LTS needs to be solidified.

While the debugger/profiler protocol may have been stable for a while there is still a chance that we'll need to make some breaking changes to it to move the project forward. We tried to keep stable subset of the protocol and it proved to be hard. We don't want to go that route if possible. Why do you think that we need stability of the remote debugging protocol with the proposed solution?

JacksonTian commented 9 years ago

Hope to see an improved debugger.

trevnorris commented 9 years ago

@yury-s

While the debugger/profiler protocol may have been stable for a while there is still a chance that we'll need to make some breaking changes to it to move the project forward.

If we still have access to the debugging console that can interpret the incoming JSON, that should be enough. This would actually be preferred. So the UI that developers have been using doesn't change over the lifetime of the release. To solidify what has been mentioned earlier, will we be able to use, and have access to, the older debugging consoles for older APIs?

mattdesl commented 9 years ago

One natural approach to that is to reuse Chrome DevTools and provide its JS debugger, performance and memory profiler functionality to Node.js users.

Another approach worth mentioning is leveraging Electron to launch a DevTools window with node integration. See hihat for an example. It has its own limitations, but doesn't involve remote debugging and provides a couple benefits over node-inspector (e.g. a more complete DevTools UX).

Having better debugging built-in to Node would be amazing, though. :smile: It's one of those things you take for granted when you start to do a lot of frontend development.

yury-s commented 9 years ago

@trevnorris

If we still have access to the debugging console that can interpret the incoming JSON, that should be enough. This would actually be preferred. So the UI that developers have been using doesn't change over the lifetime of the release. To solidify what has been mentioned earlier, will we be able to use, and have access to, the older debugging consoles for older APIs?

This is exactly the what should happen if I understand correctly what you mean. Let's assume that v8 stable branch used in Chrome 44 was created from v8 v.4.4.63 and that Blink used in Chrome 44 was branched from 195420. Let's also assume that DevTools backend implementation in Blink is based on revision 1024 of v8-inspector. As long as Node is compiled with v8-inspector r1024 the users should be able to debug it with r195420 of the front-end. Any Chrome version >= 44 can be used to host the front-end (as I mentioned above the source of the front-end will be served from https://chrome-devtools-frontend.appspot.com/serve_rev/@195420/inspector.html) and will work transparently to the user, the front-end could also be provided as Electron app or something else.

yury-s commented 9 years ago

Another approach worth mentioning is leveraging Electron to launch a DevTools window with node integration. See hihat for an example. It has its own limitations, but doesn't involve remote debugging and provides a couple benefits over node-inspector (e.g. a more complete DevTools UX).

There are already other debugging solutions for Node. The main question I'd like to answer after this discussion is to whether it would make sense to invest into extracting base debugger/profiler implementation from DevTools into v8-inspector. The benefit of the single source debugger is that it would make DevTools features available to other embedders and would allow them to use all power of the existing DevTools front-end for v8 debugging. Node.js is the second major client of v8 after Chrome so I'd like to first of all evaluate this solution with Node.js community.

It requires a lot of refactorings in Blink and adds a fair amount of complexity to Chrome itself since the debugger will have to be shipped as a third-party library. Before doing that I'd like to be sure that Node.js will be interested in integrating with the v8-inspector and that there is no another approach that would provide desirable debugging experience in a less intrusive manner/adding less maintenance cost to the projects.

trevnorris commented 9 years ago

We'll discuss this in the next TSC meeting. About whether we'll commit to bringing it into core or not.

bajtos commented 9 years ago

The main question I'd like to answer after this discussion is to whether it would make sense to invest into extracting base debugger/profiler implementation from DevTools into v8-inspector. The benefit of the single source debugger is that it would make DevTools features available to other embedders and would allow them to use all power of the existing DevTools front-end for v8 debugging.

From my point of view as a Node Inspector maintainer, this would be awesome. So far, we were playing a catch-me-up game, trying to keep in sync with the upstream changes made in DevTools UI and the protocol. We were loosing, simply because Node Inspector is a side project and our manpower cannot match speed of the Blink team of several dedicated developers.

I also think it's a waste of everybody's time when every debugger (Node Inspector, WebStorm, Visual Studio, Visual Code, etc.) has to reimplement (and keep maintaining) the same DevTools->V8 protocol bridge.

Even if Node core decides to not bring in the v8-inspector, I think it still makes sense to extract base debugger/profiler implementation from Blink into a module that can be reused by Node.js debuggers.

trevnorris commented 9 years ago

@yury-s Want to double check. Can we implement segments of the API and leave out others (e.g. async stack traces) and have it still work?

yury-s commented 9 years ago

@trevnorris Yes. Async stack traces is optional. You can opt to not support them, the core debugging/profiling functionality should still be available. In fact aforementioned prototype has debugger API for tracking async calls but it is not used.

trevnorris commented 9 years ago

@yury-s Awesome. That's great to hear.

benjamingr commented 9 years ago

Note that we might need to consider detecting if async stack traces are enabled somehow and disable certain optimizations in order to get meaningful results (like trampolining async calls).

trevnorris commented 9 years ago

@yury-s The node TSC has agreed to give a best effort at implementing "v8-inspector" into core.

Qard commented 9 years ago

Just a random comment: it'd be fantastic if this could be embedded in an atom plugin to have IDE-like functionality for node dev work.

faceyspacey commented 8 years ago

+1

stevemao commented 8 years ago

Have you guys seen https://github.com/Jam3/devtool? (I can't search for keyword "devtool" here so maybe someone already mentioned it).

petkaantonov commented 8 years ago

ofrobots commented 8 years ago

I wanted to update the folks on this thread about the current status of this effort.

First, to recap the goals, we want to bring all the current (and future) DevTools's JS features to Node.js and other embedders (including sampling profilers, heap profilers, debugger, async stacks, etc.). To this end we have been working on extracting the DevTools backend from blink, extricate all its dependencies on Blink, and get it integrated into V8 instead. This way, the DevTools backend and the remote debugging protocol becomes available to all V8 embedders. We are calling this project v8-inspector.

Present status

https://github.com/repenaxa/node/tree/v8_inspector is a proof of concept integration with Node.js that @repenaxa (DevTools tech lead) has been working on. It is actually pretty functional, please do try it out and provide feedback.

Complete stepping and breakpoint debugging, blackboxing
Sourcemap support for transpiled code
LiveEdit: JavaScript hot-swap evaluation w/ V8
Console evaluation with support for ES6 and custom object formatting
Sampling JavaScript profiler with flamechart
Heap snapshot debugger, heap allocation profiler

All of the dependencies on blink have been removed, except for a dependency on the C++ container library from blink (wtf). We are actively working on swapping out the uses of wtf with C++ STL. We have a hacky integration with Node.js (see this patch: https://github.com/repenaxa/node/commit/86939cb60b22066f4ee6e818ef879c3dbd6282aa), but it does work.

Timeline

At this point, v8-inspector is not likely to land in V8 5.0. Based on this it seems that this will miss the boat for the next Node.js LTS (October 2016). It would be unfortunate if a better development experience wasn't available to Node.js LTS users until October 2017 (the subsequent LTS).

Even though the window for getting this in into V8 5.0 is closing, we do still have a runway for Node.js 6.0. Here's what we propose: v8-inspector does not necessarily need to land into V8 for Node.js to pick it up. We could integrate v8-inspector directly into Node.js (v6.0). This would unblock the work on the Node.js integration w/ v8-inspector.

Remaining Node.js integration efforts

[ ] The integration of the debug server into the Node.js message loop. We have a hacky proof of concept (patch: https://github.com/repenaxa/node/commit/86939cb60b22066f4ee6e818ef879c3dbd6282aa) which should not be used in production.
[ ] Ergonomics: What command line options do we want to expose for the debug server (host, port). Should we have a option that enables the debug server upon receipt of a signal (how would this work on Windows)? How does this relate to the existing Node.js debug server that talks to the JSON based V8 debug API?
[ ] Bring in websockets (ws) as an internal module to avoid exposing it to user space.
[ ] Wire asynchronous callstack support to Node
[ ] Network inspection integration (v2)

We are continuing to focus on getting extricating the wtf dependency from v8-inspector, and getting it landed into V8 (probably V8 5.1 or 5.2 time-frame), in the meanwhile we'd be happy if folks from the community wanted to collaborate on the above Node.js integration tasks.

We would appreciate comments on the idea of getting v8-inspector landed into Node.js 6.0 as a direct dependency. ( +cc @nodejs/ctc )

It would be great to make better debug and profiling experience available to Node.js developers for the upcoming v6.0 release.

nodejs / node