use hooks

Signed-off-by: Aminu 'Seun Joshua <[email protected]>

Author: seun-ja

Cargo.lock

@@ -65,12 +65,13 @@ spin-oci = { path = "crates/oci" }
 spin-plugins = { path = "crates/plugins" }
 spin-runtime-factors = { path = "crates/runtime-factors" }
 spin-telemetry = { path = "crates/telemetry", features = [
-  "tracing-log-compat",
+    "tracing-log-compat",
 ] }
 spin-templates = { path = "crates/templates" }
 spin-trigger = { path = "crates/trigger" }
 spin-trigger-http = { path = "crates/trigger-http" }
 spin-trigger-redis = { path = "crates/trigger-redis" }
+spin-variables = { path = "crates/variables" }
 terminal = { path = "crates/terminal" }
 
 [target.'cfg(target_os = "linux")'.dependencies]
@@ -96,10 +97,10 @@ testing-framework = { path = "tests/testing-framework" }
 [build-dependencies]
 cargo-target-dep = { git = "https://github.com/fermyon/cargo-target-dep", rev = "482f269eceb7b1a7e8fc618bf8c082dd24979cf1" }
 vergen = { version = "^8.2.1", default-features = false, features = [
-  "build",
-  "git",
-  "gitcl",
-  "cargo",
+    "build",
+    "git",
+    "gitcl",
+    "cargo",
 ] }
 
 [features]
@@ -112,10 +113,10 @@ llm-cublas = ["llm", "spin-runtime-factors/llm-cublas"]
 
 [workspace]
 members = [
-  "crates/*",
-  "tests/conformance-tests",
-  "tests/runtime-tests",
-  "tests/testing-framework",
+    "crates/*",
+    "tests/conformance-tests",
+    "tests/runtime-tests",
+    "tests/testing-framework",
 ]
 
 [workspace.dependencies]

Cargo.toml

@@ -11,7 +11,6 @@ use spin_locked_app::{
         LockedComponentSource, LockedTrigger,
     },
     values::{ValuesMap, ValuesMapBuilder},
-    Variable,
 };
 use spin_manifest::schema::v2::{self, AppManifest, KebabId, WasiFilesMount};
 use spin_outbound_networking_config::allowed_hosts::{AllowedHostConfig, AllowedHostsConfig};
@@ -141,21 +140,6 @@ impl LocalLoader {
         })
     }
 
-    fn env_checker((key, val): (String, Variable)) -> anyhow::Result<(String, Variable)> {
-        if val.default.is_none() {
-            if std::env::var(env_key(None, key.as_ref())).is_err() {
-                Err(anyhow::anyhow!(
-                    "Variable data not provided for {}",
-                    quoted_path(key)
-                ))
-            } else {
-                Ok((key, val))
-            }
-        } else {
-            Ok((key, val))
-        }
-    }
-
     // Load the given component into a LockedComponent, ready for execution.
     async fn load_component(
         &self,

crates/loader/src/local.rs

@@ -1,3 +1,19 @@
+//! The runtime configuration for the variables factor used in the Spin CLI.
+
+mod azure_key_vault;
+mod env;
+mod statik;
+mod vault;
+
+use std::path::PathBuf;
+
+pub use azure_key_vault::*;
+pub use env::*;
+use spin_common::{env::env_key, ui::quoted_path};
+use spin_locked_app::Variable;
+pub use statik::*;
+pub use vault::*;
+
 use serde::Deserialize;
 use spin_expressions::Provider;
 use spin_factor_variables::runtime_config::RuntimeConfig;
@@ -29,6 +45,24 @@ pub fn runtime_config_from_toml(table: &impl GetTomlValue) -> anyhow::Result<Run
     Ok(RuntimeConfig { providers })
 }
 
+pub fn variable_provider_config_from_toml(
+    table: &impl GetTomlValue,
+) -> anyhow::Result<Vec<VariableProviderConfiguration>> {
+    if let Some(array) = table
+        .get("variables_provider")
+        .or_else(|| table.get("config_provider"))
+    {
+        array
+            .clone()
+            .try_into::<Vec<VariableProviderConfiguration>>()
+            .map_err(|e| anyhow::anyhow!("Failed to parse variable provider configuration: {}", e))
+    } else {
+        Ok(vec![VariableProviderConfiguration::Env(
+            EnvVariablesConfig::default(),
+        )])
+    }
+}
+
 /// A runtime configuration used in the Spin CLI for one type of variable provider.
 #[derive(Debug, Deserialize)]
 #[serde(rename_all = "snake_case", tag = "type")]
@@ -61,3 +95,38 @@ impl VariableProviderConfiguration {
         Ok(provider)
     }
 }
