Skip to content

Commit

Permalink
fixup! fs: add docs and tests for AsyncIterable support in `fh.writ…
Browse files Browse the repository at this point in the history
…eFile`
  • Loading branch information
aduh95 committed Aug 27, 2021
1 parent b4224fa commit 24d0df7
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 52 deletions.
126 changes: 77 additions & 49 deletions test/parallel/test-fs-promises-file-handle-writeFile.js
Expand Up @@ -18,13 +18,15 @@ tmpdir.refresh();
async function validateWriteFile() {
const filePathForHandle = path.resolve(tmpDir, 'tmp-write-file2.txt');
const fileHandle = await open(filePathForHandle, 'w+');
const buffer = Buffer.from('Hello world'.repeat(100), 'utf8');

await fileHandle.writeFile(buffer);
const readFileData = fs.readFileSync(filePathForHandle);
assert.deepStrictEqual(buffer, readFileData);
try {
const buffer = Buffer.from('Hello world'.repeat(100), 'utf8');

await fileHandle.close();
await fileHandle.writeFile(buffer);
const readFileData = fs.readFileSync(filePathForHandle);
assert.deepStrictEqual(buffer, readFileData);
} finally {
await fileHandle.close();
}
}

// Signal aborted while writing file
Expand Down Expand Up @@ -82,80 +84,106 @@ const asyncIterable = {

async function doWriteStream() {
const fileHandle = await open(dest, 'w+');
await fileHandle.writeFile(stream);
const expected = 'abc';
const data = fs.readFileSync(dest, 'utf-8');
assert.deepStrictEqual(data, expected);
await fileHandle.close();
try {
await fileHandle.writeFile(stream);
const expected = 'abc';
const data = fs.readFileSync(dest, 'utf-8');
assert.deepStrictEqual(data, expected);
} finally {
await fileHandle.close();
}
}

async function doWriteStreamWithCancel() {
const controller = new AbortController();
const { signal } = controller;
process.nextTick(() => controller.abort());
const fileHandle = await open(otherDest, 'w+');
await assert.rejects(
fileHandle.writeFile(stream, { signal }),
{ name: 'AbortError' }
);
await fileHandle.close();
try {
await assert.rejects(
fileHandle.writeFile(stream, { signal }),
{ name: 'AbortError' }
);
} finally {
await fileHandle.close();
}
}

async function doWriteIterable() {
const fileHandle = await open(dest, 'w+');
await fileHandle.writeFile(iterable);
const data = fs.readFileSync(dest, 'utf-8');
assert.deepStrictEqual(data, iterable.expected);
await fileHandle.close();
try {
await fileHandle.writeFile(iterable);
const data = fs.readFileSync(dest, 'utf-8');
assert.deepStrictEqual(data, iterable.expected);
} finally {
await fileHandle.close();
}
}

async function doWriteInvalidIterable() {
const fileHandle = await open(dest, 'w+');
await Promise.all(
[42, 42n, {}, Symbol('42'), true, undefined, null, NaN].map((value) =>
assert.rejects(fileHandle.writeFile(iterableWith(value)), {
code: 'ERR_INVALID_ARG_TYPE',
})
)
);
await fileHandle.close();
try {
await Promise.all(
[42, 42n, {}, Symbol('42'), true, undefined, null, NaN].map((value) =>
assert.rejects(
fileHandle.writeFile(iterableWith(value)),
{ code: 'ERR_INVALID_ARG_TYPE' }
)
)
);
} finally {
await fileHandle.close();
}
}

async function doWriteIterableWithEncoding() {
const fileHandle = await open(dest, 'w+');
await fileHandle.writeFile(stream2, 'latin1');
const expected = 'ümlaut sechzig';
const data = fs.readFileSync(dest, 'latin1');
assert.deepStrictEqual(data, expected);
await fileHandle.close();
try {
await fileHandle.writeFile(stream2, 'latin1');
const expected = 'ümlaut sechzig';
const data = fs.readFileSync(dest, 'latin1');
assert.deepStrictEqual(data, expected);
} finally {
await fileHandle.close();
}
}

async function doWriteBufferIterable() {
const fileHandle = await open(dest, 'w+');
await fileHandle.writeFile(bufferIterable);
const data = fs.readFileSync(dest, 'utf-8');
assert.deepStrictEqual(data, bufferIterable.expected);
await fileHandle.close();
try {
await fileHandle.writeFile(bufferIterable);
const data = fs.readFileSync(dest, 'utf-8');
assert.deepStrictEqual(data, bufferIterable.expected);
} finally {
await fileHandle.close();
}
}

async function doWriteAsyncIterable() {
const fileHandle = await open(dest, 'w+');
await fileHandle.writeFile(asyncIterable);
const data = fs.readFileSync(dest, 'utf-8');
assert.deepStrictEqual(data, asyncIterable.expected);
await fileHandle.close();
try {
await fileHandle.writeFile(asyncIterable);
const data = fs.readFileSync(dest, 'utf-8');
assert.deepStrictEqual(data, asyncIterable.expected);
} finally {
await fileHandle.close();
}
}

async function doWriteInvalidValues() {
const fileHandle = await open(dest, 'w+');
await Promise.all(
[42, 42n, {}, Symbol('42'), true, undefined, null, NaN].map((value) =>
assert.rejects(fileHandle.writeFile(value), {
code: 'ERR_INVALID_ARG_TYPE',
})
)
);
await fileHandle.close();
try {
await Promise.all(
[42, 42n, {}, Symbol('42'), true, undefined, null, NaN].map((value) =>
assert.rejects(
fileHandle.writeFile(value),
{ code: 'ERR_INVALID_ARG_TYPE' }
)
)
);
} finally {
await fileHandle.close();
}
}

(async () => {
Expand Down
7 changes: 4 additions & 3 deletions test/parallel/test-fs-promises-writefile.js
Expand Up @@ -135,9 +135,10 @@ async function doWriteWithCancel() {
const controller = new AbortController();
const { signal } = controller;
process.nextTick(() => controller.abort());
assert.rejects(fsPromises.writeFile(otherDest, buffer, { signal }), {
name: 'AbortError'
});
await assert.rejects(
fsPromises.writeFile(otherDest, buffer, { signal }),
{ name: 'AbortError' }
);
}

async function doAppend() {
Expand Down

0 comments on commit 24d0df7

Please sign in to comment.