refactor(stream): rename BufferedStream to BufferedReadableStream

refs #427

apps/demo/next.config.js

@@ -51,7 +51,7 @@ module.exports = withMDX({
             enforce: 'pre',
         });
 
-        config.experiments.topLevelAwait = true;
+        // config.experiments.topLevelAwait = true;
 
         return config;
     },

apps/demo/src/utils/file.ts

@@ -37,7 +37,7 @@ if (typeof window !== 'undefined') {
     const { publicRuntimeConfig } = getConfig();
     // Can't use `import` here because ESM is read-only (can't set `mitm` field)
     // Add `await` here because top-level await is on, so every import can be a `Promise`
-    StreamSaver = await require('streamsaver');
+    StreamSaver = require('streamsaver');
     StreamSaver.mitm = publicRuntimeConfig.basePath + '/StreamSaver/mitm.html';
 }
 

libraries/adb-backend-direct-sockets/tsconfig.json

@@ -9,6 +9,9 @@
     "references": [
         {
             "path": "../adb/tsconfig.build.json"
+        },
+        {
+            "path": "../stream-extra/tsconfig.build.json"
         }
     ]
 }

libraries/adb-backend-webusb/tsconfig.json

@@ -13,6 +13,9 @@
         {
             "path": "../adb/tsconfig.build.json"
         },
+        {
+            "path": "../stream-extra/tsconfig.build.json"
+        },
         {
             "path": "../struct/tsconfig.build.json"
         }

libraries/adb-backend-ws/tsconfig.json

@@ -9,6 +9,9 @@
     "references": [
         {
             "path": "../adb/tsconfig.build.json"
+        },
+        {
+            "path": "../stream-extra/tsconfig.build.json"
         }
     ]
 }

libraries/adb/src/commands/framebuffer.ts

@@ -1,4 +1,4 @@
-import { BufferedStream } from '@yume-chan/stream-extra';
+import { BufferedReadableStream } from '@yume-chan/stream-extra';
 import Struct from '@yume-chan/struct';
 
 import type { Adb } from '../adb.js';
