webdriverbidi 0.2.2

WebDriver BiDi client implementation in Rust.
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
use std::sync::Arc;

use anyhow::Result;
use log::debug;
use tokio::sync::Mutex;
use webdriverbidi::events::EventType;
use webdriverbidi::model::browser::{CreateUserContextParameters, RemoveUserContextParameters};
use webdriverbidi::model::browsing_context::{
    ActivateParameters, CloseParameters, GetTreeParameters,
};
use webdriverbidi::model::common::EmptyParams;
use webdriverbidi::model::session::SubscriptionRequest;

mod utils;

const DEFAULT_USER_CONTEXT: &str = "default";

// https://github.com/web-platform-tests/wpt/tree/master/webdriver/tests/bidi/browser/create_user_context
mod create_user_context {
    use super::*;

    async fn create_context_with_accept_insecure_certs(accept_insecure_certs: bool) -> Result<()> {
        let mut bidi_session = utils::session::init().await?;

        let user_context = bidi_session
            .browser_create_user_context(CreateUserContextParameters::new(
                Some(accept_insecure_certs),
                None,
                None,
            ))
            .await?
            .user_context;
        let ids = utils::browser::get_user_context_ids(&mut bidi_session).await?;

        utils::session::close(&mut bidi_session).await?;

        assert!(ids.contains(&user_context));

        Ok(())
    }

    #[tokio::test]
    async fn test_create_context_accept_insecure_true() -> Result<()> {
        create_context_with_accept_insecure_certs(true).await
    }

    #[tokio::test]
    async fn test_create_context_accept_insecure_false() -> Result<()> {
        create_context_with_accept_insecure_certs(false).await
    }

    //     const TEST_STORAGE_ISOLATION_HTML: &str = "test_storage_isolation.html";

    //     #[tokio::test]
    //     async fn test_create_context() -> Result<()> {
    //         let mut bidi_session = utils::session::init().await?;

    //         let user_context = utils::browser::create_user_context(&mut bidi_session).await?;
    //         let ids = utils::browser::get_user_context_ids(&mut bidi_session).await?;

    //         utils::session::close(&mut bidi_session).await?;

    //         assert!(ids.contains(&user_context));

    //         Ok(())
    //     }

    //     #[tokio::test]
    //     async fn test_unique_id() -> Result<()> {
    //         let mut bidi_session = utils::session::init().await?;

    //         let first_context = utils::browser::create_user_context(&mut bidi_session).await?;
    //         let second_context = utils::browser::create_user_context(&mut bidi_session).await?;
    //         let ids = utils::browser::get_user_context_ids(&mut bidi_session).await?;

    //         utils::session::close(&mut bidi_session).await?;

    //         assert!(ids.contains(&first_context));
    //         assert!(ids.contains(&second_context));
    //         assert_ne!(first_context, second_context);

    //         Ok(())
    //     }

    //     #[tokio::test]
    //     async fn test_storage_isolation() -> Result<()> {
    //         let (url, server_handle) =
    //             utils::axum_utils::serve_static(TEST_STORAGE_ISOLATION_HTML).await?;

    //         let mut bidi_session = utils::session::init().await?;

    //         let first_context = utils::browser::create_user_context(&mut bidi_session).await?;
    //         let second_context = utils::browser::create_user_context(&mut bidi_session).await?;

    //         let tab_first_context =
    //             utils::browsing_context::new_tab_in_user_context(&mut bidi_session, first_context)
    //                 .await?;
    //         let tab_second_context =
    //             utils::browsing_context::new_tab_in_user_context(&mut bidi_session, second_context)
    //                 .await?;

    //         utils::browsing_context::navigate(
    //             &mut bidi_session,
    //             tab_first_context.clone(),
    //             url.clone(),
    //         )
    //         .await?;

    //         utils::browsing_context::navigate(&mut bidi_session, tab_second_context.clone(), url)
    //             .await?;

    //         let test_key = "test";
    //         let test_value = "value";

    //         let initial_tab_first_context_storage =
    //             utils::local_storage::get(&mut bidi_session, tab_first_context.as_str(), test_key)
    //                 .await?;

    //         let initial_tab_second_context_storage =
    //             utils::local_storage::get(&mut bidi_session, tab_second_context.as_str(), test_key)
    //                 .await?;

