node.jsのDELETEメソッドのリクエストを送る処理の、リクエストボディの扱いについて質問

Question

例えば、以下のREST APIに、以下のようなリクエストボディを付けてリクエストを投げるとします。

[DELETE] http://httpbin.org/delete
・リクエストボディ:{"param" : "hello"}

以下のサンプルソースのような記述でリクエストを送ったところ、リクエストボディの内容がAPIに届く時点で空になってしまいます。

// expressで作るサンプルAPIです
router.delete('/', (req, res, next) => {
  const http = require('http');
  const async = require('async');

  let options = {
    host : 'httpbin.org',
    port : 80,
    path : '/delete',
    method : 'DELETE',
    headers : {"Content-Type" : "application/json"}
  };

  // let options = {
  //   host : 'httpbin.org',
  //   port : 80,
  //   path : '/put',
  //   method : 'PUT',
  //   headers : ''
  // };

  let payload = JSON.stringify({"param" : "hello"});

  let req2;

 async.waterfall([
   function(callback) {
     req2 = http.request(options, (res2) => {
       let body = '';
       res2.on('data', (chunk) => {
         body += chunk;
       });
       res2.on('end', () => {
         callback(null, body);
       });
     });
     req2.write(payload); // リクエストボディをセット
     req2.end();
   },
   function(body,callback) {
     res.send(body); // リクエスト送信
     callback(null, body);
   }
 ],
 (e, result) => {
   if(e) {
     next(e);
     return;
   }
 });
});

レスポンスは以下になります。
dataの値にリクエストボディが入るはずですが、空になります。

{
  "args": {}, 
  "data": "", 
  "files": {}, 
  "form": {}, 
  "headers": {
    "Content-Type": "application/json", 
    "Host": "httpbin.org"
  }, 
  "json": null, 
  "origin": "１２３．４５６．７８９．０", 
  "url": "http://httpbin.org/delete"
}

これを、例えばPUTメソッドのリクエストに変えてみると、問題なくdataの値にリクエストボディが入ります。

なぜ、このような現象が起きるのか分かりません。
（DELETEメソッドの仕様？node.jsのバグ？）
御存知の方がいましたら、教えていただけないでしょうか。
よろしくお願いします。

Answer 1

まず、DELETE に body を付ける事はGET同様、仕様上禁止されていないのですが、 POST, PUTは content-length を付けることが必須なのに対して、 GET, DELETE は任意となっております。

この仕様上、 content-length がリクエストパラメータに付与されていないことになると、多くのサーバでは GET/DELETE の際にどこまでbodyとして読んだら良いのかわからないことがあります。

このため、多くのweb サーバでは GET/DELETE でbodyを付けることに対応していないことが多いです。
そして node.js の場合は、 http-parser で DELETE に body があろうがなかろうが、Content-Lengthがない場合は無視します。

ちゃんと試してはいないですが、DELETE時に content-length パラメータをheaderに付与すればもしかしたら読んでくれる可能性があります。

let options = {
    host : 'httpbin.org',
    port : 80,
    path : '/delete',
    method : 'DELETE',
    headers : {"Content-Type" : "application/json", "Content-Length": body.length }
  };

追記：

以下の方法で Content-Length さえ渡せば body を渡せることが確認できました。

const http = require('http');

const body = 'hello server';
let options = {
    host : 'localhost',
    path : '/delete',
    method : 'DELETE',
    headers : {"Content-Type" : "application/json", "Content-Length": body.length}
};

const server = http.createServer((req, res) => {
  let chunk = '';
  req.on('data', (d) => chunk += d);
  req.on('end', () => {
    res.end('hello client ' + chunk);
  });
});

server.listen(0, () => {
  const port = server.address().port;
  options.port = port;
  const req = http.request(options, (res) => {
    // hello client hello server
    res.pipe(process.stdout);
  });

  req.write(body)
  req.end();
})

Comments

[kong]

ご回答ありがとうございます。
教えていただいた内容で確認したところ、無事にbodyを送る事ができました。

そして、HTTPの仕様、http-parserの仕様について、大変勉強になりました。
ヘッダーパラメータも、厳密に必要なものをチョイスして付与していなかったので、この辺の仕様は正しく理解しないとまずそうですね。

本当に助かりました。ありがとうございます。