-
Notifications
You must be signed in to change notification settings - Fork 29.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fs: make params in writing methods optional
This change allows passing objects as "named parameters": - `fs.write(fd, buffer[, options], callback)` - `fs.writeSync(fd, buffer[, options])` - `filehandle.write(buffer[, options])` Fixes: #41666 PR-URL: #42601 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Minwoo Jung <nodecorelab@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
- Loading branch information
1 parent
c4833ff
commit c3ae514
Showing
6 changed files
with
388 additions
and
13 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| 'use strict'; | ||
|
|
||
| const common = require('../common'); | ||
|
|
||
| // This test ensures that filehandle.write accepts "named parameters" object | ||
| // and doesn't interpret objects as strings | ||
|
|
||
| const assert = require('assert'); | ||
| const fsPromises = require('fs').promises; | ||
| const path = require('path'); | ||
| const tmpdir = require('../common/tmpdir'); | ||
|
|
||
| tmpdir.refresh(); | ||
|
|
||
| const dest = path.resolve(tmpdir.path, 'tmp.txt'); | ||
| const buffer = Buffer.from('zyx'); | ||
|
|
||
| async function testInvalid(dest, expectedCode, ...params) { | ||
| let fh; | ||
| try { | ||
| fh = await fsPromises.open(dest, 'w+'); | ||
| await assert.rejects( | ||
| fh.write(...params), | ||
| { code: expectedCode }); | ||
| } finally { | ||
| await fh?.close(); | ||
| } | ||
| } | ||
|
|
||
| async function testValid(dest, buffer, options) { | ||
| let fh; | ||
| try { | ||
| fh = await fsPromises.open(dest, 'w+'); | ||
| const writeResult = await fh.write(buffer, options); | ||
| const writeBufCopy = Uint8Array.prototype.slice.call(writeResult.buffer); | ||
|
|
||
| const readResult = await fh.read(buffer, options); | ||
| const readBufCopy = Uint8Array.prototype.slice.call(readResult.buffer); | ||
|
|
||
| assert.ok(writeResult.bytesWritten >= readResult.bytesRead); | ||
| if (options.length !== undefined && options.length !== null) { | ||
| assert.strictEqual(writeResult.bytesWritten, options.length); | ||
| } | ||
| if (options.offset === undefined || options.offset === 0) { | ||
| assert.deepStrictEqual(writeBufCopy, readBufCopy); | ||
| } | ||
| assert.deepStrictEqual(writeResult.buffer, readResult.buffer); | ||
| } finally { | ||
| await fh?.close(); | ||
| } | ||
| } | ||
|
|
||
| (async () => { | ||
| // Test if first argument is not wrongly interpreted as ArrayBufferView|string | ||
| for (const badBuffer of [ | ||
| undefined, null, true, 42, 42n, Symbol('42'), NaN, [], () => {}, | ||
| Promise.resolve(new Uint8Array(1)), | ||
| {}, | ||
| { buffer: 'amNotParam' }, | ||
| { string: 'amNotParam' }, | ||
| { buffer: new Uint8Array(1).buffer }, | ||
| new Date(), | ||
| new String('notPrimitive'), | ||
| { toString() { return 'amObject'; } }, | ||
| { [Symbol.toPrimitive]: (hint) => 'amObject' }, | ||
| ]) { | ||
| await testInvalid(dest, 'ERR_INVALID_ARG_TYPE', badBuffer, {}); | ||
| } | ||
|
|
||
| // First argument (buffer or string) is mandatory | ||
| await testInvalid(dest, 'ERR_INVALID_ARG_TYPE'); | ||
|
|
||
| // Various invalid options | ||
| await testInvalid(dest, 'ERR_OUT_OF_RANGE', buffer, { length: 5 }); | ||
| await testInvalid(dest, 'ERR_OUT_OF_RANGE', buffer, { offset: 5 }); | ||
| await testInvalid(dest, 'ERR_OUT_OF_RANGE', buffer, { length: 1, offset: 3 }); | ||
| await testInvalid(dest, 'ERR_OUT_OF_RANGE', buffer, { length: -1 }); | ||
| await testInvalid(dest, 'ERR_OUT_OF_RANGE', buffer, { offset: -1 }); | ||
| await testInvalid(dest, 'ERR_INVALID_ARG_TYPE', buffer, { offset: false }); | ||
| await testInvalid(dest, 'ERR_INVALID_ARG_TYPE', buffer, { offset: true }); | ||
|
|
||
| // Test compatibility with filehandle.read counterpart | ||
| for (const options of [ | ||
| {}, | ||
| { length: 1 }, | ||
| { position: 5 }, | ||
| { length: 1, position: 5 }, | ||
| { length: 1, position: -1, offset: 2 }, | ||
| { length: null }, | ||
| { position: null }, | ||
| { offset: 1 }, | ||
| ]) { | ||
| await testValid(dest, buffer, options); | ||
| } | ||
| })().then(common.mustCall()); |
Oops, something went wrong.