use async_trait::async_trait; use crate::Environment; use crate::ExecServerError; use crate::environment::CODEX_EXEC_SERVER_URL_ENV_VAR; use crate::environment::LOCAL_ENVIRONMENT_ID; use crate::environment::REMOTE_ENVIRONMENT_ID; /// Lists the concrete environments available to Codex. /// /// Implementations own a startup snapshot containing both the available /// environment list in configured order and the default environment /// selection. Providers should only return provider-owned remote environments; /// `include_local` controls whether `EnvironmentManager` should add the local /// environment to the snapshot. #[async_trait] pub trait EnvironmentProvider: Send + Sync { /// Returns the provider-owned environment startup snapshot. async fn snapshot(&self) -> Result; } #[derive(Clone, Debug)] pub struct EnvironmentProviderSnapshot { pub environments: Vec<(String, Environment)>, pub default: EnvironmentDefault, pub include_local: bool, } #[derive(Clone, Debug, PartialEq, Eq)] pub enum EnvironmentDefault { Disabled, EnvironmentId(String), } /// Default provider backed by `CODEX_EXEC_SERVER_URL`. #[derive(Clone, Debug)] pub struct DefaultEnvironmentProvider { exec_server_url: Option, } impl DefaultEnvironmentProvider { /// Builds a provider from an already-read raw `CODEX_EXEC_SERVER_URL` value. pub fn new(exec_server_url: Option) -> Self { Self { exec_server_url } } /// Builds a provider by reading `CODEX_EXEC_SERVER_URL`. pub fn from_env() -> Self { Self::new(std::env::var(CODEX_EXEC_SERVER_URL_ENV_VAR).ok()) } pub(crate) fn snapshot_inner(&self) -> EnvironmentProviderSnapshot { let mut environments = Vec::new(); let (exec_server_url, disabled) = normalize_exec_server_url(self.exec_server_url.clone()); if let Some(exec_server_url) = exec_server_url { environments.push(( REMOTE_ENVIRONMENT_ID.to_string(), Environment::remote_inner(exec_server_url, /*local_runtime_paths*/ None), )); } let has_remote = environments .iter() .any(|(id, _environment)| id == REMOTE_ENVIRONMENT_ID); let include_local = !disabled && !has_remote; let default = if disabled { EnvironmentDefault::Disabled } else if has_remote { EnvironmentDefault::EnvironmentId(REMOTE_ENVIRONMENT_ID.to_string()) } else { EnvironmentDefault::EnvironmentId(LOCAL_ENVIRONMENT_ID.to_string()) }; EnvironmentProviderSnapshot { environments, default, include_local, } } } #[async_trait] impl EnvironmentProvider for DefaultEnvironmentProvider { async fn snapshot(&self) -> Result { Ok(self.snapshot_inner()) } } pub(crate) fn normalize_exec_server_url(exec_server_url: Option) -> (Option, bool) { match exec_server_url.as_deref().map(str::trim) { None | Some("") => (None, false), Some(url) if url.eq_ignore_ascii_case("none") => (None, true), Some(url) => (Some(url.to_string()), false), } } #[cfg(test)] mod tests { use std::collections::HashMap; use pretty_assertions::assert_eq; use super::*; #[tokio::test] async fn default_provider_requests_local_environment_when_url_is_missing() { let provider = DefaultEnvironmentProvider::new(/*exec_server_url*/ None); let snapshot = provider.snapshot().await.expect("environments"); let EnvironmentProviderSnapshot { environments, default, include_local, } = snapshot; let environments: HashMap<_, _> = environments.into_iter().collect(); assert!(include_local); assert!(!environments.contains_key(LOCAL_ENVIRONMENT_ID)); assert!(!environments.contains_key(REMOTE_ENVIRONMENT_ID)); assert_eq!( default, EnvironmentDefault::EnvironmentId(LOCAL_ENVIRONMENT_ID.to_string()) ); } #[tokio::test] async fn default_provider_requests_local_environment_when_url_is_empty() { let provider = DefaultEnvironmentProvider::new(Some(String::new())); let snapshot = provider.snapshot().await.expect("environments"); let EnvironmentProviderSnapshot { environments, default, include_local, } = snapshot; let environments: HashMap<_, _> = environments.into_iter().collect(); assert!(include_local); assert!(!environments.contains_key(LOCAL_ENVIRONMENT_ID)); assert!(!environments.contains_key(REMOTE_ENVIRONMENT_ID)); assert_eq!( default, EnvironmentDefault::EnvironmentId(LOCAL_ENVIRONMENT_ID.to_string()) ); } #[tokio::test] async fn default_provider_omits_local_environment_for_none_value() { let provider = DefaultEnvironmentProvider::new(Some("none".to_string())); let snapshot = provider.snapshot().await.expect("environments"); let EnvironmentProviderSnapshot { environments, default, include_local, } = snapshot; let environments: HashMap<_, _> = environments.into_iter().collect(); assert!(!include_local); assert!(!environments.contains_key(LOCAL_ENVIRONMENT_ID)); assert!(!environments.contains_key(REMOTE_ENVIRONMENT_ID)); assert_eq!(default, EnvironmentDefault::Disabled); } #[tokio::test] async fn default_provider_adds_remote_environment_for_websocket_url() { let provider = DefaultEnvironmentProvider::new(Some("ws://127.0.0.1:8765".to_string())); let snapshot = provider.snapshot().await.expect("environments"); let EnvironmentProviderSnapshot { environments, default, include_local, } = snapshot; let environments: HashMap<_, _> = environments.into_iter().collect(); assert!(!include_local); assert!(!environments.contains_key(LOCAL_ENVIRONMENT_ID)); let remote_environment = &environments[REMOTE_ENVIRONMENT_ID]; assert!(remote_environment.is_remote()); assert_eq!( remote_environment.exec_server_url(), Some("ws://127.0.0.1:8765") ); assert_eq!( default, EnvironmentDefault::EnvironmentId(REMOTE_ENVIRONMENT_ID.to_string()) ); } #[tokio::test] async fn default_provider_normalizes_exec_server_url() { let provider = DefaultEnvironmentProvider::new(Some(" ws://127.0.0.1:8765 ".to_string())); let snapshot = provider.snapshot().await.expect("environments"); let environments: HashMap<_, _> = snapshot.environments.into_iter().collect(); assert_eq!( environments[REMOTE_ENVIRONMENT_ID].exec_server_url(), Some("ws://127.0.0.1:8765") ); } }