@yume-chan/adb 0.0.13 → 0.0.16

package/src/commands/subprocess/index.ts

@@ -1,139 +1,139 @@
-import type { Adb } from '../../adb.js';
-import { DecodeUtf8Stream, GatherStringStream } from "../../stream/index.js";
-import { AdbSubprocessNoneProtocol, AdbSubprocessShellProtocol, type AdbSubprocessProtocol, type AdbSubprocessProtocolConstructor } from './protocols/index.js';
-
-export * from './protocols/index.js';
-export * from './utils.js';
-
-export interface AdbSubprocessOptions {
-    /**
-     * A list of `AdbSubprocessProtocolConstructor`s to be used.
-     *
-     * Different `AdbSubprocessProtocol` has different capabilities, thus requires specific adaptations.
-     * Check their documentations for details.
-     *
-     * The first protocol whose `isSupported` returns `true` will be used.
-     * If no `AdbSubprocessProtocol` is supported, an error will be thrown.
-     *
-     * @default [AdbSubprocessShellProtocol, AdbSubprocessNoneProtocol]
-     */
-    protocols: AdbSubprocessProtocolConstructor[];
-}
-
-const DEFAULT_OPTIONS: AdbSubprocessOptions = {
-    protocols: [AdbSubprocessShellProtocol, AdbSubprocessNoneProtocol],
-};
-
-export interface AdbSubprocessWaitResult {
-    stdout: string;
-    stderr: string;
-    exitCode: number;
-}
-
-export class AdbSubprocess {
-    public readonly adb: Adb;
-
-    public constructor(adb: Adb) {
-        this.adb = adb;
-    }
-
-    private async createProtocol(
-        mode: 'pty' | 'raw',
-        command?: string | string[],
-        options?: Partial<AdbSubprocessOptions>
-    ): Promise<AdbSubprocessProtocol> {
-        const { protocols } = { ...DEFAULT_OPTIONS, ...options };
-
-        let Constructor: AdbSubprocessProtocolConstructor | undefined;
-        for (const item of protocols) {
-            // It's async so can't use `Array#find`
-            if (await item.isSupported(this.adb)) {
-                Constructor = item;
-                break;
-            }
-        }
-
-        if (!Constructor) {
-            throw new Error('No specified protocol is supported by the device');
-        }
-
-        if (Array.isArray(command)) {
-            command = command.join(' ');
-        } else if (command === undefined) {
-            // spawn the default shell
-            command = '';
-        }
-        return await Constructor[mode](this.adb, command);
-    }
-
-    /**
-     * Spawns an executable in PTY (interactive) mode.
-     * @param command The command to run. If omitted, the default shell will be spawned.
-     * @param options The options for creating the `AdbSubprocessProtocol`
-     * @returns A new `AdbSubprocessProtocol` instance connecting to the spawned process.
-     */
-    public shell(
-        command?: string | string[],
-        options?: Partial<AdbSubprocessOptions>
-    ): Promise<AdbSubprocessProtocol> {
-        return this.createProtocol('pty', command, options);
-    }
-
-    /**
-     * Spawns an executable and pipe the output.
-     * @param command The command to run, or an array of strings containing both command and args.
-     * @param options The options for creating the `AdbSubprocessProtocol`
-     * @returns A new `AdbSubprocessProtocol` instance connecting to the spawned process.
-     */
-    public spawn(
-        command: string | string[],
-        options?: Partial<AdbSubprocessOptions>
-    ): Promise<AdbSubprocessProtocol> {
-        return this.createProtocol('raw', 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 `AdbSubprocessProtocol`
-     * @returns The entire output of the command
-     */
-    public async spawnAndWait(
-        command: string | string[],
-        options?: Partial<AdbSubprocessOptions>
-    ): Promise<AdbSubprocessWaitResult> {
-        const shell = await this.spawn(command, options);
-
-        const stdout = new GatherStringStream();
-        const stderr = new GatherStringStream();
-
-        const [, , exitCode] = await Promise.all([
-            shell.stdout
-                .pipeThrough(new DecodeUtf8Stream())
-                .pipeTo(stdout),
-            shell.stderr
-                .pipeThrough(new DecodeUtf8Stream())
-                .pipeTo(stderr),
-            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: [AdbSubprocessNoneProtocol] }
-        );
-        return stdout;
-    }
-}
+import type { Adb } from '../../adb.js';
+import { DecodeUtf8Stream, GatherStringStream } from "../../stream/index.js";
+import { AdbSubprocessNoneProtocol, AdbSubprocessShellProtocol, type AdbSubprocessProtocol, type AdbSubprocessProtocolConstructor } from './protocols/index.js';
+
+export * from './protocols/index.js';
+export * from './utils.js';
+
+export interface AdbSubprocessOptions {
+    /**
+     * A list of `AdbSubprocessProtocolConstructor`s to be used.
+     *
+     * Different `AdbSubprocessProtocol` has different capabilities, thus requires specific adaptations.
+     * Check their documentations for details.
+     *
+     * The first protocol whose `isSupported` returns `true` will be used.
+     * If no `AdbSubprocessProtocol` is supported, an error will be thrown.
+     *
+     * @default [AdbSubprocessShellProtocol, AdbSubprocessNoneProtocol]
+     */
+    protocols: AdbSubprocessProtocolConstructor[];
+}
+
+const DEFAULT_OPTIONS: AdbSubprocessOptions = {
+    protocols: [AdbSubprocessShellProtocol, AdbSubprocessNoneProtocol],
+};
+
+export interface AdbSubprocessWaitResult {
+    stdout: string;
+    stderr: string;
+    exitCode: number;
+}
+
+export class AdbSubprocess {
+    public readonly adb: Adb;
+
+    public constructor(adb: Adb) {
+        this.adb = adb;
+    }
+
+    private async createProtocol(
+        mode: 'pty' | 'raw',
+        command?: string | string[],
+        options?: Partial<AdbSubprocessOptions>
+    ): Promise<AdbSubprocessProtocol> {
+        const { protocols } = { ...DEFAULT_OPTIONS, ...options };
+
+        let Constructor: AdbSubprocessProtocolConstructor | undefined;
+        for (const item of protocols) {
+            // It's async so can't use `Array#find`
+            if (await item.isSupported(this.adb)) {
+                Constructor = item;
+                break;
+            }
+        }
+
+        if (!Constructor) {
+            throw new Error('No specified protocol is supported by the device');
+        }
+
+        if (Array.isArray(command)) {
+            command = command.join(' ');
+        } else if (command === undefined) {
+            // spawn the default shell
+            command = '';
+        }
+        return await Constructor[mode](this.adb, command);
+    }
+
+    /**
+     * Spawns an executable in PTY (interactive) mode.
+     * @param command The command to run. If omitted, the default shell will be spawned.
+     * @param options The options for creating the `AdbSubprocessProtocol`
+     * @returns A new `AdbSubprocessProtocol` instance connecting to the spawned process.
+     */
+    public shell(
+        command?: string | string[],
+        options?: Partial<AdbSubprocessOptions>
+    ): Promise<AdbSubprocessProtocol> {
+        return this.createProtocol('pty', command, options);
+    }
+
+    /**
+     * Spawns an executable and pipe the output.
+     * @param command The command to run, or an array of strings containing both command and args.
+     * @param options The options for creating the `AdbSubprocessProtocol`
+     * @returns A new `AdbSubprocessProtocol` instance connecting to the spawned process.
+     */
+    public spawn(
+        command: string | string[],
+        options?: Partial<AdbSubprocessOptions>
+    ): Promise<AdbSubprocessProtocol> {
+        return this.createProtocol('raw', 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 `AdbSubprocessProtocol`
+     * @returns The entire output of the command
+     */
+    public async spawnAndWait(
+        command: string | string[],
+        options?: Partial<AdbSubprocessOptions>
+    ): Promise<AdbSubprocessWaitResult> {
+        const shell = await this.spawn(command, options);
+
+        const stdout = new GatherStringStream();
+        const stderr = new GatherStringStream();
+
+        const [, , exitCode] = await Promise.all([
+            shell.stdout
+                .pipeThrough(new DecodeUtf8Stream())
+                .pipeTo(stdout),
+            shell.stderr
+                .pipeThrough(new DecodeUtf8Stream())
+                .pipeTo(stderr),
+            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: [AdbSubprocessNoneProtocol] }
+        );
+        return stdout;
+    }
+}

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

@@ -1,68 +1,70 @@
-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 AdbSubprocessNoneProtocol implements AdbSubprocessProtocol {
-    public static isSupported() { return true; }
-
-    public static async pty(adb: Adb, command: string) {
-        return new AdbSubprocessNoneProtocol(await adb.createSocket(`shell:${command}`));
-    }
-
-    public static async raw(adb: Adb, command: string) {
-        // Native ADB client doesn't allow none protocol + raw mode,
-        // But ADB daemon supports it.
-        return new AdbSubprocessNoneProtocol(await adb.createSocket(`shell,raw:${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 mixes stdout and stderr.
-     */
-    public get stdout() { return this._stdout; }
-
-    private _stderr: ReadableStream<Uint8Array>;
-    /**
-     * `stderr` will always be empty.
-     */
-    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();
-    }
-}
+import type { Adb } from "../../../adb.js";
+import type { AdbSocket } from "../../../socket/index.js";
+import { DuplexStreamFactory, 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 AdbSubprocessNoneProtocol implements AdbSubprocessProtocol {
+    public static isSupported() { return true; }
+
+    public static async pty(adb: Adb, command: string) {
+        return new AdbSubprocessNoneProtocol(await adb.createSocket(`shell:${command}`));
+    }
+
+    public static async raw(adb: Adb, command: string) {
+        // `shell,raw:${command}` also triggers raw mode,
+        // But is not supported before Android 7.
+        return new AdbSubprocessNoneProtocol(await adb.createSocket(`exec:${command}`));
+    }
+
+    private readonly socket: AdbSocket;
+
+    private readonly duplex: DuplexStreamFactory<Uint8Array, Uint8Array>;
+
+    // Legacy shell forwards all data to stdin.
+    public get stdin() { return this.socket.writable; }
+
+    private _stdout: ReadableStream<Uint8Array>;
+    /**
+     * Legacy shell mixes stdout and stderr.
+     */
+    public get stdout() { return this._stdout; }
+
+    private _stderr: ReadableStream<Uint8Array>;
+    /**
+     * `stderr` will always be empty.
+     */
+    public get stderr() { return this._stderr; }
+
+    private _exit: Promise<number>;
+    public get exit() { return this._exit; }
+
+    public constructor(socket: AdbSocket) {
+        this.socket = socket;
+
+        this.duplex = new DuplexStreamFactory<Uint8Array, Uint8Array>({
+            close: async () => {
+                await this.socket.close();
+            },
+        });
+
+        this._stdout = this.duplex.wrapReadable(this.socket.readable);
+        this._stderr = this.duplex.wrapReadable(new ReadableStream());
+        this._exit = this.duplex.closed.then(() => 0);
+    }
+
+    public resize() {
+        // Not supported
+    }
+
+    public kill() {
+        return this.duplex.close();
+    }
+}