Add transport status events (#790)

* Transport status events Add symbol docs Emit transport status events Transport test suite * Review fixes * Remove core dependency * HTTP transport use AbortSignal, error handling in TransportNode * Improve stream handling * Update packages/transport-web-serial/src/transport.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Fix linting --------- Co-authored-by: philon- <philon-@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-08-23 20:44:03 -04:00
parent 449fb3ac36
commit d7e32e9b03
15 changed files with 1884 additions and 181 deletions
@@ -0,0 +1,166 @@
+import { describe, vi, expect, beforeEach, afterEach } from "vitest";
+import { runTransportContract } from "../../../tests/utils/transportContract";
+import { TransportWebBluetooth } from "./transport";
+
+class MiniEmitter {
+  private listeners = new Map<string, Set<(e: Event) => void>>();
+  addEventListener(type: string, listener: (e: Event) => void) {
+    if (!this.listeners.has(type)) this.listeners.set(type, new Set());
+    this.listeners.get(type)!.add(listener);
+  }
+  removeEventListener(type: string, listener: (e: Event) => void) {
+    this.listeners.get(type)?.delete(listener);
+  }
+  dispatchEvent(event: Event) {
+    this.listeners.get(event.type)?.forEach((l) => l(event));
+  }
+}
+
+function stubWebBluetooth() {
+  const incomingQueue: Uint8Array[] = [];
+  let lastWritten: Uint8Array | undefined;
+
+  // fromRadioCharacteristic: read bytes from queue, one buffer per read
+  const fromRadioCharacteristic: BluetoothRemoteGATTCharacteristic = {
+    async readValue() {
+      const next = incomingQueue.shift() ?? new Uint8Array();
+      return new DataView(
+        next.buffer,
+        next.byteOffset,
+        next.byteLength,
+      ) as unknown as DataView;
+    },
+    addEventListener() {},
+    removeEventListener() {},
+  } as unknown as BluetoothRemoteGATTCharacteristic;
+
+  // characteristicvaluechanged event plumbing (fromNumCharacteristic)
+  const charEmitter = new MiniEmitter();
+
+  const fromNumCharacteristic: BluetoothRemoteGATTCharacteristic = {
+    async startNotifications() {
+      return this;
+    },
+    addEventListener(type: string, listener: (e: Event) => void) {
+      charEmitter.addEventListener(type, listener);
+    },
+    removeEventListener(type: string, listener: (e: Event) => void) {
+      charEmitter.removeEventListener(type, listener);
+    },
+  } as unknown as BluetoothRemoteGATTCharacteristic;
+
+  const toRadioCharacteristic: BluetoothRemoteGATTCharacteristic = {
+    async writeValue(bufferSource: BufferSource) {
+      const u8 =
+        bufferSource instanceof ArrayBuffer
+          ? new Uint8Array(bufferSource)
+          : new Uint8Array(
+              bufferSource.buffer,
+              bufferSource.byteOffset,
+              bufferSource.byteLength,
+            );
+      lastWritten = new Uint8Array(u8);
+    },
+  } as unknown as BluetoothRemoteGATTCharacteristic;
+
+  // Primary service returns our three characteristics by UUID
+  const primaryService: BluetoothRemoteGATTService = {
+    async getCharacteristic(uuid: string) {
+      if (uuid === TransportWebBluetooth.ToRadioUuid) return toRadioCharacteristic;
+      if (uuid === TransportWebBluetooth.FromRadioUuid) return fromRadioCharacteristic;
+      if (uuid === TransportWebBluetooth.FromNumUuid) return fromNumCharacteristic;
+      throw new Error("Unknown characteristic: " + uuid);
+    },
+  } as unknown as BluetoothRemoteGATTService;
+
+  // Device-level emitter to deliver gattserverdisconnected
+  const deviceEmitter = new MiniEmitter();
+
+  // GATT server with readonly connected
+  let isConnected = true;
+  const gattServer: BluetoothRemoteGATTServer = {
+    get connected() {
+      return isConnected;
+    },
+    async connect() {
+      isConnected = true;
+      return gattServer;
+    },
+    disconnect() {
+      isConnected = false;
+      deviceEmitter.dispatchEvent(new Event("gattserverdisconnected"));
+    },
+    async getPrimaryService() {
+      return primaryService;
+    },
+    device: {
+      addEventListener: (...args: Parameters<EventTarget["addEventListener"]>) =>
+        deviceEmitter.addEventListener(args[0] as string, args[1] as (e: Event) => void),
+      removeEventListener: (...args: Parameters<EventTarget["removeEventListener"]>) =>
+        deviceEmitter.removeEventListener(args[0] as string, args[1] as (e: Event) => void),
+    } as unknown as BluetoothDevice,
+  } as unknown as BluetoothRemoteGATTServer;
+
+  const fakeDevice: BluetoothDevice = {
+    async watchAdvertisements() {},
+    gatt: gattServer,
+  } as unknown as BluetoothDevice;
+
+  const fakeNavigator = {
+    bluetooth: {
+      async requestDevice() {
+        return fakeDevice;
+      },
+    },
+  };
+
+  vi.stubGlobal("navigator", Object.assign({}, globalThis.navigator, fakeNavigator));
+
+  // helper actions for tests/contract
+  return {
+    pushIncoming: (u8: Uint8Array) => {
+      incomingQueue.push(u8);
+      charEmitter.dispatchEvent(new Event("characteristicvaluechanged"));
+    },
+    assertLastWritten: (u8: Uint8Array) => {
+      expect(lastWritten).toBeDefined();
+      expect(lastWritten).toEqual(u8);
+    },
+    // simulate underlying link drop (OS-level disconnect)
+    triggerGattDisconnect: () => {
+      isConnected = false;
+      deviceEmitter.dispatchEvent(new Event("gattserverdisconnected"));
+    },
+    cleanup: () => {
+      vi.unstubAllGlobals();
+    },
+  };
+}
+
+describe("TransportWebBluetooth (contract)", () => {
+  runTransportContract({
+    name: "TransportWebBluetooth",
+    setup: () => {},
+    teardown: () => {
+      (globalThis as unknown as { __ble?: ReturnType<typeof stubWebBluetooth> }).__ble?.cleanup();
+      (globalThis as unknown as { __ble?: ReturnType<typeof stubWebBluetooth> }).__ble = undefined;
+      vi.restoreAllMocks();
+      vi.unstubAllGlobals();
+    },
+    create: async () => {
+      (globalThis as unknown as { __ble: ReturnType<typeof stubWebBluetooth> }).__ble = stubWebBluetooth();
+      return await TransportWebBluetooth.create();
+    },
+    pushIncoming: async (bytes) => {
+      (globalThis as unknown as { __ble: ReturnType<typeof stubWebBluetooth> }).__ble.pushIncoming(bytes);
+      await Promise.resolve();
+    },
+    assertLastWritten: (bytes) => {
+      (globalThis as unknown as { __ble: ReturnType<typeof stubWebBluetooth> }).__ble.assertLastWritten(bytes);
+    },
+    triggerDisconnect: async () => {
+      (globalThis as unknown as { __ble: ReturnType<typeof stubWebBluetooth> }).__ble.triggerGattDisconnect();
+      await Promise.resolve();
+    },
+  });
+});