ExpressJS - Debugging

Express.js - Debugging Techniques

Debugging is a critical skill for any developer. In a Node.js and Express environment, you have several powerful tools and techniques at your disposal to find and fix issues, from simple console logs to sophisticated integrated debuggers.

1. Using the debug Module

Express is built with the popular debug module, which allows you to see internal logging information by setting an environment variable. This is extremely useful for understanding how Express is processing a request, matching routes, and executing middleware.

To enable debug logs, set the DEBUG environment variable when starting your application. You do not need to install debug separately, as it’s a dependency of Express.

Enabling Debug Logs

The command differs based on your operating system’s shell:

• Linux/macOS: export DEBUG=express:* && node index.js
• Windows (PowerShell): $env:DEBUG='express:*'; node index.js
• Windows (CMD): set DEBUG=express:* && node index.js

A cross-platform solution is to use the cross-env package. First, install it: npm install --save-dev cross-env

Then, add a script to your package.json:

"scripts": {
  "start:dev": "cross-env DEBUG=express:* nodemon index.js"
}

Now you can simply run npm run start:dev on any OS. The * is a wildcard that enables all logs within the express namespace. You’ll see detailed output about routing, middleware execution, and more.

Filtering Logs

To reduce noise, you can specify which parts of Express you want to debug. For example, to see only router and application-level logs:

cross-env DEBUG=express:router,express:application nodemon index.js

2. Classic console.log

Never underestimate the power of a simple console.log(). It’s the quickest way to inspect the value of a variable, check if a piece of code is being executed, or examine the contents of the req and res objects.

app.get('/users/:id', (req, res) => {
    console.log('--- New Request ---');
    console.log('Route Parameters:', req.params);
    console.log('Query String:', req.query);

    const { id } = req.params;
    res.send(`Profile for User ID: ${id}`);
});

Pro Tip: Use console.dir(object, { depth: null }) to print the full contents of a large object without truncation.

3. Integrated Debugger (VS Code)

For more complex issues, using a step-through debugger is the most effective method. It allows you to pause your code’s execution, inspect variables, and step through the logic line by line. Visual Studio Code has excellent built-in support for Node.js debugging.

Setup Steps:

1. Open the ‘Run and Debug’ panel in VS Code (Ctrl+Shift+D).
2. Click on ‘create a launch.json file’ and select ‘Node.js’.
3. This will generate a launch.json file inside a .vscode directory.

Example launch.json configuration:

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "node",
            "request": "launch",
            "name": "Launch Express App",
            "program": "${workspaceFolder}/index.js",
            "restart": true,
            "runtimeExecutable": "nodemon",
            "console": "integratedTerminal"
        }
    ]
}

This configuration tells VS Code to launch your app using nodemon for automatic restarts. Now you can:

1. Set breakpoints by clicking in the gutter next to the line numbers in your code.
2. Start the debugger by pressing F5.
3. Send a request to your server (e.g., from a browser or API client).
4. Execution will pause at your breakpoint, allowing you to inspect the program’s state.