edgee_sdk/
lib.rs

1use serde::{Deserialize, Serialize};
2
3pub mod token;
4
5#[derive(Debug, Serialize, Deserialize, Clone)]
6pub struct Autocapture {
7    #[serde(default)]
8    pub pageview: bool,
9    #[serde(default)]
10    pub spa_pageview: bool,
11    #[serde(default)]
12    pub engagement: bool,
13    #[serde(default)]
14    pub click: bool,
15    #[serde(default)]
16    pub form: bool,
17    #[serde(default)]
18    pub scroll: bool,
19}
20
21impl Default for Autocapture {
22    fn default() -> Self {
23        Self {
24            pageview: true,
25            spa_pageview: false,
26            engagement: false,
27            click: false,
28            form: false,
29            scroll: false,
30        }
31    }
32}
33
34/// Retrieves and customizes the SDK content.
35///
36/// This function gets the SDK content based on the URL and customizes it for the given host and autocapture settings.
37/// For URLs ending in "sdk.js", it returns the latest version. Otherwise, it extracts and returns a specific version.
38///
39/// # Arguments
40///
41/// * `url` - A string slice containing the URL path to get the SDK from (e.g. "/_edgee/sdk.js" or "/_edgee/edgee.v1.5.0.js")
42/// * `host` - A string slice containing the host domain to customize the SDK for
43/// * `autocapture` - An Autocapture struct specifying which events to automatically capture
44///
45/// # Returns
46///
47/// * `Ok(String)` - The customized SDK content if successful
48/// * `Err(&'static str)` - An error message if the SDK content could not be retrieved
49///
50/// # Example
51///
52/// ```rust
53/// use edgee_sdk::Autocapture;
54/// let url = "/_edgee/edgee.v1.6.2.js";
55/// let host = "example.com";
56/// let sdk_content = edgee_sdk::get_sdk(url, host, Autocapture::default());
57/// assert!(sdk_content.is_ok());
58/// ```
59pub fn get_sdk(url: &str, host: &str, autocapture: Autocapture) -> Result<String, &'static str> {
60    let content = get_sdk_content(url)?;
61    Ok(dynamize_sdk(content, host, autocapture))
62}
63
64pub fn get_sdk_for_unsafe_user(url: &str) -> Result<String, &'static str> {
65    let content = get_sdk_content(url)?;
66    Ok(content.replace("{{safe}}", "unsafe"))
67}
68
69fn get_sdk_content(url: &str) -> Result<&str, &'static str> {
70    if url.ends_with("sdk.js") {
71        return Ok(include_str!("../release/edgee.v1.6.2.js").trim());
72    }
73
74    let Some((_, part)) = url.rsplit_once("edgee.v") else {
75        return Err("Failed to read the JS SDK file");
76    };
77    let Some(part) = part.strip_suffix(".js") else {
78        return Err("Failed to read the JS SDK file");
79    };
80
81    let content = match part {
82        "1.5.0" => include_str!("../release/edgee.v1.5.0.js").trim(),
83        "1.6.2" => include_str!("../release/edgee.v1.6.2.js").trim(),
84        // Add more versions as needed
85        _ => return Err("Failed to read the JS SDK file"),
86    };
87
88    Ok(content)
89}
90
91fn dynamize_sdk(sdk: &str, host: &str, autocapture: Autocapture) -> String {
92    let token = token::generate(host);
93    let mut sdk = sdk.replace("{{token}}", token.as_str());
94
95    if !autocapture.pageview {
96        sdk = sdk.replace("{{ac_pageview}}", "n");
97    }
98    if autocapture.spa_pageview {
99        sdk = sdk.replace("{{ac_spa_pageview}}", "y");
100    }
101    if autocapture.engagement {
102        sdk = sdk.replace("{{ac_engagement}}", "y");
103    }
104    if autocapture.click {
105        sdk = sdk.replace("{{ac_click}}", "y");
106    }
107    if autocapture.form {
108        sdk = sdk.replace("{{ac_form}}", "y");
109    }
110    if autocapture.scroll {
111        sdk = sdk.replace("{{ac_scroll}}", "y");
112    }
113    sdk.to_string()
114}
115
116#[cfg(test)]
117mod tests {
118    use super::*;
119
120    #[test]
121    fn retrieves_sdk_content_for_valid_url() {
122        let url = "/sdk.js";
123        let host = "example.com";
124        let result = get_sdk(url, host, Autocapture::default());
125        assert!(result.is_ok());
126        assert!(result.unwrap().contains("{{side}}"));
127    }
128
129    #[test]
130    fn retrieves_versioned_sdk_content() {
131        let url = "/edgee.v1.5.0.js";
132        let host = "example.com";
133        let result = get_sdk(url, host, Autocapture::default());
134        assert!(result.is_ok());
135        assert!(result.unwrap().contains("{{side}}"));
136    }
137
138    #[test]
139    fn returns_error_for_invalid_url_format() {
140        let url = "/invalid.js";
141        let host = "example.com";
142        let result = get_sdk(url, host, Autocapture::default());
143        assert!(result.is_err());
144        assert_eq!(result.unwrap_err(), "Failed to read the JS SDK file");
145    }
146
147    #[test]
148    fn returns_error_for_unsupported_version() {
149        let url = "/edgee.v2.0.0.js";
150        let host = "example.com";
151        let result = get_sdk(url, host, Autocapture::default());
152        assert!(result.is_err());
153        assert_eq!(result.unwrap_err(), "Failed to read the JS SDK file");
154    }
155}
edgee_sdk/lib.rs

edgee_sdk/
lib.rs
