zendriver 0.2.9

Async-first, undetectable browser automation via the Chrome DevTools Protocol
Documentation 
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

//! Integration tests for `tab.monitor()` and `tab.request()`.
//!
//! These tests start a real Chrome instance against a wiremock server and
//! exercise the network monitor stream and the browser-context HTTP builder.
//! They are gated behind `integration-tests` and marked `#[ignore]` so they
//! only run when a Chrome binary is available and the caller passes `--ignored`.
//!
//! Run:
//! ```bash
//! cargo test -p zendriver --features integration-tests \
//!     --test network_monitor_http -- --ignored
//! ```

#![cfg(feature = "integration-tests")]
#![allow(clippy::panic, clippy::unwrap_used)]

use std::time::Duration;

use futures::StreamExt;
use serial_test::serial;
use wiremock::matchers::{method, path};
use wiremock::{Mock, MockServer, ResponseTemplate};
use zendriver::{Browser, NetworkEvent};

// ──────────────────────────────────────────────────────────────────────────────
// Helpers — mirrored verbatim from integration_phase4.rs
// ──────────────────────────────────────────────────────────────────────────────

/// Spin up a mock HTTP server that returns `html` at `/`.
async fn fixture_with_html(html: &str) -> MockServer {
    let mock = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/"))
        .respond_with(
            ResponseTemplate::new(200).set_body_raw(html.as_bytes().to_vec(), "text/html"),
        )
        .mount(&mock)
        .await;
    mock
}

// ──────────────────────────────────────────────────────────────────────────────
// monitor_captures_fetch
// ──────────────────────────────────────────────────────────────────────────────

/// The monitor sees an in-page `fetch("/data")` as a `NetworkEvent::Http` with
/// status 200 and a retrievable text body.
#[tokio::test]
#[serial]
#[ignore]
async fn monitor_captures_fetch() {
    let mock = MockServer::start().await;

    // Serve the data endpoint BEFORE the page so the page fetch always hits it.
    Mock::given(method("GET"))
        .and(path("/data"))
        .respond_with(ResponseTemplate::new(200).set_body_string("hello-monitor"))
        .mount(&mock)
        .await;

    Mock::given(method("GET"))
        .and(path("/"))
        .respond_with(
            ResponseTemplate::new(200).set_body_raw(
                r#"<!doctype html><html><body>
                  <script>
                    window.fetchDone = false;
                    fetch('/data')
                      .then(r => r.text())
                      .then(t => { window.fetchResult = t; window.fetchDone = true; })
                      .catch(e => { window.fetchErr = String(e); window.fetchDone = true; });
                  </script>
                </body></html>"#
                    .as_bytes()
                    .to_vec(),
                "text/html",
            ),
        )
        .mount(&mock)
        .await;

    let browser = Browser::builder().headless(true).launch().await.unwrap();
    let tab = browser.main_tab();

    // Start monitor BEFORE navigation so it catches the page's /data fetch.
    let mut monitor = tab.monitor().start().await.unwrap();

    tab.goto(&mock.uri()).await.unwrap();
    tab.wait_for_load().await.unwrap();

    // Poll until we see the /data exchange, skipping unrelated navigation
    // requests (e.g. the page itself, favicon).
    let base = mock.uri();
    let data_url = format!("{base}/data");

    let deadline = std::time::Instant::now() + Duration::from_secs(10);
    let exchange = loop {
        if std::time::Instant::now() >= deadline {
            panic!("monitor did not emit a NetworkEvent::Http for /data within 10s");
        }
        match tokio::time::timeout(Duration::from_secs(5), monitor.next()).await {
            Ok(Some(NetworkEvent::Http(ex))) if ex.request.url == data_url => break ex,
            Ok(Some(_)) => continue, // skip unrelated events
            Ok(None) => panic!("monitor stream ended before /data exchange"),
            Err(_) => panic!("timed out waiting for /data exchange"),
        }
    };

    assert_eq!(exchange.status(), Some(200), "expected status 200");
    assert!(exchange.is_success());
    assert!(exchange.error.is_none());

    // Fetch the body lazily via getResponseBody.
    let body = exchange.text().await.unwrap();
    assert_eq!(body, "hello-monitor", "body mismatch");

    monitor.stop();
    browser.close().await.unwrap();
}

// ──────────────────────────────────────────────────────────────────────────────
// request_get_inherits_cookies
// ──────────────────────────────────────────────────────────────────────────────

