Clarify when readable._read(...) is called. #38726
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
github-actions bot added doc 
jasnell approved these changes May 24, 2021
Collaborator
bl-ue reviewed May 24, 2021
Comment on lines +2517 to +2518
| called again after it has stopped should it resume pushing additional data into | ||
| the queue. |
Contributor
There was a problem hiding this comment.
Was this change onto the queue → into the queue intentional? I noticed that into the read queue was used above, on line 2512, even before this change.
Contributor Author
There was a problem hiding this comment.
It was not intentional, but I think accomplishes the same goal. I tried to reword the existing paragraph, but it always seemed confusing and contradictory, so I ended up just rewriting it. I think into makes more sense though. I'd only use onto if I were saying I'm pushing onto *the end of* the queue.
bl-ue approved these changes May 25, 2021
ronag approved these changes Jun 2, 2021
Ayase-252 added the author ready 
Contributor
| Landed in 7f742ae |
Merged
Merged
foxxyz pushed a commit to foxxyz/node that referenced this pull request Oct 18, 2021
Fixes: nodejs#38586 PR-URL: nodejs#38726 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
8 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Fixes: #38586
This PR clarifies some confusion with the
readable._read(...)function dealing with when it is called. The current version of the documentation seems to suggest that_read()is responsible for looping itself to continually request data untilthis.push(...)returnsfalse, but this is not the case. After implementing a readable stream this way, I quickly found memory leaks in my code, because Node.JS was calling my_readfunction after everythis.push(...), but I was also looping inside_read, resulting in an exponentially increasing number of reads on the remote resource. Hopefully this will help to clarify this behavior.This is my first PR against NodeJS, so please let me know if there's anything I could do better.