    //         utils::local_storage::set(
    //             &mut bidi_session,
    //             tab_first_context.as_str(),
    //             test_key,
    //             test_value,
    //         )
    //         .await?;

    //         let final_tab_first_context_storage =
    //             utils::local_storage::get(&mut bidi_session, tab_first_context.as_str(), test_key)
    //                 .await?;

    //         let final_tab_second_context_storage =
    //             utils::local_storage::get(&mut bidi_session, tab_second_context.as_str(), test_key)
    //                 .await?;

    //         utils::session::close(&mut bidi_session).await?;
    //         server_handle.abort();

    //         assert_eq!(initial_tab_first_context_storage, None);
    //         assert_eq!(initial_tab_second_context_storage, None);
    //         assert_eq!(
    //             final_tab_first_context_storage,
    //             Some(test_value.to_string())
    //         );
    //         assert_eq!(final_tab_second_context_storage, None);

    //         Ok(())
    //     }
}

// // --------------------------------------------------

// // https://github.com/web-platform-tests/wpt/tree/master/webdriver/tests/bidi/browser/get_client_windows
// mod get_client_windows {
//     use super::*;

//     #[tokio::test]
//     async fn test_open_and_close() -> Result<()> {
//         let mut bidi_session = utils::session::init().await?;

//         let initial_windows = utils::browser::get_client_windows(&mut bidi_session).await?;
//         let new_browsing_context = utils::browsing_context::new_window(&mut bidi_session).await?;
//         let updated_windows = utils::browser::get_client_windows(&mut bidi_session).await?;

//         bidi_session
//             .browsing_context_close(CloseParameters::new(new_browsing_context, None))
//             .await?;

//         let final_windows = utils::browser::get_client_windows(&mut bidi_session).await?;

//         utils::session::close(&mut bidi_session).await?;

//         assert_eq!(initial_windows.len(), 1);
//         assert_eq!(updated_windows.len(), 2);
//         assert_ne!(
//             updated_windows[0].client_window,
//             updated_windows[1].client_window
//         );
//         assert_eq!(final_windows, initial_windows);

//         Ok(())
//     }

//     #[tokio::test]
//     async fn test_activate_client_windows() -> Result<()> {
//         let mut bidi_session = utils::session::init().await?;

//         let initial_windows = utils::browser::get_client_windows(&mut bidi_session).await?;
//         let initial_window = &initial_windows[0];
//         let initial_window_id = &initial_window.client_window;

//         let initial_contexts = bidi_session
//             .browsing_context_get_tree(GetTreeParameters::new(None, None))
//             .await?
//             .contexts;
//         let initial_context_id = &initial_contexts[0].context;

//         let new_browsing_context = utils::browsing_context::new_window(&mut bidi_session).await?;

//         let initial_all_windows = utils::browser::get_client_windows(&mut bidi_session).await?;
//         let initial_first_window = initial_all_windows
//             .iter()
//             .find(|&window| window.client_window == *initial_window_id)
//             .ok_or_else(|| anyhow::anyhow!("initial first window not found"))?;
//         let initial_second_window = initial_all_windows
//             .iter()
//             .find(|&window| window.client_window != *initial_window_id)
//             .ok_or_else(|| anyhow::anyhow!("initial second window not found"))?;

//         bidi_session
//             .browsing_context_activate(ActivateParameters::new(initial_context_id.to_string()))
//             .await?;

//         let final_all_windows = utils::browser::get_client_windows(&mut bidi_session).await?;
//         let final_first_window = final_all_windows
//             .iter()
//             .find(|&window| window.client_window == *initial_window_id)
//             .ok_or_else(|| anyhow::anyhow!("final first window not found"))?;
//         let final_second_window = final_all_windows
//             .iter()
//             .find(|&window| window.client_window != *initial_window_id)
//             .ok_or_else(|| anyhow::anyhow!("final second window not found"))?;

//         bidi_session
//             .browsing_context_close(CloseParameters::new(new_browsing_context, None))
//             .await?;

//         let final_windows = utils::browser::get_client_windows(&mut bidi_session).await?;

//         utils::session::close(&mut bidi_session).await?;

//         assert_eq!(initial_windows.len(), 1);
//         assert_eq!(initial_contexts.len(), 1);

