@yume-chan/adb 0.0.17 → 0.0.18

package/src/socket/dispatcher.ts

@@ -1,11 +1,22 @@
-import { AsyncOperationManager, PromiseResolver } from '@yume-chan/async';
-import type { RemoveEventListener } from '@yume-chan/event';
-import { AbortController, WritableStream, WritableStreamDefaultWriter, type ReadableWritablePair } from '@yume-chan/stream-extra';
-import { EMPTY_UINT8_ARRAY, type ValueOrPromise } from '@yume-chan/struct';
-
-import { AdbCommand, calculateChecksum, type AdbPacketData, type AdbPacketInit } from '../packet.js';
-import { decodeUtf8, encodeUtf8 } from '../utils/index.js';
-import { AdbSocket, AdbSocketController } from './socket.js';
+import { AsyncOperationManager, PromiseResolver } from "@yume-chan/async";
+import { type RemoveEventListener } from "@yume-chan/event";
+import {
+    AbortController,
+    WritableStream,
+    type ReadableWritablePair,
+    type WritableStreamDefaultWriter,
+} from "@yume-chan/stream-extra";
+import { EMPTY_UINT8_ARRAY, type ValueOrPromise } from "@yume-chan/struct";
+
+import {
+    AdbCommand,
+    calculateChecksum,
+    type AdbPacketData,
+    type AdbPacketInit,
+} from "../packet.js";
+import { decodeUtf8, encodeUtf8 } from "../utils/index.js";
+
+import { AdbSocketController, type AdbSocket } from "./socket.js";
 
 export interface AdbPacketDispatcherOptions {
     calculateChecksum: boolean;
@@ -19,7 +30,9 @@ export interface AdbPacketDispatcherOptions {
     maxPayloadSize: number;
 }
 
-export type AdbIncomingSocketHandler = (socket: AdbSocket) => ValueOrPromise<boolean>;
+export type AdbIncomingSocketHandler = (
+    socket: AdbSocket
+) => ValueOrPromise<boolean>;
 
 export interface Closeable {
     close(): ValueOrPromise<void>;
@@ -50,7 +63,9 @@ export class AdbPacketDispatcher implements Closeable {
 
     private _closed = false;
     private _disconnected = new PromiseResolver<void>();
-    public get disconnected() { return this._disconnected.promise; }
+    public get disconnected() {
+        return this._disconnected.promise;
+    }
 
     private _incomingSocketHandlers: Set<AdbIncomingSocketHandler> = new Set();
 
@@ -63,53 +78,68 @@ export class AdbPacketDispatcher implements Closeable {
         this.options = options;
 
         connection.readable
-            .pipeTo(new WritableStream({
-                write: async (packet) => {
-                    switch (packet.command) {
-                        case AdbCommand.OK:
-                            this.handleOk(packet);
-                            break;
-                        case AdbCommand.Close:
-                            await this.handleClose(packet);
-                            break;
-                        case AdbCommand.Write:
-                            if (this.sockets.has(packet.arg1)) {
-                                await this.sockets.get(packet.arg1)!.enqueue(packet.payload);
-                                await this.sendPacket(AdbCommand.OK, packet.arg1, packet.arg0);
+            .pipeTo(
+                new WritableStream({
+                    write: async (packet) => {
+                        switch (packet.command) {
+                            case AdbCommand.OK:
+                                this.handleOk(packet);
                                 break;
-                            }
-                            throw new Error(`Unknown local socket id: ${packet.arg1}`);
-                        case AdbCommand.Open:
-                            await this.handleOpen(packet);
-                            break;
-                        default:
-                            // Junk data may only appear in the authentication phase,
-                            // since the dispatcher only works after authentication,
-                            // all packets should have a valid command.
-                            // (although it's possible that Adb added new commands in the future)
-                            throw new Error(`Unknown command: ${packet.command.toString(16)}`);
-                    }
+                            case AdbCommand.Close:
+                                await this.handleClose(packet);
+                                break;
+                            case AdbCommand.Write:
+                                if (this.sockets.has(packet.arg1)) {
+                                    await this.sockets
+                                        .get(packet.arg1)!
+                                        .enqueue(packet.payload);
+                                    await this.sendPacket(
+                                        AdbCommand.OK,
+                                        packet.arg1,
+                                        packet.arg0
+                                    );
+                                    break;
+                                }
+                                throw new Error(
+                                    `Unknown local socket id: ${packet.arg1}`
+                                );
+                            case AdbCommand.Open:
+                                await this.handleOpen(packet);
+                                break;
+                            default:
+                                // Junk data may only appear in the authentication phase,
+                                // since the dispatcher only works after authentication,
+                                // all packets should have a valid command.
+                                // (although it's possible that Adb added new commands in the future)
+                                throw new Error(
+                                    `Unknown command: ${packet.command.toString(
+                                        16
+                                    )}`
+                                );
+                        }
+                    },
+                }),
+                {
+                    // There are multiple reasons for the pipe to stop,
+                    // (device disconnection, protocol error, or user abortion)
+                    // if the underlying streams are still open,
+                    // it's still possible to create another ADB connection.
+                    // So don't close `readable` here.
+                    preventCancel: true,
+                    signal: this._abortController.signal,
+                }
+            )
+            .then(
+                () => {
+                    this.dispose();
                 },
-            }), {
-                // There are multiple reasons for the pipe to stop,
-                // (device disconnection, protocol error, or user abortion)
-                // if the underlying streams are still open,
-                // it's still possible to create another ADB connection.
-                // So don't close `readable` here.
-                preventCancel: true,
-                signal: this._abortController.signal,
-            })
-            .then(() => {
-                this.dispose();
-            }, (e) => {
-                // https://github.com/MattiasBuelens/web-streams-polyfill/issues/115
-                // `e` is always `AbortError` (instead of what I give in `abortController.abort()`)
-                // so we can't check if `e` is a real error.
-                if (!this._closed) {
-                    this._disconnected.reject(e);
+                (e) => {
+                    if (!this._closed) {
+                        this._disconnected.reject(e);
+                    }
+                    this.dispose();
                 }
-                this.dispose();
-            });
+            );
 
         this._writer = connection.writable.getWriter();
     }
@@ -129,13 +159,18 @@ export class AdbPacketDispatcher implements Closeable {
 
         // Maybe the device is responding to a packet of last connection
         // Tell the device to close the socket
-        this.sendPacket(AdbCommand.Close, packet.arg1, packet.arg0);
+        void this.sendPacket(AdbCommand.Close, packet.arg1, packet.arg0);
     }
 
     private async handleClose(packet: AdbPacketData) {
         // If the socket is still pending
-        if (packet.arg0 === 0 &&
-            this.initializers.reject(packet.arg1, new Error('Socket open failed'))) {
+        if (
+            packet.arg0 === 0 &&
+            this.initializers.reject(
+                packet.arg1,
+                new Error("Socket open failed")
+            )
+        ) {
             // Device failed to create the socket
             // (unknown service string, failed to execute command, etc.)
             // it doesn't break the connection,
@@ -156,9 +191,13 @@ export class AdbPacketDispatcher implements Closeable {
         if (socket) {
             // The device want to close the socket
             if (!socket.closed) {
-                await this.sendPacket(AdbCommand.Close, packet.arg1, packet.arg0);
+                await this.sendPacket(
+                    AdbCommand.Close,
+                    packet.arg1,
+                    packet.arg0
+                );
             }
-            socket.dispose();
+            await socket.dispose();
             this.sockets.delete(packet.arg1);
             return;
         }
@@ -173,7 +212,9 @@ export class AdbPacketDispatcher implements Closeable {
      * @param handler A function to call with new incoming sockets. It must return `true` if it accepts the socket.
      * @returns A function to remove the handler.
      */
-    public onIncomingSocket(handler: AdbIncomingSocketHandler): RemoveEventListener {
+    public onIncomingSocket(
+        handler: AdbIncomingSocketHandler
+    ): RemoveEventListener {
         this._incomingSocketHandlers.add(handler);
         const remove = () => {
             this._incomingSocketHandlers.delete(handler);
@@ -212,16 +253,11 @@ export class AdbPacketDispatcher implements Closeable {
 
     public async createSocket(serviceString: string): Promise<AdbSocket> {
         if (this.options.appendNullToServiceString) {
-            serviceString += '\0';
+            serviceString += "\0";
         }
 
         const [localId, initializer] = this.initializers.add<number>();
-        await this.sendPacket(
-            AdbCommand.Open,
-            localId,
-            0,
-            serviceString
-        );
+        await this.sendPacket(AdbCommand.Open, localId, 0, serviceString);
 
         // Fulfilled by `handleOk`
         const remoteId = await initializer;
@@ -248,27 +284,29 @@ export class AdbPacketDispatcher implements Closeable {
         packetOrCommand: AdbPacketInit | AdbCommand,
         arg0?: number,
         arg1?: number,
-        payload: string | Uint8Array = EMPTY_UINT8_ARRAY,
+        payload: string | Uint8Array = EMPTY_UINT8_ARRAY
     ): Promise<void> {
         let init: AdbPacketData;
         if (arg0 === undefined) {
             init = packetOrCommand as AdbPacketInit;
         } else {
-            if (typeof payload === 'string') {
+            if (typeof payload === "string") {
                 payload = encodeUtf8(payload);
             }
 
             init = {
                 command: packetOrCommand as AdbCommand,
-                arg0: arg0 as number,
+                arg0: arg0,
                 arg1: arg1 as number,
                 payload,
             };
         }
 
-        if (init.payload &&
-            init.payload.byteLength > this.options.maxPayloadSize) {
-            throw new Error('payload too large');
+        if (
+            init.payload &&
+            init.payload.byteLength > this.options.maxPayloadSize
+        ) {
+            throw new Error("payload too large");
         }
 
         if (this.options.calculateChecksum) {
@@ -284,10 +322,7 @@ export class AdbPacketDispatcher implements Closeable {
     public async close() {
         // Send `CLSE` packets for all sockets
         await Promise.all(
-            Array.from(
-                this.sockets.values(),
-                socket => socket.close(),
-            )
+            Array.from(this.sockets.values(), (socket) => socket.close())
         );
 
         // Stop receiving
@@ -302,7 +337,9 @@ export class AdbPacketDispatcher implements Closeable {
 
     private dispose() {
         for (const socket of this.sockets.values()) {
-            socket.dispose();
+            socket.dispose().catch((e) => {
+                void e;
+            });
         }
 
         this._disconnected.resolve();

package/src/socket/socket.ts

@@ -1,9 +1,19 @@
-import { PromiseResolver } from '@yume-chan/async';
-import type { Disposable } from '@yume-chan/event';
-import { ChunkStream, DuplexStreamFactory, pipeFrom, PushReadableStream, WritableStream, type PushReadableStreamController, type ReadableStream, type ReadableWritablePair } from '@yume-chan/stream-extra';
-
-import { AdbCommand } from '../packet.js';
-import type { AdbPacketDispatcher, Closeable } from './dispatcher.js';
+import { PromiseResolver } from "@yume-chan/async";
+import { type Disposable } from "@yume-chan/event";
+import {
+    ChunkStream,
+    DuplexStreamFactory,
+    PushReadableStream,
+    WritableStream,
+    pipeFrom,
+    type PushReadableStreamController,
+    type ReadableStream,
+    type ReadableWritablePair,
+} from "@yume-chan/stream-extra";
+
+import { AdbCommand } from "../packet.js";
+
+import { type AdbPacketDispatcher, type Closeable } from "./dispatcher.js";
 
 export interface AdbSocketInfo {
     localId: number;
@@ -19,7 +29,13 @@ export interface AdbSocketConstructionOptions extends AdbSocketInfo {
     highWaterMark?: number | undefined;
 }
 
-export class AdbSocketController implements AdbSocketInfo, ReadableWritablePair<Uint8Array, Uint8Array>, Closeable, Disposable {
+export class AdbSocketController
+    implements
+        AdbSocketInfo,
+        ReadableWritablePair<Uint8Array, Uint8Array>,
+        Closeable,
+        Disposable
+{
     private readonly dispatcher!: AdbPacketDispatcher;
 
     public readonly localId!: number;
@@ -31,7 +47,9 @@ export class AdbSocketController implements AdbSocketInfo, ReadableWritablePair<
 
     private _readable: ReadableStream<Uint8Array>;
     private _readableController!: PushReadableStreamController<Uint8Array>;
-    public get readable() { return this._readable; }
+    public get readable() {
+        return this._readable;
+    }
 
     private _writePromise: PromiseResolver<void> | undefined;
     public readonly writable: WritableStream<Uint8Array>;
@@ -42,10 +60,14 @@ export class AdbSocketController implements AdbSocketInfo, ReadableWritablePair<
      *
      * It's only used by dispatcher to avoid sending another `CLSE` packet to remote.
      */
-    public get closed() { return this._closed; }
+    public get closed() {
+        return this._closed;
+    }
 
     private _socket: AdbSocket;
-    public get socket() { return this._socket; }
+    public get socket() {
+        return this._socket;
+    }
 
     public constructor(options: AdbSocketConstructionOptions) {
         Object.assign(this, options);
@@ -69,17 +91,22 @@ export class AdbSocketController implements AdbSocketInfo, ReadableWritablePair<
             },
             dispose: () => {
                 // Error out the pending writes
-                this._writePromise?.reject(new Error('Socket closed'));
+                this._writePromise?.reject(new Error("Socket closed"));
             },
         });
 
         this._readable = this._duplex.wrapReadable(
-            new PushReadableStream(controller => {
-                this._readableController = controller;
-            }, {
-                highWaterMark: options.highWaterMark ?? 16 * 1024,
-                size(chunk) { return chunk.byteLength; }
-            })
+            new PushReadableStream(
+                (controller) => {
+                    this._readableController = controller;
+                },
+                {
+                    highWaterMark: options.highWaterMark ?? 16 * 1024,
+                    size(chunk) {
+                        return chunk.byteLength;
+                    },
+                }
+            )
         );
 
         this.writable = pipeFrom(
@@ -95,8 +122,8 @@ export class AdbSocketController implements AdbSocketInfo, ReadableWritablePair<
                             chunk
                         );
                         await this._writePromise.promise;
-                    }
-                }),
+                    },
+                })
             ),
             new ChunkStream(this.dispatcher.options.maxPayloadSize)
         );
@@ -123,7 +150,7 @@ export class AdbSocketController implements AdbSocketInfo, ReadableWritablePair<
     }
 
     public dispose() {
-        this._duplex.dispose();
+        return this._duplex.dispose();
     }
 }
 
@@ -135,16 +162,30 @@ export class AdbSocketController implements AdbSocketInfo, ReadableWritablePair<
  * `socket.writable.abort()`, `socket.writable.getWriter().abort()`,
  * `socket.writable.close()` or `socket.writable.getWriter().close()`.
  */
-export class AdbSocket implements AdbSocketInfo, ReadableWritablePair<Uint8Array, Uint8Array>{
+export class AdbSocket
+    implements AdbSocketInfo, ReadableWritablePair<Uint8Array, Uint8Array>
+{
     private _controller: AdbSocketController;
 
-    public get localId(): number { return this._controller.localId; }
-    public get remoteId(): number { return this._controller.remoteId; }
-    public get localCreated(): boolean { return this._controller.localCreated; }
-    public get serviceString(): string { return this._controller.serviceString; }
+    public get localId(): number {
+        return this._controller.localId;
+    }
+    public get remoteId(): number {
+        return this._controller.remoteId;
+    }
+    public get localCreated(): boolean {
+        return this._controller.localCreated;
+    }
+    public get serviceString(): string {
+        return this._controller.serviceString;
+    }
 
-    public get readable(): ReadableStream<Uint8Array> { return this._controller.readable; }
-    public get writable(): WritableStream<Uint8Array> { return this._controller.writable; }
+    public get readable(): ReadableStream<Uint8Array> {
+        return this._controller.readable;
+    }
+    public get writable(): WritableStream<Uint8Array> {
+        return this._controller.writable;
+    }
 
     public constructor(controller: AdbSocketController) {
         this._controller = controller;

package/src/utils/auto-reset-event.ts

@@ -1,5 +1,5 @@
-import { PromiseResolver } from '@yume-chan/async';
-import type { Disposable } from '@yume-chan/event';
+import { PromiseResolver } from "@yume-chan/async";
+import { type Disposable } from "@yume-chan/event";
 
 export class AutoResetEvent implements Disposable {
     private readonly list: PromiseResolver<void>[] = [];
@@ -34,7 +34,7 @@ export class AutoResetEvent implements Disposable {
 
     public dispose() {
         for (const item of this.list) {
-            item.reject(new Error('The AutoResetEvent has been disposed'));
+            item.reject(new Error("The AutoResetEvent has been disposed"));
         }
         this.list.length = 0;
     }