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
use crate::components::Component;
use crate::error::WebDriverResult;
use crate::extensions::query::ElementQueryOptions;
use crate::prelude::ElementQueryable;
use crate::{By, ElementQueryFn, WebElement};
use parking_lot::Mutex;
use std::fmt::{Debug, Formatter};
use std::sync::Arc;

/// Type alias for `ElementResolver<WebElement>`, for convenience.
pub type ElementResolverSingle = ElementResolver<WebElement>;
/// Type alias for `ElementResolver<Vec<WebElement>>` for convenience.
pub type ElementResolverMulti = ElementResolver<Vec<WebElement>>;

/// `resolve!(x)` expands to `x.resolve().await?`
#[macro_export]
macro_rules! resolve {
    ($a:expr) => {
        $a.resolve().await?
    };
}

/// `resolve_present!(x)` expands to `x.resolve_present().await?`
#[macro_export]
macro_rules! resolve_present {
    ($a:expr) => {
        $a.resolve_present().await?
    };
}

/// Element resolver that can resolve a particular element or list of elements on demand.
///
/// Once resolved, the result will be cached for later retrieval until manually invalidated.
pub struct ElementResolver<T: Clone> {
    base_element: WebElement,
    query_fn: Arc<ElementQueryFn<T>>,
    element: Arc<Mutex<Option<T>>>,
}

impl<T: Debug + Clone> Debug for ElementResolver<T> {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let element = self.element.lock();
        f.debug_struct("ElementResolver")
            .field("base_element", &self.base_element)
            .field("element", &element)
            .finish()
    }
}

impl<T: Clone> Clone for ElementResolver<T> {
    fn clone(&self) -> Self {
        Self {
            base_element: self.base_element.clone(),
            query_fn: self.query_fn.clone(),
            element: self.element.clone(),
        }
    }
}

impl<T: Clone> ElementResolver<T> {
    fn peek(&self) -> Option<T> {
        self.element.lock().clone()
    }

    fn replace(&self, new: T) {
        let mut element = self.element.lock();
        element.replace(new);
    }

    /// Return the cached element(s) if any, otherwise run the query and return the result.
    pub async fn resolve(&self) -> WebDriverResult<T> {
        {
            let element = self.element.lock();
            if let Some(elem) = element.as_ref() {
                return Ok(elem.clone());
            }
        }

        let elem_fut = (self.query_fn)(&self.base_element);
        let elem = elem_fut.await?;
        self.replace(elem.clone());
        Ok(elem)
    }

    /// Invalidate any cached element(s).
    pub fn invalidate(&self) {
        self.element.lock().take();
    }

    /// Run the query, ignoring any cached element(s).
    pub async fn resolve_force(&self) -> Option<T> {
        self.invalidate();
        self.resolve().await.ok()
    }
}

impl ElementResolver<WebElement> {
    /// Create new element resolver that must return a single element.
    pub fn new_single(base_element: WebElement, by: By) -> Self {
        let resolver: ElementQueryFn<WebElement> = Box::new(move |elem| {
            let by = by.clone();
            Box::pin(async move { elem.query(by).single().await })
        });
        Self::new_custom(base_element, resolver)
    }

    /// Create new element resolver that must return a single element, with extra options.
    pub fn new_single_opts(base_element: WebElement, by: By, options: ElementQueryOptions) -> Self {
        let resolver: ElementQueryFn<WebElement> = Box::new(move |elem| {
            let by = by.clone();
            let options = options.clone();
            Box::pin(async move { elem.query(by).options(options).single().await })
        });
        Self::new_custom(base_element, resolver)
    }

    /// Create new element resolver that returns the first element.
    pub fn new_first(base_element: WebElement, by: By) -> Self {
        let resolver: ElementQueryFn<WebElement> = Box::new(move |elem| {
            let by = by.clone();
            Box::pin(async move { elem.query(by).first().await })
        });
        Self::new_custom(base_element, resolver)
    }

