@yume-chan/adb 0.0.19 → 0.0.21

package/src/banner.ts

@@ -0,0 +1,82 @@
+import type { AdbFeature } from "./features.js";
+
+export enum AdbBannerKey {
+    Product = "ro.product.name",
+    Model = "ro.product.model",
+    Device = "ro.product.device",
+    Features = "features",
+}
+
+export class AdbBanner {
+    static parse(banner: string) {
+        let product: string | undefined;
+        let model: string | undefined;
+        let device: string | undefined;
+        let features: AdbFeature[] = [];
+
+        const pieces = banner.split("::");
+        if (pieces.length > 1) {
+            const props = pieces[1]!;
+            for (const prop of props.split(";")) {
+                if (!prop) {
+                    continue;
+                }
+
+                const keyValue = prop.split("=");
+                if (keyValue.length !== 2) {
+                    continue;
+                }
+
+                const [key, value] = keyValue;
+                switch (key) {
+                    case AdbBannerKey.Product:
+                        product = value;
+                        break;
+                    case AdbBannerKey.Model:
+                        model = value;
+                        break;
+                    case AdbBannerKey.Device:
+                        device = value;
+                        break;
+                    case AdbBannerKey.Features:
+                        features = value!.split(",") as AdbFeature[];
+                        break;
+                }
+            }
+        }
+
+        return new AdbBanner(product, model, device, features);
+    }
+
+    #product: string | undefined;
+    get product() {
+        return this.#product;
+    }
+
+    #model: string | undefined;
+    get model() {
+        return this.#model;
+    }
+
+    #device: string | undefined;
+    get device() {
+        return this.#device;
+    }
+
+    #features: AdbFeature[] = [];
+    get features() {
+        return this.#features;
+    }
+
+    constructor(
+        product: string | undefined,
+        model: string | undefined,
+        device: string | undefined,
+        features: AdbFeature[],
+    ) {
+        this.#product = product;
+        this.#model = model;
+        this.#device = device;
+        this.#features = features;
+    }
+}

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 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(name = "") {
-        return this.adb.createSocketAndWait(`reboot:${name}`);
+    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

@@ -1,15 +1,11 @@
 // cspell: ignore killforward
 
 import { AutoDisposable } from "@yume-chan/event";
-import {
-    BufferedReadableStream,
-    BufferedReadableStreamEndedError,
-} from "@yume-chan/stream-extra";
-import Struct from "@yume-chan/struct";
+import { BufferedReadableStream } from "@yume-chan/stream-extra";
+import Struct, { ExactReadableEndedError } from "@yume-chan/struct";
 
-import type { Adb } from "../adb.js";
-import type { AdbIncomingSocketHandler, AdbSocket } from "../socket/index.js";
-import { decodeUtf8 } from "../utils/index.js";
+import type { Adb, AdbIncomingSocketHandler } from "../adb.js";
+import { decodeUtf8, hexToNumber } from "../utils/index.js";
 
 export interface AdbForwardListener {
     deviceSerial: string;
@@ -24,23 +20,22 @@ 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, AdbReverseError.prototype);
+        Object.setPrototypeOf(this, new.target.prototype);
     }
 }
 
-export class AdbReverseNotSupportedError extends Error {
-    public constructor() {
+export class AdbReverseNotSupportedError extends AdbReverseError {
+    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.",
         );
-        Object.setPrototypeOf(this, AdbReverseNotSupportedError.prototype);
     }
 }
 
 const AdbReverseErrorResponse = new Struct()
-    .fields(AdbReverseStringResponse)
+    .concat(AdbReverseStringResponse)
     .postDeserialize((value) => {
         // https://issuetracker.google.com/issues/37066218
         // ADB on Android <9 can't create reverse tunnels when connected wirelessly (ADB over WiFi),
@@ -52,49 +47,37 @@ const AdbReverseErrorResponse = new Struct()
         }
     });
 
