Debug Node.js Effectively with Chrome DevTools

2018-05-02 06:20 AM

178

Debugging Node.js with Google Chrome. Debugging is the task to identify and remove errors from software applications, and is more than just printing out values in your code. This post describes how to efficiently debug Node.js programs using the latest Google Chrome DevTools.

Debugging is the task of identifying and removing errors from software applications, and it’s more than just printing out values in your code. This post describes how to efficiently debug Node.js programs using the latest Google Chrome DevTools.

A lot of developers use console.log in order to debug their application. But why? The answer is easy: It’s inconvenient to use the debugger if you haven’t set up your environment correctly.

Why console.log Is Not the Best Option

Using console.log to debug your code generally sends you into an infinite loop of stopping your app, adding a console.log, and starting your app again. Besides slowing down the development of your app, it also makes your writing dirty and creates unnecessary code. Also, trying to log out variables alongside the noise of other potential logging operations may make debugging difficult when you’re attempting to find the values you are debugging.

Debugging tools provide you with a few important functionalities that console.log isn’t able to provide. In particular, they let you pause the execution of your application at specific points in the code and inspect and modify the values of the variables while the program is still running.

The Built-in Debugger of Node.js

Node.js ships with a built-in debugging facility. If you start your application on the command line with node debug index.js where index.js is the starting point of your application, then it is started in debug mode.

This command has two effects:

You start an interactive debugging shell.

And you open a TCP connection on port 5858 where you can connect a remote debugger with your application.

The CLI debugger is an uncomfortable solution directly after debugging with console.log. But you have a set of commands that make it possible to navigate within your application at runtime.

$ node debug index.js

Advanced Debugging

Chrome and Node.js share the same JavaScript engine with V8, so it should be possible to use the same tools for debugging and profiling your applications.

For older versions of Node.js, there was a tool called node-inspector that connected the V8 engine of Node with Chrome Developer Tools. It doesn’t work for current Node.js versions, but in May 2016, the --inspect flag landed in Node.js and with it a much better debugging support.

In contrast to node-inspector, you don’t have to install any additional module in order to get the --inspect flag working. You just have to start your application with this flag.

$ node--inspect index.jsAs soon as you start your application, Node.js provides you with a URL that you copy to the address field of your Chrome browser. Your browser then connects to your Node.js instance and lets you debug and profile your application. This includes setting breakpoints and watch expressions or capturing memory snapshots of your application.
Debug your Node.js application with Chrome Developer Tools

IDE Debugging (VS Code)

Most of the current IDEs support debugging of Node.js applications, such as WebStorm, Eclipse, or Visual Studio Code.

It’s surprisingly easy to get your debugging environment started in Visual Studio Code, which is by the way just another Node.js application. You just have to hit the debug button on the left side of the window and select the environment you want to debug (Node.js).

Visual Studio Code then creates the launch configuration for you and saves it to the .vscode/launch.json file in the root folder of your application. Depending on the starting point of your application, you have to make an adjustment here. VS Code expects your application to start at app.js. If you name the starting point differently, just go to launch.json and change the value of the program key. After that, you can launch your debugger and have a look at your application.

Let’s use a simple web server as an example. In order to debug this application, you have to set a breakpoint (by clicking to the left of the line number), launch the debugger, and go to the server URL in your local browser. The application then automatically stops at your breakpoint and you can start stepping through your code.

As you see, there’s no more need for console.log statements to debug your application code. Just start the debugger of your choice and have a comfortable interface to have a look at your code at runtime.