@yume-chan/adb 0.0.9 → 0.0.12

package/src/commands/reverse.ts

@@ -1,133 +1,136 @@
-import { AutoDisposable } from '@yume-chan/event';
-import Struct from '@yume-chan/struct';
-import { AdbPacket } from '../packet';
-import { AdbIncomingSocketEventArgs, AdbPacketDispatcher, AdbSocket } from '../socket';
-import { AdbBufferedStream } from '../stream';
-
-export interface AdbReverseHandler {
-    onSocket(packet: AdbPacket, socket: AdbSocket): void;
-}
-
-export interface AdbForwardListener {
-    deviceSerial: string;
-
-    localName: string;
-
-    remoteName: string;
-}
-
-const AdbReverseStringResponse =
-    new Struct({ littleEndian: true })
-        .string('length', { length: 4 })
-        .string('content', { lengthField: 'length', lengthFieldBase: 16 });
-
-const AdbReverseErrorResponse =
-    new Struct({ littleEndian: true })
-        .fields(AdbReverseStringResponse)
-        .postDeserialize((value) => {
-            throw new Error(value.content);
-        });
-
-export class AdbReverseCommand extends AutoDisposable {
-    protected localPortToHandler = new Map<number, AdbReverseHandler>();
-
-    protected deviceAddressToLocalPort = new Map<string, number>();
-
-    protected dispatcher: AdbPacketDispatcher;
-
-    protected listening = false;
-
-    public constructor(dispatcher: AdbPacketDispatcher) {
-        super();
-
-        this.dispatcher = dispatcher;
-        this.addDisposable(this.dispatcher.onIncomingSocket(this.handleIncomingSocket, this));
-    }
-
-    protected handleIncomingSocket(e: AdbIncomingSocketEventArgs): void {
-        if (e.handled) {
-            return;
-        }
-
-        const address = this.dispatcher.backend.decodeUtf8(e.packet.payload!);
-        // tcp:1234\0
-        const port = Number.parseInt(address.substring(4));
-        if (this.localPortToHandler.has(port)) {
-            this.localPortToHandler.get(port)!.onSocket(e.packet, e.socket);
-            e.handled = true;
-        }
-    }
-
-    private async createBufferedStream(service: string) {
-        const socket = await this.dispatcher.createSocket(service);
-        return new AdbBufferedStream(socket);
-    }
-
-    private async sendRequest(service: string) {
-        const stream = await this.createBufferedStream(service);
-        const success = this.dispatcher.backend.decodeUtf8(await stream.read(4)) === 'OKAY';
-        if (!success) {
-            await AdbReverseErrorResponse.deserialize(stream);
-        }
-        return stream;
-    }
-
-    public async list(): Promise<AdbForwardListener[]> {
-        const stream = await this.createBufferedStream('reverse:list-forward');
-
-        const response = await AdbReverseStringResponse.deserialize(stream);
-        return response.content!.split('\n').map(line => {
-            const [deviceSerial, localName, remoteName] = line.split(' ');
-            return { deviceSerial, localName, remoteName };
-        });
-
-        // No need to close the stream, device will close it
-    }
-
-    /**
-     * @param deviceAddress The address adbd on device is listening on. Can be `tcp:0` to let adbd choose an available TCP port by itself.
-     * @param localPort Native ADB will open a connection to localPort when reverse connection starts. In webadb, it's only used to uniquely identify a reverse registry, `handler` will be called on connection.
-     * @param handler A callback to handle incoming connections
-     * @returns If `deviceAddress` is `tcp:0`, return `tcp:{ACTUAL_LISTENING_PORT}`; otherwise, return `deviceAddress`.
-     */
-    public async add(
-        deviceAddress: string,
-        localPort: number,
-        handler: AdbReverseHandler,
-    ): Promise<string> {
-        const stream = await this.sendRequest(`reverse:forward:${deviceAddress};tcp:${localPort}`);
-
-        // `tcp:0` tells the device to pick an available port.
-        // However, device will response with the selected port for all `tcp:` requests.
-        if (deviceAddress.startsWith('tcp:')) {
-            const response = await AdbReverseStringResponse.deserialize(stream);
-            deviceAddress = `tcp:${Number.parseInt(response.content!, 10)}`;
-        }
-
-        this.localPortToHandler.set(localPort, handler);
-        this.deviceAddressToLocalPort.set(deviceAddress, localPort);
-        return deviceAddress;
-
-        // No need to close the stream, device will close it
-    }
-
-    public async remove(deviceAddress: string): Promise<void> {
-        await this.sendRequest(`reverse:killforward:${deviceAddress}`);
-
-        if (this.deviceAddressToLocalPort.has(deviceAddress)) {
-            this.localPortToHandler.delete(this.deviceAddressToLocalPort.get(deviceAddress)!);
-            this.deviceAddressToLocalPort.delete(deviceAddress);
-        }
-
-        // No need to close the stream, device will close it
-    }
-
-    public async removeAll(): Promise<void> {
-        await this.sendRequest(`reverse:killforward-all`);
-
-        this.deviceAddressToLocalPort.clear();
-        this.localPortToHandler.clear();
-
-        // No need to close the stream, device will close it
-    }
-}
+// cspell: ignore killforward
+
+import { AutoDisposable } from '@yume-chan/event';
+import Struct from '@yume-chan/struct';
+import type { AdbPacketCore } from '../packet.js';
+import type { AdbIncomingSocketEventArgs, AdbPacketDispatcher, AdbSocket } from '../socket/index.js';
+import { AdbBufferedStream } from '../stream/index.js';
+import { decodeUtf8 } from "../utils/index.js";
+
+export interface AdbReverseHandler {
+    onSocket(packet: AdbPacketCore, socket: AdbSocket): void;
+}
+
+export interface AdbForwardListener {
+    deviceSerial: string;
+
+    localName: string;
+
+    remoteName: string;
+}
+
+const AdbReverseStringResponse =
+    new Struct({ littleEndian: true })
+        .string('length', { length: 4 })
+        .string('content', { lengthField: 'length', lengthFieldBase: 16 });
+
+const AdbReverseErrorResponse =
+    new Struct({ littleEndian: true })
+        .fields(AdbReverseStringResponse)
+        .postDeserialize((value) => {
+            throw new Error(value.content);
+        });
+
+export class AdbReverseCommand extends AutoDisposable {
+    protected localPortToHandler = new Map<number, AdbReverseHandler>();
+
+    protected deviceAddressToLocalPort = new Map<string, number>();
+
+    protected dispatcher: AdbPacketDispatcher;
+
+    protected listening = false;
+
+    public constructor(dispatcher: AdbPacketDispatcher) {
+        super();
+
+        this.dispatcher = dispatcher;
+        this.addDisposable(this.dispatcher.onIncomingSocket(this.handleIncomingSocket, this));
+    }
+
+    protected handleIncomingSocket(e: AdbIncomingSocketEventArgs): void {
+        if (e.handled) {
+            return;
+        }
+
+        const address = decodeUtf8(e.packet.payload);
+        // Address format: `tcp:12345\0`
+        const port = Number.parseInt(address.substring(4));
+        if (this.localPortToHandler.has(port)) {
+            this.localPortToHandler.get(port)!.onSocket(e.packet, e.socket);
+            e.handled = true;
+        }
+    }
+
+    private async createBufferedStream(service: string) {
+        const socket = await this.dispatcher.createSocket(service);
+        return new AdbBufferedStream(socket);
+    }
+
+    private async sendRequest(service: string) {
+        const stream = await this.createBufferedStream(service);
+        const success = decodeUtf8(await stream.read(4)) === 'OKAY';
+        if (!success) {
+            await AdbReverseErrorResponse.deserialize(stream);
+        }
+        return stream;
+    }
+
+    public async list(): Promise<AdbForwardListener[]> {
+        const stream = await this.createBufferedStream('reverse:list-forward');
+
+        const response = await AdbReverseStringResponse.deserialize(stream);
+        return response.content!.split('\n').map(line => {
+            const [deviceSerial, localName, remoteName] = line.split(' ') as [string, string, string];
+            return { deviceSerial, localName, remoteName };
+        });
+
+        // No need to close the stream, device will close it
+    }
+
+    /**
+     * @param deviceAddress The address adbd on device is listening on. Can be `tcp:0` to let adbd choose an available TCP port by itself.
+     * @param localPort Native ADB will open a connection to localPort when reverse connection starts. In webadb, it's only used to uniquely identify a reverse registry, `handler` will be called on connection.
+     * @param handler A callback to handle incoming connections
+     * @returns If `deviceAddress` is `tcp:0`, return `tcp:{ACTUAL_LISTENING_PORT}`; otherwise, return `deviceAddress`.
+     */
+    public async add(
+        deviceAddress: string,
+        localPort: number,
+        handler: AdbReverseHandler,
+    ): Promise<string> {
+        const stream = await this.sendRequest(`reverse:forward:${deviceAddress};tcp:${localPort}`);
+
+        // `tcp:0` tells the device to pick an available port.
+        // However, device will response with the selected port for all `tcp:` requests.
+        if (deviceAddress.startsWith('tcp:')) {
+            const response = await AdbReverseStringResponse.deserialize(stream);
+            deviceAddress = `tcp:${Number.parseInt(response.content!, 10)}`;
+        }
+
+        this.localPortToHandler.set(localPort, handler);
+        this.deviceAddressToLocalPort.set(deviceAddress, localPort);
+        return deviceAddress;
+
+        // No need to close the stream, device will close it
+    }
+
+    public async remove(deviceAddress: string): Promise<void> {
+        await this.sendRequest(`reverse:killforward:${deviceAddress}`);
+
+        if (this.deviceAddressToLocalPort.has(deviceAddress)) {
+            this.localPortToHandler.delete(this.deviceAddressToLocalPort.get(deviceAddress)!);
+            this.deviceAddressToLocalPort.delete(deviceAddress);
+        }
+
+        // No need to close the stream, device will close it
+    }
+
+    public async removeAll(): Promise<void> {
+        await this.sendRequest(`reverse:killforward-all`);
+
+        this.deviceAddressToLocalPort.clear();
+        this.localPortToHandler.clear();
+
+        // No need to close the stream, device will close it
+    }
+}