//         assert_eq!(initial_all_windows.len(), 2);
//         assert!(initial_second_window.active);
//         assert!(!initial_first_window.active);

//         assert!(final_first_window.active);
//         assert!(!final_second_window.active);

//         assert!(final_windows[0].active);
//         assert_eq!(final_windows[0].client_window, *initial_window_id);

//         Ok(())
//     }
// }

// // --------------------------------------------------

// // https://github.com/web-platform-tests/wpt/tree/master/webdriver/tests/bidi/browser/get_user_contexts
// mod get_user_contexts {
//     use super::*;

//     #[tokio::test]
//     async fn test_default() -> Result<()> {
//         let mut bidi_session = utils::session::init().await?;

//         let user_context_ids = utils::browser::get_user_context_ids(&mut bidi_session).await?;

//         utils::session::close(&mut bidi_session).await?;

//         assert!(!user_context_ids.is_empty());
//         assert!(user_context_ids.contains(&DEFAULT_USER_CONTEXT.to_string()));

//         Ok(())
//     }

//     #[tokio::test]
//     async fn test_create_remove_contexts() -> Result<()> {
//         let mut bidi_session = utils::session::init().await?;

//         let user_context_1 = utils::browser::create_user_context(&mut bidi_session).await?;
//         let user_context_2 = utils::browser::create_user_context(&mut bidi_session).await?;

//         let user_context_ids_1 = utils::browser::get_user_context_ids(&mut bidi_session).await?;

//         utils::browser::remove_user_context(&mut bidi_session, user_context_1.clone()).await?;

//         let user_context_ids_2 = utils::browser::get_user_context_ids(&mut bidi_session).await?;

//         utils::browser::remove_user_context(&mut bidi_session, user_context_2.clone()).await?;

//         let user_context_ids_3 = utils::browser::get_user_context_ids(&mut bidi_session).await?;

//         utils::session::close(&mut bidi_session).await?;

//         assert!(user_context_ids_1.len() >= 3);
//         assert!(user_context_ids_1.contains(&user_context_1));
//         assert!(user_context_ids_1.contains(&user_context_2));
//         assert!(user_context_ids_1.contains(&DEFAULT_USER_CONTEXT.to_string()));

//         assert!(!user_context_ids_2.contains(&user_context_1));
//         assert!(user_context_ids_2.contains(&user_context_2));
//         assert!(user_context_ids_2.contains(&DEFAULT_USER_CONTEXT.to_string()));

//         assert!(!user_context_ids_3.contains(&user_context_2));
//         assert!(user_context_ids_3.contains(&DEFAULT_USER_CONTEXT.to_string()));

//         Ok(())
//     }
// }

// // // --------------------------------------------------

// // https://github.com/web-platform-tests/wpt/tree/master/webdriver/tests/bidi/browser/remove_user_context
// mod remove_user_context {
//     use super::*;

//     const BROWSING_CTX_DESTROYED_EVENT: &str = "browsingContext.contextDestroyed";
//     const USER_PROMPT_OPENED_EVENT: &str = "browsingContext.userPromptOpened";

//     #[tokio::test]
//     async fn test_remove_context() -> Result<()> {
//         let mut bidi_session = utils::session::init().await?;

//         let user_context = utils::browser::create_user_context(&mut bidi_session).await?;
//         let initial_user_context_ids =
//             utils::browser::get_user_context_ids(&mut bidi_session).await?;

//         utils::browser::remove_user_context(&mut bidi_session, user_context.clone()).await?;

//         let final_user_context_ids =
//             utils::browser::get_user_context_ids(&mut bidi_session).await?;

//         utils::session::close(&mut bidi_session).await?;

//         assert!(initial_user_context_ids.contains(&user_context));

//         assert!(!final_user_context_ids.contains(&user_context));
//         assert!(final_user_context_ids.contains(&DEFAULT_USER_CONTEXT.to_string()));

//         Ok(())
//     }

//     #[tokio::test]
//     async fn test_remove_context_closes_contexts() -> Result<()> {
//         let mut bidi_session = utils::session::init().await?;

//         let events = Arc::new(Mutex::new(Vec::<serde_json::Value>::new()));

//         {
//             let events = events.clone();