+
+pub trait VariableSourcer {
+    fn variable_env_checker(
+        &self,
+        key: String,
+        val: Variable,
+    ) -> anyhow::Result<(String, Variable)>;
+
+    fn check(
+        &self,
+        key: String,
+        mut val: Variable,
+        dotenv_path: Option<PathBuf>,
+        prefix: Option<String>,
+    ) -> anyhow::Result<(String, Variable)> {
+        if val.default.is_some() {
+            return Ok((key, val));
+        }
+
+        if let Some(path) = dotenv_path {
+            _ = std::env::set_current_dir(path);
+        }
+
+        match std::env::var(env_key(prefix, &key)) {
+            Ok(v) => {
+                val.default = Some(v);
+                Ok((key, val))
+            }
+            Err(_) => Err(anyhow::anyhow!(
+                "Variable data not provided for {}",
+                quoted_path(key)
+            )),
+        }
+    }
+}

crates/runtime-config/src/variables.rs

@@ -72,6 +72,9 @@ impl RuntimeFactorsBuilder for FactorsBuilder {
         executor.add_hooks(InitialKvSetterHook::new(args.key_values.clone()));
         executor.add_hooks(SqliteDefaultStoreSummaryHook);
         executor.add_hooks(KeyValueDefaultStoreSummaryHook);
+        executor.add_hooks(VariableSorterExecutorHooks::new(
+            runtime_config.toml.clone(),
+        ));
 
         let max_instance_memory = args
             .max_instance_memory

crates/runtime-factors/src/build.rs

@@ -32,7 +32,9 @@ spin-factor-wasi = { path = "../factor-wasi" }
 spin-factors = { path = "../factors" }
 spin-factors-executor = { path = "../factors-executor" }
 spin-telemetry = { path = "../telemetry" }
+spin-variables = { path = "../variables" }
 tokio = { workspace = true, features = ["fs", "rt"] }
+toml = { workspace = true }
 tracing = { workspace = true }
 
 [dev-dependencies]

crates/trigger/Cargo.toml

@@ -4,6 +4,7 @@ mod max_instance_memory;
 mod sqlite_statements;
 mod stdio;
 mod summary;
+mod variables;
 
 use std::path::PathBuf;
 use std::{future::Future, sync::Arc};
@@ -25,6 +26,7 @@ pub use sqlite_statements::SqlStatementExecutorHook;
 use stdio::FollowComponents;
 pub use stdio::StdioLoggingExecutorHooks;
 pub use summary::{KeyValueDefaultStoreSummaryHook, SqliteDefaultStoreSummaryHook};
+pub use variables::VariableSorterExecutorHooks;
 
 pub const APP_LOG_DIR: &str = "APP_LOG_DIR";
 pub const SPIN_TRUNCATE_LOGS: &str = "SPIN_TRUNCATE_LOGS";

crates/trigger/src/cli.rs

@@ -0,0 +1,48 @@
+use spin_core::async_trait;
+use spin_factors::RuntimeFactors;
+use spin_factors_executor::ExecutorHooks;
+use spin_variables::{VariableProviderConfiguration, VariableSourcer};
+
+/// Implements TriggerHooks, sorting required variables
+pub struct VariableSorterExecutorHooks {
+    table: toml::Table,
+}
+
+impl VariableSorterExecutorHooks {
+    pub fn new(table: toml::Table) -> Self {
+        Self { table }
+    }
+}
+
+#[async_trait]
+impl<F: RuntimeFactors, U> ExecutorHooks<F, U> for VariableSorterExecutorHooks {
+    async fn configure_app(
+        &self,
+        configured_app: &spin_factors::ConfiguredApp<F>,
+    ) -> anyhow::Result<()> {
+        for (key, variable) in configured_app.app().variables() {
+            self.variable_env_checker(key.clone(), variable.clone())?;
+        }
+        Ok(())
+    }
+}
+
+impl VariableSourcer for VariableSorterExecutorHooks {
+    fn variable_env_checker(
+        &self,
+        key: String,
+        val: spin_app::Variable,
+    ) -> anyhow::Result<(String, spin_app::Variable)> {
+        let configs = spin_variables::variable_provider_config_from_toml(&self.table)?;
+
+        if let Some(config) = configs.into_iter().next() {
+            let (dotenv_path, prefix) = match config {
+                VariableProviderConfiguration::Env(env) => (env.dotenv_path, env.prefix),
+                _ => (None, None),
+            };
+            return self.check(key, val, dotenv_path, prefix);
+        }
+
+        Err(anyhow::anyhow!("No environment variable provider found"))
+    }
+}

crates/trigger/src/cli/variables.rs

@@ -16,6 +16,7 @@ serde = { workspace = true }
 spin-common = { path = "../common" }
 spin-expressions = { path = "../expressions" }
 spin-factors = { path = "../factors" }
+spin-locked-app = { path = "../locked-app" }
 spin-world = { path = "../world" }
 tracing = { workspace = true }