bao-browser 0.1.0

A Rust-native programmable browser runtime built on Servo and SpiderMonkey
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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
// REQ-CDP WS command-face e2e: real WebSocket round-trips against a live
// BaoRuntime + CdpServer wired through BaoWsRegistry (the production wiring
// run_browser performs). Asserts the Playwright-direct-connect minimal face:
// Target.getTargets / Target.attachToTarget(flatten) / Page.navigate /
// Runtime.evaluate all reach the real servo PagePool via the bridge.
// @trace REQ-CDP-001 [entity:CdpServer]
// @trace REQ-CDP-005 [req:REQ-CDP-005] [level:e2e]

use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{mpsc, Arc};
use std::time::Duration;

use bao_browser::{handle_bridge_command, BaoConfig, BaoRuntime, BaoWsRegistry, PageConfig};
use bao_cdp::domains::ServoTargetProvider;
use bao_cdp::servo_bridge::bridge_channel;
use bun_uws::ws_client::{RecvOutcome, WebSocketClient};
use cdp_server::{CdpServer, EventSender, ServerConfig};
use serde_json::{json, Value};

/// Bind a TcpListener to 127.0.0.1:0 to reserve an ephemeral port, then
/// release it for the CdpServer to bind (tiny race window, test-only).
fn pick_free_port() -> u16 {
    std::net::TcpListener::bind("127.0.0.1:0")
        .unwrap()
        .local_addr()
        .unwrap()
        .port()
}

struct WsCdp {
    client: WebSocketClient,
    next_id: i64,
}

impl WsCdp {
    fn connect(url: &str) -> Self {
        let mut client = WebSocketClient::connect(url).expect("ws connect");
        client.set_read_timeout(Duration::from_secs(5));
        WsCdp {
            client,
            next_id: 1,
        }
    }

    /// Send a command and wait for the matching response id (events are
    /// skipped). Returns the full response object.
    fn send(&mut self, method: &str, params: Value) -> Value {
        let id = self.next_id;
        self.next_id += 1;
        let mut msg = json!({ "id": id, "method": method });
        if !params.is_null() {
            msg["params"] = params;
        }
        self.client
            .send_text(&serde_json::to_string(&msg).unwrap())
            .expect("ws send");
        let deadline = std::time::Instant::now() + Duration::from_secs(30);
        while std::time::Instant::now() < deadline {
            match self.client.recv().expect("ws recv") {
                RecvOutcome::Message(_op, payload) => {
                    let v: Value = serde_json::from_slice(&payload).expect("valid json frame");
                    if v.get("id").and_then(|i| i.as_i64()) == Some(id) {
                        return v;
                    }
                    // event or unrelated response — keep reading
                }
                RecvOutcome::Timeout => {
                    continue;
                }
                RecvOutcome::Closed => panic!("ws closed waiting for {method} response"),
            }
        }
        panic!("timeout waiting for {method} response");
    }

    /// Send a raw message object (carrying a sessionId) and wait for the
    /// matching response id.
    fn send_raw(&mut self, msg: Value) -> Value {
        let id = msg["id"].as_i64().unwrap();
        self.client
            .send_text(&serde_json::to_string(&msg).unwrap())
            .expect("ws send");
        let deadline = std::time::Instant::now() + Duration::from_secs(30);
        while std::time::Instant::now() < deadline {
            match self.client.recv().expect("ws recv") {
                RecvOutcome::Message(_op, payload) => {
                    let v: Value = serde_json::from_slice(&payload).expect("valid json frame");
                    if v.get("id").and_then(|i| i.as_i64()) == Some(id) {
                        return v;
                    }
                }
                RecvOutcome::Timeout => continue,
                RecvOutcome::Closed => panic!("ws closed waiting for raw response"),
            }
        }
        panic!("timeout waiting for raw response");
    }
}