//             bidi_session
//                 .register_event_handler(
//                     EventType::BrowsingContextContextDestroyed,
//                     move |event: serde_json::Value| {
//                         let events = events.clone();
//                         async move {
//                             debug!(
//                                 "Received browsingContext.contextDestroyed event: {:?}",
//                                 event
//                             );
//                             events.lock().await.push(event);
//                         }
//                     },
//                 )
//                 .await;
//         }

//         bidi_session
//             .session_subscribe(SubscriptionRequest::new(
//                 vec![String::from(BROWSING_CTX_DESTROYED_EVENT)],
//                 None,
//                 None,
//             ))
//             .await?;

//         let user_context_1 = utils::browser::create_user_context(&mut bidi_session).await?;
//         let user_context_2 = utils::browser::create_user_context(&mut bidi_session).await?;

//         let context_1 = utils::browsing_context::new_tab_in_user_context(
//             &mut bidi_session,
//             user_context_1.clone(),
//         )
//         .await?;

//         let context_2 = utils::browsing_context::new_tab_in_user_context(
//             &mut bidi_session,
//             user_context_1.clone(),
//         )
//         .await?;

//         let context_3 = utils::browsing_context::new_tab_in_user_context(
//             &mut bidi_session,
//             user_context_2.clone(),
//         )
//         .await?;

//         let context_4 = utils::browsing_context::new_tab_in_user_context(
//             &mut bidi_session,
//             user_context_2.clone(),
//         )
//         .await?;

//         bidi_session
//             .browser_remove_user_context(RemoveUserContextParameters::new(user_context_1))
//             .await?;

//         let initial_events_len = events.lock().await.len();

//         let initial_destroyed_contexts = events
//             .lock()
//             .await
//             .iter()
//             .filter_map(|event| event["parasm"]["context"].as_str().map(String::from))
//             .collect::<Vec<_>>();

//         bidi_session
//             .browser_remove_user_context(RemoveUserContextParameters::new(user_context_2))
//             .await?;

//         utils::session::close(&mut bidi_session).await?;

//         let final_events_len = events.lock().await.len();

//         let final_destroyed_contexts = events
//             .lock()
//             .await
//             .iter()
//             .filter_map(|event| event["parasm"]["context"].as_str().map(String::from))
//             .collect::<Vec<_>>();

//         assert!(initial_events_len == 2);
//         assert!(initial_destroyed_contexts.contains(&context_1));
//         assert!(initial_destroyed_contexts.contains(&context_2));

//         assert!(final_events_len == 4);
//         assert!(final_destroyed_contexts.contains(&context_3));
//         assert!(final_destroyed_contexts.contains(&context_4));

//         Ok(())
//     }

//     const TEST_BEFORE_UNLOAD_HTML: &str = "beforeunload.html";

//     #[tokio::test]
//     async fn test_remove_context_skips_beforeunload_prompt() -> Result<()> {
//         let mut bidi_session = utils::session::init().await?;

//         bidi_session
//             .session_subscribe(SubscriptionRequest::new(
//                 vec![String::from(USER_PROMPT_OPENED_EVENT)],
//                 None,
//                 None,
//             ))
//             .await?;

//         let events = Arc::new(Mutex::new(Vec::<serde_json::Value>::new()));

//         {
//             let events = events.clone();

//             bidi_session
//                 .register_event_handler(
//                     EventType::BrowsingContextUserPromptOpened,
//                     move |event: serde_json::Value| {
//                         let events = events.clone();
//                         async move {
//                             debug!(
//                                 "Received browsingContext.userPromptOpened event: {:?}",
//                                 event
//                             );
//                             events.lock().await.push(event);
//                         }
//                     },
//                 )
//                 .await;
//         }

//         let (url, server_handle) = utils::axum_utils::serve_static(TEST_BEFORE_UNLOAD_HTML).await?;

//         let user_context = utils::browser::create_user_context(&mut bidi_session).await?;
//         let context = utils::browsing_context::new_tab_in_user_context(
//             &mut bidi_session,
//             user_context.clone(),
//         )
//         .await?;

//         utils::browsing_context::navigate(&mut bidi_session, context, url).await?;

//         utils::browser::remove_user_context(&mut bidi_session, user_context).await?;

//         utils::session::close(&mut bidi_session).await?;
//         server_handle.abort();

//         // debug!("Events vec len: {}", events.lock().await.len());
//         assert!(events.lock().await.len() > 0);

//         Ok(())
//     }
// }