fs: do not throw exception after creating FSReqCallback #35487
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
Once an `FSReqCallback` instance is created, it is a GC root until the underlying fs operation has completed, meaning that it cannot be garbage collected. This is a problem when the underlying operation never starts because an exception is thrown before that happens, for example as part of parameter validation. Instead, move all potentially throwing code before the `FSReqCallback` creation.
nodejs-github-bot added the fs 
addaleax added request-ci 
github-actions bot removed the request-ci 
Collaborator
jasnell approved these changes Oct 3, 2020
addaleax added a commit to addaleax/node that referenced this pull request Oct 3, 2020
When a process exits cleanly, i.e. because the event loop ends up without things to wait for, the Node.js objects that are left on the heap should be: 1. weak, i.e. ready for garbage collection once no longer referenced, or 2. detached, i.e. scheduled for destruction once no longer referenced, or 3. an unrefed libuv handle, i.e. does not keep the event loop alive, or 4. an inactive libuv handle (essentially the same here) There are a few exceptions to this rule, but generally, if there are C++-backed Node.js objects on the heap that do not fall into the above categories, we may be looking at a potential memory leak. Most likely, the cause is a missing `MakeWeak()` call on the corresponding object. In order to avoid this kind of problem, we check the list of BaseObjects for these criteria. In this commit, we only do so when explicitly instructed to or when in debug mode (where --verify-base-objects is always-on). In particular, this avoids the kinds of memory leak issues that were fixed in the PRs referenced below. Refs: nodejs#35488 Refs: nodejs#35487 Refs: nodejs#35481
2 tasks
Collaborator
joyeecheung approved these changes Oct 4, 2020
Member
joyeecheung left a comment
joyeecheung left a comment There was a problem hiding this comment.
Can we document this somehow? Otherwise next time someone may add a new method that does this again and we would have to catch it through code reviews
Member Author
| @joyeecheung I don’t really know where to document this, but #35490 would make CI fail if this happens again, so I think we’re okay there |
Collaborator
Member
| @addaleax Maybe at the top of the file? (I think when someone tries to add a new method they would probably look there). I imagine when the CI fails they would just see the callback being printed before exit which could be difficult for new comers to understand.. |
Member Author
| @joyeecheung I’ve added a comment. |
github-actions bot removed the request-ci Collaborator
addaleax added the commit-queue github-actions bot removed the commit-queue 
Contributor
Commit Queue failed- Loading data for nodejs/node/pull/35487 ✔ Done loading data for nodejs/node/pull/35487 ----------------------------------- PR info ------------------------------------ Title fs: do not throw exception after creating FSReqCallback (#35487) ⚠ Could not retrieve the email or name of the PR author's from user's GitHub profile! Branch addaleax:fsreqcallback -> nodejs:master Labels fs, lts-watch-v12.x Commits 2 - fs: do not throw exception after creating FSReqCallback - fixup! fs: do not throw exception after creating FSReqCallback Committers 1 - Anna Henningsen PR-URL: https://github.com/nodejs/node/pull/35487 Reviewed-By: James M Snell Reviewed-By: Joyee Cheung ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/35487 Reviewed-By: James M Snell Reviewed-By: Joyee Cheung -------------------------------------------------------------------------------- ⚠ Commits were pushed since the last review: ⚠ - fixup! fs: do not throw exception after creating FSReqCallback ✔ Last GitHub Actions successful ℹ Last Full PR CI on 2020-10-05T20:23:13Z: https://ci.nodejs.org/job/node-test-pull-request/33410/ - Querying data for job/node-test-pull-request/33410/ ✔ Build data downloaded ✔ Last Jenkins CI successful ℹ This PR was created on Sat, 03 Oct 2020 22:43:13 GMT ✔ Approvals: 2 ✔ - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/35487#pullrequestreview-501578948 ✔ - Joyee Cheung (@joyeecheung) (TSC): https://github.com/nodejs/node/pull/35487#pullrequestreview-501630754 -------------------------------------------------------------------------------- ✔ Aborted `git node land` session in /home/runner/work/node/node/.ncu |
github-actions bot added the commit-queue-failed addaleax added a commit that referenced this pull request Oct 6, 2020
Once an `FSReqCallback` instance is created, it is a GC root until the underlying fs operation has completed, meaning that it cannot be garbage collected. This is a problem when the underlying operation never starts because an exception is thrown before that happens, for example as part of parameter validation. Instead, move all potentially throwing code before the `FSReqCallback` creation. PR-URL: #35487 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Member Author
| Landed in e817c36 |
Merged
This was referenced Sep 29, 2022
This was referenced Oct 5, 2022
This was referenced Oct 8, 2022
This was referenced Oct 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
7 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.
Once an
FSReqCallbackinstance is created, it is a GC root untilthe underlying fs operation has completed, meaning that it cannot
be garbage collected.
This is a problem when the underlying operation never starts
because an exception is thrown before that happens, for example
as part of parameter validation.
Instead, move all potentially throwing code before the
FSReqCallbackcreation.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes