Supercharge your debugging experience for Node.js
When console logs just aren’t enough
What do you do when you see this?
You might check every line of code and try to find a typo. If you find no typos, you might start using console.logs to see the output for code, which is a pain. Surely there are better methods out there?
Console logs simply aren’t enough. They require us to slowly go line by line, restarting our server each time. Console logs also clutter our codebase with unnecessary code and removing them requires effort.
Exhibit A: how much energy does it take to spot the console log among the dummy data and other processes?
Very daunting. It doesn’t have to be this way.
A much more efficient way of doing things would be debugging with breakpoints. With breakpoints, we can step over the call stack and event loop to diagnose the problem.
You get the point. Time to explore other options. What are the options? I’m glad you asked!
By the way, there’s a very tasty treat at the end of the article —( just saying!).
Node has a built-in inspector!
Let me show you. Let’s start a new node project:
Starting our project and installing express and nodemon:
Now we have a basic express server. But instead of using the
node server.js command the traditional way, we’re adding an extra flag to our node command, the inspector.
--inspect tells Node to expose the new debugging protocol.
Once we start our server with the inspector, here’s what the console outputs:
Sweet, it worked! Open the Chrome at http://localhost:3000 with the dev tools. Notice something extra?
Node inside our browser? Yes indeed! We still consume our app like before —
http://0.0.0.0:9229/ port is for the DevTools to consume.
What does Node Inspector do?
Node Inspector lets you use the DevTools user interface with the native Node debugger. DevTools can now connect directly to the Node process!
If you know how to get this working on Firefox or Safari, let us know in the comments.
Using the debugger
Using the chrome debugger is similar to using the debugger for client-side code. You set breakpoints, execute the code, step over the breakpoints and find the bug.
Can you imagine how useful this can be when we have an error inside a big controller? We have access to the debugger, call stack, scopes, local variables, global variables, etc. We have so many sharp tools to use!
Taking it to another level
We’re not done yet. 20 July 2018 was a very special day for debugging node. Why?
Google Chrome labs team open sourced their advanced debugging tool: ndb!
Ndb is a great tool for debugging. Let’s give it a go.
npm install -g ndb
It’s like any other npm package, — simple to use and install.
To use ndb, we just have to prefix our start script with ndb.
That’s it! Let’s restart our server — notice we’re using nodemon — just like any traditional project.
We have a new chrome instance for the sole purpose of debugging. How cool is that?
We even have access to the node
process global object — which is the
window object for node.
Hacker news discussion about the new debugger — check it out!
Ndb - An improved debugging experience for Node.js | Hacker News
That said, with both VSCode and WebStorm, I've seen finicky issues from time to time, like source maps not working…
Thanks for reading, stay awesome! ❤