@@ -61,7 +61,7 @@ export type AdbFrameBuffer = AdbFrameBufferV1 | AdbFrameBufferV2;
 
 export async function framebuffer(adb: Adb): Promise<AdbFrameBuffer> {
     const socket = await adb.createSocket('framebuffer:');
-    const stream = new BufferedStream(socket.readable);
+    const stream = new BufferedReadableStream(socket.readable);
     const { version } = await Version.deserialize(stream);
     switch (version) {
         case 1:

libraries/adb/src/commands/reverse.ts

@@ -1,7 +1,7 @@
 // cspell: ignore killforward
 
 import { AutoDisposable } from '@yume-chan/event';
-import { BufferedStream, BufferedStreamEndedError } from '@yume-chan/stream-extra';
+import { BufferedReadableStream, BufferedReadableStreamEndedError } from '@yume-chan/stream-extra';
 import Struct from '@yume-chan/struct';
 
 import type { Adb } from '../adb.js';
@@ -53,7 +53,7 @@ export class AdbReverseCommand extends AutoDisposable {
 
     private async createBufferedStream(service: string) {
         const socket = await this.adb.createSocket(service);
-        return new BufferedStream(socket.readable);
+        return new BufferedReadableStream(socket.readable);
     }
 
     private async sendRequest(service: string) {
@@ -97,7 +97,7 @@ export class AdbReverseCommand extends AutoDisposable {
             try {
                 length = Number.parseInt(decodeUtf8(await stream.read(4)), 16);
             } catch (e) {
-                if (!(e instanceof BufferedStreamEndedError)) {
+                if (!(e instanceof BufferedReadableStreamEndedError)) {
                     throw e;
                 }
 

libraries/adb/src/commands/sync/list.ts

@@ -1,4 +1,4 @@
-import type { BufferedStream, WritableStreamDefaultWriter } from '@yume-chan/stream-extra';
+import type { BufferedReadableStream, WritableStreamDefaultWriter } from '@yume-chan/stream-extra';
 import Struct from '@yume-chan/struct';
 
 import { AdbSyncRequestId, adbSyncWriteRequest } from './request.js';
@@ -38,7 +38,7 @@ const LIST_V2_RESPONSE_TYPES = {
 };
 
 export async function* adbSyncOpenDir(
-    stream: BufferedStream,
+    stream: BufferedReadableStream,
     writer: WritableStreamDefaultWriter<Uint8Array>,
     path: string,
     v2: boolean,

libraries/adb/src/commands/sync/pull.ts

@@ -1,4 +1,4 @@
-import { BufferedStream, ReadableStream, WritableStreamDefaultWriter } from '@yume-chan/stream-extra';
+import { BufferedReadableStream, ReadableStream, WritableStreamDefaultWriter } from '@yume-chan/stream-extra';
 import Struct from '@yume-chan/struct';
 
 import { AdbSyncRequestId, adbSyncWriteRequest } from './request.js';
@@ -16,7 +16,7 @@ const RESPONSE_TYPES = {
 };
 
 export function adbSyncPull(
-    stream: BufferedStream,
+    stream: BufferedReadableStream,
     writer: WritableStreamDefaultWriter<Uint8Array>,
     path: string,
 ): ReadableStream<Uint8Array> {

libraries/adb/src/commands/sync/push.ts

@@ -1,4 +1,4 @@
-import { BufferedStream, ChunkStream, pipeFrom, WritableStream, WritableStreamDefaultWriter } from '@yume-chan/stream-extra';
+import { BufferedReadableStream, ChunkStream, pipeFrom, WritableStream, WritableStreamDefaultWriter } from '@yume-chan/stream-extra';
 import Struct from '@yume-chan/struct';
 
 import { AdbSyncRequestId, adbSyncWriteRequest } from './request.js';
@@ -16,7 +16,7 @@ const ResponseTypes = {
 export const ADB_SYNC_MAX_PACKET_SIZE = 64 * 1024;
 
 export function adbSyncPush(
-    stream: BufferedStream,
+    stream: BufferedReadableStream,
     writer: WritableStreamDefaultWriter<Uint8Array>,
     filename: string,
     mode: number = (LinuxFileType.File << 12) | 0o666,

libraries/adb/src/commands/sync/response.ts

@@ -1,4 +1,4 @@
-import type { BufferedStream } from '@yume-chan/stream-extra';
+import type { BufferedReadableStream } from '@yume-chan/stream-extra';
 import Struct, { type StructAsyncDeserializeStream, type StructLike, type StructValueType } from '@yume-chan/struct';
 
 import { decodeUtf8 } from '../../utils/index.js';
@@ -43,7 +43,7 @@ export const AdbSyncFailResponse =
         });
 
 export async function adbSyncReadResponse<T extends Record<string, StructLike<any>>>(
-    stream: BufferedStream,
+    stream: BufferedReadableStream,
     types: T,
     // When `T` is a union type, `T[keyof T]` only includes their common keys.
     // For example, let `type T = { a: string, b: string } | { a: string, c: string}`,

libraries/adb/src/commands/sync/stat.ts

@@ -1,4 +1,4 @@
-import type { BufferedStream, WritableStreamDefaultWriter } from '@yume-chan/stream-extra';
+import type { BufferedReadableStream, WritableStreamDefaultWriter } from '@yume-chan/stream-extra';
 import Struct, { placeholder } from '@yume-chan/struct';
 
 import { AdbSyncRequestId, adbSyncWriteRequest } from './request.js';
@@ -109,7 +109,7 @@ const LSTAT_V2_RESPONSE_TYPES = {
 };
 
 export async function adbSyncLstat(
-    stream: BufferedStream,
+    stream: BufferedReadableStream,
     writer: WritableStreamDefaultWriter<Uint8Array>,
     path: string,
     v2: boolean,
@@ -143,7 +143,7 @@ export async function adbSyncLstat(
 }
 
 export async function adbSyncStat(
-    stream: BufferedStream,
+    stream: BufferedReadableStream,
     writer: WritableStreamDefaultWriter<Uint8Array>,
     path: string,
 ): Promise<AdbSyncStatResponse> {

libraries/adb/src/commands/sync/sync.ts

@@ -1,5 +1,5 @@
 import { AutoDisposable } from '@yume-chan/event';
-import { BufferedStream, ReadableStream, WrapReadableStream, WrapWritableStream, WritableStream, WritableStreamDefaultWriter } from '@yume-chan/stream-extra';
+import { BufferedReadableStream, ReadableStream, WrapReadableStream, WrapWritableStream, WritableStream, WritableStreamDefaultWriter } from '@yume-chan/stream-extra';
 
 import type { Adb } from '../../adb.js';
 import { AdbFeatures } from '../../features.js';
@@ -30,7 +30,7 @@ export function dirname(path: string): string {
 export class AdbSync extends AutoDisposable {
     protected adb: Adb;
 
-    protected stream: BufferedStream;
+    protected stream: BufferedReadableStream;
 
     protected writer: WritableStreamDefaultWriter<Uint8Array>;
 
@@ -57,7 +57,7 @@ export class AdbSync extends AutoDisposable {
         super();
 
         this.adb = adb;
-        this.stream = new BufferedStream(socket.readable);
+        this.stream = new BufferedReadableStream(socket.readable);
         this.writer = socket.writable.getWriter();
     }
 

libraries/adb/tsconfig.json

@@ -4,6 +4,9 @@
         {
             "path": "../event/tsconfig.json"
         },
+        {
+            "path": "../stream-extra/tsconfig.build.json"
+        },
         {
             "path": "../struct/tsconfig.build.json"
         },

libraries/android-bin/src/logcat.ts

@@ -1,7 +1,7 @@
 // cspell: ignore logcat
 
 import { AdbCommandBase, AdbSubprocessNoneProtocol } from '@yume-chan/adb';
-import { BufferedStream, BufferedStreamEndedError, DecodeUtf8Stream, ReadableStream, SplitStringStream, WritableStream } from '@yume-chan/stream-extra';
+import { BufferedReadableStream, BufferedReadableStreamEndedError, DecodeUtf8Stream, ReadableStream, SplitStringStream, WritableStream } from '@yume-chan/stream-extra';
 import Struct, { decodeUtf8, StructAsyncDeserializeStream } from '@yume-chan/struct';
 
 // `adb logcat` is an alias to `adb shell logcat`
@@ -185,7 +185,7 @@ export class Logcat extends AdbCommandBase {
     }
 
     public binary(options?: LogcatOptions): ReadableStream<AndroidLogEntry> {
-        let bufferedStream: BufferedStream;
+        let bufferedStream: BufferedReadableStream;
         return new ReadableStream({
             start: async () => {
                 const { stdout } = await this.adb.subprocess.spawn([
@@ -197,14 +197,14 @@ export class Logcat extends AdbCommandBase {
                     // PERF: None protocol is 150% faster then Shell protocol
                     protocols: [AdbSubprocessNoneProtocol],
                 });
-                bufferedStream = new BufferedStream(stdout);
+                bufferedStream = new BufferedReadableStream(stdout);
             },
             async pull(controller) {
                 try {
                     const entry = await deserializeAndroidLogEntry(bufferedStream);
                     controller.enqueue(entry);
                 } catch (e) {
-                    if (e instanceof BufferedStreamEndedError) {
+                    if (e instanceof BufferedReadableStreamEndedError) {
                         controller.close();
                         return;
                     }

libraries/android-bin/tsconfig.json

@@ -3,6 +3,9 @@
     "references": [
         {
             "path": "../adb/tsconfig.build.json"
+        },
+        {
+            "path": "../stream-extra/tsconfig.build.json"
         }
     ]
 }

libraries/scrcpy/src/control/client.ts

@@ -1,5 +1,5 @@
 import { EventEmitter } from '@yume-chan/event';
-import { BufferedStream, ReadableWritablePair, type WritableStreamDefaultWriter } from '@yume-chan/stream-extra';
+import { BufferedReadableStream, ReadableWritablePair, type WritableStreamDefaultWriter } from '@yume-chan/stream-extra';
 
 import type { ScrcpyInjectScrollControlMessage1_22, ScrcpyOptions } from '../options/index.js';
 import { ClipboardMessage } from './clipboard.js';
@@ -25,7 +25,7 @@ export class ScrcpyControlClient {
     ) {
         this.options = options;
 
-        const buffered = new BufferedStream(stream.readable);
+        const buffered = new BufferedReadableStream(stream.readable);
         this.writer = stream.writable.getWriter();
         (async () => {
             try {

libraries/scrcpy/tsconfig.json

@@ -16,6 +16,9 @@
         {
             "path": "../event/tsconfig.json"
         },
+        {
+            "path": "../stream-extra/tsconfig.build.json"
+        },
         {
             "path": "../struct/tsconfig.build.json"
         }

libraries/stream-extra/src/buffered.spec.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from '@jest/globals';
 
-import { BufferedStream } from "./buffered.js";
+import { BufferedReadableStream } from "./buffered.js";
 import { ReadableStream } from "./stream.js";
 
 function randomUint8Array(length: number) {
@@ -38,7 +38,7 @@ async function runTest(inputSizes: number[], readSizes: number[]) {
     }
 
     const stream = new MockReadableStream(buffers);
-    const buffered = new BufferedStream(stream);
+    const buffered = new BufferedReadableStream(stream);
 
     index = 0;
     for (const size of readSizes) {
@@ -52,14 +52,14 @@ describe('BufferedStream', () => {
     describe('read 1 time', () => {
         it('read 0 buffer', async () => {
             const source = new MockReadableStream([]);
-            const buffered = new BufferedStream(source);
+            const buffered = new BufferedReadableStream(source);
             await expect(buffered.read(10)).rejects.toThrow();
         });
 
         it('input 1 exact buffer', async () => {
             const input = randomUint8Array(10);
             const source = new MockReadableStream([input]);
-            const buffered = new BufferedStream(source);
+            const buffered = new BufferedReadableStream(source);
             await expect(buffered.read(10)).resolves.toBe(input);
         });
 
@@ -69,7 +69,7 @@ describe('BufferedStream', () => {
 
         it('read 1 small buffer', async () => {
             const source = new MockReadableStream([randomUint8Array(5)]);
-            const buffered = new BufferedStream(source);
+            const buffered = new BufferedReadableStream(source);
             await expect(buffered.read(10)).rejects.toThrow();
         });
 
@@ -79,7 +79,7 @@ describe('BufferedStream', () => {
 
         it('read 2 small buffers', async () => {
             const source = new MockReadableStream([randomUint8Array(5), randomUint8Array(5)]);
-            const buffered = new BufferedStream(source);
+            const buffered = new BufferedReadableStream(source);
             await expect(buffered.read(20)).rejects.toThrow();
         });
 

libraries/stream-extra/src/buffered.ts

@@ -1,7 +1,7 @@
 import { PushReadableStream } from "./push-readable.js";
 import type { ReadableStream, ReadableStreamDefaultReader } from "./stream.js";
 
-export class BufferedStreamEndedError extends Error {
+export class BufferedReadableStreamEndedError extends Error {
     public constructor() {
         super('Stream ended');
 
@@ -10,7 +10,7 @@ export class BufferedStreamEndedError extends Error {
     }
 }
 
-export class BufferedStream {
+export class BufferedReadableStream {
     private buffered: Uint8Array | undefined;
     private bufferedOffset = 0;
     private bufferedLength = 0;
@@ -27,7 +27,7 @@ export class BufferedStream {
     private async readSource() {
         const { done, value } = await this.reader.read();
         if (done) {
-            throw new BufferedStreamEndedError();
+            throw new BufferedReadableStreamEndedError();
         }
         return value;
     }

libraries/stream-extra/src/struct-deserialize.ts

@@ -1,6 +1,6 @@
 import type Struct from "@yume-chan/struct";
 import type { StructValueType } from "@yume-chan/struct";
-import { BufferedStream, BufferedStreamEndedError } from "./buffered.js";
+import { BufferedReadableStream, BufferedReadableStreamEndedError } from "./buffered.js";
 import { PushReadableStream, PushReadableStreamController } from "./push-readable.js";
 import { ReadableStream, WritableStream, type ReadableWritablePair } from "./stream.js";
 
@@ -16,7 +16,7 @@ export class StructDeserializeStream<T extends Struct<any, any, any, any>>
     public constructor(struct: T) {
         // Convert incoming chunks to a `BufferedStream`
         let incomingStreamController!: PushReadableStreamController<Uint8Array>;
-        const incomingStream = new BufferedStream(
+        const incomingStream = new BufferedReadableStream(
             new PushReadableStream<Uint8Array>(
                 controller => incomingStreamController = controller,
             )
@@ -28,7 +28,7 @@ export class StructDeserializeStream<T extends Struct<any, any, any, any>>
                     const value = await struct.deserialize(incomingStream);
                     controller.enqueue(value);
                 } catch (e) {
-                    if (e instanceof BufferedStreamEndedError) {
+                    if (e instanceof BufferedReadableStreamEndedError) {
                         controller.close();
                         return;
                     }