Organized code in crates (part 1)

aram356 · aram356 · commit 3e8fd81328e0 · 2025-03-27T23:30:49.000-07:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,28 +1,6 @@
-[package]
-name = "potsi"
-version = "0.1.0"
-authors = []
-edition = "2021"
-# Remove this line if you want to be able to publish this crate as open source on crates.io.
-# Otherwise, `publish = false` prevents an accidental `cargo publish` from revealing private source.
-publish = false
-license = "Apache-2.0"
-
-[profile.release]
-debug = 1
-
-[dependencies]
-fastly = "0.11.2"
-hmac = "0.12.1"
-sha2 = "0.10.6"
-hex = "0.4.3"
-serde = { version = "1.0", features = ["derive"] }
-serde_json = "1.0.91"
-cookie = "0.18.1"
-log = "0.4.20"
-log-fastly = "0.10.0"
-futures = "0.3"
-tokio = { version = "1.0", features = ["sync", "macros", "io-util", "rt", "time"] }   
-url = "2.4.1"
-config = "0.15.11"
-handlebars = "6.3.2"
+[workspace]
+resolver = "2"
+members = [
+    "crates/common",
+    "crates/fastly", 
+]
diff --git a/README.md b/README.md
@@ -91,7 +91,7 @@ git clone git@github.com:IABTechLab/trusted-server.git
 :information_source: Note that you’ll have to edit the following files for your setup:
 
 - fastly.toml (service ID, author, description) 
-- potsi.toml (KV store ID names) 
+- trusted-server.toml (KV store ID names) 
 
 ### Build
 
diff --git a/crates/common/Cargo.toml b/crates/common/Cargo.toml
@@ -0,0 +1,28 @@
+[package]
+name = "trusted-server-common"
+version = "0.1.0"
+authors = []
+edition = "2021"
+# Remove this line if you want to be able to publish this crate as open source on crates.io.
+# Otherwise, `publish = false` prevents an accidental `cargo publish` from revealing private source.
+publish = false
+license = "Apache-2.0"
+
+[profile.release]
+debug = 1
+
+[dependencies]
+config = "0.15.11"
+cookie = "0.18.1"
+fastly = "0.11.2"
+futures = "0.3"
+handlebars = "6.3.2"
+hex = "0.4.3"
+hmac = "0.12.1"
+log = "0.4.20"
+log-fastly = "0.10.0"
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0.91"
+sha2 = "0.10.6"
+tokio = { version = "1.0", features = ["sync", "macros", "io-util", "rt", "time"] }   
+url = "2.4.1"
diff --git a/crates/common/src/constants.rs b/crates/common/src/constants.rs
@@ -1,3 +1,3 @@
 pub const SYNTHETIC_HEADER_FRESH: &str = "X-Synthetic-Fresh";
-pub const SYNTHETIC_HEADER_POTSI: &str = "X-Synthetic-Potsi";
+pub const SYNTHETIC_HEADER_TRUSTED_SERVER: &str = "X-Synthetic-Trusted-Server";
 pub const SYNTHETIC_HEADER_PUB_USER_ID: &str = "X-Pub-User-ID";
diff --git a/crates/common/src/cookies.rs b/crates/common/src/cookies.rs
diff --git a/crates/common/src/lib.rs b/crates/common/src/lib.rs
@@ -0,0 +1,7 @@
+pub mod constants;
+pub mod cookies;
+pub mod models;
+pub mod prebid;
+pub mod settings;
+pub mod synthetic;
+pub mod templates;
diff --git a/crates/common/src/models.rs b/crates/common/src/models.rs
diff --git a/crates/common/src/prebid.rs b/crates/common/src/prebid.rs
@@ -2,7 +2,7 @@ use fastly::http::{header, Method};
 use fastly::{Error, Request, Response};
 use serde_json::json;
 
-use crate::constants::{SYNTHETIC_HEADER_FRESH, SYNTHETIC_HEADER_POTSI};
+use crate::constants::{SYNTHETIC_HEADER_FRESH, SYNTHETIC_HEADER_TRUSTED_SERVER};
 use crate::settings::Settings;
 use crate::synthetic::generate_synthetic_id;
 
