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

#![cfg(feature = "integration")]

//! Tests for wait_for_function functionality.
//!
//! These tests verify that wait_for_function properly handles both primitive
//! and object return values without panicking.

mod common;

use std::time::Duration;

use viewpoint_core::page::Polling;

// =============================================================================
// Primitive Return Value Tests (should return None)
// =============================================================================

/// Test wait_for_function with boolean `true` return.
/// Should return Ok(None) because booleans are primitives with no object handle.
#[tokio::test]
async fn test_wait_for_function_boolean_true() {
    let (browser, _context, page) = common::launch_with_page().await;

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

    // This previously panicked because `true` has no object_id
    let result = page
        .wait_for_function("() => true")
        .timeout(Duration::from_secs(5))
        .wait()
        .await;

    assert!(
        result.is_ok(),
        "wait_for_function should succeed: {:?}",
        result.err()
    );
    assert!(
        result.unwrap().is_none(),
        "Boolean true should return None (no handle)"
    );

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

/// Test wait_for_function with number return (e.g., 42).
/// Should return Ok(None) because numbers are primitives.
#[tokio::test]
async fn test_wait_for_function_number() {
    let (browser, _context, page) = common::launch_with_page().await;

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

    let result = page
        .wait_for_function("() => 42")
        .timeout(Duration::from_secs(5))
        .wait()
        .await;

    assert!(result.is_ok(), "wait_for_function should succeed");
    assert!(
        result.unwrap().is_none(),
        "Number should return None (no handle)"
    );

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

/// Test wait_for_function with string return.
/// Should return Ok(None) because strings are primitives.
#[tokio::test]
async fn test_wait_for_function_string() {
    let (browser, _context, page) = common::launch_with_page().await;

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

    let result = page
        .wait_for_function("() => 'loaded'")
        .timeout(Duration::from_secs(5))
        .wait()
        .await;

    assert!(result.is_ok(), "wait_for_function should succeed");
    assert!(
        result.unwrap().is_none(),
        "String should return None (no handle)"
    );

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

/// Test wait_for_function with a text content check.
/// This is a common real-world use case that previously panicked.
#[tokio::test]
async fn test_wait_for_function_text_includes() {
    let (browser, _context, page) = common::launch_with_page().await;

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

    // This is the exact use case from the bug report
    let result = page
        .wait_for_function("() => document.body.innerText.includes('loaded')")
        .timeout(Duration::from_secs(5))
        .wait()
        .await;

    assert!(
        result.is_ok(),
        "wait_for_function should succeed: {:?}",
        result.err()
    );
    assert!(
        result.unwrap().is_none(),
        "String.includes() returns boolean, should be None"
    );

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

// =============================================================================
// Object Return Value Tests (should return Some(JsHandle))
// =============================================================================

/// Test wait_for_function with object return (document.body).
/// Should return Ok(Some(JsHandle)) because DOM elements have object handles.
#[tokio::test]
async fn test_wait_for_function_dom_element() {
    let (browser, _context, page) = common::launch_with_page().await;

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

    let result = page
        .wait_for_function("() => document.body")
        .timeout(Duration::from_secs(5))
        .wait()
        .await;

    assert!(result.is_ok(), "wait_for_function should succeed");
    let handle = result.unwrap();
    assert!(handle.is_some(), "DOM element should return Some(JsHandle)");

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

/// Test wait_for_function with querySelector result.
/// Should return Ok(Some(JsHandle)) when element is found.
#[tokio::test]
async fn test_wait_for_function_query_selector() {
    let (browser, _context, page) = common::launch_with_page().await;

    page.set_content("<html><body><div class='ready'>Content</div></body></html>")
        .set()
        .await
        .expect("Failed to set content");

    let result = page
        .wait_for_function("() => document.querySelector('.ready')")
        .timeout(Duration::from_secs(5))
        .wait()
        .await;

    assert!(result.is_ok(), "wait_for_function should succeed");
    let handle = result.unwrap();
    assert!(
        handle.is_some(),
        "querySelector result should return Some(JsHandle)"
    );

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

/// Test wait_for_function with object literal return.
/// Should return Ok(Some(JsHandle)) because objects have handles.
#[tokio::test]
async fn test_wait_for_function_object_literal() {
    let (browser, _context, page) = common::launch_with_page().await;

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

    let result = page
        .wait_for_function("() => ({ ready: true })")
        .timeout(Duration::from_secs(5))
        .wait()
        .await;

    assert!(result.is_ok(), "wait_for_function should succeed");
    let handle = result.unwrap();
    assert!(
        handle.is_some(),
        "Object literal should return Some(JsHandle)"
    );

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

/// Test wait_for_function with array return.
/// Should return Ok(Some(JsHandle)) because arrays are objects.
#[tokio::test]
async fn test_wait_for_function_array() {
    let (browser, _context, page) = common::launch_with_page().await;

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

    let result = page
        .wait_for_function("() => [1, 2, 3]")
        .timeout(Duration::from_secs(5))
        .wait()
        .await;

    assert!(result.is_ok(), "wait_for_function should succeed");
    let handle = result.unwrap();
    assert!(handle.is_some(), "Array should return Some(JsHandle)");

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

// =============================================================================
// Polling Mode Tests
// =============================================================================

/// Test wait_for_function with RAF polling (default).
#[tokio::test]
async fn test_wait_for_function_raf_polling() {
    let (browser, _context, page) = common::launch_with_page().await;

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

    // Set a variable after a short delay (void() discards the setTimeout return value)
    page.evaluate::<()>(viewpoint_js::js! {
        void(setTimeout(() => { window.ready = true; }, 100))
    })
    .await
    .expect("Failed to set timeout");

    let result = page
        .wait_for_function("() => window.ready")
        .timeout(Duration::from_secs(5))
        .wait()
        .await;

    assert!(result.is_ok(), "wait_for_function should succeed");
    // window.ready = true is a boolean, so no handle
    assert!(result.unwrap().is_none(), "Boolean should return None");

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

/// Test wait_for_function with interval polling.
#[tokio::test]
async fn test_wait_for_function_interval_polling() {
    let (browser, _context, page) = common::launch_with_page().await;

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

    // Set a variable after a short delay (void() discards the setTimeout return value)
    page.evaluate::<()>(viewpoint_js::js! {
        void(setTimeout(() => { window.intervalReady = true; }, 150))
    })
    .await
    .expect("Failed to set timeout");

    let result = page
        .wait_for_function("() => window.intervalReady")
        .polling(Polling::Interval(Duration::from_millis(50)))
        .timeout(Duration::from_secs(5))
        .wait()
        .await;

    assert!(result.is_ok(), "wait_for_function should succeed");

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

// =============================================================================
// Timeout Tests
// =============================================================================

/// Test wait_for_function times out when condition never becomes true.
#[tokio::test]
async fn test_wait_for_function_timeout() {
    let (browser, _context, page) = common::launch_with_page().await;

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

    let result = page
        .wait_for_function("() => false")
        .timeout(Duration::from_millis(500))
        .wait()
        .await;

    assert!(result.is_err(), "wait_for_function should timeout");
    let err = result.unwrap_err();
    assert!(
        err.to_string().contains("Timeout"),
        "Error should mention timeout: {err}"
    );

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

// =============================================================================
// Edge Case Tests
// =============================================================================

/// Test wait_for_function with falsy then truthy value.
#[tokio::test]
async fn test_wait_for_function_falsy_to_truthy() {
    let (browser, _context, page) = common::launch_with_page().await;

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

    // Start with falsy, then set to truthy after delay (void() discards setTimeout return)
    page.evaluate::<()>(viewpoint_js::js! {
        window.counter = 0;
        void(setTimeout(() => { window.counter = 5; }, 100))
    })
    .await
    .expect("Failed to set up counter");

    let result = page
        .wait_for_function("() => window.counter")
        .timeout(Duration::from_secs(5))
        .wait()
        .await;

    assert!(result.is_ok(), "wait_for_function should succeed");
    // Numbers are primitives, so no handle
    assert!(result.unwrap().is_none(), "Number should return None");

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

/// Test wait_for_function with argument.
#[tokio::test]
async fn test_wait_for_function_with_arg() {
    let (browser, _context, page) = common::launch_with_page().await;

    page.set_content("<html><body><div class='target'>Found</div></body></html>")
        .set()
        .await
        .expect("Failed to set content");

    let result = page
        .wait_for_function_with_arg("sel => document.querySelector(sel)", ".target")
        .timeout(Duration::from_secs(5))
        .wait()
        .await;

    assert!(result.is_ok(), "wait_for_function_with_arg should succeed");
    let handle = result.unwrap();
    assert!(
        handle.is_some(),
        "querySelector result should return Some(JsHandle)"
    );

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