Skip to content

fs: adjust position validation in reading methods #42835

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 8 commits into from
Sep 29, 2023
Merged

fs: adjust position validation in reading methods #42835

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0b4ee39
fs: adjust `position` validation in reading methods
LiviaMedeiros Apr 23, 2022
0c2bea2
squash: fix validation when `position + length` exceeds int64 limit
LiviaMedeiros Apr 23, 2022
c911c77
squash: add tests
LiviaMedeiros Apr 23, 2022
022d17c
squash: resolve todo
LiviaMedeiros May 16, 2022
39007fb
squash: add test for Promises API
LiviaMedeiros May 16, 2022
204fb4f
squash: add `changes` to docs
LiviaMedeiros Oct 11, 2022
00f9189
squash: make linter happy
LiviaMedeiros Oct 11, 2022
dc7a21e
squash: fix typo
LiviaMedeiros Oct 11, 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: add test for Promises API
  • Loading branch information
@LiviaMedeiros
LiviaMedeiros committed Sep 15, 2023
commit 39007fbdef97e821773db6f7f4b9808213e210cf
84 changes: 84 additions & 0 deletions test/parallel/test-fs-read-promises-position-validation.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
import '../common/index.mjs';
import * as fixtures from '../common/fixtures.mjs';
import fs from 'fs';
import assert from 'assert';

// This test ensures that "position" argument is correctly validated

const filepath = fixtures.path('x.txt');

const buffer = Buffer.from('xyz\n');
const offset = 0;
const length = buffer.byteLength;

// allowedErrors is an array of acceptable internal errors
// For example, on some platforms read syscall might return -EFBIG
async function testValid(position, allowedErrors = []) {
let fh;
try {
fh = await fs.promises.open(filepath, 'r');
await fh.read(buffer, offset, length, position);
await fh.read({ buffer, offset, length, position });
await fh.read(buffer, { offset, length, position });
} catch (err) {
if (!allowedErrors.includes(err.code)) {
assert.fail(err);
}
} finally {
await fh?.close();
}
}

async function testInvalid(code, position) {
let fh;
try {
fh = await fs.promises.open(filepath, 'r');
await assert.rejects(
fh.read(buffer, offset, length, position),
{ code }
);
await assert.rejects(
fh.read({ buffer, offset, length, position }),
{ code }
);
await assert.rejects(
fh.read(buffer, { offset, length, position }),
{ code }
);
} finally {
await fh?.close();
}
}

{
await testValid(undefined);
await testValid(null);
await testValid(-1);
await testValid(-1n);

await testValid(0);
await testValid(0n);
await testValid(1);
await testValid(1n);
await testValid(9);
await testValid(9n);
await testValid(Number.MAX_SAFE_INTEGER, [ 'EFBIG' ]);

await testValid(2n ** 63n - 1n - BigInt(length), [ 'EFBIG' ]);
await testInvalid('ERR_OUT_OF_RANGE', 2n ** 63n);
await testInvalid('ERR_OUT_OF_RANGE', 2n ** 63n - BigInt(length));

await testInvalid('ERR_OUT_OF_RANGE', NaN);
await testInvalid('ERR_OUT_OF_RANGE', -Infinity);
await testInvalid('ERR_OUT_OF_RANGE', Infinity);
await testInvalid('ERR_OUT_OF_RANGE', -0.999);
await testInvalid('ERR_OUT_OF_RANGE', -(2n ** 64n));
await testInvalid('ERR_OUT_OF_RANGE', Number.MAX_SAFE_INTEGER + 1);
await testInvalid('ERR_OUT_OF_RANGE', Number.MAX_VALUE);

for (const badTypeValue of [
false, true, '1', Symbol(1), {}, [], () => {}, Promise.resolve(1),
]) {
testInvalid('ERR_INVALID_ARG_TYPE', badTypeValue);
}
}
2 changes: 1 addition & 1 deletion test/parallel/test-fs-readSync-position-validation.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ function testValid(position, allowedErrors = []) {
}
}

function testInvalid(code, position, internalCatch = false) {
function testInvalid(code, position) {
let fdSync;
try {
fdSync = fs.openSync(filepath, 'r');
Expand Down