fs: add support for async iterators to fs.writeFile
#38525
+281
−28
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
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 |
|---|---|---|
|
|
@@ -32,6 +32,7 @@ const { | |
| ArrayPrototypePush, | ||
| BigIntPrototypeToString, | ||
| MathMax, | ||
| MathMin, | ||
| Number, | ||
| ObjectCreate, | ||
| ObjectDefineProperties, | ||
|
|
@@ -44,6 +45,8 @@ const { | |
| StringPrototypeCharCodeAt, | ||
| StringPrototypeIndexOf, | ||
| StringPrototypeSlice, | ||
| SymbolAsyncIterator, | ||
| SymbolIterator, | ||
| } = primordials; | ||
|
|
||
| const { fs: constants } = internalBinding('constants'); | ||
|
|
@@ -85,10 +88,12 @@ const { | |
| const { FSReqCallback } = binding; | ||
| const { toPathIfFileURL } = require('internal/url'); | ||
| const internalUtil = require('internal/util'); | ||
| const { isCustomIterable } = require('internal/streams/utils'); | ||
| const { | ||
| constants: { | ||
| kIoMaxLength, | ||
| kMaxUserId, | ||
| kWriteFileMaxChunkSize, | ||
| }, | ||
| copyObject, | ||
| Dirent, | ||
|
|
@@ -828,12 +833,12 @@ function write(fd, buffer, offset, length, position, callback) { | |
| } else { | ||
| position = length; | ||
| } | ||
| length = length || 'utf8'; | ||
| } | ||
|
|
||
| const str = String(buffer); | ||
| validateEncoding(str, length); | ||
| callback = maybeCallback(callback || position); | ||
|
|
||
| const req = new FSReqCallback(); | ||
| req.oncomplete = wrapper; | ||
|
|
@@ -2039,28 +2044,24 @@ function lutimesSync(path, atime, mtime) { | |
| handleErrorFromBinding(ctx); | ||
| } | ||
|
|
||
| function writeAll( | ||
| fd, isUserFd, buffer, offset, length, signal, encoding, callback) { | ||
| if (signal?.aborted) { | ||
| handleWriteAllErrorCallback(fd, isUserFd, new AbortError(), callback); | ||
| return; | ||
| } | ||
|
|
||
| if (isCustomIterable(buffer)) { | ||
| writeAllCustomIterable( | ||
| fd, isUserFd, buffer, offset, length, signal, encoding, callback) | ||
| .catch((reason) => { | ||
| handleWriteAllErrorCallback(fd, isUserFd, reason, callback); | ||
| }); | ||
| return; | ||
| } | ||
| fs.write(fd, buffer, offset, length, null, (writeErr, written) => { | ||
| if (writeErr) { | ||
| handleWriteAllErrorCallback(fd, isUserFd, writeErr, callback); | ||
| } else if (written === length) { | ||
| if (isUserFd) { | ||
| callback(null); | ||
|
|
@@ -2070,11 +2071,82 @@ function writeAll(fd, isUserFd, buffer, offset, length, signal, callback) { | |
| } else { | ||
| offset += written; | ||
| length -= written; | ||
| writeAll( | ||
| fd, isUserFd, buffer, offset, length, signal, encoding, callback); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| async function writeAllCustomIterable( | ||
|
There was a problem hiding this comment. Do not use There was a problem hiding this comment. @mcollina Thanks for your suggestion 👍 . I'm curious about the advantages of having a promisified version of |
||
| fd, isUserFd, buffer, offset, length, signal, encoding, callback) { | ||
| if (signal?.aborted) { | ||
| handleWriteAllErrorCallback(fd, isUserFd, new AbortError(), callback); | ||
| return; | ||
| } | ||
|
|
||
| const result = await buffer.next(); | ||
| if (result.done) { | ||
| if (isUserFd) { | ||
| callback(null); | ||
| } else { | ||
| fs.close(fd, callback); | ||
| } | ||
| return; | ||
| } | ||
| if (signal?.aborted) { | ||
| handleWriteAllErrorCallback(fd, isUserFd, new AbortError(), callback); | ||
| return; | ||
| } | ||
| const resultValue = isArrayBufferView(result.value) ? | ||
Linkgoron marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| result.value : Buffer.from(String(result.value), encoding); | ||
| const remaining = resultValue.byteLength; | ||
| const writeSize = MathMin(kWriteFileMaxChunkSize, remaining); | ||
| fs.write(fd, resultValue, resultValue.byteLength - remaining, writeSize, | ||
| null, (writeErr, written) => { | ||
| handleWriteAllCustomIterableCallback( | ||
| fd, isUserFd, buffer, resultValue, | ||
| resultValue.byteLength - remaining, writeSize, | ||
| signal, encoding, writeErr, remaining, written, callback); | ||
| } | ||
| ); | ||
| } | ||
|
|
||
| function handleWriteAllCustomIterableCallback(fd, isUserFd, buffer, resultValue, | ||
| offset, length, signal, encoding, | ||
| writeErr, remaining, written, | ||
| callback) { | ||
| if (writeErr) { | ||
| handleWriteAllErrorCallback(fd, isUserFd, writeErr, callback); | ||
| return; | ||
| } | ||
|
|
||
| remaining -= written; | ||
| if (remaining > 0) { | ||
| const writeSize = MathMin(kWriteFileMaxChunkSize, remaining); | ||
| fs.write(fd, resultValue, | ||
| resultValue.byteLength - remaining, writeSize, | ||
| null, (writeErr, written) => { | ||
| handleWriteAllCustomIterableCallback( | ||
| fd, isUserFd, buffer, resultValue, offset, length, | ||
| signal, encoding, writeErr, remaining, written, callback); | ||
| }); | ||
| return; | ||
| } | ||
|
|
||
| writeAllCustomIterable( | ||
| fd, isUserFd, buffer, offset, length, signal, encoding, callback); | ||
| } | ||
|
|
||
| function handleWriteAllErrorCallback(fd, isUserFd, writeErr, callback) { | ||
| if (isUserFd) { | ||
| callback(writeErr); | ||
| } else { | ||
| fs.close(fd, (err) => { | ||
| callback(aggregateTwoErrors(err, writeErr)); | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Asynchronously writes data to the file. | ||
| * @param {string | Buffer | URL | number} path | ||
|
|
@@ -2093,15 +2165,20 @@ function writeFile(path, data, options, callback) { | |
| options = getOptions(options, { encoding: 'utf8', mode: 0o666, flag: 'w' }); | ||
| const flag = options.flag || 'w'; | ||
|
|
||
| if (!isArrayBufferView(data) && !isCustomIterable(data)) { | ||
| validateStringAfterArrayBufferView(data, 'data'); | ||
| data = Buffer.from(String(data), options.encoding || 'utf8'); | ||
| } | ||
|
|
||
| if (isCustomIterable(data)) { | ||
| data = data[SymbolIterator]?.() ?? data[SymbolAsyncIterator]?.(); | ||
| } | ||
|
|
||
| if (isFd(path)) { | ||
| const isUserFd = true; | ||
| const signal = options.signal; | ||
| writeAll(path, isUserFd, data, | ||
| 0, data.byteLength, signal, options.encoding, callback); | ||
| return; | ||
| } | ||
|
|
||
|
|
@@ -2114,7 +2191,8 @@ function writeFile(path, data, options, callback) { | |
| } else { | ||
| const isUserFd = false; | ||
| const signal = options.signal; | ||
| writeAll(fd, isUserFd, data, | ||
| 0, data.byteLength, signal, options.encoding, callback); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
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
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
Oops, something went wrong.
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.
I would schedule this via
process.nextTick. If this throws synchronously for whatever reason, it will lead to an unhandled rejection.