    /// Create new element resolver that returns the first element, with extra options.
    pub fn new_first_opts(base_element: WebElement, by: By, options: ElementQueryOptions) -> Self {
        let resolver: ElementQueryFn<WebElement> = Box::new(move |elem| {
            let by = by.clone();
            let options = options.clone();
            Box::pin(async move { elem.query(by).options(options).first().await })
        });
        Self::new_custom(base_element, resolver)
    }

    /// Create new element resolver using custom resolver function.
    pub fn new_custom(
        base_element: WebElement,
        custom_resolver_fn: ElementQueryFn<WebElement>,
    ) -> Self {
        Self {
            base_element,
            query_fn: Arc::new(custom_resolver_fn),
            element: Arc::new(Mutex::new(None)),
        }
    }

    /// Validate that the cached element is present, and if so, return it.
    pub async fn validate(&self) -> WebDriverResult<Option<WebElement>> {
        match self.peek() {
            Some(elem) => match elem.is_present().await? {
                true => Ok(Some(elem)),
                false => {
                    self.invalidate();
                    Ok(None)
                }
            },
            None => Ok(None),
        }
    }

    /// Validate the element and repeat the query if it is not present, returning the result.
    ///
    /// If the element is already present, the cached element will be returned without
    /// performing an additional query.
    pub async fn resolve_present(&self) -> WebDriverResult<WebElement> {
        match self.validate().await? {
            Some(elem) => Ok(elem),
            None => {
                let elem_fut = (self.query_fn)(&self.base_element);
                let elem = elem_fut.await?;
                self.replace(elem.clone());
                Ok(elem)
            }
        }
    }
}

impl ElementResolver<Vec<WebElement>> {
    /// Create new element resolver that returns all elements, if any.
    ///
    /// If no elements were found, this will resolve to an empty Vec.
    pub fn new_allow_empty(base_element: WebElement, by: By) -> Self {
        let resolver: ElementQueryFn<Vec<WebElement>> = Box::new(move |elem| {
            let by = by.clone();
            Box::pin(async move { elem.query(by).all_from_selector().await })
        });
        Self::new_custom(base_element, resolver)
    }

    /// Create new element resolver that returns all elements (if any), with extra options.
    pub fn new_allow_empty_opts(
        base_element: WebElement,
        by: By,
        options: ElementQueryOptions,
    ) -> Self {
        let resolver: ElementQueryFn<Vec<WebElement>> = Box::new(move |elem| {
            let by = by.clone();
            let options = options.clone();
            Box::pin(async move { elem.query(by).options(options).all_from_selector().await })
        });
        Self::new_custom(base_element, resolver)
    }

    /// Create new element resolver that returns at least one element.
    ///
    /// If no elements were found, a NoSuchElement error will be returned by the resolver's
    /// `resolve()` method.
    pub fn new_not_empty(base_element: WebElement, by: By) -> Self {
        let resolver: ElementQueryFn<Vec<WebElement>> = Box::new(move |elem| {
            let by = by.clone();
            Box::pin(async move { elem.query(by).all_from_selector_required().await })
        });
        Self::new_custom(base_element, resolver)
    }

    /// Create new element resolver that returns at least one element, with extra options.
    ///
    /// If no elements were found, a NoSuchElement error will be returned by the resolver's
    /// `resolve()` method.
    pub fn new_not_empty_opts(
        base_element: WebElement,
        by: By,
        options: ElementQueryOptions,
    ) -> Self {
        let resolver: ElementQueryFn<Vec<WebElement>> = Box::new(move |elem| {
            let by = by.clone();
            let options = options.clone();
            Box::pin(
                async move { elem.query(by).options(options).all_from_selector_required().await },
            )
        });
        Self::new_custom(base_element, resolver)
    }

