@yume-chan/adb 0.0.23 → 0.0.24

package/src/commands/subprocess/protocols/shell.ts

@@ -1,12 +1,11 @@
 import { PromiseResolver } from "@yume-chan/async";
 import type {
-    Consumable,
     PushReadableStreamController,
     ReadableStream,
     WritableStreamDefaultWriter,
 } from "@yume-chan/stream-extra";
 import {
-    ConsumableWritableStream,
+    MaybeConsumable,
     PushReadableStream,
     StructDeserializeStream,
     WritableStream,
@@ -64,9 +63,9 @@ export class AdbSubprocessShellProtocol implements AdbSubprocessProtocol {
     }
 
     readonly #socket: AdbSocket;
-    #writer: WritableStreamDefaultWriter<Consumable<Uint8Array>>;
+    #writer: WritableStreamDefaultWriter<MaybeConsumable<Uint8Array>>;
 
-    #stdin: WritableStream<Consumable<Uint8Array>>;
+    #stdin: WritableStream<MaybeConsumable<Uint8Array>>;
     get stdin() {
         return this.#stdin;
     }
@@ -140,23 +139,20 @@ export class AdbSubprocessShellProtocol implements AdbSubprocessProtocol {
 
         this.#writer = this.#socket.writable.getWriter();
 
-        this.#stdin = new WritableStream<Consumable<Uint8Array>>({
+        this.#stdin = new MaybeConsumable.WritableStream<Uint8Array>({
             write: async (chunk) => {
-                await ConsumableWritableStream.write(
-                    this.#writer,
+                await this.#writer.write(
                     AdbShellProtocolPacket.serialize({
                         id: AdbShellProtocolId.Stdin,
-                        data: chunk.value,
+                        data: chunk,
                     }),
                 );
-                chunk.consume();
             },
         });
     }
 
     async resize(rows: number, cols: number) {
-        await ConsumableWritableStream.write(
-            this.#writer,
+        await this.#writer.write(
             AdbShellProtocolPacket.serialize({
                 id: AdbShellProtocolId.WindowSizeChange,
                 // The "correct" format is `${rows}x${cols},${x_pixels}x${y_pixels}`

package/src/commands/subprocess/protocols/types.ts

@@ -1,5 +1,5 @@
 import type {
-    Consumable,
+    MaybeConsumable,
     ReadableStream,
     WritableStream,
 } from "@yume-chan/stream-extra";
@@ -11,7 +11,7 @@ export interface AdbSubprocessProtocol {
     /**
      * A WritableStream that writes to the `stdin` stream.
      */
-    readonly stdin: WritableStream<Consumable<Uint8Array>>;
+    readonly stdin: WritableStream<MaybeConsumable<Uint8Array>>;
 
     /**
      * The `stdout` stream of the process.

package/src/commands/sync/list.ts

@@ -17,8 +17,7 @@ export interface AdbSyncEntry extends AdbSyncStat {
 export const AdbSyncEntryResponse = new Struct({ littleEndian: true })
     .concat(AdbSyncLstatResponse)
     .uint32("nameLength")
-    .string("name", { lengthField: "nameLength" })
-    .extra({ id: AdbSyncResponseId.Entry as const });
+    .string("name", { lengthField: "nameLength" });
 
 export type AdbSyncEntryResponse =
     (typeof AdbSyncEntryResponse)["TDeserializeResult"];
@@ -26,8 +25,7 @@ export type AdbSyncEntryResponse =
 export const AdbSyncEntry2Response = new Struct({ littleEndian: true })
     .concat(AdbSyncStatResponse)
     .uint32("nameLength")
-    .string("name", { lengthField: "nameLength" })
-    .extra({ id: AdbSyncResponseId.Entry2 as const });
+    .string("name", { lengthField: "nameLength" });
 
 export type AdbSyncEntry2Response =
     (typeof AdbSyncEntry2Response)["TDeserializeResult"];

package/src/commands/sync/pull.ts

@@ -8,8 +8,7 @@ import type { AdbSyncSocket } from "./socket.js";
 
 export const AdbSyncDataResponse = new Struct({ littleEndian: true })
     .uint32("dataLength")
-    .uint8Array("data", { lengthField: "dataLength" })
-    .extra({ id: AdbSyncResponseId.Data as const });
+    .uint8Array("data", { lengthField: "dataLength" });
 
 export type AdbSyncDataResponse =
     (typeof AdbSyncDataResponse)["TDeserializeResult"];
@@ -52,6 +51,7 @@ export function adbSyncPull(
     socket: AdbSyncSocket,
     path: string,
 ): ReadableStream<Uint8Array> {
+    // TODO: use `ReadableStream.from` when it's supported
     return new PushReadableStream(async (controller) => {
         for await (const data of adbSyncPullGenerator(socket, path)) {
             await controller.enqueue(data);

package/src/commands/sync/push.ts

@@ -1,8 +1,8 @@
-import type { Consumable, ReadableStream } from "@yume-chan/stream-extra";
+import type { ReadableStream } from "@yume-chan/stream-extra";
 import {
     AbortController,
-    ConsumableWritableStream,
     DistributionStream,
+    MaybeConsumable,
 } from "@yume-chan/stream-extra";
 import Struct, { placeholder } from "@yume-chan/struct";
 
@@ -18,7 +18,7 @@ export const ADB_SYNC_MAX_PACKET_SIZE = 64 * 1024;
 export interface AdbSyncPushV1Options {
     socket: AdbSyncSocket;
     filename: string;
-    file: ReadableStream<Consumable<Uint8Array>>;
+    file: ReadableStream<MaybeConsumable<Uint8Array>>;
     type?: LinuxFileType;
     permission?: number;
     mtime?: number;
@@ -31,7 +31,7 @@ export const AdbSyncOkResponse = new Struct({ littleEndian: true }).uint32(
 
 async function pipeFileData(
     locked: AdbSyncSocketLocked,
-    file: ReadableStream<Consumable<Uint8Array>>,
+    file: ReadableStream<MaybeConsumable<Uint8Array>>,
     packetSize: number,
     mtime: number,
 ) {
@@ -40,7 +40,7 @@ async function pipeFileData(
     const abortController = new AbortController();
     file.pipeThrough(new DistributionStream(packetSize, true))
         .pipeTo(
-            new ConsumableWritableStream({
+            new MaybeConsumable.WritableStream({
                 write: async (chunk) => {
                     await adbSyncWriteRequest(
                         locked,
@@ -97,10 +97,7 @@ export enum AdbSyncSendV2Flags {
      * 4
      */
     Zstd = 1 << 2,
-    /**
-     * 0x80000000
-     */
-    DryRun = (1 << 31) >>> 0,
+    DryRun = 0x80000000,
 }
 
 export interface AdbSyncPushV2Options extends AdbSyncPushV1Options {
@@ -114,7 +111,7 @@ export interface AdbSyncPushV2Options extends AdbSyncPushV1Options {
 }
 
 export const AdbSyncSendV2Request = new Struct({ littleEndian: true })
-    .uint32("id", placeholder<AdbSyncRequestId>())
+    .uint32("id")
     .uint32("mode")
     .uint32("flags", placeholder<AdbSyncSendV2Flags>());
 

package/src/commands/sync/request.ts

@@ -2,53 +2,53 @@ import Struct from "@yume-chan/struct";
 
 import { encodeUtf8 } from "../../utils/index.js";
 
-export enum AdbSyncRequestId {
-    List = "LIST",
-    ListV2 = "LIS2",
-    Send = "SEND",
-    SendV2 = "SND2",
-    Lstat = "STAT",
-    Stat = "STA2",
-    LstatV2 = "LST2",
-    Data = "DATA",
-    Done = "DONE",
-    Receive = "RECV",
+import { adbSyncEncodeId } from "./response.js";
+
+export namespace AdbSyncRequestId {
+    export const List = adbSyncEncodeId("LIST");
+    export const ListV2 = adbSyncEncodeId("LIS2");
+    export const Send = adbSyncEncodeId("SEND");
+    export const SendV2 = adbSyncEncodeId("SND2");
+    export const Lstat = adbSyncEncodeId("STAT");
+    export const Stat = adbSyncEncodeId("STA2");
+    export const LstatV2 = adbSyncEncodeId("LST2");
+    export const Data = adbSyncEncodeId("DATA");
+    export const Done = adbSyncEncodeId("DONE");
+    export const Receive = adbSyncEncodeId("RECV");
 }
 
 export const AdbSyncNumberRequest = new Struct({ littleEndian: true })
-    .string("id", { length: 4 })
+    .uint32("id")
     .uint32("arg");
 
-export const AdbSyncDataRequest = new Struct({ littleEndian: true })
-    .concat(AdbSyncNumberRequest)
-    .uint8Array("data", { lengthField: "arg" });
-
 export interface AdbSyncWritable {
     write(buffer: Uint8Array): Promise<void>;
 }
 
 export async function adbSyncWriteRequest(
     writable: AdbSyncWritable,
-    id: AdbSyncRequestId | string,
+    id: number | string,
     value: number | string | Uint8Array,
 ): Promise<void> {
+    if (typeof id === "string") {
+        id = adbSyncEncodeId(id);
+    }
+
     if (typeof value === "number") {
-        const buffer = AdbSyncNumberRequest.serialize({
-            id,
-            arg: value,
-        });
-        await writable.write(buffer);
-    } else if (typeof value === "string") {
-        // Let `writable` buffer writes
-        const buffer = encodeUtf8(value);
         await writable.write(
-            AdbSyncNumberRequest.serialize({ id, arg: buffer.byteLength }),
+            AdbSyncNumberRequest.serialize({ id, arg: value }),
         );
-        await writable.write(buffer);
-    } else {
-        await writable.write(
-            AdbSyncNumberRequest.serialize({ id, arg: value.byteLength }),
-        );
-        await writable.write(value);
+        return;
+    }
+
+    if (typeof value === "string") {
+        value = encodeUtf8(value);
     }
+
+    // `writable` is buffered, it copies inputs to an internal buffer,
+    // so don't concatenate headers and data here, that will be an unnecessary copy.
+    await writable.write(
+        AdbSyncNumberRequest.serialize({ id, arg: value.length }),
+    );
+    await writable.write(value);
 }

package/src/commands/sync/response.ts

@@ -1,22 +1,39 @@
+import { getUint32LittleEndian } from "@yume-chan/no-data-view";
 import type {
     AsyncExactReadable,
     StructLike,
     StructValueType,
 } from "@yume-chan/struct";
-import Struct from "@yume-chan/struct";
+import Struct, { decodeUtf8 } from "@yume-chan/struct";
 
-import { decodeUtf8 } from "../../utils/index.js";
+function encodeAsciiUnchecked(value: string): Uint8Array {
+    const result = new Uint8Array(value.length);
+    for (let i = 0; i < value.length; i += 1) {
+        result[i] = value.charCodeAt(i);
+    }
+    return result;
+}
+
+/**
+ * Encode ID to numbers for faster comparison
+ * @param value A 4-character string
+ * @returns A 32-bit integer by encoding the string as little-endian
+ */
+export function adbSyncEncodeId(value: string): number {
+    const buffer = encodeAsciiUnchecked(value);
+    return getUint32LittleEndian(buffer, 0);
+}
 
-export enum AdbSyncResponseId {
-    Entry = "DENT",
-    Entry2 = "DNT2",
-    Lstat = "STAT",
-    Stat = "STA2",
-    Lstat2 = "LST2",
-    Done = "DONE",
-    Data = "DATA",
-    Ok = "OKAY",
-    Fail = "FAIL",
+export namespace AdbSyncResponseId {
+    export const Entry = adbSyncEncodeId("DENT");
+    export const Entry2 = adbSyncEncodeId("DNT2");
+    export const Lstat = adbSyncEncodeId("STAT");
+    export const Stat = adbSyncEncodeId("STA2");
+    export const Lstat2 = adbSyncEncodeId("LST2");
+    export const Done = adbSyncEncodeId("DONE");
+    export const Data = adbSyncEncodeId("DATA");
+    export const Ok = adbSyncEncodeId("OKAY");
+    export const Fail = adbSyncEncodeId("FAIL");
 }
 
 export class AdbSyncError extends Error {}
@@ -30,18 +47,24 @@ export const AdbSyncFailResponse = new Struct({ littleEndian: true })
 
 export async function adbSyncReadResponse<T>(
     stream: AsyncExactReadable,
-    id: AdbSyncResponseId,
+    id: number | string,
     type: StructLike<T>,
 ): Promise<T> {
-    const actualId = decodeUtf8(await stream.readExactly(4));
-    switch (actualId) {
+    if (typeof id === "string") {
+        id = adbSyncEncodeId(id);
+    }
+
+    const buffer = await stream.readExactly(4);
+    switch (getUint32LittleEndian(buffer, 0)) {
         case AdbSyncResponseId.Fail:
             await AdbSyncFailResponse.deserialize(stream);
             throw new Error("Unreachable");
         case id:
             return await type.deserialize(stream);
         default:
-            throw new Error(`Expected '${id}', but got '${actualId}'`);
+            throw new Error(
+                `Expected '${id}', but got '${decodeUtf8(buffer)}'`,
+            );
     }
 }
 
@@ -49,12 +72,16 @@ export async function* adbSyncReadResponses<
     T extends Struct<object, PropertyKey, object, unknown>,
 >(
     stream: AsyncExactReadable,
-    id: AdbSyncResponseId,
+    id: number | string,
     type: T,
 ): AsyncGenerator<StructValueType<T>, void, void> {
+    if (typeof id === "string") {
+        id = adbSyncEncodeId(id);
+    }
+
     while (true) {
-        const actualId = decodeUtf8(await stream.readExactly(4));
-        switch (actualId) {
+        const buffer = await stream.readExactly(4);
+        switch (getUint32LittleEndian(buffer, 0)) {
             case AdbSyncResponseId.Fail:
                 await AdbSyncFailResponse.deserialize(stream);
                 throw new Error("Unreachable");
@@ -70,7 +97,7 @@ export async function* adbSyncReadResponses<
                 break;
             default:
                 throw new Error(
-                    `Expected '${id}' or '${AdbSyncResponseId.Done}', but got '${actualId}'`,
+                    `Expected '${id}' or '${AdbSyncResponseId.Done}', but got '${decodeUtf8(buffer)}'`,
                 );
         }
     }

package/src/commands/sync/socket.ts

@@ -1,11 +1,11 @@
 import type {
-    Consumable,
+    MaybeConsumable,
     WritableStreamDefaultWriter,
 } from "@yume-chan/stream-extra";
 import {
     BufferCombiner,
     BufferedReadableStream,
-    ConsumableWritableStream,
+    Consumable,
 } from "@yume-chan/stream-extra";
 import type { AsyncExactReadable } from "@yume-chan/struct";
 
@@ -13,7 +13,7 @@ import type { AdbSocket } from "../../adb.js";
 import { AutoResetEvent } from "../../utils/index.js";
 
 export class AdbSyncSocketLocked implements AsyncExactReadable {
-    readonly #writer: WritableStreamDefaultWriter<Consumable<Uint8Array>>;
+    readonly #writer: WritableStreamDefaultWriter<MaybeConsumable<Uint8Array>>;
     readonly #readable: BufferedReadableStream;
     readonly #socketLock: AutoResetEvent;
     readonly #writeLock = new AutoResetEvent();
@@ -24,7 +24,7 @@ export class AdbSyncSocketLocked implements AsyncExactReadable {
     }
 
     constructor(
-        writer: WritableStreamDefaultWriter<Consumable<Uint8Array>>,
+        writer: WritableStreamDefaultWriter<MaybeConsumable<Uint8Array>>,
         readable: BufferedReadableStream,
         bufferSize: number,
         lock: AutoResetEvent,
@@ -35,8 +35,9 @@ export class AdbSyncSocketLocked implements AsyncExactReadable {
         this.#combiner = new BufferCombiner(bufferSize);
     }
 
-    async #writeInnerStream(buffer: Uint8Array) {
-        await ConsumableWritableStream.write(this.#writer, buffer);
+    async #write(buffer: Uint8Array) {
+        // `#combiner` will reuse the buffer, so we need to use the Consumable pattern
+        await Consumable.WritableStream.write(this.#writer, buffer);
     }
 
     async flush() {
@@ -44,7 +45,7 @@ export class AdbSyncSocketLocked implements AsyncExactReadable {
             await this.#writeLock.wait();
             const buffer = this.#combiner.flush();
             if (buffer) {
-                await this.#writeInnerStream(buffer);
+                await this.#write(buffer);
             }
         } finally {
             this.#writeLock.notifyOne();
@@ -55,7 +56,7 @@ export class AdbSyncSocketLocked implements AsyncExactReadable {
         try {
             await this.#writeLock.wait();
             for (const buffer of this.#combiner.push(data)) {
-                await this.#writeInnerStream(buffer);
+                await this.#write(buffer);
             }
         } finally {
             this.#writeLock.notifyOne();
@@ -63,11 +64,15 @@ export class AdbSyncSocketLocked implements AsyncExactReadable {
     }
 
     async readExactly(length: number) {
+        // The request may still be in the internal buffer.
+        // Call `flush` to send it before starting reading
         await this.flush();
         return await this.#readable.readExactly(length);
     }
 
     release(): void {
+        // In theory, the writer shouldn't leave anything in the buffer,
+        // but to be safe, call `flush` to throw away any remaining data.
         this.#combiner.flush();
         this.#socketLock.notifyOne();
     }

package/src/commands/sync/stat.ts

@@ -29,7 +29,6 @@ export const AdbSyncLstatResponse = new Struct({ littleEndian: true })
     .int32("size")
     .int32("mtime")
     .extra({
-        id: AdbSyncResponseId.Lstat as const,
         get type() {
             return (this.mode >> 12) as LinuxFileType;
         },
@@ -83,7 +82,6 @@ export const AdbSyncStatResponse = new Struct({ littleEndian: true })
     .uint64("mtime")
     .uint64("ctime")
     .extra({
-        id: AdbSyncResponseId.Stat as const,
         get type() {
             return (this.mode >> 12) as LinuxFileType;
         },

package/src/commands/sync/sync.ts

@@ -1,5 +1,5 @@
 import { AutoDisposable } from "@yume-chan/event";
-import type { Consumable, ReadableStream } from "@yume-chan/stream-extra";
+import type { MaybeConsumable, ReadableStream } from "@yume-chan/stream-extra";
 
 import type { Adb, AdbSocket } from "../../adb.js";
 import { AdbFeature } from "../../features.js";
@@ -9,6 +9,7 @@ import type { AdbSyncEntry } from "./list.js";
 import { adbSyncOpenDir } from "./list.js";
 import { adbSyncPull } from "./pull.js";
 import { adbSyncPush } from "./push.js";
+import type { AdbSyncSocketLocked } from "./socket.js";
 import { AdbSyncSocket } from "./socket.js";
 import type { AdbSyncStat, LinuxFileType } from "./stat.js";
 import { adbSyncLstat, adbSyncStat } from "./stat.js";
@@ -31,7 +32,7 @@ export function dirname(path: string): string {
 
 export interface AdbSyncWriteOptions {
     filename: string;
-    file: ReadableStream<Consumable<Uint8Array>>;
+    file: ReadableStream<MaybeConsumable<Uint8Array>>;
     type?: LinuxFileType;
     permission?: number;
     mtime?: number;
@@ -150,7 +151,7 @@ export class AdbSync extends AutoDisposable {
      */
     async write(options: AdbSyncWriteOptions): Promise<void> {
         if (this.needPushMkdirWorkaround) {
-            // It may fail if the path is already existed.
+            // It may fail if `filename` already exists.
             // Ignore the result.
             // TODO: sync: test push mkdir workaround (need an Android 8 device)
             await this._adb.subprocess.spawnAndWait([
@@ -167,6 +168,10 @@ export class AdbSync extends AutoDisposable {
         });
     }
 
+    lockSocket(): Promise<AdbSyncSocketLocked> {
+        return this._socket.lock();
+    }
+
     override async dispose() {
         super.dispose();
         await this._socket.close();

package/src/commands/tcpip.ts

@@ -47,7 +47,7 @@ export class AdbTcpIpCommand extends AdbCommandBase {
 
     async setPort(port: number): Promise<string> {
         if (port <= 0) {
-            throw new Error(`Invalid port ${port}`);
+            throw new TypeError(`Invalid port ${port}`);
         }
 
         const output = await this.adb.createSocketAndWait(`tcpip:${port}`);

package/src/daemon/auth.ts

@@ -83,7 +83,7 @@ export const AdbSignatureAuthenticator: AdbAuthenticator = async function* (
             command: AdbCommand.Auth,
             arg0: AdbAuthType.Signature,
             arg1: 0,
-            payload: new Uint8Array(signature),
+            payload: signature,
         };
     }
 };