playwright-rs 0.12.3

Rust bindings for Microsoft Playwright
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
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
use playwright_rs::api::LaunchOptions;
use playwright_rs::protocol::Playwright;

/// Test that a Browser object is created when the server sends a Browser __create__ message
#[tokio::test]
async fn test_browser_object_creation_via_launch() {
    crate::common::init_tracing();
    // Initialize Playwright
    let playwright = Playwright::launch()
        .await
        .expect("Failed to launch Playwright");

    // Get chromium browser type
    let chromium = playwright.chromium();

    // Launch browser - this will:
    // 1. Send "launch" RPC to server
    // 2. Server creates Browser object
    // 3. Server sends __create__ message with Browser initializer
    // 4. Object factory creates Browser from initializer
    // 5. Browser added to connection registry
    // 6. launch() returns Browser reference

    let browser = chromium.launch().await.expect("Failed to launch browser");

    // Verify Browser object fields
    assert_eq!(browser.name(), "chromium");
    assert!(!browser.version().is_empty());
    tracing::info!(
        "✅ Browser created: {} version {}",
        browser.name(),
        browser.version()
    );

    // Cleanup
    browser.close().await.expect("Failed to close browser");
}

/// Test that Browser object has correct structure
///
/// Verifies that Browser struct exists and implements ChannelOwner trait.
/// This test passes as soon as Browser is defined and added to the object factory.
#[test]
fn test_browser_type_exists() {
    crate::common::init_tracing();
    // This is a compile-time test - if Browser doesn't exist or doesn't
    // implement ChannelOwner, this won't compile
    use playwright_rs::protocol::Browser;
    use playwright_rs::server::channel_owner::ChannelOwner;
    use std::any::TypeId;

    // Verify Browser type exists
    assert_eq!(TypeId::of::<Browser>(), TypeId::of::<Browser>());

    // Verify Browser implements ChannelOwner (dyn trait check)
    // This verifies the trait is implemented correctly
    fn assert_channel_owner<T: ChannelOwner + 'static>() {}
    assert_channel_owner::<Browser>();

    tracing::info!("✅ Browser struct exists and implements ChannelOwner");
}

// ============================================================================
// BrowserType::launch()
// ============================================================================

#[tokio::test]
async fn test_launch_chromium() {
    crate::common::init_tracing();
    tracing::debug!("[TEST] test_launch_chromium: Starting");

    // Launch Playwright
    tracing::debug!("[TEST] Launching Playwright server...");
    let playwright = Playwright::launch()
        .await
        .expect("Failed to launch Playwright");
    tracing::debug!("[TEST] Playwright server launched successfully");

    // Get chromium browser type
    let chromium = playwright.chromium();

    // Launch browser with default options
    tracing::debug!("[TEST] Launching Chromium browser...");
    let browser = chromium.launch().await.expect("Failed to launch Chromium");
    tracing::debug!("[TEST] Chromium browser launched successfully");

    // Verify browser was created
    assert_eq!(browser.name(), "chromium");
    assert!(!browser.version().is_empty());

    tracing::info!("Launched Chromium version: {}", browser.version());

    // Cleanup
    tracing::debug!("[TEST] Closing browser...");
    browser.close().await.expect("Failed to close browser");
    tracing::debug!("[TEST] Browser closed successfully");
    tracing::debug!("[TEST] test_launch_chromium: Complete");
}

#[tokio::test]
async fn test_launch_with_headless_option() {
    crate::common::init_tracing();
    tracing::debug!("[TEST] test_launch_with_headless_option: Starting");

    tracing::debug!("[TEST] Launching Playwright server...");
    let playwright = Playwright::launch()
        .await
        .expect("Failed to launch Playwright");
    tracing::debug!("[TEST] Playwright server launched successfully");

    let chromium = playwright.chromium();

    // Launch with explicit headless option
    let options = LaunchOptions::default().headless(true);

    tracing::debug!("[TEST] Launching Chromium browser with headless option...");
    let browser = chromium
        .launch_with_options(options)
        .await
        .expect("Failed to launch Chromium with options");
    tracing::debug!("[TEST] Chromium browser launched successfully");

    assert_eq!(browser.name(), "chromium");
    assert!(!browser.version().is_empty());

    // Cleanup
    tracing::debug!("[TEST] Closing browser...");
    browser.close().await.expect("Failed to close browser");
    tracing::debug!("[TEST] Browser closed successfully");
    tracing::debug!("[TEST] test_launch_with_headless_option: Complete");
}