    /// Create new multi element resolver using a custom resolver function.
    pub fn new_custom(
        base_element: WebElement,
        custom_resolver_fn: ElementQueryFn<Vec<WebElement>>,
    ) -> Self {
        Self {
            base_element,
            query_fn: Arc::new(custom_resolver_fn),
            element: Arc::new(Mutex::new(None)),
        }
    }

    /// Validate that all cached elements are present, if any.
    pub async fn validate(&self) -> WebDriverResult<Option<Vec<WebElement>>> {
        match self.peek() {
            Some(elems) => {
                for elem in &elems {
                    if !elem.is_present().await? {
                        self.invalidate();
                        return Ok(None);
                    }
                }
                Ok(Some(elems))
            }
            None => Ok(None),
        }
    }

    /// Validate all elements and repeat the query if any are not present, returning the results.
    ///
    /// If all elements are already present, the cached elements will be returned without
    /// performing an additional query.
    pub async fn resolve_present(&self) -> WebDriverResult<Vec<WebElement>> {
        match self.validate().await? {
            Some(elem) => Ok(elem),
            None => {
                let elem_fut = (self.query_fn)(&self.base_element);
                let elem = elem_fut.await?;
                self.replace(elem.clone());
                Ok(elem)
            }
        }
    }
}

impl<T: Component + Clone> ElementResolver<T> {
    /// Create new element resolver that must return a single component.
    pub fn new_single(base_element: WebElement, by: By) -> Self {
        let resolver: ElementQueryFn<T> = Box::new(move |elem| {
            let by = by.clone();
            Box::pin(async move {
                let elem = elem.query(by).single().await?;
                Ok(elem.into())
            })
        });
        Self::new_custom(base_element, resolver)
    }

    /// Create new element resolver that must return a single component, with extra options.
    pub fn new_single_opts(base_element: WebElement, by: By, options: ElementQueryOptions) -> Self {
        let resolver: ElementQueryFn<T> = Box::new(move |elem| {
            let by = by.clone();
            let options = options.clone();
            Box::pin(async move {
                let elem = elem.query(by).options(options).single().await?;
                Ok(elem.into())
            })
        });
        Self::new_custom(base_element, resolver)
    }

    /// Create new element resolver that returns the first component.
    pub fn new_first(base_element: WebElement, by: By) -> Self {
        let resolver: ElementQueryFn<T> = Box::new(move |elem| {
            let by = by.clone();
            Box::pin(async move {
                let elem = elem.query(by).first().await?;
                Ok(elem.into())
            })
        });
        Self::new_custom(base_element, resolver)
    }

    /// Create new element resolver that returns the first component, with extra options.
    pub fn new_first_opts(base_element: WebElement, by: By, options: ElementQueryOptions) -> Self {
        let resolver: ElementQueryFn<T> = Box::new(move |elem| {
            let by = by.clone();
            let options = options.clone();
            Box::pin(async move {
                let elem = elem.query(by).options(options).first().await?;
                Ok(elem.into())
            })
        });
        Self::new_custom(base_element, resolver)
    }

    /// Create new component resolver using custom resolver function.
    pub fn new_custom(base_element: WebElement, custom_resolver_fn: ElementQueryFn<T>) -> Self {
        Self {
            base_element,
            query_fn: Arc::new(custom_resolver_fn),
            element: Arc::new(Mutex::new(None)),
        }
    }

    /// Validate that the cached component is present, and if so, return it.
    pub async fn validate(&self) -> WebDriverResult<Option<T>> {
        match self.peek() {
            Some(component) => match component.base_element().is_present().await? {
                true => Ok(Some(component)),
                false => {
                    self.invalidate();
                    Ok(None)
                }
            },
            None => Ok(None),
        }
    }

    /// Validate the component and repeat the query if it is not present, returning the result.
    ///
    /// If the component is already present, the cached component will be returned without
    /// performing an additional query.
    pub async fn resolve_present(&self) -> WebDriverResult<T> {
        match self.validate().await? {
            Some(component) => Ok(component),
            None => {
                let comp_fut = (self.query_fn)(&self.base_element);
                let comp = comp_fut.await?;
                self.replace(comp.clone());
                Ok(comp)
            }
        }
    }
}

