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] = &["rest_url", "rest_token"];
44}
45
46impl FamilyResource for UpstashVector {
47    type Config = UpstashVectorConfig;
48    const PROVIDER_PREFIX: &'static str = "UPSTASH";
49    // Provisional until pinned by `mise run discover upstash/vector`.
50    const OUTPUT_FIELDS: &'static [(&'static str, &'static str, bool)] = &[
51        ("REST_URL", "rest_url", true),
52        ("REST_TOKEN", "rest_token", true),
53    ];
54
55    fn build_config(ctx: &ProvisionContext<'_>) -> Result<UpstashVectorConfig, IntegrationError> {
56        let config = super::integration_config(ctx)?;
57        Ok(UpstashVectorConfig {
58            dimension: super::int_optional(ctx, &config, "dimension")?,
59            embedding_model: super::interp_optional(ctx, &config, "embedding_model")?,
60            name: super::interp_optional(ctx, &config, "name")?,
61            price: super::interp_optional(ctx, &config, "price")?,
62            region: super::interp_optional(ctx, &config, "region")?,
63            similarity_function: super::interp_optional(ctx, &config, "similarity_function")?,
64        })
65    }
66}
67
68pub fn validate_config(
69    name: &str,
70    config: &BTreeMap<String, toml::Value>,
71) -> Result<(), IntegrationError> {
72    let _ = (name, config);
73    Ok(())
74}
75
76#[cfg(test)]
77mod tests {
78    use super::*;
79    use crate::ProviderOps;
80    use crate::resource::ResourcePayload;
81    use stackless_core::def::StackDef;
82    use stackless_stripe_projects::stripe::StripeProjects;
83    use stackless_stripe_projects::test_support;
84
85    #[test]
86    fn config_matches_catalog() {
87        const FIXTURE: &str = include_str!(concat!(
88            env!("CARGO_MANIFEST_DIR"),
89            "/../stackless-stripe-projects/tests/fixtures/catalog.json"
90        ));
91        let catalog = stackless_stripe_projects::Catalog::from_json_envelope(FIXTURE).unwrap();
92        let failures = stackless_stripe_projects::verify_service(
93            &catalog,
94            &UpstashVectorConfig {
95                dimension: None,
96                embedding_model: None,
97                name: None,
98                price: None,
99                region: None,
100                similarity_function: None,
101            },
102        );
103        assert!(
104            failures.is_empty(),
105            "upstash/vector catalog gaps:\n{}",
106            failures.join("\n")
107        );
108    }
109
110    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"}}]}}"##;
111
112    fn test_def() -> StackDef {
113        StackDef::parse(
114            r#"
115[stack]
116name = "atto"
117[stack.projects.stripe]
118project = "project_1"
119[integrations.res]
120provider = "upstash-vector"
121[services.api]
122source = { repo = "r", ref = "main" }
123env = { OUT = "${integrations.res.rest_url}" }
124health = { path = "/health" }
125[services.api.local]
126run = "true"
127"#,
128        )
129        .unwrap()
130    }
131
132    #[tokio::test]
133    async fn provision_records_outputs() {
134        let runner = test_support::provision_script(
135            CATALOG_ENVELOPE,
136            serde_json::json!({"UPSTASH_REST_URL": "val_rest_url", "UPSTASH_REST_TOKEN": "val_rest_token"}),
137            0,
138        );
139        let dir = tempfile::tempdir().unwrap();
140        std::fs::write(
141            dir.path().join("stackless.toml"),
142            "[stack]\nname=\"atto\"\n",
143        )
144        .unwrap();
145        let stripe = StripeProjects::new(&runner, dir.path());
146
147        let resource = UpstashVector
148            .provision(
149                &stripe.as_dyn(),
150                &test_def(),
151                dir.path(),
152                "demo",
153                "res",
154                "local",
155                false,
156            )
157            .await
158            .unwrap();
159        assert_eq!(resource.resource_kind, "integration-upstash-vector");
160        let payload: ResourcePayload = serde_json::from_str(&resource.payload).unwrap();
161        assert_eq!(payload.outputs["rest_url"], "val_rest_url");
162    }
163}