Merge pull request #2666 from kate-goldenring/key-value-factor-cleanups

factors: key value tests, doc comments, and Azure factor

crates/factor-key-value-azure/Cargo.toml

@@ -0,0 +1,19 @@
+[package]
+name = "spin-factor-key-value-azure"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+license.workspace = true
+homepage.workspace = true
+repository.workspace = true
+rust-version.workspace = true
+
+[dependencies]
+anyhow = "1.0"
+serde = { version = "1.0", features = ["rc"] }
+spin-factor-key-value = { path = "../factor-key-value" }
+# TODO: merge with this crate
+spin-key-value-azure = { path = "../key-value-azure" }
+
+[lints]
+workspace = true

crates/factor-key-value-azure/src/lib.rs

@@ -0,0 +1,40 @@
+use serde::Deserialize;
+use spin_factor_key_value::MakeKeyValueStore;
+use spin_key_value_azure::KeyValueAzureCosmos;
+
+/// A key-value store that uses Azure Cosmos as the backend.
+pub struct AzureKeyValueStore;
+
+/// Runtime configuration for the Azure Cosmos key-value store.
+#[derive(Deserialize)]
+pub struct AzureCosmosKeyValueRuntimeConfig {
+    /// The authorization token for the Azure Cosmos DB account.
+    key: String,
+    /// The Azure Cosmos DB account name.
+    account: String,
+    /// The Azure Cosmos DB database.
+    database: String,
+    /// The Azure Cosmos DB container where data is stored.
+    /// The CosmosDB container must be created with the default partition key, /id
+    container: String,
+}
+
+impl MakeKeyValueStore for AzureKeyValueStore {
+    const RUNTIME_CONFIG_TYPE: &'static str = "azure_cosmos";
+
+    type RuntimeConfig = AzureCosmosKeyValueRuntimeConfig;
+
+    type StoreManager = KeyValueAzureCosmos;
+
+    fn make_store(
+        &self,
+        runtime_config: Self::RuntimeConfig,
+    ) -> anyhow::Result<Self::StoreManager> {
+        KeyValueAzureCosmos::new(
+            runtime_config.key,
+            runtime_config.account,
+            runtime_config.database,
+            runtime_config.container,
+        )
+    }
+}

crates/factor-key-value-redis/src/lib.rs

@@ -1,10 +1,14 @@
 use serde::Deserialize;
 use spin_factor_key_value::MakeKeyValueStore;
 use spin_key_value_redis::KeyValueRedis;
+
+/// A key-value store that uses Redis as the backend.
 pub struct RedisKeyValueStore;
 
+/// Runtime configuration for the Redis key-value store.
 #[derive(Deserialize)]
 pub struct RedisKeyValueRuntimeConfig {
+    /// The URL of the Redis server.
     url: String,
 }
 

crates/factor-key-value-spin/src/lib.rs

@@ -8,30 +8,36 @@ use serde::{Deserialize, Serialize};
 use spin_factor_key_value::MakeKeyValueStore;
 use spin_key_value_sqlite::{DatabaseLocation, KeyValueSqlite};
 