package/src/commands/subprocess/index.ts

@@ -0,0 +1,124 @@
+import type { Adb } from '../../adb.js';
+import { DecodeUtf8Stream, GatherStringStream } from "../../stream/index.js";
+import { AdbNoneSubprocessProtocol } from './legacy.js';
+import { AdbShellSubprocessProtocol } from './protocol.js';
+import type { AdbSubprocessProtocol, AdbSubprocessProtocolConstructor } from './types.js';
+
+export * from './legacy.js';
+export * from './protocol.js';
+export * from './types.js';
+export * from './utils.js';
+
+export interface AdbSubprocessOptions {
+    /**
+     * A list of `AdbShellConstructor`s to be used.
+     *
+     * Different `AdbShell` has different capabilities, thus requires specific adaptations.
+     * Check each `AdbShell`'s documentation for details.
+     *
+     * The first one whose `isSupported` returns `true` will be used.
+     * If no `AdbShell` is supported, an error will be thrown.
+     *
+     * The default value is `[AdbShellProtocol, AdbLegacyShell]`.
+     */
+    protocols: AdbSubprocessProtocolConstructor[];
+}
+
+const DefaultOptions: AdbSubprocessOptions = {
+    protocols: [AdbShellSubprocessProtocol, AdbNoneSubprocessProtocol],
+};
+
+export interface SubprocessResult {
+    stdout: string;
+    stderr: string;
+    exitCode: number;
+}
+
+export class AdbSubprocess {
+    public readonly adb: Adb;
+
+    public constructor(adb: Adb) {
+        this.adb = adb;
+    }
+
+    private async createProtocol(command: string, options?: Partial<AdbSubprocessOptions>): Promise<AdbSubprocessProtocol> {
+        let { protocols } = { ...DefaultOptions, ...options };
+
+        let Constructor: AdbSubprocessProtocolConstructor | undefined;
+        for (const item of protocols) {
+            if (await item.isSupported(this.adb)) {
+                Constructor = item;
+                break;
+            }
+        }
+
+        if (!Constructor) {
+            throw new Error('No specified protocol is supported by the device');
+        }
+
+        return await Constructor.spawn(this.adb, command);
+    }
+
+    /**
+     * Spawns the default shell in interactive mode.
+     * @param options The options for creating the `AdbShell`
+     * @returns A new `AdbShell` instance connecting to the spawned shell process.
+     */
+    public shell(options?: Partial<AdbSubprocessOptions>): Promise<AdbSubprocessProtocol> {
+        return this.createProtocol('', options);
+    }
+
+    /**
+     * Spawns a new process using the given `command`.
+     * @param command The command to run, or an array of strings containing both command and args.
+     * @param options The options for creating the `AdbShell`
+     * @returns A new `AdbShell` instance connecting to the spawned process.
+     */
+    public spawn(command: string | string[], options?: Partial<AdbSubprocessOptions>): Promise<AdbSubprocessProtocol> {
+        if (Array.isArray(command)) {
+            command = command.join(' ');
+        }
+        return this.createProtocol(command, options);
+    }
+
+    /**
+     * Spawns a new process, waits until it exits, and returns the entire output.
+     * @param command The command to run
+     * @param options The options for creating the `AdbShell`
+     * @returns The entire output of the command
+     */
+    public async spawnAndWait(
+        command: string | string[],
+        options?: Partial<AdbSubprocessOptions>
+    ): Promise<SubprocessResult> {
+        const shell = await this.spawn(command, options);
+
+        const stdout = new GatherStringStream();
+        shell.stdout
+            .pipeThrough(new DecodeUtf8Stream())
+            .pipeThrough(stdout);
+
+        const stderr = new GatherStringStream();
+        shell.stderr
+            .pipeThrough(new DecodeUtf8Stream())
+            .pipeThrough(stderr);
+
+        const exitCode = await shell.exit;
+
+        return {
+            stdout: stdout.result,
+            stderr: stderr.result,
+            exitCode,
+        };
+    }
+
+    /**
+     * Spawns a new process, waits until it exits, and returns the entire output.
+     * @param command The command to run
+     * @returns The entire output of the command
+     */
+    public async spawnAndWaitLegacy(command: string | string[]): Promise<string> {
+        const { stdout } = await this.spawnAndWait(command, { protocols: [AdbNoneSubprocessProtocol] });
+        return stdout;
+    }
+}

