Skip to main content

stackless_integrations/providers/upstash/
vector.rs

1//! `upstash/vector` integration.
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::FamilyResource;
10use crate::error::IntegrationError;
11use crate::hostable::{ConfigScope, Hostable, IntegrationHosting};
12
13pub const RESOURCE_KIND: &str = "integration-upstash-vector";
14
15#[derive(Debug, Serialize)]
16pub struct UpstashVectorConfig {
17    #[serde(skip_serializing_if = "Option::is_none")]
18    pub dimension: Option<i64>,
19    #[serde(skip_serializing_if = "Option::is_none")]
20    pub embedding_model: Option<String>,
21    #[serde(skip_serializing_if = "Option::is_none")]
22    pub name: Option<String>,
23    #[serde(skip_serializing_if = "Option::is_none")]
24    pub price: Option<String>,
25    #[serde(skip_serializing_if = "Option::is_none")]
26    pub region: Option<String>,
27    #[serde(skip_serializing_if = "Option::is_none")]
28    pub similarity_function: Option<String>,
29}
30
31impl CatalogService for UpstashVectorConfig {
32    const REFERENCE: &'static str = "upstash/vector";
33}
34
35#[derive(Debug)]
36pub struct UpstashVector;
37
38impl Hostable for UpstashVector {
39    const PROVIDER: &'static str = "upstash-vector";
40    const HOSTING: IntegrationHosting = IntegrationHosting::Managed;
41    const CONFIG_SCOPE: ConfigScope = ConfigScope::GlobalOnly;
42    const RESOURCE_KIND: &'static str = RESOURCE_KIND;
43    const OUTPUTS: &'static [&'static str] = &["token", "url"];
44}
45
46impl FamilyResource for UpstashVector {
47    type Config = UpstashVectorConfig;
48    const PROVIDER_PREFIX: &'static str = "UPSTASH";
49    const OUTPUT_FIELDS: &'static [(&'static str, &'static str, bool)] =
50        &[("TOKEN", "token", true), ("URL", "url", true)];
51
52    fn build_config(ctx: &ProvisionContext<'_>) -> Result<UpstashVectorConfig, IntegrationError> {
53        let config = super::integration_config(ctx)?;
54        Ok(UpstashVectorConfig {
55            dimension: super::int_optional(ctx, &config, "dimension")?,
56            embedding_model: super::interp_optional(ctx, &config, "embedding_model")?,
57            name: super::interp_optional(ctx, &config, "name")?,
58            price: super::interp_optional(ctx, &config, "price")?,
59            region: super::interp_optional(ctx, &config, "region")?,
60            similarity_function: super::interp_optional(ctx, &config, "similarity_function")?,
61        })
62    }
63}
64
65pub fn validate_config(
66    name: &str,
67    config: &BTreeMap<String, toml::Value>,
68) -> Result<(), IntegrationError> {
69    let _ = (name, config);
70    Ok(())
71}
72
73#[cfg(test)]
74mod tests {
75    use super::*;
76    use crate::ProviderOps;
77    use crate::resource::ResourcePayload;
78    use stackless_core::def::StackDef;
79    use stackless_stripe_projects::stripe::StripeProjects;
80    use stackless_stripe_projects::test_support;
81
82    #[test]
83    fn config_matches_catalog() {
84        const FIXTURE: &str = include_str!(concat!(
85            env!("CARGO_MANIFEST_DIR"),
86            "/../stackless-stripe-projects/tests/fixtures/catalog.json"
87        ));
88        let catalog = stackless_stripe_projects::Catalog::from_json_envelope(FIXTURE).unwrap();
89        let failures = stackless_stripe_projects::verify_service(
90            &catalog,
91            &UpstashVectorConfig {
92                dimension: None,
93                embedding_model: None,
94                name: None,
95                price: None,
96                region: None,
97                similarity_function: None,
98            },
99        );
100        assert!(
101            failures.is_empty(),
102            "upstash/vector catalog gaps:\n{}",
103            failures.join("\n")
104        );
105    }
106
107    const CATALOG_ENVELOPE: &str = r##"{"ok":true,"command":"projects catalog","data":{"last_updated":"2026-07-11T00:00:00Z","services":[{"id":"prvsvc_vector","object":"v2.provisioning.provider_service_detail","provider_id":"prvdr_upstash","provider_name":"Upstash","service_id":"vector","categories":["database"],"kind":"deployable","scope":"project","availability":"available","development":false,"livemode":true,"pricing":{"type":"paid"},"configuration_schema":{"properties":{"dimension":{"description":"Vector dimension count. Ignored when embedding_model is set (dimension is derived from the model)","maximum":3072,"minimum":1,"type":"integer"},"embedding_model":{"description":"Embedding model. Use empty string to bring your own vectors (dimension required).","enum":["BGE_SMALL_EN_V1_5","BGE_BASE_EN_V1_5","BGE_LARGE_EN_V1_5","BGE_M3"],"type":"string"},"name":{"description":"Index name","minLength":1,"type":"string"},"price":{"default":"payg","description":"Pricing tier. 'free' provisions on the free plan (subject to free-tier limits and one-per-account). 'payg' provisions pay-as-you-go. Defaults to 'payg'.","enum":["free","payg"],"type":"string"},"region":{"description":"Region for the vector index","enum":["us-east-1","eu-west-1","us-central1"],"type":"string"},"similarity_function":{"description":"Distance metric for similarity search","enum":["COSINE","EUCLIDEAN","DOT_PRODUCT"],"type":"string"}},"type":"object"}}]}}"##;
108
109    fn test_def() -> StackDef {
110        StackDef::parse(
111            r#"
112[stack]
113name = "atto"
114[stack.projects.stripe]
115project = "project_1"
116[integrations.res]
117provider = "upstash-vector"
118[services.api]
119source = { repo = "r", ref = "main" }
120env = { OUT = "${integrations.res.url}" }
121health = { path = "/health" }
122[services.api.local]
123run = "true"
124"#,
125        )
126        .unwrap()
127    }
128
129    #[tokio::test]
130    async fn provision_records_outputs() {
131        let runner = test_support::provision_script(
132            CATALOG_ENVELOPE,
133            serde_json::json!({"UPSTASH_TOKEN": "val_token", "UPSTASH_URL": "val_url"}),
134            0,
135        );
136        let dir = tempfile::tempdir().unwrap();
137        std::fs::write(
138            dir.path().join("stackless.toml"),
139            "[stack]\nname=\"atto\"\n",
140        )
141        .unwrap();
142        let stripe = StripeProjects::new(&runner, dir.path());
143
144        let resource = UpstashVector
145            .provision(
146                &stripe.as_dyn(),
147                &test_def(),
148                dir.path(),
149                "demo",
150                "res",
151                "local",
152                false,
153            )
154            .await
155            .unwrap();
156        assert_eq!(resource.resource_kind, "integration-upstash-vector");
157        let payload: ResourcePayload = serde_json::from_str(&resource.payload).unwrap();
158        assert_eq!(payload.outputs["url"], "val_url");
159    }
160}