Skip to main content

stackless_integrations/providers/cloudflare/
queues.rs

1//! Cloudflare Queues (`cloudflare/queues`).
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-queues";
15
16#[derive(Debug, Serialize)]
17pub struct QueuesConfig {
18    pub queue_name: String,
19}
20
21impl CatalogService for QueuesConfig {
22    const REFERENCE: &'static str = "cloudflare/queues";
23}
24
25#[derive(Debug)]
26pub struct CloudflareQueues;
27
28impl Hostable for CloudflareQueues {
29    const PROVIDER: &'static str = "cloudflare-queues";
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] = &["queue_id", "queue_name", "account_id"];
34}
35
36impl CloudflareResource for CloudflareQueues {
37    type Config = QueuesConfig;
38    const PROVIDER_PREFIX: &'static str = "CLOUDFLARE";
39    // Confirmed by live provisioning 2026-06-16.
40    const OUTPUT_FIELDS: &'static [(&'static str, &'static str, bool)] = &[
41        ("QUEUE_ID", "queue_id", true),
42        ("QUEUE_NAME", "queue_name", false),
43        ("ACCOUNT_ID", "account_id", false),
44    ];
45
46    fn build_config(ctx: &ProvisionContext<'_>) -> Result<QueuesConfig, IntegrationError> {
47        let config = super::integration_config(ctx)?;
48        Ok(QueuesConfig {
49            queue_name: super::interp_required(ctx, &config, "queue_name")?,
50        })
51    }
52}
53
54pub fn validate_config(
55    name: &str,
56    config: &BTreeMap<String, toml::Value>,
57) -> Result<(), IntegrationError> {
58    registry::config_string(config, "queue_name").map_err(|err| {
59        IntegrationError::ConfigInvalid {
60            location: format!("integrations.{name}.queue_name"),
61            detail: err.to_string(),
62        }
63    })?;
64    Ok(())
65}
66
67#[cfg(test)]
68mod tests {
69    use super::*;
70    use crate::ProviderOps;
71    use crate::resource::ResourcePayload as CloudflarePayload;
72    use stackless_core::def::StackDef;
73    use stackless_stripe_projects::stripe::{CommandOutput, StripeProjects};
74    use stackless_stripe_projects::test_support::ScriptedRunner;
75
76    fn out(stdout: &str) -> CommandOutput {
77        CommandOutput {
78            status: 0,
79            stdout: stdout.to_owned(),
80            stderr: String::new(),
81        }
82    }
83
84    #[test]
85    fn queues_config_matches_catalog() {
86        const FIXTURE: &str = include_str!(concat!(
87            env!("CARGO_MANIFEST_DIR"),
88            "/../stackless-stripe-projects/tests/fixtures/catalog.json"
89        ));
90        let catalog = stackless_stripe_projects::Catalog::from_json_envelope(FIXTURE).unwrap();
91        let failures = stackless_stripe_projects::verify_service(
92            &catalog,
93            &QueuesConfig {
94                queue_name: "stackless-jobs".into(),
95            },
96        );
97        assert!(
98            failures.is_empty(),
99            "cloudflare/queues catalog gaps:\n{}",
100            failures.join("\n")
101        );
102    }
103
104    const QUEUES_CATALOG_ENVELOPE: &str = r#"{"ok":true,"command":"projects catalog","data":{
105        "last_updated":"2026-06-16T00:00:00Z","services":[{
106            "id":"prvsvc_queues","object":"v2.provisioning.provider_service_detail",
107            "provider_id":"prvdr_cloudflare","provider_name":"Cloudflare","service_id":"queues",
108            "categories":["queue"],"kind":"deployable","scope":"project","availability":"available",
109            "development":false,"livemode":true,"pricing":{"type":"component"},
110            "configuration_schema":{"type":"object","required":["queue_name"],"additionalProperties":false,
111                "properties":{"queue_name":{"type":"string"}}}
112        }]}}"#;
113
114    fn test_def() -> StackDef {
115        StackDef::parse(
116            r#"
117[stack]
118name = "atto"
119[stack.projects.stripe]
120project = "project_1"
121[integrations.jobs]
122provider = "cloudflare-queues"
123queue_name = "${stack.name}-jobs"
124[services.api]
125source = { repo = "r", ref = "main" }
126env = { QUEUE_ID = "${integrations.jobs.queue_id}" }
127health = { path = "/health" }
128[services.api.local]
129run = "true"
130"#,
131        )
132        .unwrap()
133    }
134
135    #[tokio::test]
136    async fn provision_queues_records_outputs() {
137        let runner = ScriptedRunner::new(vec![
138            out(QUEUES_CATALOG_ENVELOPE),
139            out(r#"{"ok":true,"data":{"project":{"id":"project_1"}}}"#),
140            out(r#"{"ok":true,"data":{"environments":[{"name":"demo"}]}}"#),
141            out(r#"{"ok":true,"data":null}"#),
142            out(r#"{"ok":true,"data":{"services":[]}}"#),
143            out(&serde_json::json!({"ok":true,"data":{"variables":{
144                "CLOUDFLARE_QUEUE_ID": "q_123",
145                "CLOUDFLARE_QUEUE_NAME": "atto-jobs",
146                "CLOUDFLARE_ACCOUNT_ID": "acc_1"
147            }}})
148            .to_string()),
149            out(r#"{"ok":true,"data":null}"#),
150            out(r#"{"ok":true,"data":null}"#),
151        ]);
152        let dir = tempfile::tempdir().unwrap();
153        std::fs::write(
154            dir.path().join("stackless.toml"),
155            "[stack]\nname=\"atto\"\n",
156        )
157        .unwrap();
158        let stripe = StripeProjects::new(&runner, dir.path());
159
160        let resource = CloudflareQueues
161            .provision(
162                &stripe.as_dyn(),
163                &test_def(),
164                dir.path(),
165                "demo",
166                "jobs",
167                "local",
168                false,
169            )
170            .await
171            .unwrap();
172        assert_eq!(resource.resource_kind, "integration-cloudflare-queues");
173        let payload: CloudflarePayload = serde_json::from_str(&resource.payload).unwrap();
174        assert_eq!(payload.outputs["queue_id"], "q_123");
175        assert_eq!(payload.outputs["queue_name"], "atto-jobs");
176    }
177}