@yume-chan/adb 0.0.20 → 0.0.22

package/src/adb.ts

@@ -1,5 +1,5 @@
 import type { Consumable, ReadableWritablePair } from "@yume-chan/stream-extra";
-import { DecodeUtf8Stream, GatherStringStream } from "@yume-chan/stream-extra";
+import { ConcatStringStream, DecodeUtf8Stream } from "@yume-chan/stream-extra";
 import type { ValueOrPromise } from "@yume-chan/struct";
 
 import type { AdbBanner } from "./banner.js";
@@ -15,20 +15,22 @@ import {
 } from "./commands/index.js";
 import type { AdbFeature } from "./features.js";
 
+export interface Closeable {
+    close(): ValueOrPromise<void>;
+}
+
 export interface AdbSocket
     extends ReadableWritablePair<Uint8Array, Consumable<Uint8Array>>,
         Closeable {
-    readonly service: string;
+    get service(): string;
+
+    get closed(): Promise<void>;
 }
 
 export type AdbIncomingSocketHandler = (
-    socket: AdbSocket
+    socket: AdbSocket,
 ) => ValueOrPromise<void>;
 
-export interface Closeable {
-    close(): ValueOrPromise<void>;
-}
-
 export interface AdbTransport extends Closeable {
     readonly serial: string;
 
@@ -42,7 +44,7 @@ export interface AdbTransport extends Closeable {
 
     addReverseTunnel(
         handler: AdbIncomingSocketHandler,
-        address?: string
+        address?: string,
     ): ValueOrPromise<string>;
 
     removeReverseTunnel(address: string): ValueOrPromise<void>;
@@ -51,30 +53,30 @@ export interface AdbTransport extends Closeable {
 }
 
 export class Adb implements Closeable {
-    public readonly transport: AdbTransport;
+    readonly transport: AdbTransport;
 
-    public get serial() {
+    get serial() {
         return this.transport.serial;
     }
 
-    public get maxPayloadSize() {
+    get maxPayloadSize() {
         return this.transport.maxPayloadSize;
     }
 
-    public get banner() {
+    get banner() {
         return this.transport.banner;
     }
 
-    public get disconnected() {
+    get disconnected() {
         return this.transport.disconnected;
     }
 
-    public readonly subprocess: AdbSubprocess;
-    public readonly power: AdbPower;
-    public readonly reverse: AdbReverseCommand;
-    public readonly tcpip: AdbTcpIpCommand;
+    readonly subprocess: AdbSubprocess;
+    readonly power: AdbPower;
+    readonly reverse: AdbReverseCommand;
+    readonly tcpip: AdbTcpIpCommand;
 
-    public constructor(transport: AdbTransport) {
+    constructor(transport: AdbTransport) {
         this.transport = transport;
 
         this.subprocess = new AdbSubprocess(this);
@@ -83,24 +85,22 @@ export class Adb implements Closeable {
         this.tcpip = new AdbTcpIpCommand(this);
     }
 
-    public supportsFeature(feature: AdbFeature): boolean {
+    supportsFeature(feature: AdbFeature): boolean {
         return this.banner.features.includes(feature);
     }
 
-    public async createSocket(service: string): Promise<AdbSocket> {
+    async createSocket(service: string): Promise<AdbSocket> {
         return this.transport.connect(service);
     }
 
-    public async createSocketAndWait(service: string): Promise<string> {
+    async createSocketAndWait(service: string): Promise<string> {
         const socket = await this.createSocket(service);
-        const gatherStream = new GatherStringStream();
-        await socket.readable
+        return await socket.readable
             .pipeThrough(new DecodeUtf8Stream())
-            .pipeTo(gatherStream);
-        return gatherStream.result;
+            .pipeThrough(new ConcatStringStream());
     }
 
-    public async getProp(key: string): Promise<string> {
+    async getProp(key: string): Promise<string> {
         const stdout = await this.subprocess.spawnAndWaitLegacy([
             "getprop",
             key,
@@ -108,26 +108,40 @@ export class Adb implements Closeable {
         return stdout.trim();
     }
 
-    public async rm(...filenames: string[]): Promise<string> {
+    async rm(
+        filenames: string | string[],
+        options?: { recursive?: boolean; force?: boolean },
+    ): Promise<string> {
+        const args = ["rm"];
+        if (options?.recursive) {
+            args.push("-r");
+        }
+        if (options?.force) {
+            args.push("-f");
+        }
+        if (Array.isArray(filenames)) {
+            for (const filename of filenames) {
+                args.push(escapeArg(filename));
+            }
+        } else {
+            args.push(escapeArg(filenames));
+        }
         // https://android.googlesource.com/platform/packages/modules/adb/+/1a0fb8846d4e6b671c8aa7f137a8c21d7b248716/client/adb_install.cpp#984
-        const stdout = await this.subprocess.spawnAndWaitLegacy([
-            "rm",
-            ...filenames.map((arg) => escapeArg(arg)),
-            "</dev/null",
-        ]);
+        args.push("</dev/null");
+        const stdout = await this.subprocess.spawnAndWaitLegacy(args);
         return stdout;
     }
 
-    public async sync(): Promise<AdbSync> {
+    async sync(): Promise<AdbSync> {
         const socket = await this.createSocket("sync:");
         return new AdbSync(this, socket);
     }
 
-    public async framebuffer(): Promise<AdbFrameBuffer> {
+    async framebuffer(): Promise<AdbFrameBuffer> {
         return framebuffer(this);
     }
 
-    public async close(): Promise<void> {
+    async close(): Promise<void> {
         await this.transport.close();
     }
 }

package/src/banner.ts

@@ -8,7 +8,7 @@ export enum AdbBannerKey {
 }
 
 export class AdbBanner {
-    public static parse(banner: string) {
+    static parse(banner: string) {
         let product: string | undefined;
         let model: string | undefined;
         let device: string | undefined;
@@ -49,30 +49,30 @@ export class AdbBanner {
     }
 
     #product: string | undefined;
-    public get product() {
+    get product() {
         return this.#product;
     }
 
     #model: string | undefined;
-    public get model() {
+    get model() {
         return this.#model;
     }
 
     #device: string | undefined;
-    public get device() {
+    get device() {
         return this.#device;
     }
 
     #features: AdbFeature[] = [];
-    public get features() {
+    get features() {
         return this.#features;
     }
 
-    public constructor(
+    constructor(
         product: string | undefined,
         model: string | undefined,
         device: string | undefined,
-        features: AdbFeature[]
+        features: AdbFeature[],
     ) {
         this.#product = product;
         this.#model = model;

package/src/commands/base.ts

@@ -5,7 +5,7 @@ import type { Adb } from "../adb.js";
 export class AdbCommandBase extends AutoDisposable {
     protected adb: Adb;
 
-    public constructor(adb: Adb) {
+    constructor(adb: Adb) {
         super();
         this.adb = adb;
     }

package/src/commands/framebuffer.ts

@@ -1,5 +1,5 @@
 import { BufferedReadableStream } from "@yume-chan/stream-extra";
-import Struct from "@yume-chan/struct";
+import Struct, { StructEmptyError } from "@yume-chan/struct";
 
 import type { Adb } from "../adb.js";
 
@@ -58,10 +58,38 @@ export type AdbFrameBufferV2 = (typeof AdbFrameBufferV2)["TDeserializeResult"];
  */
 export type AdbFrameBuffer = AdbFrameBufferV1 | AdbFrameBufferV2;
 
+export abstract class AdbFrameBufferError extends Error {
+    constructor(message: string, options?: ErrorOptions) {
+        super(message, options);
+    }
+}
+
+export class AdbFrameBufferUnsupportedVersionError extends AdbFrameBufferError {
+    constructor(version: number) {
+        super(`Unsupported FrameBuffer version ${version}`);
+    }
+}
+
+export class AdbFrameBufferForbiddenError extends AdbFrameBufferError {
+    constructor() {
+        super("FrameBuffer is disabled by current app");
+    }
+}
+
 export async function framebuffer(adb: Adb): Promise<AdbFrameBuffer> {
     const socket = await adb.createSocket("framebuffer:");
     const stream = new BufferedReadableStream(socket.readable);
-    const { version } = await Version.deserialize(stream);
+
+    let version: number;
+    try {
+        ({ version } = await Version.deserialize(stream));
+    } catch (e) {
+        if (e instanceof StructEmptyError) {
+            throw new AdbFrameBufferForbiddenError();
+        }
+        throw e;
+    }
+
     switch (version) {
         case 1:
             // TODO: AdbFrameBuffer: does all v1 responses uses the same color space? Add it so the command returns same format for all versions.
@@ -69,6 +97,6 @@ export async function framebuffer(adb: Adb): Promise<AdbFrameBuffer> {
         case 2:
             return AdbFrameBufferV2.deserialize(stream);
         default:
-            throw new Error("Unsupported FrameBuffer version");
+            throw new AdbFrameBufferUnsupportedVersionError(version);
     }
 }

package/src/commands/power.ts

@@ -6,23 +6,23 @@
 import { AdbCommandBase } from "./base.js";
 
 export class AdbPower extends AdbCommandBase {
-    public reboot(mode = "") {
+    reboot(mode = "") {
         return this.adb.createSocketAndWait(`reboot:${mode}`);
     }
 
-    public bootloader() {
+    bootloader() {
         return this.reboot("bootloader");
     }
 
-    public fastboot() {
+    fastboot() {
         return this.reboot("fastboot");
     }
 
-    public recovery() {
+    recovery() {
         return this.reboot("recovery");
     }
 
-    public sideload() {
+    sideload() {
         return this.reboot("sideload");
     }
 
@@ -31,15 +31,15 @@ export class AdbPower extends AdbCommandBase {
      *
      * Only works on some Qualcomm devices.
      */
-    public qualcommEdlMode() {
+    qualcommEdlMode() {
         return this.reboot("edl");
     }
 
-    public powerOff() {
+    powerOff() {
         return this.adb.subprocess.spawnAndWaitLegacy(["reboot", "-p"]);
     }
 
-    public powerButton(longPress = false) {
+    powerButton(longPress = false) {
         return this.adb.subprocess.spawnAndWaitLegacy([
             "input",
             "keyevent",
@@ -52,7 +52,7 @@ export class AdbPower extends AdbCommandBase {
      *
      * Only works on Samsung devices.
      */
-    public samsungOdin() {
+    samsungOdin() {
         return this.reboot("download");
     }
 }

package/src/commands/reverse.ts

@@ -20,16 +20,16 @@ const AdbReverseStringResponse = new Struct()
     .string("content", { lengthField: "length", lengthFieldRadix: 16 });
 
 export class AdbReverseError extends Error {
-    public constructor(message: string) {
+    constructor(message: string) {
         super(message);
         Object.setPrototypeOf(this, new.target.prototype);
     }
 }
 
 export class AdbReverseNotSupportedError extends AdbReverseError {
-    public constructor() {
+    constructor() {
         super(
-            "ADB reverse tunnel is not supported on this device when connected wirelessly."
+            "ADB reverse tunnel is not supported on this device when connected wirelessly.",
         );
     }
 }
@@ -57,7 +57,7 @@ export class AdbReverseCommand extends AutoDisposable {
 
     readonly #deviceAddressToLocalAddress = new Map<string, string>();
 
-    public constructor(adb: Adb) {
+    constructor(adb: Adb) {
         super();
 
         this.adb = adb;
@@ -77,7 +77,7 @@ export class AdbReverseCommand extends AutoDisposable {
         return stream;
     }
 
-    public async list(): Promise<AdbForwardListener[]> {
+    async list(): Promise<AdbForwardListener[]> {
         const stream = await this.createBufferedStream("reverse:list-forward");
 
         const response = await AdbReverseStringResponse.deserialize(stream);
@@ -85,7 +85,7 @@ export class AdbReverseCommand extends AutoDisposable {
             const [deviceSerial, localName, remoteName] = line.split(" ") as [
                 string,
                 string,
-                string
+                string,
             ];
             return { deviceSerial, localName, remoteName };
         });
@@ -99,9 +99,9 @@ export class AdbReverseCommand extends AutoDisposable {
      * @param localAddress The address that listens on the local machine.
      * @returns `tcp:{ACTUAL_LISTENING_PORT}`, If `deviceAddress` is `tcp:0`; otherwise, `deviceAddress`.
      */
-    public async addExternal(deviceAddress: string, localAddress: string) {
+    async addExternal(deviceAddress: string, localAddress: string) {
         const stream = await this.sendRequest(
-            `reverse:forward:${deviceAddress};${localAddress}`
+            `reverse:forward:${deviceAddress};${localAddress}`,
         );
 
         // `tcp:0` tells the device to pick an available port.
@@ -137,14 +137,14 @@ export class AdbReverseCommand extends AutoDisposable {
      * @throws {AdbReverseNotSupportedError} If ADB reverse tunnel is not supported on this device when connected wirelessly.
      * @throws {AdbReverseError} If ADB daemon returns an error.
      */
-    public async add(
+    async add(
         deviceAddress: string,
         handler: AdbIncomingSocketHandler,
-        localAddress?: string
+        localAddress?: string,
     ): Promise<string> {
         localAddress = await this.adb.transport.addReverseTunnel(
             handler,
-            localAddress
+            localAddress,
         );
 
         try {
@@ -157,7 +157,7 @@ export class AdbReverseCommand extends AutoDisposable {
         }
     }
 
-    public async remove(deviceAddress: string): Promise<void> {
+    async remove(deviceAddress: string): Promise<void> {
         const localAddress =
             this.#deviceAddressToLocalAddress.get(deviceAddress);
         if (localAddress) {
@@ -169,7 +169,7 @@ export class AdbReverseCommand extends AutoDisposable {
         // No need to close the stream, device will close it
     }
 
-    public async removeAll(): Promise<void> {
+    async removeAll(): Promise<void> {
         await this.adb.transport.clearReverseTunnels();
         this.#deviceAddressToLocalAddress.clear();
 

package/src/commands/subprocess/command.ts

@@ -1,4 +1,4 @@
-import { DecodeUtf8Stream, GatherStringStream } from "@yume-chan/stream-extra";
+import { ConcatStringStream, DecodeUtf8Stream } from "@yume-chan/stream-extra";
 
 import { AdbCommandBase } from "../base.js";
 
@@ -37,10 +37,10 @@ export interface AdbSubprocessWaitResult {
 }
 
 export class AdbSubprocess extends AdbCommandBase {
-    private async createProtocol(
+    async #createProtocol(
         mode: "pty" | "raw",
         command?: string | string[],
-        options?: Partial<AdbSubprocessOptions>
+        options?: Partial<AdbSubprocessOptions>,
     ): Promise<AdbSubprocessProtocol> {
         const { protocols } = { ...DEFAULT_OPTIONS, ...options };
 
@@ -75,11 +75,11 @@ export class AdbSubprocess extends AdbCommandBase {
      * @param options The options for creating the `AdbSubprocessProtocol`
      * @returns A new `AdbSubprocessProtocol` instance connecting to the spawned process.
      */
-    public shell(
+    shell(
         command?: string | string[],
-        options?: Partial<AdbSubprocessOptions>
+        options?: Partial<AdbSubprocessOptions>,
     ): Promise<AdbSubprocessProtocol> {
-        return this.createProtocol("pty", command, options);
+        return this.#createProtocol("pty", command, options);
     }
 
     /**
@@ -91,11 +91,11 @@ export class AdbSubprocess extends AdbCommandBase {
      * @param options The options for creating the `AdbSubprocessProtocol`
      * @returns A new `AdbSubprocessProtocol` instance connecting to the spawned process.
      */
-    public spawn(
+    spawn(
         command: string | string[],
-        options?: Partial<AdbSubprocessOptions>
+        options?: Partial<AdbSubprocessOptions>,
     ): Promise<AdbSubprocessProtocol> {
-        return this.createProtocol("raw", command, options);
+        return this.#createProtocol("raw", command, options);
     }
 
     /**
@@ -104,24 +104,25 @@ export class AdbSubprocess extends AdbCommandBase {
      * @param options The options for creating the `AdbSubprocessProtocol`
      * @returns The entire output of the command
      */
-    public async spawnAndWait(
+    async spawnAndWait(
         command: string | string[],
-        options?: Partial<AdbSubprocessOptions>
+        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,
+        const process = await this.spawn(command, options);
+
+        const [stdout, stderr, exitCode] = await Promise.all([
+            process.stdout
+                .pipeThrough(new DecodeUtf8Stream())
+                .pipeThrough(new ConcatStringStream()),
+            process.stderr
+                .pipeThrough(new DecodeUtf8Stream())
+                .pipeThrough(new ConcatStringStream()),
+            process.exit,
         ]);
 
         return {
-            stdout: stdout.result,
-            stderr: stderr.result,
+            stdout,
+            stderr,
             exitCode,
         };
     }
@@ -131,9 +132,7 @@ export class AdbSubprocess extends AdbCommandBase {
      * @param command The command to run
      * @returns The entire output of the command
      */
-    public async spawnAndWaitLegacy(
-        command: string | string[]
-    ): Promise<string> {
+    async spawnAndWaitLegacy(command: string | string[]): Promise<string> {
         const { stdout } = await this.spawnAndWait(command, {
             protocols: [AdbSubprocessNoneProtocol],
         });

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

@@ -1,6 +1,8 @@
-import { DuplexStreamFactory, ReadableStream } from "@yume-chan/stream-extra";
+import type { Consumable, WritableStream } from "@yume-chan/stream-extra";
+import { ReadableStream } from "@yume-chan/stream-extra";
 
 import type { Adb, AdbSocket } from "../../../adb.js";
+import { unreachable } from "../../../utils/index.js";
 
 import type { AdbSubprocessProtocol } from "./types.js";
 
@@ -13,75 +15,69 @@ import type { AdbSubprocessProtocol } from "./types.js";
  * * `resize`: No
  */
 export class AdbSubprocessNoneProtocol implements AdbSubprocessProtocol {
-    public static isSupported() {
+    static isSupported() {
         return true;
     }
 
-    public static async pty(adb: Adb, command: string) {
+    static async pty(adb: Adb, command: string) {
         return new AdbSubprocessNoneProtocol(
-            await adb.createSocket(`shell:${command}`)
+            await adb.createSocket(`shell:${command}`),
         );
     }
 
-    public static async raw(adb: Adb, command: string) {
+    static async raw(adb: Adb, command: string) {
         // `shell,raw:${command}` also triggers raw mode,
         // But is not supported on Android version <7.
         return new AdbSubprocessNoneProtocol(
-            await adb.createSocket(`exec:${command}`)
+            await adb.createSocket(`exec:${command}`),
         );
     }
 
     readonly #socket: AdbSocket;
 
-    readonly #duplex: DuplexStreamFactory<Uint8Array, Uint8Array>;
-
     // Legacy shell forwards all data to stdin.
-    public get stdin() {
+    get stdin(): WritableStream<Consumable<Uint8Array>> {
         return this.#socket.writable;
     }
 
-    #stdout: ReadableStream<Uint8Array>;
     /**
      * Legacy shell mixes stdout and stderr.
      */
-    public get stdout() {
-        return this.#stdout;
+    get stdout(): ReadableStream<Uint8Array> {
+        return this.#socket.readable;
     }
 
     #stderr: ReadableStream<Uint8Array>;
     /**
      * `stderr` will always be empty.
      */
-    public get stderr() {
+    get stderr(): ReadableStream<Uint8Array> {
         return this.#stderr;
     }
 
     #exit: Promise<number>;
-    public get exit() {
+    get exit() {
         return this.#exit;
     }
 
-    public constructor(socket: AdbSocket) {
+    constructor(socket: AdbSocket) {
         this.#socket = socket;
 
-        // Link `stdout`, `stderr` and `stdin` together,
-        // so closing any of them will close the others.
-        this.#duplex = new DuplexStreamFactory<Uint8Array, Uint8Array>({
-            close: async () => {
-                await this.#socket.close();
+        this.#stderr = new ReadableStream({
+            start: (controller) => {
+                this.#socket.closed
+                    .then(() => controller.close())
+                    .catch(unreachable);
             },
         });
-
-        this.#stdout = this.#duplex.wrapReadable(this.#socket.readable);
-        this.#stderr = this.#duplex.wrapReadable(new ReadableStream());
-        this.#exit = this.#duplex.closed.then(() => 0);
+        this.#exit = socket.closed.then(() => 0);
     }
 
-    public resize() {
+    resize() {
         // Not supported, but don't throw.
     }
 
-    public kill() {
-        return this.#duplex.close();
+    async kill() {
+        await this.#socket.close();
     }
 }