/// The WS-client half of the e2e. Runs on a helper thread while the main
/// thread drives the servo event loop (BaoRuntime holds Rc<Servo> — the loop
/// must stay on the thread that created it, exactly like run_browser).
fn client_phase(ws_url: String, page_id: usize, done: Arc<AtomicBool>) {
    let mut cdp = WsCdp::connect(&ws_url);

    // 1. Target.getTargets — real PagePool enumeration via the bridge.
    let resp = cdp.send("Target.getTargets", json!({}));
    assert!(
        resp.get("error").is_none(),
        "getTargets must succeed: {resp}"
    );
    let infos = resp["result"]["targetInfos"].as_array().expect("targetInfos");
    assert!(
        infos
            .iter()
            .any(|i| i["targetId"].as_str() == Some(&page_id.to_string())),
        "the real page id must be listed: {infos:?}"
    );

    // 2. Page.navigate — a real servo navigation must happen.
    let html = "<html><head><title>bao-ws-e2e</title></head><body><h1>ok</h1></body></html>";
    let url = format!("data:text/html;charset=utf-8,{html}");
    let resp = cdp.send("Page.navigate", json!({ "url": url }));
    assert!(resp.get("error").is_none(), "navigate must succeed: {resp}");
    let frame_id = resp["result"]["frameId"].as_str().expect("frameId");
    assert_eq!(frame_id, page_id.to_string(), "frameId = real page id");

    // 3. Runtime.evaluate — poll until the navigation landed, then assert
    //    the document title genuinely reflects the navigated document.
    //    Transient evaluate errors are expected mid-navigation (the old
    //    document is being torn down) — only the final state is asserted.
    let mut title = String::new();
    let mut last_error = Value::Null;
    for _ in 0..200 {
        let resp = cdp.send(
            "Runtime.evaluate",
            json!({ "expression": "document.title", "returnByValue": true }),
        );
        if let Some(err) = resp.get("error") {
            last_error = err.clone();
        } else if let Some(t) = resp["result"]["result"]["value"].as_str() {
            if t == "bao-ws-e2e" {
                title = t.to_string();
                break;
            }
        }
        std::thread::sleep(Duration::from_millis(50));
    }
    assert_eq!(
        title, "bao-ws-e2e",
        "evaluate must observe the navigated document (last error: {last_error})"
    );

    // 4. Flattened session routing (the Playwright browser-connection mode):
    //    attach to the page target, then route a command through sessionId.
    let resp = cdp.send(
        "Target.attachToTarget",
        json!({ "targetId": page_id.to_string(), "flatten": true }),
    );
    assert!(
        resp.get("error").is_none(),
        "attachToTarget must succeed: {resp}"
    );
    let session_id = resp["result"]["sessionId"]
        .as_str()
        .expect("sessionId")
        .to_string();
    assert!(!session_id.is_empty());

    let flat = cdp.send_raw(json!({
        "id": cdp.next_id,
        "method": "Runtime.evaluate",
        "params": { "expression": "1 + 41", "returnByValue": true },
        "sessionId": session_id,
    }));
    cdp.next_id += 1;
    assert!(
        flat.get("error").is_none(),
        "flat evaluate must succeed: {flat}"
    );
    assert_eq!(
        flat["result"]["result"]["value"], 42,
        "sessionId routing reaches the page"
    );

    // 5. Explicit-error contract through the WS face: Fetch.enable must
    //    surface the no-interception-facility error, never a canned ok.
    let resp = cdp.send("Fetch.enable", json!({ "patterns": [{ "urlPattern": "*" }] }));
    let err = resp["error"]
        .as_object()
        .expect("Fetch.enable must fail explicitly");
    assert_eq!(err["code"], -32000);
    assert!(err["message"]
        .as_str()
        .unwrap()
        .contains("no request interception facility"));

    done.store(true, Ordering::Relaxed);
}

