使用--inspect启动Node.js应用时断点无法触发的原因排查

问题描述 #

我有如下Node.js应用代码：

const express = require("express")
const bodyParser = require("body-parser")
const mysql = require("mysql2")
const path = require("path")

const app = express()
app.use(bodyParser.json())

const connection = mysql.createConnection({
    host: process.env.MYSQL_HOST,
    user: process.env.MYSQL_USER,
    password: process.env.MYSQL_PASSWORD,
    database: process.env.MYSQL_DATABASE
})

connection.connect((err) => {
    if (err) {
        console.error(err);
    }
})

connection.query("CREATE TABLE IF NOT EXISTS todo (id INTEGER AUTO_INCREMENT, todo VARCHAR(255), PRIMARY KEY(id))", err => {
    if(err) {
        console.error(err);
    }
})

app.get("/todos", (req, res) => {
    connection.query("SELECT todo FROM todo", (err, results) => {
        if(err) {
            console.error(err);
            res.sendStatus(500);
        }
        res.status(200);
        res.send(results);
    })
})

app.post("/todo", (req, res) => {
    connection.query("SELECT COUNT(*) AS count FROM todo", (err, results) => {
        if (err) {
            console.error(err);
            res.sendStatus(500);
        }
        const id = results[0].count + 1;
        connection.query("INSERT INTO todo (id, todo) VALUES (?, ?)", [id, req.body.todo], (err) => {
            if(err) {
                console.error(err);
                res.sendStatus(500);
            }
            res.status(201);
            res.send(id.toString())
        })
    })
})

app.get("/", (req, res) => {
    res.sendFile(path.join(__dirname, "index.html"));
})

app.get("/client.js", (req, res) => {
    res.sendFile(path.join(__dirname, "client.js"))
})

app.listen(8000);

当我使用node --inspect（或--inspect-brk）启动该服务后，在const id = results[0].count + 1;和app.listen(8000);行设置断点，触发对应代码（发送POST请求触发前者，启动应用触发后者）时，断点并未生效。我尝试过WebStorm和Chrome DevTools两种调试工具，请问这是什么原因？

原因分析与解决方法 #

1. app.listen(8000)断点不生效的原因 #

• 使用node --inspect启动时，Node会先执行应用代码，再等待调试器连接。当你打开调试器并设置断点时，app.listen(8000)这行代码已经执行完成，自然无法触发断点。
• 即使使用--inspect-brk，如果启动后直接点击继续执行，没有提前设置好app.listen的断点，代码也会直接运行到该行并执行完毕。

解决方法：

• 用node --inspect-brk启动服务，此时Node会在代码第一行暂停。
• 在调试器中找到app.listen(8000)所在行，设置断点后再点击"继续执行"，代码运行到该行时就会触发断点。

2. const id = results[0].count + 1;断点不生效的原因 #

• 异步回调的上下文问题：这行代码位于mysql2的connection.query回调函数中，属于异步执行代码。调试器需要正确关联到当前Node进程的异步上下文，否则无法捕获断点。
• 文件路径不匹配：如果调试器中打开的文件路径与Node实际执行的文件路径不一致（比如工作目录错误、使用了符号链接），调试器会认为断点设置在不存在的代码行上。
• 进程连接错误：如果同时运行了多个Node进程，调试器可能连接到了错误的进程，导致断点无法触发。

解决方法：

• 确保调试器连接的是当前运行的目标Node进程，关闭其他无关的Node进程。
• 检查调试器中打开的文件路径，确认和node命令执行的文件路径完全一致（比如避免用相对路径打开文件，直接打开项目中的原始文件）。
• 可以先在回调函数的第一行（if (err) {）设置断点，确认能触发后，再逐步移动到const id = ...行，排查是否是断点设置位置的问题。

额外提示 #

你的POST接口中手动生成id的方式存在并发风险，因为多个请求同时调用时，COUNT(*)+1会生成重复的id。既然数据库中id字段已经设置为AUTO_INCREMENT，可以修改插入语句，让数据库自动生成id：

// 去掉手动生成的id，直接插入todo字段
connection.query("INSERT INTO todo (todo) VALUES (?)", [req.body.todo], (err, result) => {
    if(err) {
        console.error(err);
        res.sendStatus(500);
    }
    res.status(201);
    // 使用result.insertId获取数据库自动生成的id
    res.send(result.insertId.toString())
})

内容的提问来源于stack exchange，提问作者FCBayernFan2012