/// `tab.request().get(...)` inherits the cookies set on the page origin.
#[tokio::test]
#[serial]
#[ignore]
async fn request_get_inherits_cookies() {
    // Single MockServer: page + /echo-cookie must be same-origin so the
    // in-page fetch actually sends the Cookie header.
    let mock = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/"))
        .respond_with(
            ResponseTemplate::new(200).set_body_raw(
                r#"<!doctype html><html><body><div id="d">x</div></body></html>"#
                    .as_bytes()
                    .to_vec(),
                "text/html",
            ),
        )
        .mount(&mock)
        .await;
    // /echo-cookie: wiremock can't reflect dynamic request headers, so we
    // just need the endpoint to return 200 — cookie inheritance is proved by
    // the cookie being set on the page *before* the request and by the request
    // reaching the endpoint (not 404/blocked). Cookie presence is verified
    // via document.cookie; the browser guarantee handles the rest.
    Mock::given(method("GET"))
        .and(path("/echo-cookie"))
        .respond_with(ResponseTemplate::new(200).set_body_string("ok"))
        .mount(&mock)
        .await;

    let browser = Browser::builder().headless(true).launch().await.unwrap();
    let tab = browser.main_tab();
    tab.goto(&mock.uri()).await.unwrap();
    tab.wait_for_load().await.unwrap();

    // Plant a cookie on this origin via JS.
    tab.evaluate_main::<serde_json::Value>("document.cookie = 'session=abc123; path=/'; null")
        .await
        .unwrap();

    // Confirm cookie is set.
    let cookie_val: String = tab.evaluate_main("document.cookie").await.unwrap();
    assert!(
        cookie_val.contains("session=abc123"),
        "cookie not set on page; got: {cookie_val:?}"
    );

    // Issue the GET to the same origin — cookies are inherited by in-page fetch.
    let echo_url = format!("{}/echo-cookie", mock.uri());
    let resp = tab.request().get(&echo_url).send().await.unwrap();

    assert_eq!(resp.status(), 200, "echo-cookie endpoint should return 200");

    browser.close().await.unwrap();
}

// ──────────────────────────────────────────────────────────────────────────────
// request_post_json_round_trips
// ──────────────────────────────────────────────────────────────────────────────

/// `tab.request().post(url).json(&payload).send()` delivers JSON and the
/// echoed response body deserializes back to the original shape.
#[tokio::test]
#[serial]
#[ignore]
async fn request_post_json_round_trips() {
    // Single MockServer: page + /echo-json must be same-origin so the
    // in-page fetch is not blocked by CORS.
    let mock = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/"))
        .respond_with(ResponseTemplate::new(200).set_body_raw(
            r#"<!doctype html><html><body></body></html>"#.as_bytes().to_vec(),
            "text/html",
        ))
        .mount(&mock)
        .await;

    // /echo-json: wiremock returns the known payload statically (can't echo
    // request body, but we control both sides so the content matches).
    let echo_body = serde_json::json!({"key": "value", "num": 42});
    Mock::given(method("POST"))
        .and(path("/echo-json"))
        .respond_with(
            ResponseTemplate::new(200)
                .set_body_bytes(echo_body.to_string().into_bytes())
                .insert_header("content-type", "application/json"),
        )
        .mount(&mock)
        .await;

    let browser = Browser::builder().headless(true).launch().await.unwrap();
    let tab = browser.main_tab();
    tab.goto(&mock.uri()).await.unwrap();
    tab.wait_for_load().await.unwrap();

    #[derive(serde::Serialize, serde::Deserialize, Debug, PartialEq)]
    struct Payload {
        key: String,
        num: i32,
    }
    let payload = Payload {
        key: "value".into(),
        num: 42,
    };

    let echo_url = format!("{}/echo-json", mock.uri());
    let resp = tab
        .request()
        .post(&echo_url)
        .json(&payload)
        .unwrap()
        .send()
        .await
        .unwrap();

    assert_eq!(resp.status(), 200);

    let echoed: Payload = resp.json().unwrap();
    assert_eq!(echoed, payload, "echoed JSON should match sent payload");

    browser.close().await.unwrap();
}

// ──────────────────────────────────────────────────────────────────────────────
// bypass_cors_reaches_cross_origin
// ──────────────────────────────────────────────────────────────────────────────

