Skip to content

WIP net: enable emitclose in socket #36662

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

WIP net: enable emitclose in socket #36662

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 12 additions & 5 deletions lib/internal/streams/destroy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ const {
const {
FunctionPrototypeCall,
Symbol,
Boolean
} = primordials;

const kDestroy = Symbol('kDestroy');
const kConstruct = Symbol('kConstruct');

Expand Down Expand Up @@ -155,12 +155,15 @@ function _destroy(self, err, cb) {

function emitErrorCloseNT(self, err) {
emitErrorNT(self, err);
emitCloseNT(self);
emitCloseNT(self, err);
}

function emitCloseNT(self) {
function emitCloseNT(self, err) {
const r = self._readableState;
const w = self._writableState;
const emitClose = (w && w.emitClose) || (r && r.emitClose);
const shouldPassErrorFlag = (w && w.errorFlagOnClose) ||
(r && r.errorFlagOnClose);

if (w) {
w.closeEmitted = true;
Expand All @@ -169,8 +172,12 @@ function emitCloseNT(self) {
r.closeEmitted = true;
}

if ((w && w.emitClose) || (r && r.emitClose)) {
self.emit('close');
if (emitClose) {
if (shouldPassErrorFlag) {
self.emit('close', Boolean(err));
} else {
self.emit('close');
}
}
}

Expand Down
4 changes: 4 additions & 0 deletions lib/internal/streams/readable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,10 @@ function ReadableState(options, stream, isDuplex) {
// Should close be emitted on destroy. Defaults to true.
this.emitClose = !options || options.emitClose !== false;

// Should a boolean flag be passed as argument when emitting close if an error
// occurred
this.errorFlagOnClose = options && options.errorFlagOnClose === true;

// Should .destroy() be called after 'end' (and potentially 'finish').
this.autoDestroy = !options || options.autoDestroy !== false;

Expand Down
4 changes: 4 additions & 0 deletions lib/internal/streams/writable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,10 @@ function WritableState(options, stream, isDuplex) {
// Should close be emitted on destroy. Defaults to true.
this.emitClose = !options || options.emitClose !== false;

// Should a boolean flag be passed as argument when emitting close if an error
// occurred
this.errorFlagOnClose = options && options.errorFlagOnClose === true;

// Should .destroy() be called after 'finish' (and potentially 'end').
this.autoDestroy = !options || options.autoDestroy !== false;

Expand Down
23 changes: 5 additions & 18 deletions lib/net.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,8 +299,9 @@ function Socket(options) {

// Default to *not* allowing half open sockets.
options.allowHalfOpen = Boolean(options.allowHalfOpen);
// For backwards compat do not emit close on destroy.
options.emitClose = false;
// For backward compatibility, pass a flag when emitting close for
// comunicating that an error occurred.
options.errorFlagOnClose = true;
options.autoDestroy = true;
// Handle strings directly.
options.decodeStrings = false;
Expand Down Expand Up @@ -655,28 +656,20 @@ Socket.prototype._destroy = function(exception, cb) {
if (this._handle) {
if (this !== process.stderr)
debug('close handle');
const isException = exception ? true : false;

// `bytesRead` and `kBytesWritten` should be accessible after `.destroy()`
this[kBytesRead] = this._handle.bytesRead;
this[kBytesWritten] = this._handle.bytesWritten;

this._handle.close(() => {
debug('emit close');
if (this._writableState) {
this._writableState.closed = true;
}
if (this._readableState) {
this._readableState.closed = true;
}
this.emit('close', isException);
cb(exception);
});
this._handle.onread = noop;
this._handle = null;
this._sockname = null;
cb(exception);
} else {
cb(exception);
process.nextTick(emitCloseNT, this);
}

if (this._server) {
Expand Down Expand Up @@ -1655,12 +1648,6 @@ Server.prototype._emitCloseIfDrained = function() {

function emitCloseNT(self) {
debug('SERVER: emit close');
if (self._writableState) {
self._writableState.closed = true;
}
if (self._readableState) {
self._readableState.closed = true;
}
self.emit('close');
}

Expand Down
4 changes: 4 additions & 0 deletions test/parallel/test-http2-respond-with-file-connection-abort.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ server.listen(0, common.mustCall(() => {

req.on('response', common.mustCall(() => {}));
req.once('data', common.mustCall(() => {
// TODO: is this test needed?
// It errors with ERR_HTTP2_NO_SOCKET_MANIPULATION because we are
// calling destroy on the Proxy(ed) socket of the Http2ClientSession
// which causes `emit` to becalled and the error to be thrown.
Copy link
Contributor Author

@dnlup dnlup Jan 21, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Calling destroy this way will cause HTTP2_NO_SOCKET_MANIPULATION, I don't see a way around that atm

net.Socket.prototype.destroy.call(client.socket);
server.close();
}));
Expand Down
5 changes: 5 additions & 0 deletions test/parallel/test-tls-socket-close.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
'use strict';

const common = require('../common');
if (!common.hasCrypto)
common.skip('missing crypto');
Expand All @@ -8,6 +9,10 @@ const tls = require('tls');
const net = require('net');
const fixtures = require('../common/fixtures');

// TODO: is this test needed?
// It fails with a timeout error because the `error` event is never emitted.
// `write` doesn't error, is that a good thing?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

While trying different approaches in this PR I saw it is quite easy to cause SIGSEV errors in the tls module, so I might understand why this is here.

// Regression test for https://github.com/nodejs/node/issues/8074
//
// This test has a dependency on the order in which the TCP connection is made,
Expand Down