#[tokio::test]
async fn test_launch_all_three_browsers() {
    crate::common::init_tracing();
    tracing::debug!("[TEST] test_launch_all_three_browsers: Starting");

    tracing::debug!("[TEST] Launching Playwright server...");
    let playwright = Playwright::launch()
        .await
        .expect("Failed to launch Playwright");
    tracing::debug!("[TEST] Playwright server launched successfully");

    // Test Chromium
    tracing::debug!("[TEST] === Testing Chromium ===");
    let chromium = playwright.chromium();
    tracing::debug!("[TEST] Launching Chromium browser...");
    let chromium_browser = chromium.launch().await.expect("Failed to launch Chromium");
    assert_eq!(chromium_browser.name(), "chromium");
    tracing::info!("✓ Chromium: {}", chromium_browser.version());
    tracing::debug!("[TEST] Closing Chromium...");
    chromium_browser
        .close()
        .await
        .expect("Failed to close Chromium");
    tracing::debug!("[TEST] Chromium closed successfully");

    // Test Firefox
    tracing::debug!("[TEST] === Testing Firefox ===");
    let firefox = playwright.firefox();
    tracing::debug!("[TEST] Launching Firefox browser...");
    let firefox_browser = firefox.launch().await.expect("Failed to launch Firefox");
    assert_eq!(firefox_browser.name(), "firefox");
    tracing::info!("✓ Firefox: {}", firefox_browser.version());
    tracing::debug!("[TEST] Closing Firefox...");
    firefox_browser
        .close()
        .await
        .expect("Failed to close Firefox");
    tracing::debug!("[TEST] Firefox closed successfully");

    // Test WebKit
    tracing::debug!("[TEST] === Testing WebKit ===");
    let webkit = playwright.webkit();
    tracing::debug!("[TEST] Launching WebKit browser...");
    let webkit_browser = webkit.launch().await.expect("Failed to launch WebKit");
    assert_eq!(webkit_browser.name(), "webkit");
    tracing::info!("✓ WebKit: {}", webkit_browser.version());
    tracing::debug!("[TEST] Closing WebKit...");
    webkit_browser
        .close()
        .await
        .expect("Failed to close WebKit");
    tracing::debug!("[TEST] WebKit closed successfully");

    tracing::debug!("[TEST] test_launch_all_three_browsers: Complete");
}

#[tokio::test]
async fn test_browser_close() {
    let (_pw, browser, _page) = crate::common::setup().await;

    // Verify browser is open
    assert_eq!(browser.name(), "chromium");

    // Close browser
    browser.close().await.expect("Failed to close browser");

    tracing::info!("✓ Browser closed successfully");
}

#[tokio::test]
async fn test_close_multiple_browsers() {
    crate::common::init_tracing();
    let playwright = Playwright::launch()
        .await
        .expect("Failed to launch Playwright");

    // Launch multiple browsers
    let chromium = playwright.chromium();
    let browser1 = chromium
        .launch()
        .await
        .expect("Failed to launch Chromium 1");
    let browser2 = chromium
        .launch()
        .await
        .expect("Failed to launch Chromium 2");

    tracing::info!("Launched 2 browsers");

    // Close both browsers
    browser1.close().await.expect("Failed to close browser 1");
    tracing::info!("✓ Browser 1 closed");

    browser2.close().await.expect("Failed to close browser 2");
    tracing::info!("✓ Browser 2 closed");
}

#[tokio::test]
async fn test_browser_is_connected() {
    let (_pw, browser, _page) = crate::common::setup().await;

    // Should be connected initially
    assert!(
        browser.is_connected(),
        "Browser should be connected after launch"
    );

    // Close browser
    browser.close().await.expect("Failed to close browser");

    // Should be disconnected after close
    // Note: close() waits for the server to process the close command,
    // which should trigger the "disconnected" event before returning or shortly after.

    // Check immediately first.
    if browser.is_connected() {
        // Give it a moment for the event to arrive
        tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;
    }

    assert!(
        !browser.is_connected(),
        "Browser should be disconnected after close"
    );
}

/// Exercise Browser::bind / unbind — exposes the browser over WebSocket so
/// external clients (Playwright CLI, `@playwright/mcp`) can attach. The
/// returned endpoint must be usable with BrowserType::connect().
#[tokio::test]
async fn test_browser_bind_and_unbind() {
    use playwright_rs::protocol::BindOptions;
    let (_pw, browser, _page) = crate::common::setup().await;

    // Bind on an ephemeral TCP port so we can verify the endpoint is reachable
    let result = browser
        .bind(
            "playwright-rs-bind-test",
            Some(BindOptions {
                host: Some("127.0.0.1".to_string()),
                port: Some(0), // OS-assigned
                ..Default::default()
            }),
        )
        .await
        .expect("bind should succeed");

    assert!(
        result.endpoint.starts_with("ws://"),
        "endpoint should be a WebSocket URL, got: {}",
        result.endpoint
    );
    assert!(
        result.endpoint.contains("127.0.0.1"),
        "endpoint should reference the bound host, got: {}",
        result.endpoint
    );

    browser.unbind().await.expect("unbind should succeed");

    // unbind is idempotent — a second call must not error
    browser
        .unbind()
        .await
        .expect("second unbind should be a no-op");

    browser.close().await.expect("Failed to close browser");
}