-export class AdbReverseCommand extends AutoDisposable {
-    protected localAddressToHandler = new Map<
-        string,
-        AdbIncomingSocketHandler
-    >();
-
-    protected deviceAddressToLocalAddress = new Map<string, string>();
+async function readString(stream: BufferedReadableStream, length: number) {
+    const buffer = await stream.readExactly(length);
+    return decodeUtf8(buffer);
+}
 
+export class AdbReverseCommand extends AutoDisposable {
     protected adb: Adb;
 
-    protected listening = false;
+    readonly #deviceAddressToLocalAddress = new Map<string, string>();
 
-    public constructor(adb: Adb) {
+    constructor(adb: Adb) {
         super();
 
         this.adb = adb;
-        this.addDisposable(
-            this.adb.onIncomingSocket(this.handleIncomingSocket)
-        );
     }
 
-    protected handleIncomingSocket = async (socket: AdbSocket) => {
-        let address = socket.serviceString;
-        // ADB daemon appends `\0` to the service string
-        address = address.replace(/\0/g, "");
-        return !!(await this.localAddressToHandler.get(address)?.(socket));
-    };
-
-    private async createBufferedStream(service: string) {
+    protected async createBufferedStream(service: string) {
         const socket = await this.adb.createSocket(service);
         return new BufferedReadableStream(socket.readable);
     }
 
-    private async sendRequest(service: string) {
+    protected async sendRequest(service: string) {
         const stream = await this.createBufferedStream(service);
-        const success = decodeUtf8(await stream.read(4)) === "OKAY";
+        const success = (await readString(stream, 4)) === "OKAY";
         if (!success) {
             await AdbReverseErrorResponse.deserialize(stream);
         }
         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);
@@ -102,7 +85,7 @@ export class AdbReverseCommand extends AutoDisposable {
             const [deviceSerial, localName, remoteName] = line.split(" ") as [
                 string,
                 string,
-                string
+                string,
             ];
             return { deviceSerial, localName, remoteName };
         });
@@ -111,74 +94,86 @@ export class AdbReverseCommand extends AutoDisposable {
     }
 
     /**
-     * @param deviceAddress
-     * The address to be listened on device by ADB daemon. Or `tcp:0` to choose an available TCP port.
-     * @param localAddress
-     * An identifier for the reverse tunnel.
-     *
-     * When a socket wants to connect to {@link deviceAddress}, native ADB client will forward that connection to {@link localAddress}.
-     * However in this library, the {@link handler} is invoked instead. So this parameter is only used to identify the reverse tunnel.
-     * @param handler A callback to handle incoming connections. It must return `true` if it accepts the connection.
+     * Add an already existing reverse tunnel. Depends on the transport type, this may not do anything.
+     * @param deviceAddress The address to be listened on device by ADB daemon. Or `tcp:0` to choose an available TCP port.
+     * @param localAddress The address that listens on the local machine.
      * @returns `tcp:{ACTUAL_LISTENING_PORT}`, If `deviceAddress` is `tcp:0`; otherwise, `deviceAddress`.
-     * @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(
-        deviceAddress: string,
-        localAddress: string,
-        handler: AdbIncomingSocketHandler
-    ): Promise<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.
         // On Android >=8, device will respond with the selected port for all `tcp:` requests.
         if (deviceAddress.startsWith("tcp:")) {
-            let length: number | undefined;
+            const position = stream.position;
             try {
-                length = Number.parseInt(decodeUtf8(await stream.read(4)), 16);
+                const length = hexToNumber(await stream.readExactly(4));
+                const port = await readString(stream, length);
+                deviceAddress = `tcp:${Number.parseInt(port, 10)}`;
             } catch (e) {
-                if (!(e instanceof BufferedReadableStreamEndedError)) {
+                if (
+                    e instanceof ExactReadableEndedError &&
+                    stream.position === position
+                ) {
+                    // Android <8 doesn't have this response.
+                    // (the stream is closed now)
+                    // Can be safely ignored.
+                } else {
                     throw e;
                 }
-
-                // Android <8 doesn't have this response.
-                // (the stream is closed now)
-                // Can be safely ignored.
-            }
-
-            if (length !== undefined) {
-                const port = decodeUtf8(await stream.read(length));
-                deviceAddress = `tcp:${Number.parseInt(port, 10)}`;
             }
         }
 
-        this.localAddressToHandler.set(localAddress, handler);
-        this.deviceAddressToLocalAddress.set(deviceAddress, localAddress);
         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}`);
+    /**
+     * @param deviceAddress The address to be listened on device by ADB daemon. Or `tcp:0` to choose an available TCP port.
+     * @param handler A callback to handle incoming connections.
+     * @param localAddressThe The address that listens on the local machine. May be `undefined` to let the transport choose an appropriate one.
+     * @returns `tcp:{ACTUAL_LISTENING_PORT}`, If `deviceAddress` is `tcp:0`; otherwise, `deviceAddress`.
+     * @throws {AdbReverseNotSupportedError} If ADB reverse tunnel is not supported on this device when connected wirelessly.
+     * @throws {AdbReverseError} If ADB daemon returns an error.
+     */
+    async add(
+        deviceAddress: string,
+        handler: AdbIncomingSocketHandler,
+        localAddress?: string,
+    ): Promise<string> {
+        localAddress = await this.adb.transport.addReverseTunnel(
+            handler,
+            localAddress,
+        );
+
+        try {
+            deviceAddress = await this.addExternal(deviceAddress, localAddress);
+            this.#deviceAddressToLocalAddress.set(deviceAddress, localAddress);
+            return deviceAddress;
+        } catch (e) {
+            await this.adb.transport.removeReverseTunnel(localAddress);
+            throw e;
+        }
+    }
 
-        if (this.deviceAddressToLocalAddress.has(deviceAddress)) {
-            this.localAddressToHandler.delete(
-                this.deviceAddressToLocalAddress.get(deviceAddress)!
-            );
-            this.deviceAddressToLocalAddress.delete(deviceAddress);
+    async remove(deviceAddress: string): Promise<void> {
+        const localAddress =
+            this.#deviceAddressToLocalAddress.get(deviceAddress);
+        if (localAddress) {
+            await this.adb.transport.removeReverseTunnel(localAddress);
         }
 
+        await this.sendRequest(`reverse:killforward:${deviceAddress}`);
+
         // No need to close the stream, device will close it
     }
 
-    public async removeAll(): Promise<void> {
-        await this.sendRequest(`reverse:killforward-all`);
+    async removeAll(): Promise<void> {
+        await this.adb.transport.clearReverseTunnels();
+        this.#deviceAddressToLocalAddress.clear();
 
-        this.deviceAddressToLocalAddress.clear();
-        this.localAddressToHandler.clear();
+        await this.sendRequest(`reverse:killforward-all`);
 
         // No need to close the stream, device will close it
     }

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,7 +1,6 @@
 import { DuplexStreamFactory, ReadableStream } from "@yume-chan/stream-extra";
 
-import type { Adb } from "../../../adb.js";
-import type { AdbSocket } from "../../../socket/index.js";
+import type { Adb, AdbSocket } from "../../../adb.js";
 
 import type { AdbSubprocessProtocol } from "./types.js";
 
@@ -14,75 +13,75 @@ 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}`),
         );
     }
 
-    private readonly socket: AdbSocket;
+    readonly #socket: AdbSocket;
 
-    private readonly duplex: DuplexStreamFactory<Uint8Array, Uint8Array>;
+    readonly #duplex: DuplexStreamFactory<Uint8Array, Uint8Array>;
 
     // Legacy shell forwards all data to stdin.
-    public get stdin() {
-        return this.socket.writable;
+    get stdin() {
+        return this.#socket.writable;
     }
 
-    private _stdout: ReadableStream<Uint8Array>;
+    #stdout: ReadableStream<Uint8Array>;
     /**
      * Legacy shell mixes stdout and stderr.
      */
-    public get stdout() {
-        return this._stdout;
+    get stdout() {
+        return this.#stdout;
     }
 
-    private _stderr: ReadableStream<Uint8Array>;
+    #stderr: ReadableStream<Uint8Array>;
     /**
      * `stderr` will always be empty.
      */
-    public get stderr() {
-        return this._stderr;
+    get stderr() {
+        return this.#stderr;
     }
 
-    private _exit: Promise<number>;
-    public get exit() {
-        return this._exit;
+    #exit: Promise<number>;
+    get exit() {
+        return this.#exit;
     }
 
-    public constructor(socket: AdbSocket) {
-        this.socket = socket;
+    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>({
+        this.#duplex = new DuplexStreamFactory<Uint8Array, Uint8Array>({
             close: async () => {
-                await this.socket.close();
+                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);
+        this.#stdout = this.#duplex.wrapReadable(this.#socket.readable);
+        this.#stderr = this.#duplex.wrapReadable(new ReadableStream());
+        this.#exit = this.#duplex.closed.then(() => 0);
     }
 
-    public resize() {
+    resize() {
         // Not supported, but don't throw.
     }
 
-    public kill() {
-        return this.duplex.close();
+    kill() {
+        return this.#duplex.close();
     }
 }