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

stream: fix disparity between buffer and the count #15661

Closed
Closed
Show file tree
Hide file tree
Changes from 1 commit
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
3 changes: 2 additions & 1 deletion lib/_stream_writable.js
Original file line number Diff line number Diff line change
Expand Up @@ -502,6 +502,7 @@ function clearBuffer(stream, state) {
corkReq.finish = onCorkedFinish.bind(undefined, corkReq, state);
state.corkedRequestsFree = corkReq;
}
state.bufferedRequestCount = 0;
} else {
// Slow case, write chunks one-by-one
while (entry) {
Expand All @@ -512,6 +513,7 @@ function clearBuffer(stream, state) {

doWrite(stream, state, false, len, chunk, encoding, cb);
entry = entry.next;
state.bufferedRequestCount--;
// if we didn't call the onwrite immediately, then
// it means that we need to wait until it does.
// also, that means that the chunk and cb are currently
Expand All @@ -525,7 +527,6 @@ function clearBuffer(stream, state) {
state.lastBufferedRequest = null;
}

state.bufferedRequestCount = 0;
state.bufferedRequest = entry;
state.bufferProcessing = false;
}
Expand Down
34 changes: 34 additions & 0 deletions test/sequential/test-stream-writable-clear-buffer.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
'use strict';
const common = require('../common');
const Stream = require('stream');
//this test ensures that the _writeableState.bufferedRequestCount and
Copy link
Member

Choose a reason for hiding this comment

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

Nit - would you be so kind upper case the first letter and also add a whitespace after //?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure no problem, would there be any other style changes you'd think might be appropriate? If not I'll just commit with that one change and squash if required/requested.

Copy link
Member

Choose a reason for hiding this comment

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

In the comment below, please also add a whitespace on each line after //. Besides that everything is LGTM.

// the actual buffered request count are the same
const assert = require('assert');

class StreamWritable extends Stream.Writable {
constructor() {
super({ objectMode: true });
}

//We need a timeout like on the original issue thread
//otherwise the code will never reach our test case
//this means this should go on the sequential folder.
_write(chunk, encoding, cb) {
setTimeout(cb, common.platformTimeout(10));
}
}

const testStream = new StreamWritable();
testStream.cork();

for (let i = 1; i <= 5; i++) {
testStream.write(i, function() {
assert.strictEqual(
testStream._writableState.bufferedRequestCount,
testStream._writableState.getBuffer().length,
'bufferedRequestCount variable is different from the actual length of' +
' the buffer');
});
}

testStream.end();