+/// A key-value store that uses SQLite as the backend.
 pub struct SpinKeyValueStore {
+    /// The base path or directory for the SQLite database file.
     base_path: PathBuf,
 }
 
 impl SpinKeyValueStore {
-    pub fn new(base_path: Option<PathBuf>) -> anyhow::Result<Self> {
-        let base_path = match base_path {
-            Some(path) => path,
-            None => std::env::current_dir().context("failed to get current directory")?,
-        };
-        Ok(Self { base_path })
+    /// Create a new SpinKeyValueStore with the given base path.
+    pub fn new(base_path: PathBuf) -> Self {
+        Self { base_path }
     }
 }
 
+/// Runtime configuration for the SQLite key-value store.
 #[derive(Deserialize, Serialize)]
 pub struct SpinKeyValueRuntimeConfig {
+    /// The path to the SQLite database file.
     path: Option<PathBuf>,
 }
 
 impl SpinKeyValueRuntimeConfig {
+    /// The default filename for the SQLite database.
     const DEFAULT_SPIN_STORE_FILENAME: &'static str = "sqlite_key_value.db";
 
-    pub fn default(state_dir: Option<PathBuf>) -> Self {
-        let path = state_dir.map(|dir| dir.join(Self::DEFAULT_SPIN_STORE_FILENAME));
+    /// Create a new runtime configuration with the given state directory.
+    ///
+    /// If the database directory is None, the database is in-memory.
+    /// If the database directory is Some, the database is stored in a file in the state directory.
+    pub fn default(default_database_dir: Option<PathBuf>) -> Self {
+        let path = default_database_dir.map(|dir| dir.join(Self::DEFAULT_SPIN_STORE_FILENAME));
         Self { path }
     }
 }

crates/factor-key-value/Cargo.toml

@@ -13,5 +13,13 @@ spin-key-value = { path = "../key-value" }
 spin-world = { path = "../world" }
 toml = "0.8"
 
+[dev-dependencies]
+spin-factors-test = { path = "../factors-test" }
+tokio = { version = "1", features = ["macros", "rt"] }
+spin-factor-key-value-spin = { path = "../factor-key-value-spin" }
+spin-factor-key-value-redis = { path = "../factor-key-value-redis" }
+tempdir = "0.3"
+
+
 [lints]
 workspace = true

crates/factor-key-value/src/delegating_resolver.rs

@@ -1,26 +1,34 @@
 use crate::runtime_config::RuntimeConfigResolver;
 use crate::store::{store_from_toml_fn, MakeKeyValueStore, StoreFromToml};
-use serde::Deserialize;
+use serde::{Deserialize, Serialize};
 use spin_key_value::StoreManager;
 use std::{collections::HashMap, sync::Arc};
 
+/// A RuntimeConfigResolver that delegates to the appropriate key-value store
+/// for a given label.
+///
+/// The store types are registered with the resolver using `add_store_type`. The
+/// default store for a label is registered using `add_default_store`.
 #[derive(Default)]
 pub struct DelegatingRuntimeConfigResolver {
+    /// A map of store types to a function that returns the appropriate store
+    /// manager from runtime config TOML.
     store_types: HashMap<&'static str, StoreFromToml>,
+    /// A map of default store configurations for a label.
     defaults: HashMap<&'static str, StoreConfig>,
 }
 
 impl DelegatingRuntimeConfigResolver {
+    /// Create a new DelegatingRuntimeConfigResolver.
     pub fn new() -> Self {
         Self::default()
     }
 
     pub fn add_default_store(&mut self, label: &'static str, config: StoreConfig) {
         self.defaults.insert(label, config);
     }
-}
 
-impl DelegatingRuntimeConfigResolver {
+    /// Adds a store type to the resolver.
     pub fn add_store_type<T: MakeKeyValueStore>(&mut self, store_type: T) -> anyhow::Result<()> {
         if self
             .store_types
@@ -48,6 +56,9 @@ impl RuntimeConfigResolver for DelegatingRuntimeConfigResolver {
         store_from_toml(config.config)
     }
 
+    /// Get the default store manager for the given label.
+    ///
+    /// Returns None if no default store is registered for the label.
     fn default_store(&self, label: &str) -> Option<Arc<dyn StoreManager>> {
         let config = self.defaults.get(label)?;
         self.get_store(config.clone()).ok()
@@ -61,3 +72,15 @@ pub struct StoreConfig {
     #[serde(flatten)]
     pub config: toml::Table,
 }
+
+impl StoreConfig {
+    pub fn new<T>(type_: String, config: T) -> anyhow::Result<Self>
+    where
+        T: Serialize,
+    {
+        Ok(Self {
+            type_,
+            config: toml::value::Table::try_from(config)?,
+        })
+    }
+}