/// REQ-CDP Runtime object protocol e2e: the callFunctionOn/objectId/release
/// surface Playwright's page.evaluate drives — evaluateHandle (rbv=false)
/// mints objectIds, callFunctionOn calls a stringized function on/with those
/// objects ({value}/{objectId}/{unserializableValue} args), awaitPromise
/// resolves, getProperties roundtrips nested objectIds, and releaseObject/
/// releaseObjectGroup drop registry entries.
fn object_protocol_phase(ws_url: String, done: Arc<AtomicBool>) {
    let mut cdp = WsCdp::connect(&ws_url);

    // Navigate to a stable document first (evaluate needs a live realm).
    let html = "<html><body><div id='d'>ok</div></body></html>";
    let url = format!("data:text/html;charset=utf-8,{html}");
    let resp = cdp.send("Page.navigate", json!({ "url": url }));
    assert!(resp.get("error").is_none(), "navigate must succeed: {resp}");

    // Wait for the document to exist (mid-navigation evaluates are flaky).
    let mut ready = false;
    for _ in 0..200 {
        let r = cdp.send(
            "Runtime.evaluate",
            json!({ "expression": "!!document.body", "returnByValue": true }),
        );
        if r["result"]["result"]["value"] == json!(true) {
            ready = true;
            break;
        }
        std::thread::sleep(Duration::from_millis(50));
    }
    assert!(ready, "document never became ready");

    // 1. evaluateHandle (returnByValue=false) → RemoteObject with objectId.
    let resp = cdp.send(
        "Runtime.evaluate",
        json!({ "expression": "({answer: 42})", "returnByValue": false }),
    );
    assert!(resp.get("error").is_none(), "evaluateHandle: {resp}");
    let oid1 = resp["result"]["result"]["objectId"]
        .as_str()
        .expect("evaluateHandle must return an objectId")
        .to_string();
    assert_eq!(resp["result"]["result"]["type"], "object");
    assert_eq!(resp["result"]["result"]["className"], "Object");
    assert!(resp["result"]["exceptionDetails"].is_null());

    // 2. callFunctionOn with objectId `this` + {value} arg, returnByValue.
    let resp = cdp.send(
        "Runtime.callFunctionOn",
        json!({
            "objectId": oid1,
            "functionDeclaration": "function(bump) { return this.answer + bump; }",
            "arguments": [{ "value": 10 }],
            "returnByValue": true,
        }),
    );
    assert!(resp.get("error").is_none(), "callFunctionOn value arg: {resp}");
    assert_eq!(resp["result"]["result"]["value"], 52);
    assert!(resp["result"]["exceptionDetails"].is_null());

    // 3. {objectId} argument roundtrip: a second handle passed as an arg.
    let resp = cdp.send(
        "Runtime.evaluate",
        json!({ "expression": "({x: 100})", "returnByValue": false }),
    );
    let oid2 = resp["result"]["result"]["objectId"]
        .as_str()
        .expect("second objectId")
        .to_string();
    let resp = cdp.send(
        "Runtime.callFunctionOn",
        json!({
            "objectId": oid1,
            "functionDeclaration": "function(other) { return this.answer + other.x; }",
            "arguments": [{ "objectId": oid2 }],
            "returnByValue": true,
        }),
    );
    assert!(
        resp.get("error").is_none(),
        "callFunctionOn objectId arg: {resp}"
    );
    assert_eq!(resp["result"]["result"]["value"], 142);

    // 4. unserializableValue arg (NaN).
    let resp = cdp.send(
        "Runtime.callFunctionOn",
        json!({
            "objectId": oid1,
            "functionDeclaration": "function(v) { return v !== v ? 'nan' : 'not-nan'; }",
            "arguments": [{ "unserializableValue": "NaN" }],
            "returnByValue": true,
        }),
    );
    assert!(resp.get("error").is_none(), "NaN arg: {resp}");
    assert_eq!(resp["result"]["result"]["value"], "nan");

    // 5. awaitPromise (executionContextId form, this=undefined).
    let resp = cdp.send(
        "Runtime.callFunctionOn",
        json!({
            "functionDeclaration": "function() { return Promise.resolve(7).then(function(v) { return v * 6; }); }",
            "arguments": [],
            "returnByValue": true,
            "awaitPromise": true,
        }),
    );
    assert!(resp.get("error").is_none(), "awaitPromise: {resp}");
    assert_eq!(resp["result"]["result"]["value"], 42);

    // 6. Thrown exception → exceptionDetails, never a fake ok.
    let resp = cdp.send(
        "Runtime.callFunctionOn",
        json!({
            "objectId": oid1,
            "functionDeclaration": "function() { throw new Error('boom-cdp'); }",
            "returnByValue": true,
        }),
    );
    assert!(resp.get("error").is_none(), "throw path: {resp}");
    let text = resp["result"]["exceptionDetails"]["text"]
        .as_str()
        .unwrap_or("");
    assert!(
        text.contains("boom-cdp"),
        "exceptionDetails must carry the message, got: {resp}"
    );

    // 7. getProperties roundtrip: nested object values carry real objectIds.
    let resp = cdp.send(
        "Runtime.getProperties",
        json!({ "objectId": oid1, "ownProperties": true }),
    );
    assert!(resp.get("error").is_none(), "getProperties: {resp}");
    let props = resp["result"]["result"]
        .as_array()
        .expect("properties array");
    let answer = props
        .iter()
        .find(|p| p["name"] == json!("answer"))
        .expect("answer property present");
    assert_eq!(answer["value"]["type"], "number");
    assert_eq!(answer["value"]["value"], 42);

    // 8. releaseObject drops the entry: a follow-up getProperties sees an
    //    unregistered object (empty result), proving the release landed.
    let resp = cdp.send(
        "Runtime.releaseObject",
        json!({ "objectId": oid2 }),
    );
    assert!(resp.get("error").is_none(), "releaseObject: {resp}");
    let resp = cdp.send(
        "Runtime.getProperties",
        json!({ "objectId": oid2, "ownProperties": true }),
    );
    assert!(resp.get("error").is_none());
    assert_eq!(
        resp["result"]["result"], json!([]),
        "released objectId must no longer resolve"
    );

    // 9. releaseObjectGroup: entries minted under objectGroup are freed
    //    together (the Playwright context-teardown path).
    let resp = cdp.send(
        "Runtime.callFunctionOn",
        json!({
            "objectId": oid1,
            "functionDeclaration": "function() { return {tag: 'grouped'}; }",
            "returnByValue": false,
            "objectGroup": "e2e-group",
        }),
    );
    let grouped_oid = resp["result"]["result"]["objectId"]
        .as_str()
        .expect("grouped objectId")
        .to_string();
    let resp = cdp.send(
        "Runtime.releaseObjectGroup",
        json!({ "objectGroup": "e2e-group" }),
    );
    assert!(resp.get("error").is_none(), "releaseObjectGroup: {resp}");
    let resp = cdp.send(
        "Runtime.getProperties",
        json!({ "objectId": grouped_oid, "ownProperties": true }),
    );
    assert_eq!(
        resp["result"]["result"], json!([]),
        "released group entries must no longer resolve"
    );

    done.store(true, Ordering::Relaxed);
}

