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

Commit

Permalink
stream: start old-mode read in a next tick
Browse files Browse the repository at this point in the history
Calling `.read()` in the same tick with `.on('data', ...)` may cause
users missing `error` events, because no `error` listeners were set yet.

fix #7618
  • Loading branch information
indutny committed Jun 6, 2014
1 parent a7dd0e5 commit 2efe4ab
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 4 deletions.
14 changes: 12 additions & 2 deletions lib/_stream_readable.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,9 @@ function ReadableState(options, stream) {
// if true, a maybeReadMore has been scheduled
this.readingMore = false;

// if true, stream is in old mode
this.oldMode = false;

this.decoder = null;
this.encoding = null;
if (options.encoding) {
Expand Down Expand Up @@ -766,8 +769,15 @@ function emitDataEvents(stream, startPaused) {
this.emit('resume');
};

// now make it start, just in case it hadn't already.
stream.emit('readable');
// Start reading in next tick to allow caller to set event listeners on
// the stream object (like 'error')
process.nextTick(function() {
// now make it start, just in case it hadn't already.
stream.emit('readable');
});

// Let others know about our mode
state.oldMode = true;
}

// wrap an old-style stream as the async data source.
Expand Down
2 changes: 1 addition & 1 deletion lib/http.js
Original file line number Diff line number Diff line change
Expand Up @@ -2078,7 +2078,7 @@ function connectionListener(socket) {
// if the user never called req.read(), and didn't pipe() or
// .resume() or .on('data'), then we call req._dump() so that the
// bytes will be pulled off the wire.
if (!req._consuming)
if (!req._consuming && !req._readableState.oldMode)
req._dump();

res.detachSocket(socket);
Expand Down
41 changes: 41 additions & 0 deletions test/simple/test-stream-readable-data-sync-race.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
// 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');

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

var r = new Readable();
var errors = 0;

// Setting `data` listener should not trigger `_read()` calls before we will
// set the `error` listener below
r.on('data', function() {
});

r.on('error', function() {
errors++;
});

process.on('exit', function() {
assert.equal(errors, 1);
});
4 changes: 3 additions & 1 deletion test/simple/test-stream2-compatibility.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,6 @@ TestReader.prototype._read = function(n) {
};

var reader = new TestReader();
assert.equal(ondataCalled, 1);
process.nextTick(function() {
assert.equal(ondataCalled, 1);
});

15 comments on commit 2efe4ab

@mscdex
Copy link

@mscdex mscdex commented on 2efe4ab Jun 13, 2014

Choose a reason for hiding this comment

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

FWIW This commit broke things in busboy. With this commit, I now see 'data' events that come after 'end' events. :-\

I'm trying to come up with a smaller reproducible test case, but I'm not having much success. Maybe it's some edge case?

@indutny
Copy link
Member Author

Choose a reason for hiding this comment

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

Oh gosh... Mind providing a test case?

@indutny
Copy link
Member Author

Choose a reason for hiding this comment

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

It may be an edge case, or may be a bug :) Also does it reproduce on v0.11?

@mscdex
Copy link

@mscdex mscdex commented on 2efe4ab Jun 13, 2014

Choose a reason for hiding this comment

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

I haven't tried v0.11 yet. I do notice too that when I see 'end', _readableState.sync is true. I've also tried delaying push(null); but 'end' is still emitted somehow. All of the 'end' events are emitted in the same tick, then in the next tick 'data' events are emitted.

@mscdex
Copy link

@mscdex mscdex commented on 2efe4ab Jun 13, 2014

Choose a reason for hiding this comment

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

Ok, v0.11.13 works fine with the same busboy code/tests.

EDIT: node master (includes this commit) also fails in the same way.

@indutny
Copy link
Member Author

Choose a reason for hiding this comment

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

Ok, this means that I implemented it better in v0.11 :) Still waiting for a test case.

@mscdex
Copy link

@mscdex mscdex commented on 2efe4ab Jun 13, 2014

Choose a reason for hiding this comment

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

FWIW I ended up finding a workaround that seems to work (so far): I override _readableState.sync to false after creating the stream object.

@indutny
Copy link
Member Author

Choose a reason for hiding this comment

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

@tjfontaine we should revert it.

@indutny
Copy link
Member Author

Choose a reason for hiding this comment

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

@mscdex are you doing any other trickery with streams? Are you using data event at all?

@mscdex
Copy link

@mscdex mscdex commented on 2efe4ab Jun 13, 2014

Choose a reason for hiding this comment

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

No, I'm not using streams in any unusual ways or even mutating the readable state (except for sync now). I am using 'data' events.

@tjfontaine
Copy link

Choose a reason for hiding this comment

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

@indutny Perhaps there should be a better test case that you were trying to solve for the original issue, the ENOTIMPLEMENTED error is kinda a special case, streams3's flowing mode is a bit more resilient than that -- in fact I would almost argue that ENOTIMPLEMENT should throw in this case because there's nothing we can do with this stream

@indutny
Copy link
Member Author

Choose a reason for hiding this comment

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

@tjfontaine this is just the simplest test case that I was able to create. Anyway, let's revert.

@indutny
Copy link
Member Author

Choose a reason for hiding this comment

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

@tjfontaine have we reverted it?

@mscdex
Copy link

@mscdex mscdex commented on 2efe4ab Jun 28, 2014

Choose a reason for hiding this comment

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

+100 for reverting. I think this commit may also now be causing event-related issues in my imap module too.

@indutny
Copy link
Member Author

Choose a reason for hiding this comment

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

Reverted in 4128d4d

Please sign in to comment.