use anyhow::Result; use futures::{future::Shared, FutureExt}; use std::{path::Path, sync::Arc}; use util::ResultExt; use collections::HashMap; use gpui::{AppContext, Context, Model, ModelContext, Task}; use settings::Settings as _; use worktree::WorktreeId; use crate::{ project_settings::{DirenvSettings, ProjectSettings}, worktree_store::{WorktreeStore, WorktreeStoreEvent}, }; pub struct ProjectEnvironment { cli_environment: Option>, get_environment_task: Option>>>>, cached_shell_environments: HashMap>, } impl ProjectEnvironment { pub fn new( worktree_store: &Model, cli_environment: Option>, cx: &mut AppContext, ) -> Model { cx.new_model(|cx| { cx.subscribe(worktree_store, |this: &mut Self, _, event, _| { if let WorktreeStoreEvent::WorktreeRemoved(_, id) = event { this.remove_worktree_environment(*id); } }) .detach(); Self { cli_environment, get_environment_task: None, cached_shell_environments: Default::default(), } }) } #[cfg(any(test, feature = "test-support"))] pub(crate) fn set_cached( &mut self, shell_environments: &[(WorktreeId, HashMap)], ) { self.cached_shell_environments = shell_environments .iter() .cloned() .collect::>(); } pub(crate) fn remove_worktree_environment(&mut self, worktree_id: WorktreeId) { self.cached_shell_environments.remove(&worktree_id); } /// Returns the inherited CLI environment, if this project was opened from the Zed CLI. pub(crate) fn get_cli_environment(&self) -> Option> { if let Some(mut env) = self.cli_environment.clone() { set_origin_marker(&mut env, EnvironmentOrigin::Cli); Some(env) } else { None } } /// Returns the project environment, if possible. /// If the project was opened from the CLI, then the inherited CLI environment is returned. /// If it wasn't opened from the CLI, and a worktree is given, then a shell is spawned in /// the worktree's path, to get environment variables as if the user has `cd`'d into /// the worktrees path. pub(crate) fn get_environment( &mut self, worktree_id: Option, worktree_abs_path: Option>, cx: &ModelContext, ) -> Shared>>> { if let Some(task) = self.get_environment_task.as_ref() { task.clone() } else { let task = self .build_environment_task(worktree_id, worktree_abs_path, cx) .shared(); self.get_environment_task = Some(task.clone()); task } } fn build_environment_task( &mut self, worktree_id: Option, worktree_abs_path: Option>, cx: &ModelContext, ) -> Task>> { let worktree = worktree_id.zip(worktree_abs_path); let cli_environment = self.get_cli_environment(); if cli_environment.is_some() { Task::ready(cli_environment) } else if let Some((worktree_id, worktree_abs_path)) = worktree { self.get_worktree_env(worktree_id, worktree_abs_path, cx) } else { Task::ready(None) } } fn get_worktree_env( &mut self, worktree_id: WorktreeId, worktree_abs_path: Arc, cx: &ModelContext, ) -> Task>> { let cached_env = self.cached_shell_environments.get(&worktree_id).cloned(); if let Some(env) = cached_env { Task::ready(Some(env)) } else { let load_direnv = ProjectSettings::get_global(cx).load_direnv.clone(); cx.spawn(|this, mut cx| async move { let mut shell_env = cx .background_executor() .spawn({ let cwd = worktree_abs_path.clone(); async move { load_shell_environment(&cwd, &load_direnv).await } }) .await .ok(); if let Some(shell_env) = shell_env.as_mut() { this.update(&mut cx, |this, _| { this.cached_shell_environments .insert(worktree_id, shell_env.clone()) }) .log_err(); set_origin_marker(shell_env, EnvironmentOrigin::WorktreeShell); } shell_env }) } } } fn set_origin_marker(env: &mut HashMap, origin: EnvironmentOrigin) { env.insert(ZED_ENVIRONMENT_ORIGIN_MARKER.to_string(), origin.into()); } const ZED_ENVIRONMENT_ORIGIN_MARKER: &str = "ZED_ENVIRONMENT"; enum EnvironmentOrigin { Cli, WorktreeShell, } impl From for String { fn from(val: EnvironmentOrigin) -> Self { match val { EnvironmentOrigin::Cli => "cli".into(), EnvironmentOrigin::WorktreeShell => "worktree-shell".into(), } } } #[cfg(any(test, feature = "test-support"))] async fn load_shell_environment( _dir: &Path, _load_direnv: &DirenvSettings, ) -> Result> { Ok([("ZED_FAKE_TEST_ENV".into(), "true".into())] .into_iter() .collect()) } #[cfg(not(any(test, feature = "test-support")))] async fn load_shell_environment( dir: &Path, load_direnv: &DirenvSettings, ) -> Result> { use anyhow::{anyhow, Context}; use std::path::PathBuf; use util::parse_env_output; async fn load_direnv_environment(dir: &Path) -> Result>> { let Ok(direnv_path) = which::which("direnv") else { return Ok(None); }; let direnv_output = smol::process::Command::new(direnv_path) .args(["export", "json"]) .current_dir(dir) .output() .await .context("failed to spawn direnv to get local environment variables")?; anyhow::ensure!( direnv_output.status.success(), "direnv exited with error {:?}. Stderr:\n{}", direnv_output.status, String::from_utf8_lossy(&direnv_output.stderr) ); let output = String::from_utf8_lossy(&direnv_output.stdout); if output.is_empty() { return Ok(None); } Ok(Some( serde_json::from_str(&output).context("failed to parse direnv output")?, )) } let direnv_environment = match load_direnv { DirenvSettings::ShellHook => None, DirenvSettings::Direct => load_direnv_environment(dir).await.log_err().flatten(), } .unwrap_or(HashMap::default()); let marker = "ZED_SHELL_START"; let shell = std::env::var("SHELL").context( "SHELL environment variable is not assigned so we can't source login environment variables", )?; // What we're doing here is to spawn a shell and then `cd` into // the project directory to get the env in there as if the user // `cd`'d into it. We do that because tools like direnv, asdf, ... // hook into `cd` and only set up the env after that. // // If the user selects `Direct` for direnv, it would set an environment // variable that later uses to know that it should not run the hook. // We would include in `.envs` call so it is okay to run the hook // even if direnv direct mode is enabled. // // In certain shells we need to execute additional_command in order to // trigger the behavior of direnv, etc. // // // The `exit 0` is the result of hours of debugging, trying to find out // why running this command here, without `exit 0`, would mess // up signal process for our process so that `ctrl-c` doesn't work // anymore. // // We still don't know why `$SHELL -l -i -c '/usr/bin/env -0'` would // do that, but it does, and `exit 0` helps. let additional_command = PathBuf::from(&shell) .file_name() .and_then(|f| f.to_str()) .and_then(|shell| match shell { "fish" => Some("emit fish_prompt;"), _ => None, }); let command = format!( "cd '{}';{} printf '%s' {marker}; /usr/bin/env; exit 0;", dir.display(), additional_command.unwrap_or("") ); let output = smol::process::Command::new(&shell) .args(["-l", "-i", "-c", &command]) .envs(direnv_environment) .output() .await .context("failed to spawn login shell to source login environment variables")?; anyhow::ensure!( output.status.success(), "login shell exited with error {:?}", output.status ); let stdout = String::from_utf8_lossy(&output.stdout); let env_output_start = stdout.find(marker).ok_or_else(|| { anyhow!( "failed to parse output of `env` command in login shell: {}", stdout ) })?; let mut parsed_env = HashMap::default(); let env_output = &stdout[env_output_start + marker.len()..]; parse_env_output(env_output, |key, value| { parsed_env.insert(key, value); }); Ok(parsed_env) }