#[test]
fn ws_command_face_page_navigate_and_evaluate_roundtrip() {
    let runtime = BaoRuntime::new(BaoConfig::default()).expect("BaoRuntime::new");
    let page = runtime
        .create_page(&PageConfig {
            url: None,
            ..Default::default()
        })
        .expect("initial page");

    let (bridge_tx, bridge_rx) = bridge_channel(Duration::from_secs(30));
    let (event_subscriber, servo_event_rx) = bao_cdp_client::bridge::EventSubscriber::new();
    runtime.set_event_channel(event_subscriber.sender());

    let registry = Arc::new(BaoWsRegistry::new(bridge_tx.clone()));
    let port = pick_free_port();
    let server_config = ServerConfig::builder()
        .host("127.0.0.1")
        .port(port)
        .build();
    let mut server = CdpServer::with_registry(server_config, registry);
    server.set_target_provider(Arc::new(ServoTargetProvider::new(
        bridge_tx,
        page.id().to_string(),
        "127.0.0.1".into(),
        port,
    )));
    let broadcaster = server.broadcaster();
    std::thread::spawn(move || {
        let _ = server.run();
    });

    let ws_url = format!("ws://127.0.0.1:{port}/devtools/page/{}", page.id());

    let done = Arc::new(AtomicBool::new(false));
    let page_id = page.id();
    let client = {
        let done = Arc::clone(&done);
        std::thread::spawn(move || client_phase(ws_url, page_id, done))
    };

    // Main thread: the run_with_bridge loop shape (servo spin + bridge drain
    // + event translation), bounded by the client's done flag.
    use bao_cdp_client::bridge::translate;
    let deadline = std::time::Instant::now() + Duration::from_secs(120);
    while !done.load(Ordering::Relaxed) && std::time::Instant::now() < deadline {
        runtime.spin_event_loop();
        bridge_rx.drain(|cmd| handle_bridge_command(cmd, runtime.page_pool()));
        while let Ok(servo_event) = servo_event_rx.try_recv() {
            for cdp_event in translate(servo_event) {
                broadcaster.send_event(&cdp_event.method, cdp_event.params);
            }
        }
        std::thread::yield_now();
    }

    client.join().expect("client phase must not panic");
    assert!(
        done.load(Ordering::Relaxed),
        "client phase must have completed all assertions"
    );
}

