在 Express / Node.js 中调试“发送后无法设置标头”错误的最佳方法？

Question

我正在尝试调试 node.js Express 应用程序中可怕的 Can't set headers after they are sent 错误。具体来说，我使用knox 库与s3 对话。

大致来说，我有这个 Express 处理程序，使用 knox s3client 的全局实例：

function foo(req, res) {
    //Region A
    var s3req = global.s3client.get('foo').on('response', function(s3res){
        //Region B
        res.set('content-length', s3res.headers['content-length']); //This will fail
        s3res.on('data', function(chunk){
            res.write(chunk);
        });
    });
    //Region C
    s3req.end();
}

如果我在区域 A 的 res 上设置任何标题或状态代码，一切正常。如果我在区域 B 中尝试任何这些，我会收到“发送后无法设置标头”错误。请注意，我想在res 上设置标题，而不是s3res

大概response.writeHead 在调用 knox s3client 的响应回调之前被调用或触发。是否有一些调试标志或其他方法可以让 Node 在调用 writeHead 时/在何处吐出？节点 0.10 添加了一个response.headersSent，但是通过检查这个标志来确定它被调用的位置将非常难以填充我的代码和所有 3rd 方库。还是有其他方法可以解决这个问题？

Answer 1

您可以尝试包含一个简单的中间件，在调用writeHead 时将堆栈跟踪转储到标准输出：

app.use(function(req, res, next) {
  res.on('header', function() {
    console.trace('HEADERS GOING TO BE WRITTEN');
  });
  next();
});

您必须在可能触发您的问题的路由/中间件之前插入它。

FWIW，我猜这个问题是由 C 区发生的事情触发的（res.send、res.end、res.json 或 res.render 在那里被调用）：

function foo(req, res) {
    //Region A
    var s3req = global.s3client.get('foo').on('response', function(s3res){
        //Region B
        res.set('content-length', s3res.headers['content-length']);
    }); 
    //Region C
}

编辑如果s3res 是正确的流，你可以试试这个：

function foo(req, res) {
  global.s3client.get('foo').on('response', function(s3res) {
    s3res.pipe(res);
  }).end();
}

但请注意，S3 请求返回的 所有 标头都将传递给 Express 响应。

Answer 2

我不确定它是否适用于此，但是当我看到错误时我立即想到的是“模型层”某处的“回调逻辑”中的一个简单非常简单的错误。在两个不同的情况下，我一直对此感到头疼，在这两种情况下，结果都是我两次调用了回调（即最终会调用响应写入回调的回调）。这只会在我的模型层出现错误时发生，因为它的代码如下：

if (err) cb(err) // note the missing "return" here
cb(null,result) // alternatively, also no "else"

如果我现在遇到这样的错误，我要做的第一件事就是检查是否为任何操作调用了两次响应写入回调。只需两个 console.log 语句，一个在区域 A（启动 Knox 请求的范围）和一个在区域 C（响应写入回调）就足以至少消除这种可能性。

原则上，您的res 对象应该受到很好的保护。只有 connect / express 中间件可以访问它，当然还有这个特定的请求处理程序。所以只有有限数量的地方可以写标题。