zendriver-imperva 0.1.3

Imperva WAF / Incapsula bypass for zendriver
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

//! Imperva-bypass errors.

use std::time::Duration;
use zendriver_interception::InterceptionError;
use zendriver_transport::CallError;

use crate::detection::{CaptchaKind, ImpervaSurface};

/// Error returned by [`ImpervaBypass`] operations.
///
/// [`ImpervaBypass`]: crate::bypass::ImpervaBypass
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum ImpervaError {
    /// `wait_for_clearance` exceeded the configured timeout.
    /// `last_surface` is the most recent surface observed by the poll loop.
    #[error("clearance not achieved within {timeout:?}")]
    Timeout {
        timeout: Duration,
        last_surface: Option<ImpervaSurface>,
    },

    /// CAPTCHA detected, but no `on_captcha` solver was registered.
    #[error("CAPTCHA required but no solver registered: {kind:?}")]
    CaptchaRequired { kind: CaptchaKind },

    /// User-supplied CAPTCHA solver returned an error.
    #[error("CAPTCHA solver failed: {0}")]
    CaptchaSolver(Box<dyn std::error::Error + Send + Sync>),

    /// Fetch-domain interception hook failed at startup (only when
    /// [`ImpervaBypass::with_interception`] was set).
    ///
    /// [`ImpervaBypass::with_interception`]: crate::bypass::ImpervaBypass::with_interception
    #[error("interception hook error: {0}")]
    Interception(#[from] InterceptionError),

    /// CDP transport / call error.
    #[error("call failed: {0}")]
    Call(#[from] CallError),

    /// In-page evaluator raised or returned an unexpected payload shape.
    #[error("JS error: {0}")]
    JsError(String),
}

#[cfg(test)]
#[allow(clippy::panic, clippy::unwrap_used)]
mod tests {
    use super::*;

    #[test]
    fn display_timeout_includes_duration() {
        let e = ImpervaError::Timeout {
            timeout: Duration::from_secs(30),
            last_surface: Some(ImpervaSurface::Reese84),
        };
        assert_eq!(e.to_string(), "clearance not achieved within 30s");
    }

    #[test]
    fn display_captcha_required_includes_kind() {
        let e = ImpervaError::CaptchaRequired {
            kind: CaptchaKind::HCaptcha,
        };
        assert_eq!(
            e.to_string(),
            "CAPTCHA required but no solver registered: HCaptcha"
        );
    }

    #[test]
    fn display_js_error_passthrough() {
        let e = ImpervaError::JsError("bad payload".into());
        assert_eq!(e.to_string(), "JS error: bad payload");
    }
}