Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

http: prevent aborted event when request is complete #18999

Closed
wants to merge 4 commits into from
Closed

http: prevent aborted event when request is complete #18999

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
78a7cbe
http: prevent aborted event when request is complete
billywhizz Feb 17, 2018
68850ef
http: prevent aborted event when request is complete
billywhizz Feb 17, 2018
cfc03aa
working
billywhizz Feb 18, 2018
24e5755
fix(test): refactor test after review
billywhizz Feb 27, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/_http_client.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ function socketCloseListener() {
var parser = socket.parser;
if (req.res && req.res.readable) {
// Socket closed before we emitted 'end' below.
req.res.emit('aborted');
if (!req.res.complete) req.res.emit('aborted');
var res = req.res;
res.on('end', function() {
res.emit('close');
Expand Down
83 changes: 83 additions & 0 deletions test/parallel/test-http-client-spurious-aborted.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
'use strict';

const common = require('../common');
const http = require('http');
const assert = require('assert');
const fs = require('fs');
const Countdown = require('../common/countdown');

function cleanup(fname) {
try {
if (fs.statSync(fname)) fs.unlinkSync(fname);
} catch (err) {}
}

const N = 2;
const fname = '/dev/null';
let abortRequest = true;

const server = http.Server(common.mustCall((req, res) => {
const headers = { 'Content-Type': 'text/plain' };
headers['Content-Length'] = 50;
const socket = res.socket;
res.writeHead(200, headers);
setTimeout(() => res.write('aaaaaaaaaa'), 100);
Copy link
Contributor

@mscdex mscdex Feb 26, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't all of these timers be setTimeout(..., common.platformTimeout(n)) instead? Otherwise, is there a more reliable way to trigger this issue (perhaps using nextTick() and/or setImmediate() or something else)?

setTimeout(() => res.write('bbbbbbbbbb'), 200);
setTimeout(() => res.write('cccccccccc'), 300);
setTimeout(() => res.write('dddddddddd'), 400);
if (abortRequest) {
setTimeout(() => socket.destroy(), 600);
} else {
setTimeout(() => res.end('eeeeeeeeee'), 1000);
}
}, N));

server.listen(0, common.mustCall(() => {
cleanup(fname);
download();
}));

const finishCountdown = new Countdown(N, common.mustCall(() => {
server.close();
}));
const reqCountdown = new Countdown(N, common.mustCall());
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer if N was not a constant, but rather it uses a two steps approach, maybe with some helpers.

It's not clear why you are calling twice too.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's running two tests - one to ensure we don't abort a good request, one to ensure we do abort a bad one. i can refactor to take out the countdown timers altogether. was trying to stay close to how other tests are constructed. if you can suggest how to change i am happy to refactor.


function download() {
const opts = {
port: server.address().port,
path: '/',
};
const req = http.get(opts);
req.on('error', common.mustNotCall());
req.on('response', (res) => {
assert.strictEqual(res.statusCode, 200);
assert.strictEqual(res.headers.connection, 'close');
let aborted = false;
const fstream = fs.createWriteStream(fname);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this file can be made more simple.
No need to cleanup and fs module.

const { Writable } = require('stream');

// ...

const writable = new Writable({
  write(chunk, encoding, callback) {
    callback();
  }
});
res.pipe(writable);

// ...

writable.on('finish', () => {

res.pipe(fstream);
const _handle = res.socket._handle;
_handle._close = res.socket._handle.close;
_handle.close = function(callback) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you explain why are you overriding this here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

because i could not find a way of forcing the condition we get intermittently in the wild. if you run this script and leave it it will eventually start aborting requests that are actually complete: https://gist.github.com/billywhizz/b500a0d4708f89625ddbb313601b5363. i was unable to figure out how to recreate those exact conditions in a test but after debugging i could see the aborted event was being fired even though req.res.complete was = true. so i overrode close here to recreate that condition.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to clarify, the error occurs when req.res.complete = true and res.readable is still = true. that is happening in the wild but don't know how to force it for a test. i imagine it will depend on a specific sequence of TCP session interactions.

_handle._close();
// set readable to true event though request is complete
if (res.complete) res.readable = true;
callback();
};
res.on('end', common.mustCall(() => {
reqCountdown.dec();
}));
res.on('aborted', () => {
aborted = true;
});
res.on('error', common.mustNotCall());
fstream.on('finish', () => {
assert.strictEqual(aborted, abortRequest);
cleanup(fname);
finishCountdown.dec();
if (finishCountdown.remaining === 0) return;
abortRequest = false; // next one should be a good response
download();
});
});
req.end();
}