Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

Commit

Permalink
stream: Increase highWaterMark on large reads
Browse files Browse the repository at this point in the history
If the consumer of a Readable is asking for N bytes, and N > hwm,
then clearly we have set the hwm to low, and ought to increase it.

Fix #4931
  • Loading branch information
isaacs committed Mar 6, 2013
1 parent e0cec37 commit 8c44869
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 0 deletions.
5 changes: 5 additions & 0 deletions lib/_stream_readable.js
Expand Up @@ -181,6 +181,11 @@ function howMuchToRead(n, state) {
if (n <= 0)
return 0;

// If we're asking for more than the target buffer level,
// then raise the water mark.
if (n > state.highWaterMark)
state.highWaterMark = n;

// don't have that much. return null, unless we've ended.
if (n > state.length) {
if (!state.ended) {
Expand Down
69 changes: 69 additions & 0 deletions test/simple/test-stream-readable-flow-recursion.js
@@ -0,0 +1,69 @@
// Copyright Joyent, Inc. and other Node contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to permit
// persons to whom the Software is furnished to do so, subject to the
// following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
// USE OR OTHER DEALINGS IN THE SOFTWARE.

var common = require('../common');
var assert = require('assert');

// this test verifies that passing a huge number to read(size)
// will push up the highWaterMark, and cause the stream to read
// more data continuously, but without triggering a nextTick
// warning or RangeError.

var Readable = require('stream').Readable;

// throw an error if we trigger a nextTick warning.
process.throwDeprecation = true;

var stream = new Readable({ highWaterMark: 2, bufferSize: 2 });
var reads = 0;
stream._read = function(size) {
reads++;
stream.push(new Buffer(size));
};

var depth = 0;

function flow(stream, size, callback) {
depth += 1;
var chunk = stream.read(size);

if (!chunk)
stream.once('readable', flow.bind(null, stream, size, callback));
else
callback(chunk);

depth -= 1;
console.log('flow(' + depth + '): exit');
}

flow(stream, 5000, function() {
console.log('complete (' + depth + ')');
});

process.on('exit', function(code) {
assert.equal(reads, 5000);
// we pushed up the high water mark
assert.equal(stream._readableState.highWaterMark, 5000);
assert.equal(stream._readableState.length, 5000);
assert(!code);
assert.equal(depth, 0);
console.log('ok');
});

0 comments on commit 8c44869

Please sign in to comment.