Expressにてエラーが続くとCannot set headers after they are sent to the clientとなる。

#概要
Expressにて短時間でアクセスエラーが複数回あった場合、「Cannot set headers after they are sent to the client」とログに出力されます。
データを返した後にヘッダーを上書きしたことが原因のようです。
短時間で複数回アクセスエラーがあった時に出力されるので前のエラー処理を追い越してる？または二重に実行しようとしているのが原因かと思います。

#実際のコード

app.use(function(req, res, next) {
  res.header("Access-Control-Allow-Origin", "*")
  res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept")
  next()
});

// convert url string param to expected Type
const convertUrlType = (param:any, type:any) => {
  switch(type) {
    case "N":
      return Number.parseInt(param);
    default:
      return param;
  }
}

app.get(path + hashKeyPath, function(req, res) {
  const condition:any = {}
  condition[partitionKeyName] = {
    ComparisonOperator: 'EQ'
  }
  condition[partitionKeyName]['AttributeValueList'] = [ convertUrlType(req.params[partitionKeyName], partitionKeyType) ];
  try {
    condition[partitionKeyName]['AttributeValueList'] = [ convertUrlType(req.params[partitionKeyName], partitionKeyType) ];
  } catch(err) {
    res.statusCode = 500;
    res.json({error: 'Wrong column type ' + err});
  }


  const queryParams = {
    TableName: tableName,
    KeyConditions: condition
  }
  dynamodb.query(queryParams, (err, data) => {
    if (err) {
      res.statusCode = 500;
      res.json({error: 'Could not load items: ' + err});
    } else {
      res.json(data.Items);
    }
  });
});

#質問
res.json()でそこで処理が終わるという認識なのですが、処理は完全に終わっていないのでしょうか？
コード内のエラーハンドリングで、問題があるかと思いますが、アドバイス頂けないでしょうか。
宜しくお願い致します。

行動規範の内容に同意します

回答1件

ベストアンサー

まず、NodeJS のHTTPモジュールの http.ServerResponse 実装を確認します。

response.headersSent

このプロパティは応答を開始し、ペイロードのヘッダ部分が応答された時点で true になります。
この状態で response.setHeader() を実行すると、表題に示されたエラーを発します。（追記：setHeader()のアンカー）

Cannot set headers after they are sent to the client

（Google翻訳:クライアントに送信された後、ヘッダーを設定できません）

次に、gitHubでExpressJS の実装を確認します。
res.json()（lib/response.js 264行）を追いかけると、res.set() :753行、771行で setHeader() を呼んでいますので、res.json() を多重実行（多重応答）してるのがエラー原因とわかります。

コード内のエラーハンドリングで、問題があるかと思います

http.ServerResponse は、ExpressJS のミドルウェアの第二引数に渡される res から橋渡しするので、エラー応答した場合は、適切にミドルウェア関数を抜ける必要があります。

javascript
1app.get(path + hashKeyPath, function(req, res) {
2  const condition:any = {}
3  condition[partitionKeyName] = {
4    ComparisonOperator: 'EQ'
5  }
6  condition[partitionKeyName]['AttributeValueList'] = [ convertUrlType(req.params[partitionKeyName], partitionKeyType) ];
7  try {
8    condition[partitionKeyName]['AttributeValueList'] = [ convertUrlType(req.params[partitionKeyName], partitionKeyType) ];
9  } catch(err) {
10    res.statusCode = 500;
11    res.json({error: 'Wrong column type ' + err}); // 応答している
12    return; // dynamodb.query() のコールバックで応答しない実装にする。
13  }
14
15
16  const queryParams = {
17    TableName: tableName,
18    KeyConditions: condition
19  }
20  dynamodb.query(queryParams, (err, data) => {
21    if (err) {
22      res.statusCode = 500;
23      res.json({error: 'Could not load items: ' + err});
24    } else {
25      res.json(data.Items);
26    }
27  });
28});