Merge pull request #2781 from lann/kv-summary-hook

Add KeyValueDefaultStoreSummaryHook

Author: rylev

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

@@ -119,6 +119,12 @@ pub struct AppState {
     component_allowed_stores: HashMap<String, HashSet<String>>,
 }
 
+impl AppState {
+    pub fn store_summary(&self, label: &str) -> Option<String> {
+        self.store_manager.summary(label)
+    }
+}
+
 pub struct InstanceBuilder {
     /// The store manager for the app.
     ///

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

@@ -102,6 +102,14 @@ impl StoreManager for KeyValueAzureCosmos {
     fn is_defined(&self, _store_name: &str) -> bool {
         true
     }
+
+    fn summary(&self, _store_name: &str) -> Option<String> {
+        let database = self.client.database_client().database_name();
+        let collection = self.client.collection_name();
+        Some(format!(
+            "Azure CosmosDB database: {database}, collection: {collection}"
+        ))
+    }
 }
 
 struct AzureCosmosStore {

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

@@ -47,6 +47,11 @@ impl StoreManager for KeyValueRedis {
     fn is_defined(&self, _store_name: &str) -> bool {
         true
     }
+
+    fn summary(&self, _store_name: &str) -> Option<String> {
+        let redis::ConnectionInfo { addr, .. } = self.database_url.as_str().parse().ok()?;
+        Some(format!("Redis at {addr}"))
+    }
 }
 
 struct RedisStore {

crates/key-value-sqlite/src/lib.rs

@@ -68,6 +68,13 @@ impl StoreManager for KeyValueSqlite {
     fn is_defined(&self, _store_name: &str) -> bool {
         true
     }
+
+    fn summary(&self, _store_name: &str) -> Option<String> {
+        Some(match &self.location {
+            DatabaseLocation::InMemory => "a temporary in-memory store".into(),
+            DatabaseLocation::Path(path) => format!("\"{}\"", path.display()),
+        })
+    }
 }
 
 struct SqliteStore {

crates/key-value/src/lib.rs

@@ -23,6 +23,14 @@ pub use key_value::Error;
 pub trait StoreManager: Sync + Send {
     async fn get(&self, name: &str) -> Result<Arc<dyn Store>, Error>;
     fn is_defined(&self, store_name: &str) -> bool;
+
+    /// A human-readable summary of the given store's configuration
+    ///
+    /// Example: "Redis at localhost:1234"
+    fn summary(&self, store_name: &str) -> Option<String> {
+        let _ = store_name;
+        None
+    }
 }
 
 #[async_trait]

crates/key-value/src/util.rs

@@ -66,6 +66,10 @@ impl StoreManager for DelegatingStoreManager {
     fn is_defined(&self, store_name: &str) -> bool {
         self.delegates.contains_key(store_name)
     }
+
+    fn summary(&self, store_name: &str) -> Option<String> {
+        (self.default_manager)(store_name)?.summary(store_name)
+    }
 }
 
 /// Wrap each `Store` produced by the inner `StoreManager` in an asynchronous, write-behind cache.
@@ -122,6 +126,10 @@ impl<T: StoreManager> StoreManager for CachingStoreManager<T> {
     fn is_defined(&self, store_name: &str) -> bool {
         self.inner.is_defined(store_name)
     }
+
+    fn summary(&self, store_name: &str) -> Option<String> {
+        self.inner.summary(store_name)
+    }
 }
 
 struct CachingStoreState {

crates/trigger/src/cli.rs

@@ -1,4 +1,5 @@
 mod launch_metadata;
+mod summary;
 
 use std::future::Future;
 use std::path::{Path, PathBuf};
@@ -12,6 +13,7 @@ use spin_common::{arg_parser::parse_kv, sloth};
 use spin_core::async_trait;
 use spin_factors_executor::{ComponentLoader, FactorsExecutor};
 use spin_runtime_config::{ResolvedRuntimeConfig, UserProvidedPath};
+use summary::KeyValueDefaultStoreSummaryHook;
 
 use crate::factors::{TriggerFactors, TriggerFactorsRuntimeConfig};
 use crate::stdio::{FollowComponents, StdioLoggingExecutorHooks};
@@ -418,7 +420,7 @@ impl<T: Trigger> TriggerAppBuilder<T> {
         ));
         // TODO:
         // builder.hooks(SummariseRuntimeConfigHook::new(&self.runtime_config_file));
-        // builder.hooks(KeyValuePersistenceMessageHook);
+        executor.add_hooks(KeyValueDefaultStoreSummaryHook);
         // builder.hooks(SqlitePersistenceMessageHook);
 
         let configured_app = {

crates/trigger/src/cli/summary.rs

@@ -0,0 +1,22 @@
+use spin_factor_key_value::KeyValueFactor;
+use spin_factors_executor::ExecutorHooks;
+
+use crate::factors::TriggerFactors;
+
+pub struct KeyValueDefaultStoreSummaryHook;
+
+impl<U> ExecutorHooks<TriggerFactors, U> for KeyValueDefaultStoreSummaryHook {
+    fn configure_app(
+        &mut self,
+        configured_app: &spin_factors::ConfiguredApp<TriggerFactors>,
+    ) -> anyhow::Result<()> {
+        if let Some(default_store_summary) = configured_app
+            .app_state::<KeyValueFactor>()
+            .ok()
+            .and_then(|kv_state| kv_state.store_summary("default"))
+        {
+            println!("Storing default key-value data to {default_store_summary}.");
+        }
+        Ok(())
+    }
+}