/// `.bypass_cors()` reaches a cross-origin endpoint that the in-page `fetch`
/// path would be blocked on (no CORS headers on the target).
#[tokio::test]
#[serial]
#[ignore]
async fn bypass_cors_reaches_cross_origin() {
    // Two separate mock servers = two distinct origins.
    let page_mock = fixture_with_html(r#"<!doctype html><html><body></body></html>"#).await;

    let cross_origin_mock = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/resource"))
        .respond_with(
            ResponseTemplate::new(200).set_body_string("cross-origin-data"),
            // Deliberately no Access-Control-Allow-Origin header, so an
            // in-page fetch would be CORS-blocked.
        )
        .mount(&cross_origin_mock)
        .await;

    let browser = Browser::builder().headless(true).launch().await.unwrap();
    let tab = browser.main_tab();
    tab.goto(&page_mock.uri()).await.unwrap();
    tab.wait_for_load().await.unwrap();

    let cross_url = format!("{}/resource", cross_origin_mock.uri());
    let resp = tab
        .request()
        .get(&cross_url)
        .bypass_cors()
        .send()
        .await
        .unwrap();

    assert_eq!(
        resp.status(),
        200,
        "bypass_cors should reach the cross-origin endpoint"
    );
    let body = resp.text().unwrap();
    assert_eq!(body, "cross-origin-data");

    browser.close().await.unwrap();
}

// ──────────────────────────────────────────────────────────────────────────────
// monitor_captures_websocket_frames
// ──────────────────────────────────────────────────────────────────────────────

// MANUAL: requires a live WS endpoint. tokio-tungstenite is not a dev-dep
// (adding it would pull a non-trivial transitive graph); use the unit-level
// MockConnection WS tests in monitor/mod.rs for automated coverage. This
// test is kept compile-correct and `#[ignore]`d for manual verification
// against a real WS server when desired.
//
// To run manually against a local echo server:
// 1. Start: `websocat -s 9001`
// 2. Set WS_ECHO_URL=ws://127.0.0.1:9001 in your environment.
// 3. cargo test ... -- --ignored monitor_captures_websocket_frames
#[tokio::test]
#[serial]
#[ignore]
async fn monitor_captures_websocket_frames() {
    // If no env var is set, skip gracefully rather than panicking on a missing
    // endpoint — this test is manual-only.
    let ws_url = match std::env::var("WS_ECHO_URL") {
        Ok(u) => u,
        Err(_) => {
            eprintln!("SKIP: WS_ECHO_URL not set; skipping monitor_captures_websocket_frames");
            return;
        }
    };

    let page_mock = fixture_with_html(r#"<!doctype html><html><body></body></html>"#).await;

    let browser = Browser::builder().headless(true).launch().await.unwrap();
    let tab = browser.main_tab();

    let mut monitor = tab.monitor().start().await.unwrap();

    tab.goto(&page_mock.uri()).await.unwrap();
    tab.wait_for_load().await.unwrap();

    // Open a WebSocket from the page, send one frame, wait for the echo.
    let js = format!(
        r#"(async () => {{
          return await new Promise((resolve, reject) => {{
            const ws = new WebSocket({url});
            ws.onopen = () => ws.send('hello-ws');
            ws.onmessage = (e) => {{ ws.close(); resolve(e.data); }};
            ws.onerror = (e) => reject(String(e));
            setTimeout(() => reject('timeout'), 5000);
          }});
        }})()"#,
        url = serde_json::json!(ws_url)
    );
    let echo: Option<String> = tab.evaluate_main(&js).await.unwrap_or(None);
    assert_eq!(echo.as_deref(), Some("hello-ws"), "WS echo mismatch");

    // Collect up to 5 events looking for the frame pair.
    let mut got_sent = false;
    let mut got_received = false;
    for _ in 0..10 {
        match tokio::time::timeout(Duration::from_secs(3), monitor.next()).await {
            Ok(Some(NetworkEvent::WebSocketFrame {
                direction: zendriver::FrameDirection::Sent,
                payload,
                ..
            })) if payload.contains("hello-ws") => got_sent = true,
            Ok(Some(NetworkEvent::WebSocketFrame {
                direction: zendriver::FrameDirection::Received,
                payload,
                ..
            })) if payload.contains("hello-ws") => got_received = true,
            Ok(Some(_)) => {}
            _ => break,
        }
        if got_sent && got_received {
            break;
        }
    }
    assert!(got_sent, "monitor should have seen the Sent WS frame");
    assert!(
        got_received,
        "monitor should have seen the Received WS frame"
    );

    monitor.stop();
    browser.close().await.unwrap();
}