extract fastly cdn integration into subcrate

Author: syphar

Cargo.lock

@@ -22,18 +22,20 @@ exclude = [
 
 [workspace.dependencies]
 anyhow = { version = "1.0.42", features = ["backtrace"]}
-axum-extra = { version = "0.12.0", features = ["typed-header", "routing", "middleware"] }
 askama = "0.14.0"
+axum-extra = { version = "0.12.0", features = ["typed-header", "routing", "middleware"] }
 bincode = "2.0.1"
 chrono = { version = "0.4.11", default-features = false, features = ["clock", "serde"] }
 derive_more = { version = "2.0.0", features = ["display", "deref", "from", "into", "from_str"] }
 http = "1.0.0"
 itertools = { version = "0.14.0" }
+mockito = "1.0.2"
 opentelemetry = "0.31.0"
 opentelemetry-otlp = { version = "0.31.0", features = ["grpc-tonic",  "metrics"] }
 opentelemetry-resource-detectors = "0.10.0"
 opentelemetry_sdk = { version = "0.31.0", features = ["rt-tokio"] }
 regex = "1"
+reqwest = { version = "0.12", features = ["json", "gzip"] }
 sentry = { version = "0.46.0", features = ["panic", "tracing", "tower-http", "anyhow", "backtrace"] }
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
@@ -44,6 +46,7 @@ tracing = "0.1.37"
 url = { version = "2.1.1", features = ["serde"] }
 
 [dependencies]
+docs_rs_fastly = { path = "crates/lib/docs_rs_fastly" }
 docs_rs_env_vars = { path = "crates/lib/docs_rs_env_vars" }
 docs_rs_headers = { path = "crates/lib/docs_rs_headers" }
 docs_rs_logging = { path = "crates/lib/docs_rs_logging" }
@@ -62,7 +65,7 @@ crates-index = { version = "3.0.0", default-features = false, features = ["git",
 rayon = "1.6.1"
 num_cpus = "1.15.0"
 crates-index-diff = { version = "28.0.0", features = [ "max-performance" ]}
-reqwest = { version = "0.12", features = ["json", "gzip"] }
+reqwest = { workspace = true }
 slug = "0.1.1"
 sqlx = { workspace = true }
 url = { workspace = true }
@@ -134,14 +137,15 @@ chrono = { workspace = true }
 constant_time_eq = "0.4.2"
 
 [dev-dependencies]
+docs_rs_fastly = { path = "crates/lib/docs_rs_fastly", features = ["testing"] }
 docs_rs_headers = { path = "crates/lib/docs_rs_headers", features = ["testing"] }
 docs_rs_opentelemetry = { path = "crates/lib/docs_rs_opentelemetry", features = ["testing"] }
 docs_rs_types = { path = "crates/lib/docs_rs_types", features = ["testing"] }
 criterion = "0.8.0"
 kuchikiki = "0.8"
 http-body-util = "0.1.0"
 rand = "0.9"
-mockito = "1.0.2"
+mockito = { workspace = true }
 test-case = { workspace = true }
 tower = { version = "0.5.1", features = ["util"] }
 opentelemetry_sdk = { version = "0.31.0", features = ["rt-tokio", "testing"] }

Cargo.toml

@@ -0,0 +1,29 @@
+[package]
+name = "docs_rs_fastly"
+version = "0.1.0"
+edition = "2024"
+
+[dependencies]
+anyhow = { workspace = true }
+chrono = { workspace = true }
+docs_rs_types = { path = "../docs_rs_types" }
+docs_rs_env_vars = { path = "../docs_rs_env_vars" }
+docs_rs_headers = { path = "../docs_rs_headers" }
+docs_rs_opentelemetry = { path = "../docs_rs_opentelemetry" }
+docs_rs_utils = { path = "../docs_rs_utils" }
+http = { workspace = true }
+itertools = { workspace = true }
+opentelemetry = { workspace = true }
+reqwest = { workspace = true }
+tracing = { workspace = true }
+url = { workspace = true }
+tokio = { workspace = true, optional = true }
+
+[dev-dependencies]
+docs_rs_headers = { path = "../docs_rs_headers", features = ["testing"] }
+docs_rs_opentelemetry = { path = "../docs_rs_opentelemetry", features = ["testing"] }
+mockito = { workspace = true }
+tokio = { workspace = true }
+
+[features]
+testing = ["dep:tokio"]

crates/lib/docs_rs_fastly/Cargo.toml

@@ -0,0 +1,21 @@
+use crate::CdnBehaviour;
+use anyhow::Result;
+use docs_rs_headers::{SurrogateKey, SurrogateKeys};
+use tokio::sync::Mutex;
+
+#[derive(Debug, Default)]
+pub struct MockCdn {
+    pub purged: Mutex<SurrogateKeys>,
+}
+
+impl CdnBehaviour for MockCdn {
+    async fn purge_surrogate_keys<I>(&self, keys: I) -> Result<()>
+    where
+        I: IntoIterator<Item = SurrogateKey> + 'static + Send,
+        I::IntoIter: Send,
+    {
+        let mut purged = self.purged.lock().await;
+        purged.try_extend(keys)?;
+        Ok(())
+    }
+}

crates/lib/docs_rs_fastly/src/cdn/mock.rs

@@ -0,0 +1,72 @@
+#[cfg(feature = "testing")]
+pub mod mock;
+pub mod real;
+
+use crate::Config;
+use anyhow::Result;
+use docs_rs_headers::SurrogateKey;
+use docs_rs_opentelemetry::AnyMeterProvider;
+use docs_rs_types::KrateName;
+use std::iter;
+
+pub trait CdnBehaviour {
+    fn purge_surrogate_keys<I>(&self, keys: I) -> impl Future<Output = Result<()>> + Send
+    where
+        I: IntoIterator<Item = SurrogateKey> + 'static + Send,
+        I::IntoIter: Send;
+
+    fn queue_crate_invalidation(
+        &self,
+        krate_name: &KrateName,
+    ) -> impl Future<Output = Result<()>> + Send {
+        self.purge_surrogate_keys(iter::once(SurrogateKey::from(krate_name.clone())))
+    }
+}
+
+#[derive(Debug)]
+pub enum Cdn {
+    Real(real::RealCdn),
+    #[cfg(feature = "testing")]
+    Mock(mock::MockCdn),
+}
+
+/// normal functionality
+impl Cdn {
+    pub fn from_config(config: &Config, meter_provider: &AnyMeterProvider) -> Result<Self> {
+        Ok(Self::Real(real::RealCdn::from_config(
+            config,
+            meter_provider,
+        )?))
+    }
+}
+
+/// testing functionality
+#[cfg(feature = "testing")]
+impl Cdn {
+    pub fn mock() -> Self {
+        Self::Mock(mock::MockCdn::default())
+    }
+
+    pub async fn purged_keys(&self) -> Result<docs_rs_headers::SurrogateKeys> {
+        let Self::Mock(cdn) = self else {
+            anyhow::bail!("found real cdn, no collected purges");
+        };
+
+        let purges = cdn.purged.lock().await;
+        Ok(purges.clone())
+    }
+}
+
+impl CdnBehaviour for Cdn {
+    async fn purge_surrogate_keys<I>(&self, keys: I) -> Result<()>
+    where
+        I: IntoIterator<Item = SurrogateKey> + 'static + Send,
+        I::IntoIter: Send,
+    {
+        match self {
+            Self::Real(real) => real.purge_surrogate_keys(keys).await,
+            #[cfg(feature = "testing")]
+            Self::Mock(mock) => mock.purge_surrogate_keys(keys).await,
+        }
+    }
+}