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.

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

tls: make StreamWrap work correctly when waiting for "drain" events in doShutdown #23294

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 3 additions & 4 deletions lib/internal/wrap_js_stream.js
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,6 @@ class JSStreamWrap extends Socket {
}

doShutdown(req) {
assert.strictEqual(this[kCurrentShutdownRequest], null);
this[kCurrentShutdownRequest] = req;

// TODO(addaleax): It might be nice if we could get into a state where
// DoShutdown() is not called on streams while a write is still pending.
//
Expand All @@ -113,8 +110,10 @@ class JSStreamWrap extends Socket {
// so for now that is supported here.

if (this[kCurrentWriteRequest] !== null)
oyyd marked this conversation as resolved.
Show resolved Hide resolved
return this.on('drain', () => this.doShutdown(req));
return this.once('drain', () => this.doShutdown(req));
assert.strictEqual(this[kCurrentWriteRequest], null);
assert.strictEqual(this[kCurrentShutdownRequest], null);
this[kCurrentShutdownRequest] = req;

const handle = this._handle;

Expand Down
50 changes: 50 additions & 0 deletions test/parallel/test-stream-wrap-drain.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
// Flags: --expose-internals
'use strict';
const common = require('../common');
const assert = require('assert');
const { StreamWrap } = require('_stream_wrap');
const { Duplex } = require('stream');
const { internalBinding } = require('internal/test/binding');
const { ShutdownWrap } = internalBinding('stream_wrap');

// This test makes sure that when an instance of JSStreamWrap is waiting for
// a "drain" event to `doShutdown`, the instance will work correctly when a
// "drain" event emitted.
{
let resolve = null;

class TestDuplex extends Duplex {
_write(chunk, encoding, callback) {
// We will resolve the write later.
resolve = () => {
callback();
};
}

_read() {}
}

const testDuplex = new TestDuplex();
const socket = new StreamWrap(testDuplex);

socket.write(
// Make the buffer long enough so that the `Writable` will emit "drain".
Buffer.allocUnsafe(socket.writableHighWaterMark * 2),
common.mustCall()
);

// Make sure that the 'drain' events will be emitted.
testDuplex.on('drain', common.mustCall(() => {
console.log('testDuplex drain');
}));

assert.strictEqual(typeof resolve, 'function');

const req = new ShutdownWrap();
req.oncomplete = common.mustCall();
req.handle = socket._handle;
// Should not throw.
socket._handle.shutdown(req);

resolve();
}