/// Test that browser.contexts() returns all open browser contexts.
///
/// Verifies:
/// - Empty after launch (no contexts yet)
/// - Returns one entry after new_context()
/// - Returns two entries after a second new_context()
/// - Back to zero after all contexts are closed
#[tokio::test]
async fn test_browser_contexts() {
    crate::common::init_tracing();
    let playwright = Playwright::launch()
        .await
        .expect("Failed to launch Playwright");
    let browser = playwright
        .chromium()
        .launch()
        .await
        .expect("Failed to launch Chromium");

    // No contexts yet
    let initial = browser.contexts();
    assert_eq!(initial.len(), 0, "Expected 0 contexts after launch");

    // Create first context
    let ctx1 = browser
        .new_context()
        .await
        .expect("Failed to create context 1");
    let after_first = browser.contexts();
    assert_eq!(
        after_first.len(),
        1,
        "Expected 1 context after first new_context"
    );

    // Create second context
    let ctx2 = browser
        .new_context()
        .await
        .expect("Failed to create context 2");
    let after_second = browser.contexts();
    assert_eq!(
        after_second.len(),
        2,
        "Expected 2 contexts after second new_context"
    );

    // Close first context
    ctx1.close().await.expect("Failed to close context 1");
    // Give the event a moment to propagate
    tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;
    let after_close_first = browser.contexts();
    assert_eq!(
        after_close_first.len(),
        1,
        "Expected 1 context after closing first"
    );

    ctx2.close().await.expect("Failed to close context 2");
    browser.close().await.expect("Failed to close browser");
}

/// Test that browser.browser_type() returns the BrowserType that launched it.
///
/// Verifies:
/// - Returns a BrowserType with the correct name ("chromium")
/// - Executable path is non-empty
#[tokio::test]
async fn test_browser_type_property() {
    let (_pw, browser, _page) = crate::common::setup().await;

    let bt = browser.browser_type();
    assert_eq!(
        bt.name(),
        "chromium",
        "browser_type() should return chromium"
    );
    assert!(
        !bt.executable_path().is_empty(),
        "browser_type().executable_path() should be non-empty"
    );

    browser.close().await.expect("Failed to close browser");
}

/// Test that browser.on_disconnected() handler fires when the browser closes.
///
/// Verifies:
/// - Handler is called after browser.close()
/// - is_connected() returns false after disconnect
#[tokio::test]
async fn test_browser_on_disconnected() {
    use std::sync::Arc;
    use std::sync::atomic::{AtomicBool, Ordering};
    use tokio::sync::Notify;

    let (_pw, browser, _page) = crate::common::setup().await;

    let fired = Arc::new(AtomicBool::new(false));
    let fired_clone = Arc::clone(&fired);
    let notify = Arc::new(Notify::new());
    let notify_clone = notify.clone();

    browser
        .on_disconnected(move || {
            let f = Arc::clone(&fired_clone);
            let n = notify_clone.clone();
            async move {
                f.store(true, Ordering::SeqCst);
                n.notify_one();
                Ok(())
            }
        })
        .await
        .expect("Failed to register on_disconnected handler");

    // Close the browser — this should trigger the disconnected event
    browser.close().await.expect("Failed to close browser");

    tokio::time::timeout(std::time::Duration::from_secs(5), notify.notified())
        .await
        .expect("on_disconnected handler did not fire");

    assert!(
        fired.load(Ordering::SeqCst),
        "on_disconnected handler should have fired after browser.close()"
    );
}

/// Test that start_tracing() and stop_tracing() work on Chromium.
///
/// Verifies:
/// - start_tracing() completes without error
/// - stop_tracing() returns non-empty bytes
///
/// Note: CDP tracing is Chromium-only.
#[tokio::test]
async fn test_browser_tracing() {
    let (_pw, browser, _page) = crate::common::setup().await;

    // Start tracing with screenshots enabled
    use playwright_rs::protocol::StartTracingOptions;
    let options = StartTracingOptions {
        screenshots: Some(true),
        categories: None,
        page: None,
    };
    browser
        .start_tracing(Some(options))
        .await
        .expect("start_tracing should succeed on Chromium");

    // Do some work in the browser
    let context = browser
        .new_context()
        .await
        .expect("Failed to create context");
    let page = context.new_page().await.expect("Failed to create page");
    page.goto("about:blank", None)
        .await
        .expect("Failed to navigate");
    context.close().await.expect("Failed to close context");

    // Stop tracing — should return non-empty bytes
    let trace_data = browser
        .stop_tracing()
        .await
        .expect("stop_tracing should succeed on Chromium");

    assert!(
        !trace_data.is_empty(),
        "stop_tracing should return non-empty trace data"
    );

    browser.close().await.expect("Failed to close browser");
}

#[tokio::test]
async fn test_browser_new_browser_cdp_session() {
    let (_pw, browser, _page) = crate::common::setup().await;

    let session = browser
        .new_browser_cdp_session()
        .await
        .expect("new_browser_cdp_session should succeed on Chromium");

    let result = session
        .send("Browser.getVersion", None)
        .await
        .expect("CDP Browser.getVersion should succeed");

    assert!(
        result.get("product").is_some() || result.get("result").is_some(),
        "CDP response should contain version info"
    );

    session.detach().await.expect("detach should succeed");
    browser.close().await.expect("Failed to close browser");
}