cbf-chrome 0.1.0-alpha.7

Chromium-specific safe API layer for CBF.
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

//! Chrome-specific custom scheme request/response models.

/// Immutable startup registration for a Chrome-backed custom scheme handler.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ChromeCustomSchemeRegistration {
    pub scheme: String,
    pub host: String,
}

/// Chromium-observed request method for a custom scheme load.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ChromeCustomSchemeRequestMethod {
    Get,
    Other(String),
}

impl ChromeCustomSchemeRequestMethod {
    pub fn as_str(&self) -> &str {
        match self {
            Self::Get => "GET",
            Self::Other(value) => value.as_str(),
        }
    }
}

/// A host-routable custom scheme request emitted by the Chrome backend.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ChromeCustomSchemeRequest {
    pub request_id: u64,
    pub profile_id: String,
    pub url: String,
    pub scheme: String,
    pub host: String,
    pub path: String,
    pub query: Option<String>,
    pub method: ChromeCustomSchemeRequestMethod,
}

/// Host-visible completion result for a custom scheme request.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ChromeCustomSchemeResponseResult {
    Ok,
    NotFound,
    Aborted,
}

/// Response body and headers for a custom scheme request.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ChromeCustomSchemeResponse {
    pub request_id: u64,
    pub result: ChromeCustomSchemeResponseResult,
    pub body: Vec<u8>,
    pub mime_type: String,
    pub content_security_policy: Option<String>,
    pub access_control_allow_origin: Option<String>,
}

#[cfg(test)]
mod tests {
    use super::{
        ChromeCustomSchemeRegistration, ChromeCustomSchemeRequest, ChromeCustomSchemeRequestMethod,
        ChromeCustomSchemeResponse, ChromeCustomSchemeResponseResult,
    };

    #[test]
    fn request_method_as_str_returns_expected_value() {
        assert_eq!(ChromeCustomSchemeRequestMethod::Get.as_str(), "GET");
        assert_eq!(
            ChromeCustomSchemeRequestMethod::Other("HEAD".to_string()).as_str(),
            "HEAD"
        );
    }

    #[test]
    fn custom_scheme_models_are_cloneable() {
        let registration = ChromeCustomSchemeRegistration {
            scheme: "app".to_string(),
            host: "simpleapp".to_string(),
        };
        let request = ChromeCustomSchemeRequest {
            request_id: 1,
            profile_id: "profile".to_string(),
            url: "app://simpleapp/ui.html".to_string(),
            scheme: "app".to_string(),
            host: "simpleapp".to_string(),
            path: "/ui.html".to_string(),
            query: None,
            method: ChromeCustomSchemeRequestMethod::Get,
        };
        let response = ChromeCustomSchemeResponse {
            request_id: 1,
            result: ChromeCustomSchemeResponseResult::Ok,
            body: b"ok".to_vec(),
            mime_type: "text/plain".to_string(),
            content_security_policy: Some("default-src 'self'".to_string()),
            access_control_allow_origin: Some("app://simpleapp".to_string()),
        };

        assert_eq!(registration.clone(), registration);
        assert_eq!(request.clone(), request);
        assert_eq!(response.clone(), response);
    }
}