/// Same dual-thread harness as the navigate/evaluate roundtrip, driving the
/// Runtime object-protocol client phase (evaluateHandle / callFunctionOn /
/// getProperties / releaseObject / releaseObjectGroup over live WS).
#[test]
fn ws_runtime_object_protocol_roundtrip() {
    let runtime = BaoRuntime::new(BaoConfig::default()).expect("BaoRuntime::new");
    let page = runtime
        .create_page(&PageConfig {
            url: None,
            ..Default::default()
        })
        .expect("initial page");

    let (bridge_tx, bridge_rx) = bridge_channel(Duration::from_secs(60));
    let (event_subscriber, servo_event_rx) = bao_cdp_client::bridge::EventSubscriber::new();
    runtime.set_event_channel(event_subscriber.sender());

    let registry = Arc::new(BaoWsRegistry::new(bridge_tx.clone()));
    let port = pick_free_port();
    let server_config = ServerConfig::builder()
        .host("127.0.0.1")
        .port(port)
        .build();
    let mut server = CdpServer::with_registry(server_config, registry);
    server.set_target_provider(Arc::new(ServoTargetProvider::new(
        bridge_tx,
        page.id().to_string(),
        "127.0.0.1".into(),
        port,
    )));
    let broadcaster = server.broadcaster();
    std::thread::spawn(move || {
        let _ = server.run();
    });

    let ws_url = format!("ws://127.0.0.1:{port}/devtools/page/{}", page.id());

    let done = Arc::new(AtomicBool::new(false));
    let client = {
        let done = Arc::clone(&done);
        std::thread::spawn(move || object_protocol_phase(ws_url, done))
    };

    // Main thread: the run_with_bridge loop shape (servo spin + bridge drain
    // + event translation), bounded by the client's done flag. The await-
    // Promise path polls from inside the bridge handler; each poll's
    // evaluate spins this same servo loop via spin_servo, so pending promise
    // chains progress even while the drain call is blocked.
    use bao_cdp_client::bridge::translate;
    let deadline = std::time::Instant::now() + Duration::from_secs(120);
    while !done.load(Ordering::Relaxed) && std::time::Instant::now() < deadline {
        runtime.spin_event_loop();
        bridge_rx.drain(|cmd| handle_bridge_command(cmd, runtime.page_pool()));
        while let Ok(servo_event) = servo_event_rx.try_recv() {
            for cdp_event in translate(servo_event) {
                broadcaster.send_event(&cdp_event.method, cdp_event.params);
            }
        }
        std::thread::yield_now();
    }

    client.join().expect("object protocol phase must not panic");
    assert!(
        done.load(Ordering::Relaxed),
        "object protocol phase must have completed all assertions"
    );
}

/// Regression for the ws_registry unit face: the bridge-less dispatch of a
/// Fetch command stays an explicit error and page-session commands carry the
/// WS session's target (also covered by ws_registry unit tests).
#[test]
fn ws_registry_fetch_explicit_error_and_target_routing_unit() {
    let (tx, rx) = bridge_channel(Duration::from_millis(200));
    let keeper = tx.clone();
    std::thread::spawn(move || {
        let _keeper = keeper;
        loop {
            let handled = rx.try_process(|cmd| match cmd {
                bao_cdp::servo_bridge::BridgeCommand::EvaluateJs { .. } => {
                    bao_cdp::servo_bridge::BridgeResponse {
                        result: Ok(json!({
                            "result": { "type": "number", "value": 7 }
                        })),
                    }
                }
                _ => bao_cdp::servo_bridge::BridgeResponse {
                    result: Ok(json!({})),
                },
            });
            if !handled {
                std::thread::sleep(Duration::from_millis(1));
            }
        }
    });

    let registry = BaoWsRegistry::new(tx);
    // The registry is consumed as Arc<dyn RegistryDispatch> by CdpServer —
    // exercise the same dispatch surface.
    let dispatch: Arc<dyn cdp_server::RegistryDispatch> = Arc::new(registry);
    let msg = cdp_server::CdpMessage {
        id: Some(1),
        method: "Runtime.evaluate".into(),
        params: Some(json!({"expression": "7"})),
        session_id: None,
    };
    struct Nop;
    impl cdp_server::EventSender for Nop {
        fn send_event(&self, _: &str, _: Value) {}
    }
    let r = dispatch
        .dispatch_message(&msg, "42", &Nop)
        .expect("dispatch must route the domain")
        .expect("evaluate must succeed");
    assert_eq!(r["result"]["value"], 7);

    let fetch = cdp_server::CdpMessage {
        id: Some(2),
        method: "Fetch.enable".into(),
        params: Some(json!({"patterns": []})),
        session_id: None,
    };
    let err = dispatch
        .dispatch_message(&fetch, "42", &Nop)
        .expect("Fetch domain is served")
        .expect_err("Fetch.enable must fail");
    assert_eq!(err.code, -32000);
    assert!(err.message.contains("no request interception facility"));
}