@@ -31,7 +31,7 @@ impl PrebidRequest {
     pub fn new(settings: &Settings, req: &Request) -> Result<Self, Error> {
         // Get the POTSI ID from header (which we just set in handle_prebid_test)
         let synthetic_id = req
-            .get_header(SYNTHETIC_HEADER_POTSI)
+            .get_header(SYNTHETIC_HEADER_TRUSTED_SERVER)
             .and_then(|h| h.to_str().ok())
             .map(|s| s.to_string())
             .unwrap_or_else(|| generate_synthetic_id(settings, req));
@@ -98,12 +98,12 @@ impl PrebidRequest {
 
         // Get and store the POTSI ID value from the incoming request
         let potsi_id = incoming_req
-            .get_header(SYNTHETIC_HEADER_POTSI)
+            .get_header(SYNTHETIC_HEADER_TRUSTED_SERVER)
             .and_then(|h| h.to_str().ok())
             .map(|s| s.to_string())
             .unwrap_or_else(|| self.synthetic_id.clone());
 
-        println!("Found POTSI ID from incoming request: {}", potsi_id);
+        println!("Found Truted Server ID from incoming request: {}", potsi_id);
 
         // Construct the OpenRTB2 bid request
         let prebid_body = json!({
@@ -170,7 +170,7 @@ impl PrebidRequest {
         req.set_header("X-Forwarded-For", &self.client_ip);
         req.set_header(header::ORIGIN, &self.origin);
         req.set_header(SYNTHETIC_HEADER_FRESH, &self.synthetic_id);
-        req.set_header(SYNTHETIC_HEADER_POTSI, &potsi_id);
+        req.set_header(SYNTHETIC_HEADER_TRUSTED_SERVER, &potsi_id);
 
         println!(
             "Sending prebid request with Fresh ID: {} and POTSI ID: {}",
diff --git a/crates/common/src/settings.rs b/crates/common/src/settings.rs
@@ -26,15 +26,15 @@ pub struct Synthetic {
 
 #[derive(Debug, Deserialize)]
 #[allow(unused)]
-pub(crate) struct Settings {
+pub struct Settings {
     pub ad_server: AdServer,
     pub prebid: Prebid,
     pub synthetic: Synthetic,
 }
 
 impl Settings {
-    pub(crate) fn new() -> Result<Self, ConfigError> {
-        let toml_bytes = include_bytes!("../potsi.toml");
+    pub fn new() -> Result<Self, ConfigError> {
+        let toml_bytes = include_bytes!("../../../trusted-server.toml");
         let toml_str = str::from_utf8(toml_bytes).unwrap();
 
         let s = Config::builder()
diff --git a/crates/common/src/synthetic.rs b/crates/common/src/synthetic.rs
@@ -5,7 +5,7 @@ use hmac::{Hmac, Mac};
 use serde_json::json;
 use sha2::Sha256;
 
-use crate::constants::{SYNTHETIC_HEADER_POTSI, SYNTHETIC_HEADER_PUB_USER_ID};
+use crate::constants::{SYNTHETIC_HEADER_TRUSTED_SERVER, SYNTHETIC_HEADER_PUB_USER_ID};
 use crate::cookies::handle_request_cookies;
 use crate::settings::Settings;
 
@@ -60,20 +60,20 @@ pub fn generate_synthetic_id(settings: &Settings, req: &Request) -> String {
 /// Gets or creates a synthetic_id from the request
 pub fn get_or_generate_synthetic_id(settings: &Settings, req: &Request) -> String {
     // First try to get existing POTSI ID from header
-    if let Some(potsi) = req
-        .get_header(SYNTHETIC_HEADER_POTSI)
+    if let Some(synthetic_id) = req
+        .get_header(SYNTHETIC_HEADER_TRUSTED_SERVER)
         .and_then(|h| h.to_str().ok())
         .map(|s| s.to_string())
     {
-        log::info!("Using existing POTSI ID from header: {}", potsi);
-        return potsi;
+        log::info!("Using existing Synthetic ID from header: {}", synthetic_id);
+        return synthetic_id;
     }
 
     let req_cookie_jar: Option<cookie::CookieJar> = handle_request_cookies(req);
     match req_cookie_jar {
         Some(jar) => {
-            let potsi_cookie = jar.get("synthetic_id");
-            if let Some(cookie) = potsi_cookie {
+            let ts_cookie = jar.get("synthetic_id");
+            if let Some(cookie) = ts_cookie {
                 let potsi = cookie.value().to_string();
                 log::info!("Using existing POTSI ID from cookie: {}", potsi);
                 return potsi;
@@ -84,9 +84,9 @@ pub fn get_or_generate_synthetic_id(settings: &Settings, req: &Request) -> Strin
         }
     }
 
-    // If no existing POTSI ID found, generate a fresh one
+    // If no existing Synthetic ID found, generate a fresh one
     let fresh_id = generate_synthetic_id(settings, req);
-    log::info!("No existing POTSI ID found, using fresh ID: {}", fresh_id);
+    log::info!("No existing Synthetic ID found, using fresh ID: {}", fresh_id);
     fresh_id
 }
 
@@ -144,10 +144,10 @@ mod tests {
     #[test]
     fn test_get_or_generate_synthetic_id_with_header() {
         let settings = create_settings();
-        let req = create_test_request(vec![(SYNTHETIC_HEADER_POTSI, "existing_potsi_id")]);
+        let req = create_test_request(vec![(SYNTHETIC_HEADER_TRUSTED_SERVER, "existing_synthetic_id")]);
 
         let synthetic_id = get_or_generate_synthetic_id(&settings, &req);
-        assert_eq!(synthetic_id, "existing_potsi_id");
+        assert_eq!(synthetic_id, "existing_synthetic_id");
     }
 
     #[test]
diff --git a/crates/common/src/templates.rs b/crates/common/src/templates.rs
diff --git a/crates/fastly/Cargo.toml b/crates/fastly/Cargo.toml
@@ -0,0 +1,13 @@
+[package]
+name = "trusted-server-fastly"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+fastly = "0.11.2"
+futures = "0.3"
+log = "0.4.20"
+log-fastly = "0.10.0"
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0.91"   
+trusted-server-common = { path = "../common" }
diff --git a/crates/fastly/src/main.rs b/crates/fastly/src/main.rs
@@ -5,19 +5,13 @@ use log::LevelFilter::Info;
 use serde_json::json;
 use std::env;
 
-mod constants;
-mod cookies;
-use constants::{SYNTHETIC_HEADER_FRESH, SYNTHETIC_HEADER_POTSI};
-mod models;
-use models::AdResponse;
-mod prebid;
-use prebid::PrebidRequest;
-mod settings;
-use settings::Settings;
-mod synthetic;
-use synthetic::generate_synthetic_id;
-mod templates;
-use templates::HTML_TEMPLATE;
+use trusted_server_common::constants::{SYNTHETIC_HEADER_FRESH, SYNTHETIC_HEADER_TRUSTED_SERVER};
+use trusted_server_common::cookies::create_synthetic_cookie;
+use trusted_server_common::models::AdResponse;
+use trusted_server_common::prebid::PrebidRequest;
+use trusted_server_common::settings::Settings;
+use trusted_server_common::synthetic::{generate_synthetic_id, get_or_generate_synthetic_id};
+use trusted_server_common::templates::HTML_TEMPLATE;
 
 #[fastly::main]
 fn main(req: Request) -> Result<Response, Error> {
@@ -50,32 +44,32 @@ fn handle_main_page(settings: &Settings, req: Request) -> Result<Response, Error
     log_fastly::init_simple("mylogs", Info);
 
     // Calculate fresh ID first using the synthetic module
-    let fresh_id = synthetic::generate_synthetic_id(settings, &req);
+    let fresh_id = generate_synthetic_id(settings, &req);
 
-    // Check for existing POTSI ID in this specific order:
-    // 1. X-Synthetic-Potsi header
+    // Check for existing Synthetic ID in this specific order:
+    // 1. Header
     // 2. Cookie
     // 3. Fall back to fresh ID
-    let synthetic_id = synthetic::get_or_generate_synthetic_id(settings, &req);
+    let synthetic_id = get_or_generate_synthetic_id(settings, &req);
 
     println!(
-        "Existing POTSI header: {:?}",
-        req.get_header(SYNTHETIC_HEADER_POTSI)
+        "Existing Synthetic header: {:?}",
+        req.get_header(SYNTHETIC_HEADER_TRUSTED_SERVER)
     );
     println!("Generated Fresh ID: {}", fresh_id);
-    println!("Using POTSI ID: {}", synthetic_id);
+    println!("Using Synthetic ID: {}", synthetic_id);
 
     // Create response with the main page HTML
     let mut response = Response::from_status(StatusCode::OK)
         .with_body(HTML_TEMPLATE)
         .with_header(header::CONTENT_TYPE, "text/html")
         .with_header(SYNTHETIC_HEADER_FRESH, &fresh_id) // Fresh ID always changes
-        .with_header(SYNTHETIC_HEADER_POTSI, &synthetic_id); // POTSI ID remains stable
+        .with_header(SYNTHETIC_HEADER_TRUSTED_SERVER, &synthetic_id); // Trusted Server ID remains stable
 
     // Always set the cookie with the synthetic ID
     response.set_header(
         header::SET_COOKIE,
-        cookies::create_synthetic_cookie(&synthetic_id),
+        create_synthetic_cookie(&synthetic_id),
     );
 
     // Debug: Print all request headers
@@ -305,21 +299,21 @@ async fn handle_prebid_test(settings: &Settings, mut req: Request) -> Result<Res
     println!("Starting prebid test request handling");
 
     // Calculate fresh ID
-    let fresh_id = synthetic::generate_synthetic_id(settings, &req);
+    let fresh_id = generate_synthetic_id(settings, &req);
 
-    // Check for existing POTSI ID in same order as handle_main_page
-    let synthetic_id = synthetic::get_or_generate_synthetic_id(settings, &req);
+    // Check for existing Synthetic ID in same order as handle_main_page
+    let synthetic_id = get_or_generate_synthetic_id(settings, &req);
 
     println!(
         "Existing POTSI header: {:?}",
-        req.get_header(SYNTHETIC_HEADER_POTSI)
+        req.get_header(SYNTHETIC_HEADER_TRUSTED_SERVER)
     );
     println!("Generated Fresh ID: {}", fresh_id);
     println!("Using POTSI ID: {}", synthetic_id);
 
     // Set both IDs as headers
     req.set_header(SYNTHETIC_HEADER_FRESH, &fresh_id);
-    req.set_header(SYNTHETIC_HEADER_POTSI, &synthetic_id);
+    req.set_header(SYNTHETIC_HEADER_TRUSTED_SERVER, &synthetic_id);
 
     println!("Using POTSI ID: {}, Fresh ID: {}", synthetic_id, fresh_id);
 
diff --git a/fastly.toml b/fastly.toml
@@ -6,12 +6,12 @@ cloned_from = "https://github.com/fastly/compute-starter-kit-rust-default"
 description = "aslk"
 language = "rust"
 manifest_version = 3
-name = "potsi"
+name = "trusted-server-fastly"
 service_id = "q9waEnTgJfqQV1a0cYOuo3"
 
 [scripts]
 build = """
-    cargo build --bin potsi --release --target wasm32-wasip1 --color always &&
+    cargo build --bin trusted-server-fastly --release --target wasm32-wasip1 --color always &&
     ln -fs wasm32-wasip1 target/wasm32-wasi
 """
 
diff --git a/trusted-server.toml b/trusted-server.toml
@@ -8,7 +8,7 @@ server_url = "http://68.183.113.79:8000/openrtb2/auction"
 [synthetic]
 counter_store = "jevans_synth_id_counter"
 opid_store = "jevans_synth_id_opid"
-secret_key = "potsi"
+secret_key = "trusted-server"
 # Possible values
 #   - "client_ip"
 #   - "user_agent"
