feat(adb): rewrite process spawner API (#739)

This commit is contained in:
Simon Chan 2025-04-02 15:20:05 +08:00 committed by GitHub
parent 46e78401a4
commit d3019ce738
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
75 changed files with 1422 additions and 1022 deletions

View file

@ -1,224 +0,0 @@
import assert from "node:assert";
import { describe, it } from "node:test";
import { PromiseResolver } from "@yume-chan/async";
import type { ReadableStreamDefaultController } from "@yume-chan/stream-extra";
import { ReadableStream, WritableStream } from "@yume-chan/stream-extra";
import type { AdbSocket } from "../../../adb.js";
import {
AdbShellProtocolId,
AdbShellProtocolPacket,
AdbSubprocessShellProtocol,
} from "./shell.js";
function createMockSocket(
readable: (controller: ReadableStreamDefaultController<Uint8Array>) => void,
): [AdbSocket, PromiseResolver<void>] {
const closed = new PromiseResolver<void>();
const socket: AdbSocket = {
service: "",
close() {},
closed: closed.promise,
readable: new ReadableStream({
async start(controller) {
controller.enqueue(
AdbShellProtocolPacket.serialize({
id: AdbShellProtocolId.Stdout,
data: new Uint8Array([1, 2, 3]),
}),
);
controller.enqueue(
AdbShellProtocolPacket.serialize({
id: AdbShellProtocolId.Stderr,
data: new Uint8Array([4, 5, 6]),
}),
);
await closed.promise;
readable(controller);
},
}),
writable: new WritableStream(),
};
return [socket, closed];
}
async function assertResolves<T>(promise: Promise<T>, expected: T) {
return assert.deepStrictEqual(await promise, expected);
}
describe("AdbShellProtocolPacket", () => {
it("should serialize", () => {
assert.deepStrictEqual(
AdbShellProtocolPacket.serialize({
id: AdbShellProtocolId.Stdout,
data: new Uint8Array([1, 2, 3, 4]),
}),
new Uint8Array([1, 4, 0, 0, 0, 1, 2, 3, 4]),
);
});
});
describe("AdbSubprocessShellProtocol", () => {
describe("`stdout` and `stderr`", () => {
it("should parse data from `socket", () => {
const [socket] = createMockSocket(() => {});
const process = new AdbSubprocessShellProtocol(socket);
const stdoutReader = process.stdout.getReader();
const stderrReader = process.stderr.getReader();
assertResolves(stdoutReader.read(), {
done: false,
value: new Uint8Array([1, 2, 3]),
});
assertResolves(stderrReader.read(), {
done: false,
value: new Uint8Array([4, 5, 6]),
});
});
it("should be able to be cancelled", async () => {
const [socket, closed] = createMockSocket((controller) => {
controller.enqueue(
AdbShellProtocolPacket.serialize({
id: AdbShellProtocolId.Stdout,
data: new Uint8Array([7, 8, 9]),
}),
);
controller.enqueue(
AdbShellProtocolPacket.serialize({
id: AdbShellProtocolId.Stderr,
data: new Uint8Array([10, 11, 12]),
}),
);
});
const process = new AdbSubprocessShellProtocol(socket);
const stdoutReader = process.stdout.getReader();
const stderrReader = process.stderr.getReader();
await stdoutReader.cancel();
closed.resolve();
assertResolves(stderrReader.read(), {
done: false,
value: new Uint8Array([4, 5, 6]),
});
assertResolves(stderrReader.read(), {
done: false,
value: new Uint8Array([10, 11, 12]),
});
});
});
describe("`socket` close", () => {
describe("with `exit` message", () => {
it("should close `stdout`, `stderr` and resolve `exit`", async () => {
const [socket, closed] = createMockSocket((controller) => {
controller.enqueue(
AdbShellProtocolPacket.serialize({
id: AdbShellProtocolId.Exit,
data: new Uint8Array([42]),
}),
);
controller.close();
});
const process = new AdbSubprocessShellProtocol(socket);
const stdoutReader = process.stdout.getReader();
const stderrReader = process.stderr.getReader();
assertResolves(stdoutReader.read(), {
done: false,
value: new Uint8Array([1, 2, 3]),
});
assertResolves(stderrReader.read(), {
done: false,
value: new Uint8Array([4, 5, 6]),
});
closed.resolve();
assertResolves(stdoutReader.read(), {
done: true,
value: undefined,
});
assertResolves(stderrReader.read(), {
done: true,
value: undefined,
});
assert.strictEqual(await process.exit, 42);
});
});
describe("with no `exit` message", () => {
it("should close `stdout`, `stderr` and reject `exit`", async () => {
const [socket, closed] = createMockSocket((controller) => {
controller.close();
});
const process = new AdbSubprocessShellProtocol(socket);
const stdoutReader = process.stdout.getReader();
const stderrReader = process.stderr.getReader();
assertResolves(stdoutReader.read(), {
done: false,
value: new Uint8Array([1, 2, 3]),
});
assertResolves(stderrReader.read(), {
done: false,
value: new Uint8Array([4, 5, 6]),
});
closed.resolve();
await Promise.all([
assertResolves(stdoutReader.read(), {
done: true,
value: undefined,
}),
assertResolves(stderrReader.read(), {
done: true,
value: undefined,
}),
assert.rejects(process.exit),
]);
});
});
});
describe("`socket.readable` invalid data", () => {
it("should error `stdout`, `stderr` and reject `exit`", async () => {
const [socket, closed] = createMockSocket((controller) => {
controller.enqueue(new Uint8Array([7, 8, 9]));
controller.close();
});
const process = new AdbSubprocessShellProtocol(socket);
const stdoutReader = process.stdout.getReader();
const stderrReader = process.stderr.getReader();
await assertResolves(stdoutReader.read(), {
done: false,
value: new Uint8Array([1, 2, 3]),
});
await assertResolves(stderrReader.read(), {
done: false,
value: new Uint8Array([4, 5, 6]),
});
closed.resolve();
await Promise.all([
assert.rejects(stdoutReader.read()),
assert.rejects(stderrReader.read()),
assert.rejects(process.exit),
]);
});
});
});