Skip to main content

stackless_integrations/providers/cloudflare/
kv.rs

1//! Cloudflare Workers KV namespace (`cloudflare/kv`).
2
3use std::collections::BTreeMap;
4
5use serde::Serialize;
6use stackless_stripe_projects::catalog::verify::CatalogService;
7use stackless_stripe_projects::provision::ProvisionContext;
8
9use super::CloudflareResource;
10use crate::error::IntegrationError;
11use crate::hostable::{ConfigScope, Hostable, IntegrationHosting};
12use crate::registry;
13
14pub const RESOURCE_KIND: &str = "integration-cloudflare-kv";
15
16#[derive(Debug, Serialize)]
17pub struct KvConfig {
18    pub title: String,
19}
20
21impl CatalogService for KvConfig {
22    const REFERENCE: &'static str = "cloudflare/kv";
23}
24
25#[derive(Debug)]
26pub struct CloudflareKv;
27
28impl Hostable for CloudflareKv {
29    const PROVIDER: &'static str = "cloudflare-kv";
30    const HOSTING: IntegrationHosting = IntegrationHosting::Managed;
31    const CONFIG_SCOPE: ConfigScope = ConfigScope::GlobalOnly;
32    const RESOURCE_KIND: &'static str = RESOURCE_KIND;
33    const OUTPUTS: &'static [&'static str] = &["namespace_id", "account_id"];
34}
35
36impl CloudflareResource for CloudflareKv {
37    type Config = KvConfig;
38    const PROVIDER_PREFIX: &'static str = "CLOUDFLARE";
39    // Confirmed by the live smoke 2026-06-16.
40    const OUTPUT_FIELDS: &'static [(&'static str, &'static str, bool)] = &[
41        ("NAMESPACE_ID", "namespace_id", true),
42        ("ACCOUNT_ID", "account_id", false),
43    ];
44
45    fn build_config(ctx: &ProvisionContext<'_>) -> Result<KvConfig, IntegrationError> {
46        let config = super::integration_config(ctx)?;
47        Ok(KvConfig {
48            title: super::interp_required(ctx, &config, "title")?,
49        })
50    }
51}
52
53pub fn validate_config(
54    name: &str,
55    config: &BTreeMap<String, toml::Value>,
56) -> Result<(), IntegrationError> {
57    registry::config_string(config, "title").map_err(|err| IntegrationError::ConfigInvalid {
58        location: format!("integrations.{name}.title"),
59        detail: err.to_string(),
60    })?;
61    Ok(())
62}
63
64#[cfg(test)]
65mod tests {
66    use super::*;
67    use crate::ProviderOps;
68    use crate::resource::ResourcePayload as CloudflarePayload;
69    use stackless_core::def::StackDef;
70    use stackless_stripe_projects::stripe::StripeProjects;
71    use stackless_stripe_projects::test_support;
72
73    #[test]
74    fn kv_config_matches_catalog() {
75        const FIXTURE: &str = include_str!(concat!(
76            env!("CARGO_MANIFEST_DIR"),
77            "/../stackless-stripe-projects/tests/fixtures/catalog.json"
78        ));
79        let catalog = stackless_stripe_projects::Catalog::from_json_envelope(FIXTURE).unwrap();
80        let failures = stackless_stripe_projects::verify_service(
81            &catalog,
82            &KvConfig {
83                title: "stackless-cache".into(),
84            },
85        );
86        assert!(
87            failures.is_empty(),
88            "cloudflare/kv catalog gaps:\n{}",
89            failures.join("\n")
90        );
91    }
92
93    const KV_CATALOG_ENVELOPE: &str = r#"{"ok":true,"command":"projects catalog","data":{
94        "last_updated":"2026-06-16T00:00:00Z","services":[{
95            "id":"prvsvc_kv","object":"v2.provisioning.provider_service_detail",
96            "provider_id":"prvdr_cloudflare","provider_name":"Cloudflare","service_id":"kv",
97            "categories":["cache"],"kind":"deployable","scope":"project","availability":"available",
98            "development":false,"livemode":true,"pricing":{"type":"component"},
99            "configuration_schema":{"type":"object","required":["title"],"additionalProperties":false,
100                "properties":{"title":{"type":"string"}}}
101        }]}}"#;
102
103    fn test_def() -> StackDef {
104        StackDef::parse(
105            r#"
106[stack]
107name = "atto"
108[stack.projects.stripe]
109project = "project_1"
110[integrations.cache]
111provider = "cloudflare-kv"
112title = "${stack.name}-cache"
113[services.api]
114source = { repo = "r", ref = "main" }
115env = { KV_NS = "${integrations.cache.namespace_id}" }
116health = { path = "/health" }
117[services.api.local]
118run = "true"
119"#,
120        )
121        .unwrap()
122    }
123
124    #[tokio::test]
125    async fn provision_kv_records_outputs() {
126        let runner = test_support::provision_script(
127            KV_CATALOG_ENVELOPE,
128            serde_json::json!({
129                "CLOUDFLARE_NAMESPACE_ID": "ns_123",
130                "CLOUDFLARE_ACCOUNT_ID": "acc_1"
131            }),
132            0,
133        );
134        let dir = tempfile::tempdir().unwrap();
135        std::fs::write(
136            dir.path().join("stackless.toml"),
137            "[stack]\nname=\"atto\"\n",
138        )
139        .unwrap();
140        let stripe = StripeProjects::new(&runner, dir.path());
141
142        let resource = CloudflareKv
143            .provision(
144                &stripe.as_dyn(),
145                &test_def(),
146                dir.path(),
147                "demo",
148                "cache",
149                "local",
150                false,
151            )
152            .await
153            .unwrap();
154        assert_eq!(resource.resource_kind, "integration-cloudflare-kv");
155        let payload: CloudflarePayload = serde_json::from_str(&resource.payload).unwrap();
156        assert_eq!(payload.outputs["namespace_id"], "ns_123");
157        // Component pricing → no paid confirmation.
158        let add = runner
159            .calls()
160            .into_iter()
161            .find(|c| c.first().map(String::as_str) == Some("add"))
162            .unwrap();
163        assert_eq!(add[1], "cloudflare/kv");
164        assert!(!add.contains(&"--confirm-paid-service".to_owned()));
165    }
166}