FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: add note about fs.close undefined behavior by ronag · Pull Request #30966 · nodejs/node · GitHub

/ node Public

doc: add note about fs.close undefined behavior - #30966

Closed
ronag wants to merge 6 commits into
nodejs:masterfrom
nxtedition:fs-close-note
ConversationCommits (6)ChecksFiles changed
Closed

doc: add note about fs.close undefined behavior#30966
ronag wants to merge 6 commits into
nodejs:masterfrom
nxtedition:fs-close-note

Conversation

ronag commented Dec 14, 2019

Copy link
Copy Markdown
Member

Basically what the close(2) man page says – if it’s possible that the fd is being used for a syscall in one thread of the threadpool, we should not be calling close() concurrently.

Refs: #30864

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Dec 14, 2019

ronag commented Dec 14, 2019

Copy link
Copy Markdown
Member Author

@addaleax

addaleax approved these changes Dec 14, 2019
View reviewed changes
Comment thread doc/api/fs.md Outdated

ronag commented Dec 14, 2019

Copy link
Copy Markdown
Member Author

We might want to consider adding a ref count on fs ops and provide an unsafe version that does not do so (i.e. use at own risk but with better perf).

ronag commented Dec 14, 2019

Copy link
Copy Markdown
Member Author

Is that disagreement or confusion on the previous comment?

addaleax commented Dec 14, 2019

Copy link
Copy Markdown
Member

@ronag It’s both … I feel like the suggestion misses a compelling reason to be implemented?

ronag commented Dec 14, 2019

Copy link
Copy Markdown
Member Author

I feel like the suggestion misses a compelling reason to be implemented?

Consider the amount of users that are not aware of this quirk and are ending up unknowingly with code with undefined behaviour.

I'm also sceptical whether that's compelling enough. Probably isn't as bad in practice as I make it sound. Just thought it might be worth to consider.

Trott reviewed Dec 15, 2019
View reviewed changes
Comment thread doc/api/fs.md Outdated
Trott reviewed Dec 15, 2019
View reviewed changes
Comment thread doc/api/fs.md Outdated
Trott approved these changes Dec 15, 2019
View reviewed changes

Trott left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM with two small suggestions applied.

ronag and others added 2 commits December 15, 2019 01:22
Update doc/api/fs.md
bc751b3 
Co-Authored-By: Rich Trott <rtrott@gmail.com>
Update doc/api/fs.md
6fa8257 
Co-Authored-By: Rich Trott <rtrott@gmail.com>

ronag commented Dec 15, 2019 •
edited
Loading

Copy link
Copy Markdown
Member Author

Added note to closeSync as well.

BridgeAR added the author ready PRs that have at least one approval, no outstanding review comments, and a CI started. label Dec 15, 2019

BridgeAR commented Dec 15, 2019

Copy link
Copy Markdown
Member

Lite-CI https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/4108/

ronag commented Dec 15, 2019
View reviewed changes
Comment thread doc/api/fs.md Outdated
ronag commented Dec 15, 2019
View reviewed changes
Comment thread doc/api/fs.md Outdated
Trott pushed a commit that referenced this pull request Dec 17, 2019
doc: add note about fs.close() about undefined behavior
b376965 
Add notes to fs.close and fs.closeSync() about udnefined behavior.

PR-URL: #30966
Refs: #30864
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

Trott commented Dec 17, 2019

Copy link
Copy Markdown
Member

Landed in b376965

Trott closed this Dec 17, 2019
MylesBorins pushed a commit that referenced this pull request Dec 17, 2019
doc: add note about fs.close() about undefined behavior
3abcb69 
Add notes to fs.close and fs.closeSync() about udnefined behavior.

PR-URL: #30966
Refs: #30864
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins mentioned this pull request Dec 17, 2019
Merged
targos pushed a commit that referenced this pull request Jan 14, 2020
doc: add note about fs.close() about undefined behavior
42ccf22 
Add notes to fs.close and fs.closeSync() about udnefined behavior.

PR-URL: #30966
Refs: #30864
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos mentioned this pull request Jan 15, 2020
Closed
BethGriggs pushed a commit that referenced this pull request Feb 6, 2020
doc: add note about fs.close() about undefined behavior
95eb1c2 
Add notes to fs.close and fs.closeSync() about udnefined behavior.

PR-URL: #30966
Refs: #30864
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins mentioned this pull request Feb 8, 2020
Merged
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

jasnell jasnell approved these changes
Trott Trott approved these changes
addaleax addaleax approved these changes
lpinca lpinca approved these changes
BridgeAR BridgeAR approved these changes

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no outstanding review comments, and a CI started. doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

Back | FazBrowse Home | New Git URL