package/src/commands/subprocess/legacy.ts

@@ -0,0 +1,58 @@
+import type { Adb } from "../../adb.js";
+import type { AdbSocket } from "../../socket/index.js";
+import { DuplexStreamFactory, type ReadableStream } from "../../stream/index.js";
+import type { AdbSubprocessProtocol } from "./types.js";
+
+/**
+ * The legacy shell
+ *
+ * Features:
+ * * `stderr`: No
+ * * `exit` exit code: No
+ * * `resize`: No
+ */
+export class AdbNoneSubprocessProtocol implements AdbSubprocessProtocol {
+    public static isSupported() { return true; }
+
+    public static async spawn(adb: Adb, command: string) {
+        return new AdbNoneSubprocessProtocol(await adb.createSocket(`shell:${command}`));
+    }
+
+    private readonly socket: AdbSocket;
+
+    // Legacy shell forwards all data to stdin.
+    public get stdin() { return this.socket.writable; }
+
+    private _stdout: ReadableStream<Uint8Array>;
+    // Legacy shell doesn't support splitting output streams.
+    public get stdout() { return this._stdout; }
+
+    // `stderr` of Legacy shell is always empty.
+    private _stderr: ReadableStream<Uint8Array>;
+    public get stderr() { return this._stderr; }
+
+    private _exit: Promise<number>;
+    public get exit() { return this._exit; }
+
+    public constructor(socket: AdbSocket) {
+        this.socket = socket;
+
+        const factory = new DuplexStreamFactory<Uint8Array, Uint8Array>({
+            close: async () => {
+                await this.socket.close();
+            },
+        });
+
+        this._stdout = factory.createWrapReadable(this.socket.readable);
+        this._stderr = factory.createReadable();
+        this._exit = factory.closed.then(() => 0);
+    }
+
+    public resize() {
+        // Not supported
+    }
+
+    public kill() {
+        return this.socket.close();
+    }
+}

