Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fs: filehandle.read(buffer) can't read file when options are omitted #51087

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.

Sign up for GitHub

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

Merged
nodejs-github-bot merged 3 commits into from
Dec 22, 2023
Merged

fs: filehandle.read(buffer) can't read file when options are omitted #51087

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f2f8e63
fs: make offset, position & length args in fh.read() optional
pulkit-30 Dec 7, 2023
35ee64e
fix test
pulkit-30 Dec 7, 2023
1de21b8
fix suggestions
pulkit-30 Dec 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,11 +393,14 @@ changes:
* `buffer` {Buffer|TypedArray|DataView} A buffer that will be filled with the
file data read.
* `offset` {integer} The location in the buffer at which to start filling.
* `length` {integer} The number of bytes to read.
**Default:** `0`
* `length` {integer} The number of bytes to read. **Default:**
`buffer.byteLength - offset`
* `position` {integer|bigint|null} The location where to begin reading data
from the file. If `null` or `-1`, data will be read from the current file
position, and the position will be updated. If `position` is a non-negative
integer, the current file position will remain unchanged.
**Default:**: `null`
* Returns: {Promise} Fulfills upon success with an object with two properties:
* `bytesRead` {integer} The number of bytes read
* `buffer` {Buffer|TypedArray|DataView} A reference to the passed in `buffer`
Expand Down
2 changes: 1 addition & 1 deletion lib/internal/fs/promises.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -670,7 +670,7 @@ async function read(handle, bufferOrParams, offset, length, position) {
validateInteger(offset, 'offset', 0);
}

length |= 0;
length ??= buffer.byteLength - offset;

if (length === 0)
return { __proto__: null, bytesRead: length, buffer };
Expand Down
19 changes: 18 additions & 1 deletion test/parallel/test-fs-promises-file-handle-read.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const assert = require('assert');
const tmpDir = tmpdir.path;

async function read(fileHandle, buffer, offset, length, position, options) {
return options.useConf ?
return options?.useConf ?
fileHandle.read({ buffer, offset, length, position }) :
fileHandle.read(buffer, offset, length, position);
}
Expand Down Expand Up @@ -96,6 +96,21 @@ async function validateReadLength(len) {
assert.strictEqual(bytesRead, len);
}

async function validateReadWithNoOptions(byte) {
const buf = Buffer.alloc(byte);
const filePath = fixtures.path('x.txt');
const fileHandle = await open(filePath, 'r');
let response = await fileHandle.read(buf);
assert.strictEqual(response.bytesRead, byte);
response = await read(fileHandle, buf, 0, undefined, 0);
assert.strictEqual(response.bytesRead, byte);
response = await read(fileHandle, buf, 0, null, 0);
assert.strictEqual(response.bytesRead, byte);
response = await read(fileHandle, buf, 0, undefined, 0, { useConf: true });
assert.strictEqual(response.bytesRead, byte);
response = await read(fileHandle, buf, 0, null, 0, { useConf: true });
assert.strictEqual(response.bytesRead, byte);
}

(async function() {
tmpdir.refresh();
Expand All @@ -109,4 +124,6 @@ async function validateReadLength(len) {
await validateReadWithPositionZero();
await validateReadLength(0);
await validateReadLength(1);
await validateReadWithNoOptions(0);
await validateReadWithNoOptions(1);
})().then(common.mustCall());