impl<T: Component + Clone> ElementResolver<Vec<T>> {
    /// Create new element resolver that returns all components, if any.
    ///
    /// If no components were found, this will resolve to an empty Vec.
    pub fn new_allow_empty(base_element: WebElement, by: By) -> Self {
        let resolver: ElementQueryFn<Vec<T>> = Box::new(move |elem| {
            let by = by.clone();
            Box::pin(async move {
                let elems = elem.query(by).all_from_selector().await?;
                Ok(elems.into_iter().map(T::from).collect())
            })
        });
        Self::new_custom(base_element, resolver)
    }

    /// Create new element resolver that returns all components (if any), with extra options.
    pub fn new_allow_empty_opts(
        base_element: WebElement,
        by: By,
        options: ElementQueryOptions,
    ) -> Self {
        let resolver: ElementQueryFn<Vec<T>> = Box::new(move |elem| {
            let by = by.clone();
            let options = options.clone();
            Box::pin(async move {
                let elems = elem.query(by).options(options).all_from_selector().await?;
                Ok(elems.into_iter().map(T::from).collect())
            })
        });
        Self::new_custom(base_element, resolver)
    }

    /// Create new element resolver that returns at least one component.
    ///
    /// If no components were found, a NoSuchElement error will be returned by the resolver's
    /// `resolve()` method.
    pub fn new_not_empty(base_element: WebElement, by: By) -> Self {
        let resolver: ElementQueryFn<Vec<T>> = Box::new(move |elem| {
            let by = by.clone();
            Box::pin(async move {
                let elems = elem.query(by).all_from_selector_required().await?;
                Ok(elems.into_iter().map(T::from).collect())
            })
        });
        Self::new_custom(base_element, resolver)
    }

    /// Create new element resolver that returns at least one component, with extra options.
    ///
    /// If no components were found, a NoSuchElement error will be returned by the resolver's
    /// `resolve()` method.
    pub fn new_not_empty_opts(
        base_element: WebElement,
        by: By,
        options: ElementQueryOptions,
    ) -> Self {
        let resolver: ElementQueryFn<Vec<T>> = Box::new(move |elem| {
            let by = by.clone();
            let options = options.clone();
            Box::pin(async move {
                let elems = elem.query(by).options(options).all_from_selector_required().await?;
                Ok(elems.into_iter().map(T::from).collect())
            })
        });
        Self::new_custom(base_element, resolver)
    }

    /// Create new multi component resolver using a custom resolver function.
    pub fn new_custom(
        base_element: WebElement,
        custom_resolver_fn: ElementQueryFn<Vec<T>>,
    ) -> Self {
        Self {
            base_element,
            query_fn: Arc::new(custom_resolver_fn),
            element: Arc::new(Mutex::new(None)),
        }
    }

    /// Validate that all cached components are present, if any.
    pub async fn validate(&self) -> WebDriverResult<Option<Vec<T>>> {
        match self.peek() {
            Some(comps) => {
                for comp in &comps {
                    if !comp.base_element().is_present().await? {
                        self.invalidate();
                        return Ok(None);
                    }
                }
                Ok(Some(comps))
            }
            None => Ok(None),
        }
    }

    /// Validate all components and repeat the query if any are not present, returning the results.
    ///
    /// If all components are already present, the cached components will be returned without
    /// performing an additional query.
    pub async fn resolve_present(&self) -> WebDriverResult<Vec<T>> {
        match self.validate().await? {
            Some(comp) => Ok(comp),
            None => {
                let comp_fut = (self.query_fn)(&self.base_element);
                let comp = comp_fut.await?;
                self.replace(comp.clone());
                Ok(comp)
            }
        }
    }
}