Skip to content

Commit

Permalink
http: add rawPacket in err of clientError event
Browse files Browse the repository at this point in the history
The `rawPacket` is the current buffer that just parsed. Adding this
buffer to the error object of `clientError` event is to make it possible
that developers can log the broken packet.
  • Loading branch information
XadillaX committed Dec 14, 2017
1 parent 9f61c70 commit e9eb792
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 0 deletions.
5 changes: 5 additions & 0 deletions doc/api/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -765,6 +765,11 @@ object, so any HTTP response sent, including response headers and payload,
*must* be written directly to the `socket` object. Care must be taken to
ensure the response is a properly formatted HTTP response message.

> `err` is an instance of `Error` with two extra columns:
>
> + `bytesParsed`: the bytes count of request packet that Node.js may parse correctly;
> + `rawPacket`: the raw packet of current request.
### Event: 'close'
<!-- YAML
added: v0.1.4
Expand Down
1 change: 1 addition & 0 deletions lib/_http_server.js
Original file line number Diff line number Diff line change
Expand Up @@ -476,6 +476,7 @@ function onParserExecuteCommon(server, socket, parser, state, ret, d) {
resetSocketTimeout(server, socket, state);

if (ret instanceof Error) {
ret.rawPacket = d || parser.getCurrentBuffer();
debug('parse error', ret);
socketOnError.call(socket, ret);
} else if (parser.incoming && parser.incoming.upgrade) {
Expand Down
6 changes: 6 additions & 0 deletions test/parallel/test-http-server-client-error.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ const server = http.createServer(common.mustCall(function(req, res) {
}));

server.on('clientError', common.mustCall(function(err, socket) {
assert.strictEqual(err instanceof Error, true);
assert.strictEqual(err.code, 'HPE_INVALID_METHOD');
assert.strictEqual(err.bytesParsed, 1);
assert.strictEqual(err.message, 'Parse Error');
assert.strictEqual(err.rawPacket.toString(), 'Oopsie-doopsie\r\n');

socket.end('HTTP/1.1 400 Bad Request\r\n\r\n');

server.close();
Expand Down

0 comments on commit e9eb792

Please sign in to comment.