Skip to content

fs: add read(buffer[, options]) versions #42768

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
aduh95 merged 16 commits into from
May 2, 2022
Merged

fs: add read(buffer[, options]) versions #42768

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
c69abaa
fs: add read(buffer, options) signatures
LiviaMedeiros Apr 15, 2022
aec64ca
squash: make offsetOrOptions more consistent
LiviaMedeiros Apr 17, 2022
42c9c40
squash: add doc entries
LiviaMedeiros Apr 17, 2022
71f03ce
squash: fix fs.read()
LiviaMedeiros Apr 17, 2022
0bd9de7
squash: expand fs-read-optional test
LiviaMedeiros Apr 17, 2022
abd6e4f
squash: expand fs-read-promises-optional test
LiviaMedeiros Apr 17, 2022
9826309
squash: improve tests
LiviaMedeiros Apr 18, 2022
a32c914
squash: fixup
LiviaMedeiros Apr 18, 2022
6a974c2
squash: fixup
LiviaMedeiros Apr 18, 2022
0f586d2
squash: inline null coalescing
LiviaMedeiros Apr 18, 2022
6410dec
squash: revert changes in fs.readSync()
LiviaMedeiros Apr 19, 2022
ccaa4cb
squash: disallow offset === false
LiviaMedeiros Apr 19, 2022
0e6b06a
squash: fixup
LiviaMedeiros Apr 21, 2022
42b640c
squash: allow offset === null
LiviaMedeiros Apr 21, 2022
e153143
squash: fix tests being other way round
LiviaMedeiros Apr 21, 2022
ab0b534
squash: adjust tests
LiviaMedeiros Apr 22, 2022
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
Prev Previous commit
Next Next commit
squash: allow offset === null
  • Loading branch information
@LiviaMedeiros
LiviaMedeiros committed Apr 21, 2022
commit 42b640c6ff185c7fb565eb613c31460c4e9661aa
2 changes: 1 addition & 1 deletion lib/fs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -641,7 +641,7 @@ function read(fd, buffer, offsetOrOptions, length, position, callback) {
validateBuffer(buffer);
callback = maybeCallback(callback);

if (offset === undefined) {
if (offset == null) {
offset = 0;
} else {
validateInteger(offset, 'offset', 0);
Expand Down
4 changes: 2 additions & 2 deletions lib/internal/fs/promises.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -522,7 +522,7 @@ async function read(handle, bufferOrParams, offset, length, position) {
validateBuffer(buffer);
}

if (typeof offset === 'object') {
if (offset !== null && typeof offset === 'object') {
// This is fh.read(buffer, options)
({
offset = 0,
Expand All @@ -531,7 +531,7 @@ async function read(handle, bufferOrParams, offset, length, position) {
} = offset ?? ObjectCreate(null));
}

if (offset === undefined) {
if (offset == null) {
offset = 0;
} else {
validateInteger(offset, 'offset', 0);
Expand Down
35 changes: 19 additions & 16 deletions test/parallel/test-fs-read-offset-null.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,37 +14,40 @@ const filepath = fixtures.path('x.txt');
const buf = Buffer.alloc(1);
// Reading only one character, hence buffer of one byte is enough.

// Test is done by making sure the first letter in buffer is
// same as first letter in file.
// 120 is the ascii code of letter x.

// Test for callback API.
fs.open(filepath, 'r', common.mustSucceed((fd) => {
assert.throws(
() => fs.read(fd, { offset: null, buffer: buf }, () => {}),
{ code: 'ERR_INVALID_ARG_TYPE' }
);
assert.throws(
() => fs.read(fd, buf, { offset: null }, () => {}),
{ code: 'ERR_INVALID_ARG_TYPE' }
);
fs.close(fd, common.mustSucceed(() => {}));
fs.read(fd, { offset: null, buffer: buf },
common.mustSucceed((bytesRead, buffer) => {
assert.strictEqual(buffer[0], 120);
fs.close(fd, common.mustSucceed(() => {}));
}));
}));

fs.open(filepath, 'r', common.mustSucceed((fd) => {
fs.read(fd, buf, { offset: null },
common.mustSucceed((bytesRead, buffer) => {
assert.strictEqual(buffer[0], 120);
fs.close(fd, common.mustSucceed(() => {}));
}));
}));

let filehandle = null;

// Test for promise api
(async () => {
filehandle = await fsPromises.open(filepath, 'r');
assert.rejects(
async () => filehandle.read(buf, { offset: null }),
{ code: 'ERR_INVALID_ARG_TYPE' }
);
const readObject = await filehandle.read(buf, { offset: null }, buf.length);
assert.strictEqual(readObject.buffer[0], 120);
})()
.then(common.mustCall())
.finally(() => filehandle?.close());

(async () => {
filehandle = await fsPromises.open(filepath, 'r');

// In this test, null is interpreted as default options, not null offset.
// 120 is the ascii code of letter x.
const readObject = await filehandle.read(buf, null);
assert.strictEqual(readObject.buffer[0], 120);
})()
Expand Down