aboutsummaryrefslogtreecommitdiff
path: root/src/daemon/bridge.ts
blob: c2c13555e9e5f8c6ce54e0ad1dcce00ba34fb536 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
/**
 * CdpBridge — persistent WebSocket to Chrome, ID multiplexing, event routing.
 *
 * A single long-lived process connection to Chrome that proxies CDP traffic
 * for multiple pi clients connected via the IpcServer. One Allow dialog ever.
 *
 * References:
 *   - CDP message format: https://github.com/aslushnikov/getting-started-with-cdp#protocol-fundamentals
 *   - CDP sessions + IDs: https://github.com/aslushnikov/getting-started-with-cdp#targets--sessions
 *   - Target domain: https://chromedevtools.github.io/devtools-protocol/tot/Target/
 */

import WebSocket from "ws";
import { discoverWsUrl } from "../cdp/discovery";
import type { CdpRawMessage } from "../cdp/types";
import type { WireRequest, WireResponse, WireEvent } from "./protocol";
import { CDP_CONNECT_TIMEOUT_MS, CDP_COMMAND_TIMEOUT_MS } from "./protocol";

// ── Types ──────────────────────────────────────────────────────────────────────

export type SendToClient = (clientId: string, msg: WireResponse | WireEvent) => void;

export type EventHandler = (event: WireEvent, targetClientIds: string[]) => void;

export type CloseHandler = () => void;

export type CdpBridge = {
  /** Start the bridge. Resolves when the daemon IPC + Chrome discovery loop
   *  are initialized (not when Chrome is connected — that may take retries). */
  start(): Promise<void>;
  stop(): Promise<void>;
  handleRequest(req: WireRequest, clientId: string, send: SendToClient): void;
  /** True when the Chrome WebSocket is open and ready. */
  isAlive(): boolean;
  recordSession(clientId: string, sessionId: string): void;
  releaseSession(sessionId: string): void;
  getSessionOwner(sessionId: string): string | undefined;
  removeClient(clientId: string): void;
  onEvent(handler: EventHandler): void;
  onClose(handler: CloseHandler): void;
};

// ── ID Multiplexer ────────────────────────────────────────────────────────────

interface PendingEntry {
  clientId: string;
  localId: number;
}

class IdMultiplexer {
  private nextId = 1;
  private localToRemote = new Map<string, Map<number, number>>();
  private pending = new Map<number, PendingEntry>();

  allocate(clientId: string, localId: number): number {
    const daemonId = this.nextId++;
    let m = this.localToRemote.get(clientId);
    if (!m) { m = new Map(); this.localToRemote.set(clientId, m); }
    m.set(localId, daemonId);
    this.pending.set(daemonId, { clientId, localId });
    return daemonId;
  }

  resolve(daemonId: number): PendingEntry | null {
    const e = this.pending.get(daemonId);
    if (!e) return null;
    this.pending.delete(daemonId);
    const m = this.localToRemote.get(e.clientId);
    if (m) m.delete(e.localId);
    return e;
  }

  clearClient(clientId: string): void {
    const m = this.localToRemote.get(clientId);
    if (m) { for (const [, did] of m) this.pending.delete(did); }
    this.localToRemote.delete(clientId);
  }
}

// ── Event Router ───────────────────────────────────────────────────────────────

class EventRouter {
  private owners = new Map<string, string>();       // sessionId → clientId
  private clientSessions = new Map<string, Set<string>>(); // clientId → sessions

  record(clientId: string, sessionId: string): void {
    const prev = this.owners.get(sessionId);
    if (prev && prev !== clientId) {
      this.clientSessions.get(prev)?.delete(sessionId);
    }
    this.owners.set(sessionId, clientId);
    let s = this.clientSessions.get(clientId);
    if (!s) { s = new Set(); this.clientSessions.set(clientId, s); }
    s.add(sessionId);
  }

  release(sessionId: string): void {
    const owner = this.owners.get(sessionId);
    if (owner) this.clientSessions.get(owner)?.delete(sessionId);
    this.owners.delete(sessionId);
  }

  getOwner(sessionId: string): string | undefined {
    return this.owners.get(sessionId);
  }

  removeClient(clientId: string): void {
    const sessions = this.clientSessions.get(clientId);
    if (sessions) { for (const sid of sessions) this.owners.delete(sid); }
    this.clientSessions.delete(clientId);
  }

