@kyneta/webrtc-transport 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/webrtc-transport.ts"],"sourcesContent":["// webrtc-transport — BYODC WebRTC data channel transport for @kyneta/exchange.\n//\n// \"Bring Your Own Data Channel\" design: the application manages WebRTC\n// connections (signaling, ICE, media streams). This transport attaches\n// to already-established data channels for kyneta document sync.\n//\n// Uses the shared binary pipeline from @kyneta/wire (same as WebSocket):\n// encodeBinaryAndSend — outbound: encode → fragment → sendFn\n// decodeBinaryMessages — inbound: reassemble → decode → ChannelMsg[]\n//\n// The transport accepts any object satisfying `DataChannelLike` — a\n// 5-member interface that native RTCDataChannel satisfies structurally\n// and that libraries like simple-peer can conform to via a trivial bridge.\n\nimport type {\n ChannelId,\n ChannelMsg,\n GeneratedChannel,\n TransportFactory,\n} from \"@kyneta/transport\"\nimport { Transport } from \"@kyneta/transport\"\nimport {\n decodeBinaryMessages,\n encodeBinaryAndSend,\n FragmentReassembler,\n} from \"@kyneta/wire\"\nimport type { DataChannelLike } from \"./data-channel-like.js\"\n\n// ---------------------------------------------------------------------------\n// Constants\n// ---------------------------------------------------------------------------\n\n/**\n * Default fragment threshold in bytes.\n *\n * SCTP (the underlying transport for WebRTC data channels) has a message\n * size limit of approximately 256KB. 200KB provides a safe margin.\n *\n * This differs from the WebSocket transport's 100KB default, which\n * targets AWS API Gateway's 128KB limit. WebRTC has no such gateway.\n */\nexport const DEFAULT_FRAGMENT_THRESHOLD = 200 * 1024\n\n// ---------------------------------------------------------------------------\n// Options\n// ---------------------------------------------------------------------------\n\n/**\n * Configuration options for the WebRTC transport.\n */\nexport interface WebrtcTransportOptions {\n /**\n * Fragment threshold in bytes. Messages larger than this are fragmented\n * for SCTP compatibility. Set to 0 to disable fragmentation (not recommended).\n *\n * @default 204800 (200KB)\n */\n fragmentThreshold?: number\n}\n\n// ---------------------------------------------------------------------------\n// Internal types\n// ---------------------------------------------------------------------------\n\n/**\n * Context for each attached data channel — stored per remotePeerId.\n */\ntype DataChannelContext = {\n remotePeerId: string\n channel: DataChannelLike\n}\n\n/**\n * Internal tracking for an attached data channel.\n */\ntype AttachedChannel = {\n remotePeerId: string\n channel: DataChannelLike\n channelId: ChannelId | null\n reassembler: FragmentReassembler\n cleanup: () => void\n}\n\n// ---------------------------------------------------------------------------\n// WebrtcTransport\n// ---------------------------------------------------------------------------\n\n/**\n * WebRTC data channel transport for @kyneta/exchange.\n *\n * Follows a \"Bring Your Own Data Channel\" (BYODC) design — the application\n * manages WebRTC connections and attaches data channels to this transport\n * for kyneta document synchronization.\n *\n * Uses binary CBOR encoding with transport-level fragmentation via\n * `@kyneta/wire` — the same pipeline as the WebSocket transport.\n *\n * ## Usage\n *\n * ```typescript\n * import { Exchange } from \"@kyneta/exchange\"\n * import { createWebrtcTransport } from \"@kyneta/webrtc-transport\"\n *\n * const webrtcTransport = createWebrtcTransport()\n *\n * const exchange = new Exchange({\n * identity: { peerId: \"alice\", name: \"Alice\" },\n * transports: [webrtcTransport],\n * })\n *\n * // When a WebRTC connection is established:\n * const cleanup = transport.attachDataChannel(remotePeerId, dataChannel)\n *\n * // When done:\n * cleanup() // or transport.detachDataChannel(remotePeerId)\n * ```\n *\n * ## Ownership\n *\n * The transport does NOT own the data channel. `detachDataChannel()`\n * removes the sync channel and event listeners but does not close the\n * data channel or the peer connection. The application manages the\n * WebRTC connection lifecycle independently.\n */\nexport class WebrtcTransport extends Transport<DataChannelContext> {\n /**\n * Map of remotePeerId → attached channel tracking.\n */\n readonly #attachedChannels = new Map<string, AttachedChannel>()\n\n /**\n * Fragment threshold in bytes.\n */\n readonly #fragmentThreshold: number\n\n constructor(options?: WebrtcTransportOptions) {\n super({ transportType: \"webrtc-datachannel\" })\n this.#fragmentThreshold =\n options?.fragmentThreshold ?? DEFAULT_FRAGMENT_THRESHOLD\n }\n\n // ==========================================================================\n // Transport abstract method implementations\n // ==========================================================================\n\n /**\n * Generate a channel for a data channel context.\n *\n * Called internally by the `Transport` base class when `addChannel()` is\n * invoked. Users never call this directly — use `attachDataChannel()`.\n */\n protected generate(context: DataChannelContext): GeneratedChannel {\n const { channel } = context\n\n return {\n transportType: this.transportType,\n send: (msg: ChannelMsg) => {\n if (channel.readyState !== \"open\") {\n return\n }\n encodeBinaryAndSend(msg, this.#fragmentThreshold, data =>\n channel.send(data),\n )\n },\n stop: () => {\n // Cleanup is handled by detachDataChannel().\n // This callback fires when the internal channel is removed.\n },\n }\n }\n\n /**\n * Called when the transport starts.\n *\n * No-op for WebRTC — channels are added dynamically via\n * `attachDataChannel()`, not at start time.\n */\n async onStart(): Promise<void> {}\n\n /**\n * Called when the transport stops.\n *\n * Detaches all attached data channels and cleans up resources.\n */\n async onStop(): Promise<void> {\n for (const remotePeerId of [...this.#attachedChannels.keys()]) {\n this.detachDataChannel(remotePeerId)\n }\n }\n\n // ==========================================================================\n // Public API — data channel management\n // ==========================================================================\n\n /**\n * Attach a data channel for a remote peer.\n *\n * Creates an internal sync channel when the data channel is open\n * (or waits for the `\"open\"` event if still connecting). The sync\n * channel triggers the establishment handshake with the remote peer.\n *\n * If a data channel is already attached for this peer, the old one\n * is detached first.\n *\n * @param remotePeerId - The stable peer ID of the remote peer\n * @param channel - Any object satisfying `DataChannelLike`\n * @returns A cleanup function that calls `detachDataChannel(remotePeerId)`\n */\n attachDataChannel(\n remotePeerId: string,\n channel: DataChannelLike,\n ): () => void {\n // Detach existing channel for this peer if any\n if (this.#attachedChannels.has(remotePeerId)) {\n this.detachDataChannel(remotePeerId)\n }\n\n // Best-effort: request arraybuffer mode for incoming data.\n // The message handler doesn't depend on this — it accepts both\n // ArrayBuffer and Uint8Array regardless.\n channel.binaryType = \"arraybuffer\"\n\n // Create reassembler for this data channel\n const reassembler = new FragmentReassembler({ timeoutMs: 10_000 })\n\n // Event handlers — stored as named functions for removeEventListener\n const onOpen = () => {\n this.#createSyncChannel(remotePeerId)\n }\n\n const onClose = () => {\n this.#removeSyncChannel(remotePeerId)\n }\n\n const onError = () => {\n this.#removeSyncChannel(remotePeerId)\n }\n\n const onMessage = (event: any) => {\n this.#handleMessage(remotePeerId, event)\n }\n\n // Cleanup function to remove all event listeners\n const cleanup = () => {\n channel.removeEventListener(\"open\", onOpen)\n channel.removeEventListener(\"close\", onClose)\n channel.removeEventListener(\"error\", onError)\n channel.removeEventListener(\"message\", onMessage)\n }\n\n // Register event listeners\n channel.addEventListener(\"open\", onOpen)\n channel.addEventListener(\"close\", onClose)\n channel.addEventListener(\"error\", onError)\n channel.addEventListener(\"message\", onMessage)\n\n // Track the attached channel\n const attached: AttachedChannel = {\n remotePeerId,\n channel,\n channelId: null,\n reassembler,\n cleanup,\n }\n this.#attachedChannels.set(remotePeerId, attached)\n\n // If the channel is already open, create the sync channel immediately\n if (channel.readyState === \"open\") {\n this.#createSyncChannel(remotePeerId)\n }\n\n return () => this.detachDataChannel(remotePeerId)\n }\n\n /**\n * Detach a data channel for a remote peer.\n *\n * Removes the sync channel, cleans up event listeners, and disposes\n * the reassembler. Does NOT close the data channel — the application\n * manages the WebRTC connection lifecycle.\n *\n * @param remotePeerId - The peer ID to detach\n */\n detachDataChannel(remotePeerId: string): void {\n const attached = this.#attachedChannels.get(remotePeerId)\n if (!attached) return\n\n // Remove the sync channel if it exists\n this.#removeSyncChannel(remotePeerId)\n\n // Dispose the reassembler to clean up timers\n attached.reassembler.dispose()\n\n // Remove event listeners from the data channel\n attached.cleanup()\n\n // Remove from tracking\n this.#attachedChannels.delete(remotePeerId)\n }\n\n /**\n * Check if a data channel is attached for a peer.\n */\n hasDataChannel(remotePeerId: string): boolean {\n return this.#attachedChannels.has(remotePeerId)\n }\n\n /**\n * Get all peer IDs with attached data channels.\n */\n getAttachedPeerIds(): string[] {\n return [...this.#attachedChannels.keys()]\n }\n\n // ==========================================================================\n // Internal — sync channel lifecycle\n // ==========================================================================\n\n /**\n * Create an internal sync channel for an attached data channel.\n *\n * Called when the data channel's `\"open\"` event fires (or immediately\n * if already open on attach). The sync channel is registered with the\n * Transport base class, which triggers the establishment handshake.\n */\n #createSyncChannel(remotePeerId: string): void {\n const attached = this.#attachedChannels.get(remotePeerId)\n if (!attached) return\n\n // Don't create if already exists\n if (attached.channelId !== null) return\n\n // addChannel() creates and registers the sync channel\n const syncChannel = this.addChannel({\n remotePeerId,\n channel: attached.channel,\n })\n attached.channelId = syncChannel.channelId\n\n // Start the establishment handshake\n this.establishChannel(syncChannel.channelId)\n }\n\n /**\n * Remove the internal sync channel for a peer.\n */\n #removeSyncChannel(remotePeerId: string): void {\n const attached = this.#attachedChannels.get(remotePeerId)\n if (!attached || attached.channelId === null) return\n\n this.removeChannel(attached.channelId)\n attached.channelId = null\n }\n\n // ==========================================================================\n // Internal — message handling\n // ==========================================================================\n\n /**\n * Handle an incoming message from a data channel.\n *\n * Extracts binary data from the event, feeding both `ArrayBuffer`\n * (native RTCDataChannel with binaryType \"arraybuffer\") and\n * `Uint8Array` (simple-peer and other wrappers) into the shared\n * decode pipeline.\n */\n #handleMessage(remotePeerId: string, event: any): void {\n const attached = this.#attachedChannels.get(remotePeerId)\n if (!attached || attached.channelId === null) return\n\n const syncChannel = this.channels.get(attached.channelId)\n if (!syncChannel) return\n\n // Extract bytes — robust to both ArrayBuffer and Uint8Array\n const raw = event.data\n const bytes =\n raw instanceof ArrayBuffer\n ? new Uint8Array(raw)\n : raw instanceof Uint8Array\n ? raw\n : null\n\n if (!bytes) {\n // Unexpected data type (e.g. string) — ignore silently\n return\n }\n\n try {\n const messages = decodeBinaryMessages(bytes, attached.reassembler)\n if (messages) {\n for (const msg of messages) {\n syncChannel.onReceive(msg)\n }\n }\n } catch (error) {\n console.error(\n `[webrtc-transport] Failed to decode message from peer ${remotePeerId}:`,\n error,\n )\n }\n }\n}\n\n// ---------------------------------------------------------------------------\n// Factory function\n// ---------------------------------------------------------------------------\n\n/**\n * Create a WebRTC transport factory for use with `Exchange`.\n *\n * Returns a `TransportFactory` — pass directly to\n * `Exchange({ transports: [...] })`. The returned transport instance\n * exposes `attachDataChannel()` / `detachDataChannel()` for BYODC\n * data channel management.\n *\n * To access the transport instance after creation, use\n * `exchange.getTransport(\"webrtc-datachannel\")`.\n *\n * @example\n * ```typescript\n * import { Exchange } from \"@kyneta/exchange\"\n * import { createWebrtcTransport } from \"@kyneta/webrtc-transport\"\n *\n * const exchange = new Exchange({\n * identity: { peerId: \"alice\", name: \"Alice\" },\n * transports: [createWebrtcTransport()],\n * })\n * ```\n */\nexport function createWebrtcTransport(\n options?: WebrtcTransportOptions,\n): TransportFactory {\n return () => new WebrtcTransport(options)\n}\n"],"mappings":";AAoBA,SAAS,iBAAiB;AAC1B;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAgBA,IAAM,6BAA6B,MAAM;AAmFzC,IAAM,kBAAN,cAA8B,UAA8B;AAAA;AAAA;AAAA;AAAA,EAIxD,oBAAoB,oBAAI,IAA6B;AAAA;AAAA;AAAA;AAAA,EAKrD;AAAA,EAET,YAAY,SAAkC;AAC5C,UAAM,EAAE,eAAe,qBAAqB,CAAC;AAC7C,SAAK,qBACH,SAAS,qBAAqB;AAAA,EAClC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYU,SAAS,SAA+C;AAChE,UAAM,EAAE,QAAQ,IAAI;AAEpB,WAAO;AAAA,MACL,eAAe,KAAK;AAAA,MACpB,MAAM,CAAC,QAAoB;AACzB,YAAI,QAAQ,eAAe,QAAQ;AACjC;AAAA,QACF;AACA;AAAA,UAAoB;AAAA,UAAK,KAAK;AAAA,UAAoB,UAChD,QAAQ,KAAK,IAAI;AAAA,QACnB;AAAA,MACF;AAAA,MACA,MAAM,MAAM;AAAA,MAGZ;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,UAAyB;AAAA,EAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOhC,MAAM,SAAwB;AAC5B,eAAW,gBAAgB,CAAC,GAAG,KAAK,kBAAkB,KAAK,CAAC,GAAG;AAC7D,WAAK,kBAAkB,YAAY;AAAA,IACrC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoBA,kBACE,cACA,SACY;AAEZ,QAAI,KAAK,kBAAkB,IAAI,YAAY,GAAG;AAC5C,WAAK,kBAAkB,YAAY;AAAA,IACrC;AAKA,YAAQ,aAAa;AAGrB,UAAM,cAAc,IAAI,oBAAoB,EAAE,WAAW,IAAO,CAAC;AAGjE,UAAM,SAAS,MAAM;AACnB,WAAK,mBAAmB,YAAY;AAAA,IACtC;AAEA,UAAM,UAAU,MAAM;AACpB,WAAK,mBAAmB,YAAY;AAAA,IACtC;AAEA,UAAM,UAAU,MAAM;AACpB,WAAK,mBAAmB,YAAY;AAAA,IACtC;AAEA,UAAM,YAAY,CAAC,UAAe;AAChC,WAAK,eAAe,cAAc,KAAK;AAAA,IACzC;AAGA,UAAM,UAAU,MAAM;AACpB,cAAQ,oBAAoB,QAAQ,MAAM;AAC1C,cAAQ,oBAAoB,SAAS,OAAO;AAC5C,cAAQ,oBAAoB,SAAS,OAAO;AAC5C,cAAQ,oBAAoB,WAAW,SAAS;AAAA,IAClD;AAGA,YAAQ,iBAAiB,QAAQ,MAAM;AACvC,YAAQ,iBAAiB,SAAS,OAAO;AACzC,YAAQ,iBAAiB,SAAS,OAAO;AACzC,YAAQ,iBAAiB,WAAW,SAAS;AAG7C,UAAM,WAA4B;AAAA,MAChC;AAAA,MACA;AAAA,MACA,WAAW;AAAA,MACX;AAAA,MACA;AAAA,IACF;AACA,SAAK,kBAAkB,IAAI,cAAc,QAAQ;AAGjD,QAAI,QAAQ,eAAe,QAAQ;AACjC,WAAK,mBAAmB,YAAY;AAAA,IACtC;AAEA,WAAO,MAAM,KAAK,kBAAkB,YAAY;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,kBAAkB,cAA4B;AAC5C,UAAM,WAAW,KAAK,kBAAkB,IAAI,YAAY;AACxD,QAAI,CAAC,SAAU;AAGf,SAAK,mBAAmB,YAAY;AAGpC,aAAS,YAAY,QAAQ;AAG7B,aAAS,QAAQ;AAGjB,SAAK,kBAAkB,OAAO,YAAY;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA,EAKA,eAAe,cAA+B;AAC5C,WAAO,KAAK,kBAAkB,IAAI,YAAY;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA,EAKA,qBAA+B;AAC7B,WAAO,CAAC,GAAG,KAAK,kBAAkB,KAAK,CAAC;AAAA,EAC1C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,mBAAmB,cAA4B;AAC7C,UAAM,WAAW,KAAK,kBAAkB,IAAI,YAAY;AACxD,QAAI,CAAC,SAAU;AAGf,QAAI,SAAS,cAAc,KAAM;AAGjC,UAAM,cAAc,KAAK,WAAW;AAAA,MAClC;AAAA,MACA,SAAS,SAAS;AAAA,IACpB,CAAC;AACD,aAAS,YAAY,YAAY;AAGjC,SAAK,iBAAiB,YAAY,SAAS;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA,EAKA,mBAAmB,cAA4B;AAC7C,UAAM,WAAW,KAAK,kBAAkB,IAAI,YAAY;AACxD,QAAI,CAAC,YAAY,SAAS,cAAc,KAAM;AAE9C,SAAK,cAAc,SAAS,SAAS;AACrC,aAAS,YAAY;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,eAAe,cAAsB,OAAkB;AACrD,UAAM,WAAW,KAAK,kBAAkB,IAAI,YAAY;AACxD,QAAI,CAAC,YAAY,SAAS,cAAc,KAAM;AAE9C,UAAM,cAAc,KAAK,SAAS,IAAI,SAAS,SAAS;AACxD,QAAI,CAAC,YAAa;AAGlB,UAAM,MAAM,MAAM;AAClB,UAAM,QACJ,eAAe,cACX,IAAI,WAAW,GAAG,IAClB,eAAe,aACb,MACA;AAER,QAAI,CAAC,OAAO;AAEV;AAAA,IACF;AAEA,QAAI;AACF,YAAM,WAAW,qBAAqB,OAAO,SAAS,WAAW;AACjE,UAAI,UAAU;AACZ,mBAAW,OAAO,UAAU;AAC1B,sBAAY,UAAU,GAAG;AAAA,QAC3B;AAAA,MACF;AAAA,IACF,SAAS,OAAO;AACd,cAAQ;AAAA,QACN,yDAAyD,YAAY;AAAA,QACrE;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AA4BO,SAAS,sBACd,SACkB;AAClB,SAAO,MAAM,IAAI,gBAAgB,OAAO;AAC1C;","names":[]}
package/package.json ADDED
@@ -0,0 +1,46 @@
1
+ {
2
+ "name": "@kyneta/webrtc-transport",
3
+ "version": "1.3.0",
4
+ "description": "WebRTC data channel transport for @kyneta/exchange — BYODC (Bring Your Own Data Channel) with DataChannelLike interface",
5
+ "author": "Duane Johnson",
6
+ "license": "MIT",
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "https://github.com/halecraft/kyneta",
10
+ "directory": "packages/exchange/transports/webrtc"
11
+ },
12
+ "publishConfig": {
13
+ "access": "public"
14
+ },
15
+ "type": "module",
16
+ "files": [
17
+ "dist",
18
+ "src"
19
+ ],
20
+ "exports": {
21
+ ".": {
22
+ "types": "./dist/index.d.ts",
23
+ "import": "./dist/index.js"
24
+ },
25
+ "./src/*": "./src/*"
26
+ },
27
+ "peerDependencies": {
28
+ "@kyneta/transport": "^1.3.0",
29
+ "@kyneta/wire": "^1.3.0"
30
+ },
31
+ "devDependencies": {
32
+ "@types/node": "^22",
33
+ "tsup": "^8.5.0",
34
+ "typescript": "^5.9.2",
35
+ "vitest": "^4.0.17",
36
+ "@kyneta/exchange": "^1.3.0",
37
+ "@kyneta/wire": "^1.3.0",
38
+ "@kyneta/transport": "^1.3.0",
39
+ "@kyneta/schema": "^1.3.0"
40
+ },
41
+ "scripts": {
42
+ "build": "tsup",
43
+ "test": "verify logic",
44
+ "verify": "verify"
45
+ }
46
+ }
@@ -0,0 +1,94 @@
1
+ // mock-data-channel — test helper implementing DataChannelLike.
2
+ //
3
+ // Provides a minimal, spy-friendly implementation for testing the
4
+ // WebRTC transport without a real RTCDataChannel or browser environment.
5
+
6
+ import { vi } from "vitest"
7
+ import type { DataChannelLike } from "../data-channel-like.js"
8
+
9
+ /**
10
+ * A mock DataChannelLike for testing.
11
+ *
12
+ * Features:
13
+ * - Configurable initial `readyState`
14
+ * - `send` is a vitest spy
15
+ * - `emit(type, event?)` simulates incoming events
16
+ * - Tracks all addEventListener/removeEventListener calls
17
+ */
18
+ export class MockDataChannel implements DataChannelLike {
19
+ readyState: string
20
+ binaryType = "blob"
21
+ send = vi.fn<(data: Uint8Array) => void>()
22
+
23
+ readonly #listeners = new Map<string, Set<(event: any) => void>>()
24
+
25
+ constructor(initialReadyState: string = "connecting") {
26
+ this.readyState = initialReadyState
27
+ }
28
+
29
+ addEventListener(type: string, listener: (event: any) => void): void {
30
+ let set = this.#listeners.get(type)
31
+ if (!set) {
32
+ set = new Set()
33
+ this.#listeners.set(type, set)
34
+ }
35
+ set.add(listener)
36
+ }
37
+
38
+ removeEventListener(type: string, listener: (event: any) => void): void {
39
+ const set = this.#listeners.get(type)
40
+ if (set) {
41
+ set.delete(listener)
42
+ if (set.size === 0) this.#listeners.delete(type)
43
+ }
44
+ }
45
+
46
+ /**
47
+ * Simulate an event firing on the data channel.
48
+ *
49
+ * For "message" events, pass `{ data: ... }` as the event.
50
+ * For "open"/"close"/"error", no event payload is needed.
51
+ */
52
+ emit(type: string, event?: any): void {
53
+ const set = this.#listeners.get(type)
54
+ if (!set) return
55
+ for (const listener of set) {
56
+ listener(event ?? {})
57
+ }
58
+ }
59
+
60
+ /**
61
+ * Simulate the data channel opening.
62
+ * Sets readyState to "open" and fires the "open" event.
63
+ */
64
+ open(): void {
65
+ this.readyState = "open"
66
+ this.emit("open")
67
+ }
68
+
69
+ /**
70
+ * Simulate the data channel closing.
71
+ * Sets readyState to "closed" and fires the "close" event.
72
+ */
73
+ close(): void {
74
+ this.readyState = "closed"
75
+ this.emit("close")
76
+ }
77
+
78
+ /**
79
+ * Get the number of listeners registered for a given event type.
80
+ */
81
+ listenerCount(type: string): number {
82
+ return this.#listeners.get(type)?.size ?? 0
83
+ }
84
+
85
+ /**
86
+ * Check if any listeners are registered at all.
87
+ */
88
+ hasListeners(): boolean {
89
+ for (const set of this.#listeners.values()) {
90
+ if (set.size > 0) return true
91
+ }
92
+ return false
93
+ }
94
+ }
@@ -0,0 +1,197 @@
1
+ // simple-peer-bridge.test — demonstrates that a simple-peer-style EventEmitter
2
+ // can be trivially bridged to DataChannelLike and used with WebrtcTransport.
3
+ //
4
+ // The ~20-line fromSimplePeer() bridge function maps simple-peer's
5
+ // EventEmitter API (on/off, "connect"/"data"/"close"/"error") to the
6
+ // DataChannelLike contract (addEventListener/removeEventListener,
7
+ // "open"/"message"/"close"/"error").
8
+
9
+ import { describe, expect, it, vi } from "vitest"
10
+ import type { DataChannelLike } from "../data-channel-like.js"
11
+ import { WebrtcTransport } from "../webrtc-transport.js"
12
+
13
+ // ---------------------------------------------------------------------------
14
+ // MockSimplePeer — mimics simple-peer's EventEmitter-style API
15
+ // ---------------------------------------------------------------------------
16
+
17
+ class MockSimplePeer {
18
+ connected = false
19
+ private listeners = new Map<string, Set<(...args: any[]) => void>>()
20
+
21
+ on(event: string, fn: (...args: any[]) => void) {
22
+ let set = this.listeners.get(event)
23
+ if (!set) {
24
+ set = new Set()
25
+ this.listeners.set(event, set)
26
+ }
27
+ set.add(fn)
28
+ return this
29
+ }
30
+
31
+ off(event: string, fn: (...args: any[]) => void) {
32
+ this.listeners.get(event)?.delete(fn)
33
+ }
34
+
35
+ send(_data: any) {
36
+ /* no-op for mock */
37
+ }
38
+
39
+ /** Test helper to simulate events */
40
+ _emit(event: string, ...args: any[]) {
41
+ for (const fn of this.listeners.get(event) ?? []) fn(...args)
42
+ }
43
+ }
44
+
45
+ // ---------------------------------------------------------------------------
46
+ // fromSimplePeer — the ~20-line bridge function under test
47
+ // ---------------------------------------------------------------------------
48
+
49
+ function fromSimplePeer(peer: MockSimplePeer): DataChannelLike {
50
+ // Map: DataChannelLike event → simple-peer event
51
+ const eventMap: Record<string, string> = {
52
+ open: "connect",
53
+ close: "close",
54
+ error: "error",
55
+ message: "data",
56
+ }
57
+
58
+ // Track wrapped listeners for cleanup
59
+ const wrapperMap = new Map<Function, Function>()
60
+
61
+ return {
62
+ get readyState() {
63
+ return peer.connected ? "open" : "connecting"
64
+ },
65
+ binaryType: "arraybuffer",
66
+ send(data: Uint8Array) {
67
+ peer.send(data)
68
+ },
69
+ addEventListener(type: string, listener: (event: any) => void) {
70
+ const peerEvent = eventMap[type]
71
+ if (!peerEvent) return
72
+ const wrapped =
73
+ type === "message"
74
+ ? (data: any) => listener({ data })
75
+ : () => listener({})
76
+ wrapperMap.set(listener, wrapped)
77
+ peer.on(peerEvent, wrapped)
78
+ },
79
+ removeEventListener(type: string, listener: (event: any) => void) {
80
+ const peerEvent = eventMap[type]
81
+ if (!peerEvent) return
82
+ const wrapped = wrapperMap.get(listener)
83
+ if (wrapped) {
84
+ peer.off(peerEvent, wrapped as any)
85
+ wrapperMap.delete(listener)
86
+ }
87
+ },
88
+ }
89
+ }
90
+
91
+ // ---------------------------------------------------------------------------
92
+ // Helpers
93
+ // ---------------------------------------------------------------------------
94
+
95
+ async function initializeTransport(transport: WebrtcTransport) {
96
+ transport._initialize({
97
+ identity: { peerId: "local", name: "Local", type: "user" as const },
98
+ onChannelReceive: vi.fn(),
99
+ onChannelAdded: vi.fn(),
100
+ onChannelRemoved: vi.fn(),
101
+ onChannelEstablish: vi.fn(),
102
+ })
103
+ await transport._start()
104
+ }
105
+
106
+ // ---------------------------------------------------------------------------
107
+ // Tests
108
+ // ---------------------------------------------------------------------------
109
+
110
+ describe("fromSimplePeer bridge", () => {
111
+ it("satisfies DataChannelLike", () => {
112
+ const peer = new MockSimplePeer()
113
+ const dc: DataChannelLike = fromSimplePeer(peer)
114
+
115
+ expect(dc.readyState).toBe("connecting")
116
+ expect(dc.binaryType).toBe("arraybuffer")
117
+ expect(typeof dc.send).toBe("function")
118
+ expect(typeof dc.addEventListener).toBe("function")
119
+ expect(typeof dc.removeEventListener).toBe("function")
120
+ })
121
+
122
+ it("readyState reflects peer.connected", () => {
123
+ const peer = new MockSimplePeer()
124
+ const dc = fromSimplePeer(peer)
125
+
126
+ expect(dc.readyState).toBe("connecting")
127
+
128
+ peer.connected = true
129
+ expect(dc.readyState).toBe("open")
130
+
131
+ peer.connected = false
132
+ expect(dc.readyState).toBe("connecting")
133
+ })
134
+
135
+ it("open event fires when peer emits connect", () => {
136
+ const peer = new MockSimplePeer()
137
+ const dc = fromSimplePeer(peer)
138
+ const spy = vi.fn()
139
+
140
+ dc.addEventListener("open", spy)
141
+ peer._emit("connect")
142
+
143
+ expect(spy).toHaveBeenCalledOnce()
144
+ expect(spy).toHaveBeenCalledWith({})
145
+ })
146
+
147
+ it("message event wraps data in event object", () => {
148
+ const peer = new MockSimplePeer()
149
+ const dc = fromSimplePeer(peer)
150
+ const spy = vi.fn()
151
+ const payload = new Uint8Array([1, 2, 3, 4])
152
+
153
+ dc.addEventListener("message", spy)
154
+ peer._emit("data", payload)
155
+
156
+ expect(spy).toHaveBeenCalledOnce()
157
+ expect(spy).toHaveBeenCalledWith({ data: payload })
158
+ })
159
+
160
+ it("removeEventListener cleans up", () => {
161
+ const peer = new MockSimplePeer()
162
+ const dc = fromSimplePeer(peer)
163
+ const spy = vi.fn()
164
+
165
+ dc.addEventListener("open", spy)
166
+ dc.removeEventListener("open", spy)
167
+ peer._emit("connect")
168
+
169
+ expect(spy).not.toHaveBeenCalled()
170
+ })
171
+
172
+ it("works with WebrtcTransport", async () => {
173
+ const transport = new WebrtcTransport()
174
+ await initializeTransport(transport)
175
+
176
+ const peer = new MockSimplePeer()
177
+ const dc = fromSimplePeer(peer)
178
+
179
+ transport.attachDataChannel("remote-peer", dc)
180
+
181
+ // Channel attached but not yet open — no sync channel yet
182
+ expect(transport.hasDataChannel("remote-peer")).toBe(true)
183
+ expect(transport.channels.size).toBe(0)
184
+
185
+ // Simulate simple-peer connection
186
+ peer.connected = true
187
+ peer._emit("connect")
188
+
189
+ // Transport should now have a sync channel
190
+ expect(transport.channels.size).toBe(1)
191
+
192
+ // Clean up
193
+ transport.detachDataChannel("remote-peer")
194
+ expect(transport.hasDataChannel("remote-peer")).toBe(false)
195
+ expect(transport.channels.size).toBe(0)
196
+ })
197
+ })