package/src/commands/subprocess/protocol.ts

@@ -0,0 +1,185 @@
+import { PromiseResolver } from "@yume-chan/async";
+import Struct, { placeholder, type StructValueType } from "@yume-chan/struct";
+import type { Adb } from "../../adb.js";
+import { AdbFeatures } from "../../features.js";
+import type { AdbSocket } from "../../socket/index.js";
+import { PushReadableStream, ReadableStream, StructDeserializeStream, StructSerializeStream, TransformStream, WritableStream, WritableStreamDefaultWriter, type PushReadableStreamController } from "../../stream/index.js";
+import { encodeUtf8 } from "../../utils/index.js";
+import type { AdbSubprocessProtocol } from "./types.js";
+
+export enum AdbShellProtocolId {
+    Stdin,
+    Stdout,
+    Stderr,
+    Exit,
+    CloseStdin,
+    WindowSizeChange,
+}
+
+// This packet format is used in both direction.
+const AdbShellProtocolPacket = new Struct({ littleEndian: true })
+    .uint8('id', placeholder<AdbShellProtocolId>())
+    .uint32('length')
+    .uint8Array('data', { lengthField: 'length' });
+
+type AdbShellProtocolPacketInit = typeof AdbShellProtocolPacket['TInit'];
+
+type AdbShellProtocolPacket = StructValueType<typeof AdbShellProtocolPacket>;
+
+class StdinSerializeStream extends TransformStream<Uint8Array, AdbShellProtocolPacketInit>{
+    constructor() {
+        super({
+            transform(chunk, controller) {
+                controller.enqueue({
+                    id: AdbShellProtocolId.Stdin,
+                    data: chunk,
+                });
+            },
+            flush() {
+                // TODO: AdbShellSubprocessProtocol: support closing stdin
+            }
+        });
+    }
+}
+
+class StdoutDeserializeStream extends TransformStream<AdbShellProtocolPacket, Uint8Array>{
+    constructor(type: AdbShellProtocolId.Stdout | AdbShellProtocolId.Stderr) {
+        super({
+            transform(chunk, controller) {
+                if (chunk.id === type) {
+                    controller.enqueue(chunk.data);
+                }
+            },
+        });
+    }
+}
+
+class MultiplexStream<T>{
+    private _readable: PushReadableStream<T>;
+    private _readableController!: PushReadableStreamController<T>;
+    public get readable() { return this._readable; }
+
+    private _activeCount = 0;
+
+    constructor() {
+        this._readable = new PushReadableStream(controller => {
+            this._readableController = controller;
+        });
+    }
+
+    public createWriteable() {
+        return new WritableStream<T>({
+            start: () => {
+                this._activeCount += 1;
+            },
+            write: async (chunk) => {
+                await this._readableController.enqueue(chunk);
+            },
+            abort: async (e) => {
+                this._activeCount -= 1;
+                if (this._activeCount === 0) {
+                    this._readableController.close();
+                }
+            },
+            close: async () => {
+                this._activeCount -= 1;
+                if (this._activeCount === 0) {
+                    this._readableController.close();
+                }
+            },
+        });
+    }
+}
+
+/**
+ * Shell v2 a.k.a Shell Protocol
+ *
+ * Features:
+ * * `stderr`: Yes
+ * * `exit` exit code: Yes
+ * * `resize`: Yes
+ */
+export class AdbShellSubprocessProtocol implements AdbSubprocessProtocol {
+    public static isSupported(adb: Adb) {
+        return adb.features!.includes(AdbFeatures.ShellV2);
+    }
+
+    public static async spawn(adb: Adb, command: string) {
+        // TODO: AdbShellSubprocessProtocol: Support raw mode
+        // TODO: AdbShellSubprocessProtocol: Support setting `XTERM` environment variable
+        return new AdbShellSubprocessProtocol(await adb.createSocket(`shell,v2,pty:${command}`));
+    }
+
+    private readonly _socket: AdbSocket;
+    private _socketWriter: WritableStreamDefaultWriter<AdbShellProtocolPacketInit>;
+
+    private _stdin: WritableStream<Uint8Array>;
+    public get stdin() { return this._stdin; }
+
+    private _stdout: ReadableStream<Uint8Array>;
+    public get stdout() { return this._stdout; }
+
+    private _stderr: ReadableStream<Uint8Array>;
+    public get stderr() { return this._stderr; }
+
+    private readonly _exit = new PromiseResolver<number>();
+    public get exit() { return this._exit.promise; }
+
+    public constructor(socket: AdbSocket) {
+        this._socket = socket;
+
+        // Check this image to help you understand the stream graph
+        // cspell: disable-next-line
+        // https://www.plantuml.com/plantuml/png/bL91QiCm4Bpx5SAdv90lb1JISmiw5XzaQKf5PIkiLZIqzEyLSg8ks13gYtOykpFhiOw93N6UGjVDqK7rZsxKqNw0U_NTgVAy4empOy2mm4_olC0VEVEE47GUpnGjKdgXoD76q4GIEpyFhOwP_m28hW0NNzxNUig1_JdW0bA7muFIJDco1daJ_1SAX9bgvoPJPyIkSekhNYctvIGXrCH6tIsPL5fs-s6J5yc9BpWXhKtNdF2LgVYPGM_6GlMwfhWUsIt4lbScANrwlgVVUifPSVi__t44qStnwPvZwobdSmHHlL57p2vFuHS0
+
+        // TODO: AdbShellSubprocessProtocol: Optimize stream graph
+
+        const [stdout, stderr] = socket.readable
+            .pipeThrough(new StructDeserializeStream(AdbShellProtocolPacket))
+            .pipeThrough(new TransformStream<AdbShellProtocolPacket, AdbShellProtocolPacket>({
+                transform: (chunk, controller) => {
+                    if (chunk.id === AdbShellProtocolId.Exit) {
+                        this._exit.resolve(new Uint8Array(chunk.data)[0]!);
+                        // We can let `StdoutTransformStream` to process `AdbShellProtocolId.Exit`,
+                        // but since we need this `TransformStream` to capture the exit code anyway,
+                        // terminating child streams here is killing two birds with one stone.
+                        controller.terminate();
+                        return;
+                    }
+                    controller.enqueue(chunk);
+                }
+            }))
+            .tee();
+        this._stdout = stdout
+            .pipeThrough(new StdoutDeserializeStream(AdbShellProtocolId.Stdout));
+        this._stderr = stderr
+            .pipeThrough(new StdoutDeserializeStream(AdbShellProtocolId.Stderr));
+
+        const multiplexer = new MultiplexStream<AdbShellProtocolPacketInit>();
+        multiplexer.readable
+            .pipeThrough(new StructSerializeStream(AdbShellProtocolPacket))
+            .pipeTo(socket.writable);
+
+        const { readable, writable } = new StdinSerializeStream();
+        this._stdin = writable;
+        readable.pipeTo(multiplexer.createWriteable());
+
+        this._socketWriter = multiplexer.createWriteable().getWriter();
+    }
+
+    public async resize(rows: number, cols: number) {
+        await this._socketWriter.write({
+            id: AdbShellProtocolId.WindowSizeChange,
+            data: encodeUtf8(
+                // The "correct" format is `${rows}x${cols},${x_pixels}x${y_pixels}`
+                // However, according to https://linux.die.net/man/4/tty_ioctl
+                // `x_pixels` and `y_pixels` are not used, so always passing `0` is fine.
+                `${rows}x${cols},0x0\0`
+            ),
+        });
+    }
+
+    public kill() {
+        return this._socket.close();
+    }
+}