  /**
   * Route a CDP event to client(s).
   * Session-scoped → only the owning client.
   * Browser-level (no sessionId) → all connected clients.
   */
  route(event: WireEvent): string[] {
    if (event.sessionId) {
      const owner = this.owners.get(event.sessionId);
      return owner ? [owner] : [];
    }
    return [...this.clientSessions.keys()];
  }

  allClients(): string[] {
    return [...this.clientSessions.keys()];
  }
}

// ── Implementation ─────────────────────────────────────────────────────────────

export const createCdpBridge = (): CdpBridge => {
  let ws: WebSocket | null = null;
  let wsUrl: string | null = null;
  const mux = new IdMultiplexer();
  const router = new EventRouter();
  let eventHandler: EventHandler | null = null;
  let closeHandler: CloseHandler | null = null;

  // daemonId → { send, timer, isAttach }
  const callbacks = new Map<number, {
    send: SendToClient;
    clientId: string;
    localId: number;
    timer: ReturnType<typeof setTimeout>;
    isAttach: boolean;
  }>();

  // ── Handle raw CDP messages from Chrome ─────────────────────────────────

  const onChromeMessage = (raw: string): void => {
    let msg: CdpRawMessage;
    try { msg = JSON.parse(raw); } catch { return; }

    // ---- Response (has id) ----
    if (msg.id !== undefined) {
      const cb = callbacks.get(msg.id);
      if (!cb) {
        // Stale response — client already timed out or disconnected.
        // Still clean up the multiplexer mapping.
        mux.resolve(msg.id);
        return;
      }
      clearTimeout(cb.timer);
      callbacks.delete(msg.id);

      const localId = cb.localId;

      if (msg.error) {
        cb.send(cb.clientId, {
          type: "response",
          id: localId,
          error: { code: msg.error.code ?? -1, message: msg.error.message },
        });
      } else {
        // Track session ownership for attach responses
        if (cb.isAttach && msg.result) {
          const result = msg.result as { sessionId?: string };
          if (result.sessionId) {
            router.record(cb.clientId, result.sessionId);
          }
        }
        cb.send(cb.clientId, { type: "response", id: localId, result: msg.result });
      }

      mux.resolve(msg.id);
      return;
    }

    // ---- Event (no id, has method) ----
    if (!msg.method) return;

    // Inspector.detached — release session ownership
    if (msg.method === "Inspector.detached" && msg.sessionId) {
      router.release(msg.sessionId);
    }

    const wireEvent: WireEvent = {
      type: "event",
      method: msg.method,
      ...(msg.params !== undefined ? { params: msg.params } : {}),
      ...(msg.sessionId !== undefined ? { sessionId: msg.sessionId } : {}),
    };

    // Route through the event handler for the IpcServer to broadcast
    if (eventHandler) {
      const targets = router.route(wireEvent);
      if (targets.length > 0) {
        eventHandler(wireEvent, targets);
      }
    }
  };

  // ── Connect to Chrome ───────────────────────────────────────────────────

  // ── Auto-reconnecting Chrome connection ───────────────────────────────

  let reconnectTimer: ReturnType<typeof setTimeout> | null = null;
  let reconnectAttempt = 0;
  let stopped = false;

  /**
   * Try to discover Chrome and open a WebSocket. On failure, schedule
   * an exponential backoff retry (capped at 60s). When Chrome finally
   * becomes available, the bridge connects automatically — no manual
   * daemon restart needed.
   */
  const tryConnect = (): void => {
    if (stopped) return;
    if (reconnectTimer) { clearTimeout(reconnectTimer); reconnectTimer = null; }

    const attempt = async (): Promise<void> => {
      // Already connected — nothing to do.
      if (ws && ws.readyState === WebSocket.OPEN) return;

      // Resolve URL (discover if not cached, or clear cache on retry)
      let url = wsUrl;
      if (!url || reconnectAttempt > 0) {
        const d = await discoverWsUrl();
        if (!d.success) { scheduleRetry(); return; }
        url = d.data;
        wsUrl = url;
      }

      const settledPromise = new Promise<void>((settle) => {
        let settled = false;
        const settleOnce = (): void => {
          if (settled) return;
          settled = true;
          settle();
        };

        let sock: WebSocket;
        try {
          sock = new WebSocket(url!, { perMessageDeflate: false });
        } catch {
          scheduleRetry();
          return;
        }

        const timer = setTimeout(() => {
          sock.close();
          settleOnce();
        }, CDP_CONNECT_TIMEOUT_MS);

        sock.on("open", () => {
          clearTimeout(timer);
          ws = sock;
          reconnectAttempt = 0;
          // Enable target discovery so we see page events
          ws.send(JSON.stringify({ id: 0, method: "Target.setDiscoverTargets", params: { discover: true } }));
          console.log("[pi-browser-daemon] Connected to Chrome ✓");
          settleOnce();
        });

        sock.on("message", (data: WebSocket.Data) => {
          onChromeMessage(typeof data === "string" ? data : data.toString());
        });

        sock.on("error", () => {
          clearTimeout(timer);
          settleOnce();
        });

        sock.on("close", () => {
          clearTimeout(timer);
          ws = null;
          // Reject all pending callbacks
          for (const [daemonId, cb] of callbacks) {
            clearTimeout(cb.timer);
            cb.send(cb.clientId, {
              type: "response",
              id: cb.localId,
              error: { code: -32000, message: "Chrome disconnected" },
            });
            callbacks.delete(daemonId);
            mux.resolve(daemonId);
          }
          closeHandler?.();
          // Auto-reconnect on unexpected close
          scheduleRetry();
        });
      });

      await settledPromise;
      // If connection didn't succeed, schedule a retry
      if (!ws || ws.readyState !== WebSocket.OPEN) {
        scheduleRetry();
      }
    };

    attempt().catch(() => scheduleRetry());
  };

  /** Exponential backoff: 1s, 2s, 4s, 8s, 16s, 32s, 60s (capped). */
  const scheduleRetry = (): void => {
    if (stopped) return;
    const delay = Math.min(1000 * Math.pow(2, Math.min(reconnectAttempt, 6)), 60_000);
    reconnectAttempt++;
    wsUrl = null; // force re-discovery on next attempt
    reconnectTimer = setTimeout(tryConnect, delay);
  };

  const start = async (): Promise<void> => {
    stopped = false;
    // Don't await — the retry loop runs in the background.
    // The daemon is "started" when the IPC server is listening, not when
    // Chrome is connected.
    tryConnect();
  };

  const stop = async (): Promise<void> => {
    stopped = true;
    if (reconnectTimer) { clearTimeout(reconnectTimer); reconnectTimer = null; }
    for (const [, cb] of callbacks) clearTimeout(cb.timer);
    callbacks.clear();
    if (ws) { try { ws.close(1000, "Shutdown"); } catch {} ws = null; }
    wsUrl = null;
  };

  const handleRequest = (
    req: WireRequest,
    clientId: string,
    send: SendToClient,
  ): void => {
    if (!ws || ws.readyState !== WebSocket.OPEN) {
      send(clientId, {
        type: "response",
        id: req.id,
        error: { code: -32000, message: "Chrome not connected" },
      });
      return;
    }

    const daemonId = mux.allocate(clientId, req.id);

    // Store callback for the response
    const timer = setTimeout(() => {
      callbacks.delete(daemonId);
      mux.resolve(daemonId);
      send(clientId, {
        type: "response",
        id: req.id,
        error: { code: -32000, message: `Timeout after ${CDP_COMMAND_TIMEOUT_MS}ms: ${req.method}` },
      });
    }, CDP_COMMAND_TIMEOUT_MS);

    const isAttach = req.method === "Target.attachToTarget";
    const isDetach = req.method === "Target.detachFromTarget";

    if (isDetach && req.sessionId) {
      router.release(req.sessionId);
    }

    callbacks.set(daemonId, { send, clientId, localId: req.id, timer, isAttach });

    const payload: Record<string, unknown> = {
      id: daemonId,
      method: req.method,
      params: req.params ?? {},
    };
    if (req.sessionId) payload["sessionId"] = req.sessionId;

    try {
      ws.send(JSON.stringify(payload));
    } catch (e) {
      clearTimeout(timer);
      callbacks.delete(daemonId);
      mux.resolve(daemonId);
      send(clientId, {
        type: "response",
        id: req.id,
        error: { code: -32000, message: e instanceof Error ? e.message : String(e) },
      });
    }
  };

  return {
    start,
    stop,
    handleRequest,
    isAlive: () => ws !== null && ws.readyState === WebSocket.OPEN,
    recordSession: (cid, sid) => router.record(cid, sid),
    releaseSession: (sid) => router.release(sid),
    getSessionOwner: (sid) => router.getOwner(sid),
    removeClient: (cid) => { mux.clearClient(cid); router.removeClient(cid); },
    onEvent: (h) => { eventHandler = h; },
    onClose: (h) => { closeHandler = h; },
  };
};