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

Jump to bottom

net: use _final instead of on('finish') #18608

Closed
wants to merge 3 commits into from
Closed

net: use _final instead of on('finish') #18608

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0a09c1a
net: use `_final` instead of `on('finish')`
addaleax Feb 7, 2018
845bf1d
[squash] nit
addaleax Feb 7, 2018
356ac44
[squash] add streams-only test
addaleax Feb 20, 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: 2 additions & 0 deletions lib/internal/streams/destroy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ function undestroy() {
this._writableState.destroyed = false;
this._writableState.ended = false;
this._writableState.ending = false;
this._writableState.finalCalled = false;
this._writableState.prefinished = false;
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 add a unit test for those? Maybe also place them in a separate commit, if we want to backport them separately.

Copy link
Member Author

Choose a reason for hiding this comment

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

@mcollina Do you know where those tests are? In any case, these lines are tested in the sense that tests do fail without them...

Copy link
Member

Choose a reason for hiding this comment

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

We need test that can be run as part of readable-stream.

Here are the current tests:

test/parallel/test-stream-duplex-destroy.js
test/parallel/test-stream-readable-destroy.js
test/parallel/test-stream-transform-destroy.js
test/parallel/test-stream-writable-destroy.js

this._writableState.finished = false;
this._writableState.errorEmitted = false;
}
Expand Down
28 changes: 16 additions & 12 deletions lib/net.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,6 @@ function Socket(options) {
}

// shut down the socket when we're finished with it.
this.on('finish', onSocketFinish);
this.on('_socketEnd', onSocketEnd);

initSocketHandle(this);
Expand Down Expand Up @@ -303,39 +302,42 @@ Socket.prototype._unrefTimer = function _unrefTimer() {

function shutdownSocket(self, callback) {
var req = new ShutdownWrap();
req.oncomplete = callback;
req.oncomplete = afterShutdown;
req.handle = self._handle;
req.callback = callback;
return self._handle.shutdown(req);
}

// the user has called .end(), and all the bytes have been
// sent out to the other side.
function onSocketFinish() {
// If still connecting - defer handling 'finish' until 'connect' will happen
Socket.prototype._final = function(cb) {
// If still connecting - defer handling `_final` until 'connect' will happen
if (this.connecting) {
debug('osF: not yet connected');
return this.once('connect', onSocketFinish);
debug('_final: not yet connected');
return this.once('connect', () => this._final(cb));
}

debug('onSocketFinish');
if (!this.readable || this._readableState.ended) {
debug('oSF: ended, destroy', this._readableState);
debug('_final: ended, destroy', this._readableState);
cb();
return this.destroy();
}

debug('oSF: not ended, call shutdown()');
debug('_final: not ended, call shutdown()');

// otherwise, just shutdown, or destroy() if not possible
if (!this._handle || !this._handle.shutdown)
if (!this._handle || !this._handle.shutdown) {
cb();
return this.destroy();
}

var err = defaultTriggerAsyncIdScope(
this[async_id_symbol], shutdownSocket, this, afterShutdown
this[async_id_symbol], shutdownSocket, this, cb
);

if (err)
return this.destroy(errnoException(err, 'shutdown'));
}
};


function afterShutdown(status, handle) {
Expand All @@ -344,6 +346,8 @@ function afterShutdown(status, handle) {
debug('afterShutdown destroyed=%j', self.destroyed,
self._readableState);

this.callback();

// callback may come after call to destroy.
if (self.destroyed)
return;
Expand Down
12 changes: 7 additions & 5 deletions test/async-hooks/test-shutdownwrap.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,13 @@ let endedConnection = false;
function onconnection(c) {
assert.strictEqual(hooks.activitiesOfTypes('SHUTDOWNWRAP').length, 0);
c.end();
endedConnection = true;
const as = hooks.activitiesOfTypes('SHUTDOWNWRAP');
assert.strictEqual(as.length, 1);
checkInvocations(as[0], { init: 1 }, 'after ending client connection');
this.close(onserverClosed);
process.nextTick(() => {
endedConnection = true;
const as = hooks.activitiesOfTypes('SHUTDOWNWRAP');
assert.strictEqual(as.length, 1);
checkInvocations(as[0], { init: 1 }, 'after ending client connection');
this.close(onserverClosed);
});
}

function onconnected() {
Expand Down
14 changes: 14 additions & 0 deletions test/parallel/test-stream-writable-destroy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,3 +185,17 @@ const { inherits } = require('util');
assert.strictEqual(expected, err);
}));
}

{
// Checks that `._undestroy()` restores the state so that `final` will be
// called again.
const write = new Writable({
write: common.mustNotCall(),
final: common.mustCall((cb) => cb(), 2)
});

write.end();
write.destroy();
write._undestroy();
write.end();
}