-
-
Notifications
You must be signed in to change notification settings - Fork 6.4k
Clarify race condition in blocking vs non-blocking docs (fixes #8253) #8254
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Himanshu25Sahu
wants to merge
2
commits into
nodejs:main
Choose a base branch
from
Himanshu25Sahu:fix-blocking-nonblocking-example
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -115,45 +115,63 @@ threads may be created to handle concurrent work. | |
|
|
||
| ## Dangers of Mixing Blocking and Non-Blocking Code | ||
|
|
||
| There are some patterns that should be avoided when dealing with I/O. Let's look | ||
| at an example: | ||
| There are some patterns that should be avoided when dealing with I/O. Let's look at an example: | ||
|
|
||
| ```js | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This example change isn't what we want. We want: operationWithCallback(() => { ... })
operationWithoutCallback() |
||
| const fs = require('node:fs'); | ||
|
|
||
| fs.readFile('/file.md', (err, data) => { | ||
| if (err) { | ||
| throw err; | ||
| const path = require('node:path'); | ||
|
|
||
| // Create and use a temporary file | ||
| const tempFile = path.join(__dirname, 'temp.md'); | ||
| try { | ||
| fs.writeFileSync(tempFile, 'Temporary content'); | ||
|
|
||
| // Perform blocking delete first | ||
| fs.unlinkSync(tempFile); | ||
|
|
||
| // Attempt asynchronous read afterward | ||
| fs.readFile(tempFile, (err, data) => { | ||
| if (err) { | ||
| console.log('Error: Read failed with', err.code, 'as expected due to prior deletion.'); | ||
| } else { | ||
| console.log('Unexpected success:', data.toString()); | ||
| } | ||
| }); | ||
| // Note: The callback may not log immediately; the process exits before I/O completes. | ||
| } finally { | ||
| // Cleanup (though file is already deleted) | ||
| if (fs.existsSync(tempFile)) { | ||
| fs.unlinkSync(tempFile); | ||
| } | ||
|
|
||
| console.log(data); | ||
| }); | ||
| fs.unlinkSync('/file.md'); | ||
| } | ||
| ``` | ||
|
|
||
| In the above example, `fs.unlinkSync()` is likely to be run before | ||
| `fs.readFile()`, which would delete `file.md` before it is actually read. A | ||
| better way to write this, which is completely **non-blocking** and guaranteed to | ||
| execute in the correct order is: | ||
| In the above example, fs.unlinkSync() is run before the asynchronous fs.readFile() operation, which deletes temp.md before the read can occur. This results in a failure (e.g., ENOENT error), demonstrating the danger of mixing blocking and non-blocking calls without proper sequencing. The try-finally block ensures the file is managed, though the read failure is the key lesson here. To avoid such issues, ensure operations are ordered correctly... | ||
|
|
||
|
|
||
| >**Note**: Due to the asynchronous nature of `fs.readFile`, the `console.log` may not execute immediately. You might need to add a `setTimeout` or keep the process alive (e.g., with `process.stdin.resume()`) to see the output. | ||
|
|
||
| ```js | ||
| const fs = require('node:fs'); | ||
| const path = require('node:path'); | ||
|
|
||
| const tempFile = path.join(__dirname, 'temp.md'); | ||
| fs.writeFileSync(tempFile, 'Temporary content'); | ||
|
|
||
| fs.readFile('/file.md', (readFileErr, data) => { | ||
| fs.readFile(tempFile, (readFileErr, data) => { | ||
| if (readFileErr) { | ||
| throw readFileErr; | ||
| } | ||
|
|
||
| console.log(data); | ||
|
|
||
| fs.unlink('/file.md', unlinkErr => { | ||
| fs.unlink(tempFile, unlinkErr => { | ||
| if (unlinkErr) { | ||
| throw unlinkErr; | ||
| } | ||
| }); | ||
| }); | ||
| ``` | ||
|
|
||
| The above places a **non-blocking** call to `fs.unlink()` within the callback of | ||
| `fs.readFile()` which guarantees the correct order of operations. | ||
|
|
||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unrelated change