viewpoint-core 0.4.3

High-level browser automation API for Viewpoint
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
#![cfg(feature = "integration")]

//! Clock mocking tests for viewpoint-core.
//!
//! These tests verify clock installation, time mocking, and timer control.

use std::sync::Once;
use std::time::Duration;

use viewpoint_core::Browser;
use viewpoint_js::js;

static TRACING_INIT: Once = Once::new();

/// Initialize tracing for tests.
fn init_tracing() {
    TRACING_INIT.call_once(|| {
        tracing_subscriber::fmt()
            .with_env_filter(
                tracing_subscriber::EnvFilter::from_default_env()
                    .add_directive(tracing::Level::INFO.into()),
            )
            .with_test_writer()
            .try_init()
            .ok();
    });
}

// =============================================================================
// Clock Date Mocking Tests
// =============================================================================

/// Test clock date mocking with fixed time.
#[tokio::test]
async fn test_clock_date_mocking() {
    init_tracing();

    let browser = Browser::launch()
        .headless(true)
        .launch()
        .await
        .expect("Failed to launch browser");

    let context = browser
        .new_context()
        .await
        .expect("Failed to create context");
    let page = context.new_page().await.expect("Failed to create page");

    // Set up a simple page
    page.set_content("<html><body><h1>Clock Test</h1></body></html>")
        .set()
        .await
        .expect("Failed to set content");

    // Install clock
    let mut clock = page.clock();
    clock.install().await.expect("Failed to install clock");

    // Set a fixed time: January 1, 2024 00:00:00 UTC
    clock
        .set_fixed_time("2024-01-01T00:00:00Z")
        .await
        .expect("Failed to set fixed time");

    // Get Date.now() and verify it's the expected timestamp
    let timestamp: f64 = page
        .evaluate(js! { Date.now() })
        .await
        .expect("Failed to get time");

    // Jan 1, 2024 00:00:00 UTC = 1_704_067_200_000 ms
    assert_eq!(timestamp as i64, 1_704_067_200_000);

    // Verify new Date() also returns the fixed time
    let date_string: String = page
        .evaluate(js! { new Date().toISOString() })
        .await
        .expect("Failed to get date string");
    assert!(date_string.starts_with("2024-01-01T00:00:00"));

    // Uninstall clock
    clock.uninstall().await.expect("Failed to uninstall clock");

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

// =============================================================================
// Clock Timer Mocking Tests
// =============================================================================

/// Test clock time advancement with timers.
#[tokio::test]
async fn test_clock_timer_mocking() {
    init_tracing();

    let browser = Browser::launch()
        .headless(true)
        .launch()
        .await
        .expect("Failed to launch browser");

    let context = browser
        .new_context()
        .await
        .expect("Failed to create context");
    let page = context.new_page().await.expect("Failed to create page");

    // Set up a page with a variable that will be set by setTimeout
    page.set_content("<html><body><script>window.timerFired = false;</script></body></html>")
        .set()
        .await
        .expect("Failed to set content");

    // Install clock
    let mut clock = page.clock();
    clock.install().await.expect("Failed to install clock");

    // Set up a timer that fires after 5 seconds
    let _: f64 = page
        .evaluate(js! { setTimeout(() => { window.timerFired = true; }, 5000) })
        .await
        .expect("Failed to set timer");

    // Timer should not have fired yet
    let fired_before: bool = page
        .evaluate(js! { window.timerFired })
        .await
        .expect("Failed to check timer");
    assert!(!fired_before, "Timer should not have fired yet");

    // Advance time by 5 seconds
    let timers_fired = clock
        .run_for(Duration::from_secs(5))
        .await
        .expect("Failed to run for duration");

    assert!(timers_fired >= 1, "At least one timer should have fired");

    // Timer should have fired now
    let fired_after: bool = page
        .evaluate(js! { window.timerFired })
        .await
        .expect("Failed to check timer");
    assert!(fired_after, "Timer should have fired after advancing time");

    // Uninstall clock
    clock.uninstall().await.expect("Failed to uninstall clock");

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

/// Test clock fast-forward (skip time without firing timers).
#[tokio::test]
async fn test_clock_fast_forward() {
    init_tracing();

    let browser = Browser::launch()
        .headless(true)
        .launch()
        .await
        .expect("Failed to launch browser");

    let context = browser
        .new_context()
        .await
        .expect("Failed to create context");
    let page = context.new_page().await.expect("Failed to create page");

    page.set_content("<html><body><script>window.timerFired = false;</script></body></html>")
        .set()
        .await
        .expect("Failed to set content");

    // Install clock and set fixed time
    let mut clock = page.clock();
    clock.install().await.expect("Failed to install clock");
    clock
        .set_fixed_time(1_704_067_200_000i64)
        .await
        .expect("Failed to set time");

    // Get initial time
    let time_before: f64 = page
        .evaluate(js! { Date.now() })
        .await
        .expect("Failed to get time");

    // Fast-forward 1 hour
    clock
        .fast_forward(Duration::from_secs(3600))
        .await
        .expect("Failed to fast forward");

    // Time should have advanced by 1 hour
    let time_after: f64 = page
        .evaluate(js! { Date.now() })
        .await
        .expect("Failed to get time");
    let expected_time = time_before + 3_600.0 * 1_000.0;
    assert!(
        (time_after - expected_time).abs() < 1_000.0,
        "Time should have advanced by ~1 hour. Before: {time_before}, After: {time_after}"
    );

    // Uninstall clock
    clock.uninstall().await.expect("Failed to uninstall clock");

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

/// Test clock run_all_timers.
#[tokio::test]
async fn test_clock_run_all_timers() {
    init_tracing();

    let browser = Browser::launch()
        .headless(true)
        .launch()
        .await
        .expect("Failed to launch browser");

    let context = browser
        .new_context()
        .await
        .expect("Failed to create context");
    let page = context.new_page().await.expect("Failed to create page");

    page.set_content("<html><body><script>window.count = 0;</script></body></html>")
        .set()
        .await
        .expect("Failed to set content");

    // Install clock
    let mut clock = page.clock();
    clock.install().await.expect("Failed to install clock");

    // Set up multiple timers at different times
    let _: serde_json::Value = page
        .evaluate(js! {
            setTimeout(() => { window.count = window.count + 1; }, 1000);
            setTimeout(() => { window.count = window.count + 1; }, 2000);
            setTimeout(() => { window.count = window.count + 1; }, 5000);
        })
        .await
        .expect("Failed to set timers");

    // Check pending timer count
    let pending = clock
        .pending_timer_count()
        .await
        .expect("Failed to get count");
    assert_eq!(pending, 3, "Should have 3 pending timers");

    // Run all timers
    let fired = clock.run_all_timers().await.expect("Failed to run timers");
    assert!(fired >= 3, "Should have fired at least 3 timers");

    // Count should be 3
    let count: f64 = page
        .evaluate(js! { window.count })
        .await
        .expect("Failed to get count");
    assert_eq!(count as i32, 3, "All timers should have incremented count");

    // Uninstall clock
    clock.uninstall().await.expect("Failed to uninstall clock");

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

// =============================================================================
// Clock System Time Tests
// =============================================================================

/// Test clock system time (flowing time).
#[tokio::test]
async fn test_clock_system_time() {
    init_tracing();

    let browser = Browser::launch()
        .headless(true)
        .launch()
        .await
        .expect("Failed to launch browser");

    let context = browser
        .new_context()
        .await
        .expect("Failed to create context");
    let page = context.new_page().await.expect("Failed to create page");

    page.set_content("<html><body></body></html>")
        .set()
        .await
        .expect("Failed to set content");

    // Install clock
    let mut clock = page.clock();
    clock.install().await.expect("Failed to install clock");

    // Set system time (flows normally)
    clock
        .set_system_time("2024-06-15T12:00:00Z")
        .await
        .expect("Failed to set system time");

    // Get initial time
    let time1: f64 = page
        .evaluate(js! { Date.now() })
        .await
        .expect("Failed to get time");

    // Wait a bit (real time)
    tokio::time::sleep(Duration::from_millis(100)).await;

    // Get time again - it should have advanced with real time
    let time2: f64 = page
        .evaluate(js! { Date.now() })
        .await
        .expect("Failed to get time");

    // Time should have advanced (allowing some tolerance)
    assert!(
        time2 > time1,
        "System time should flow: {time2} should be > {time1}"
    );

    // Uninstall clock
    clock.uninstall().await.expect("Failed to uninstall clock");

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

/// Test clock pause and resume.
#[tokio::test]
async fn test_clock_pause_resume() {
    init_tracing();

    let browser = Browser::launch()
        .headless(true)
        .launch()
        .await
        .expect("Failed to launch browser");

    let context = browser
        .new_context()
        .await
        .expect("Failed to create context");
    let page = context.new_page().await.expect("Failed to create page");

    page.set_content("<html><body></body></html>")
        .set()
        .await
        .expect("Failed to set content");

    // Install clock
    let mut clock = page.clock();
    clock.install().await.expect("Failed to install clock");

    // Pause at a specific time
    clock
        .pause_at("2024-01-01T12:00:00Z")
        .await
        .expect("Failed to pause");

    // Get time
    let time1: f64 = page
        .evaluate(js! { Date.now() })
        .await
        .expect("Failed to get time");

    // Wait a bit
    tokio::time::sleep(Duration::from_millis(50)).await;

    // Time should still be the same (paused)
    let time2: f64 = page
        .evaluate(js! { Date.now() })
        .await
        .expect("Failed to get time");
    // Testing exact float values for clock pausing
    #[allow(clippy::float_cmp)]
    {
        assert_eq!(time1, time2, "Time should be paused");
    }

    // Resume
    clock.resume().await.expect("Failed to resume");

    // Wait a bit
    tokio::time::sleep(Duration::from_millis(100)).await;

    // Time should now be advancing
    let time3: f64 = page
        .evaluate(js! { Date.now() })
        .await
        .expect("Failed to get time");
    assert!(time3 > time2, "Time should be flowing after resume");

    // Uninstall clock
    clock.uninstall().await.expect("Failed to uninstall clock");

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