mirror of
https://github.com/nodejs/node.git
synced 2025-04-29 06:19:07 +00:00

Some checks are pending
Coverage Linux (without intl) / coverage-linux-without-intl (push) Waiting to run
Coverage Linux / coverage-linux (push) Waiting to run
Coverage Windows / coverage-windows (push) Waiting to run
Test and upload documentation to artifacts / build-docs (push) Waiting to run
Linters / lint-addon-docs (push) Waiting to run
Linters / lint-cpp (push) Waiting to run
Linters / format-cpp (push) Waiting to run
Linters / lint-js-and-md (push) Waiting to run
Linters / lint-py (push) Waiting to run
Linters / lint-yaml (push) Waiting to run
Linters / lint-sh (push) Waiting to run
Linters / lint-codeowners (push) Waiting to run
Linters / lint-pr-url (push) Waiting to run
Linters / lint-readme (push) Waiting to run
Notify on Push / Notify on Force Push on `main` (push) Waiting to run
Notify on Push / Notify on Push on `main` that lacks metadata (push) Waiting to run
Scorecard supply-chain security / Scorecard analysis (push) Waiting to run
The original implementation of the experimental `FileHandle.readableWebStream` API created non-`type: 'bytes'` streams, which prevented callers from creating `mode: 'byob'` readers from the returned stream, which means they could not achieve the associated "zero-copy" performance characteristics. Then, #46933 added a parameter allowing callers to pass the `type` parameter down to the ReadableStream constructor, exposing the same semantics to callers of `FileHandle.readableWebStream`. But there is no point to giving callers this choice: FileHandle-derived streams are by their very nature byte streams. We should not require callers to explicitly opt in to having byte stream semantics. Moreover, I do not see a situation in which callers would ever want to have a non-bytes stream: bytes-streams only do anything differently than normal ones if `mode: 'byob'` is passed to `getReader`. So, remove the `options` parameter and always create a ReadableStream with `type: 'bytes'`. Fixes #54041. PR-URL: https://github.com/nodejs/node/pull/55461 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
130 lines
3.3 KiB
JavaScript
130 lines
3.3 KiB
JavaScript
'use strict';
|
|
|
|
const common = require('../common');
|
|
const assert = require('assert');
|
|
|
|
const {
|
|
readFileSync,
|
|
} = require('fs');
|
|
|
|
const {
|
|
open,
|
|
} = require('fs/promises');
|
|
|
|
const check = readFileSync(__filename, { encoding: 'utf8' });
|
|
|
|
// Make sure the ReadableStream works...
|
|
(async () => {
|
|
const dec = new TextDecoder();
|
|
const file = await open(__filename);
|
|
let data = '';
|
|
for await (const chunk of file.readableWebStream())
|
|
data += dec.decode(chunk);
|
|
|
|
assert.strictEqual(check, data);
|
|
|
|
assert.throws(() => file.readableWebStream(), {
|
|
code: 'ERR_INVALID_STATE',
|
|
});
|
|
|
|
await file.close();
|
|
})().then(common.mustCall());
|
|
|
|
// Make sure that acquiring a ReadableStream fails if the
|
|
// FileHandle is already closed.
|
|
(async () => {
|
|
const file = await open(__filename);
|
|
await file.close();
|
|
|
|
assert.throws(() => file.readableWebStream(), {
|
|
code: 'ERR_INVALID_STATE',
|
|
});
|
|
})().then(common.mustCall());
|
|
|
|
// Make sure that acquiring a ReadableStream fails if the
|
|
// FileHandle is already closing.
|
|
(async () => {
|
|
const file = await open(__filename);
|
|
file.close();
|
|
|
|
assert.throws(() => file.readableWebStream(), {
|
|
code: 'ERR_INVALID_STATE',
|
|
});
|
|
})().then(common.mustCall());
|
|
|
|
// Make sure the ReadableStream is closed when the underlying
|
|
// FileHandle is closed.
|
|
(async () => {
|
|
const file = await open(__filename);
|
|
const readable = file.readableWebStream();
|
|
const reader = readable.getReader();
|
|
file.close();
|
|
await reader.closed;
|
|
})().then(common.mustCall());
|
|
|
|
// Make sure the ReadableStream is closed when the underlying
|
|
// FileHandle is closed.
|
|
(async () => {
|
|
const file = await open(__filename);
|
|
const readable = file.readableWebStream();
|
|
file.close();
|
|
const reader = readable.getReader();
|
|
await reader.closed;
|
|
})().then(common.mustCall());
|
|
|
|
// Make sure that the FileHandle is properly marked "in use"
|
|
// when a ReadableStream has been acquired for it.
|
|
(async () => {
|
|
const file = await open(__filename);
|
|
file.readableWebStream();
|
|
const mc = new MessageChannel();
|
|
mc.port1.onmessage = common.mustNotCall();
|
|
assert.throws(() => mc.port2.postMessage(file, [file]), {
|
|
code: 25,
|
|
name: 'DataCloneError',
|
|
});
|
|
mc.port1.close();
|
|
await file.close();
|
|
})().then(common.mustCall());
|
|
|
|
// Make sure 'byob' reader works
|
|
(async () => {
|
|
const file = await open(__filename);
|
|
const dec = new TextDecoder();
|
|
const readable = file.readableWebStream();
|
|
const reader = readable.getReader({ mode: 'byob' });
|
|
|
|
let data = '';
|
|
let result;
|
|
do {
|
|
const buff = new ArrayBuffer(100);
|
|
result = await reader.read(new DataView(buff));
|
|
if (result.value !== undefined) {
|
|
data += dec.decode(result.value);
|
|
assert.ok(result.value.byteLength <= 100);
|
|
}
|
|
} while (!result.done);
|
|
|
|
assert.strictEqual(check, data);
|
|
|
|
assert.throws(() => file.readableWebStream(), {
|
|
code: 'ERR_INVALID_STATE',
|
|
});
|
|
|
|
await file.close();
|
|
})().then(common.mustCall());
|
|
|
|
// Make sure a warning is logged if a non-'bytes' type is passed.
|
|
(async () => {
|
|
const file = await open(__filename);
|
|
common.expectWarning({
|
|
ExperimentalWarning: [
|
|
'A non-"bytes" options.type has no effect. A byte-oriented steam is ' +
|
|
'always created.',
|
|
],
|
|
});
|
|
const stream = file.readableWebStream({ type: 'foobar' });
|
|
await stream.cancel();
|
|
await file.close();
|
|
})().then(common.mustCall());
|