Merge pull request #1771 from cachix/fix-1769

devenv: don't create local project directories on `devenv init`

Author: domenkozar

devenv/src/cnix.rs

@@ -16,7 +16,8 @@ use tracing::{debug, error, info, warn};
 
 pub struct Nix {
     pub options: Options,
-    pool: SqlitePool,
+    pool: Option<SqlitePool>,
+    database_url: String,
     // TODO: all these shouldn't be here
     config: config::Config,
     global_options: cli::GlobalOptions,
@@ -91,13 +92,11 @@ impl Nix {
             "sqlite:{}/nix-eval-cache.db",
             devenv_dotfile.to_string_lossy()
         );
-        let pool = devenv_eval_cache::db::setup_db(database_url)
-            .await
-            .into_diagnostic()?;
 
         Ok(Self {
             options,
-            pool,
+            pool: None,
+            database_url,
             config,
             global_options,
             cachix_caches,
@@ -109,6 +108,19 @@ impl Nix {
         })
     }
 
+    // Defer creating local project state
+    pub async fn assemble(&mut self) -> Result<()> {
+        if self.pool.is_none() {
+            self.pool = Some(
+                devenv_eval_cache::db::setup_db(&self.database_url)
+                    .await
+                    .into_diagnostic()?,
+            );
+        }
+
+        Ok(())
+    }
+
     pub async fn develop(
         &self,
         args: &[&str],
@@ -365,8 +377,10 @@ impl Nix {
         let result = if self.global_options.eval_cache
             && options.cache_output
             && supports_eval_caching(&cmd)
+            && self.pool.is_some()
         {
-            let mut cached_cmd = CachedCommand::new(&self.pool);
+            let pool = self.pool.as_ref().unwrap();
+            let mut cached_cmd = CachedCommand::new(pool);
 
             cached_cmd.watch_path(self.devenv_root.join("devenv.yaml"));
             cached_cmd.watch_path(self.devenv_root.join("devenv.lock"));

devenv/src/devenv.rs

@@ -107,7 +107,6 @@ impl Devenv {
             .expect("Failed to create DEVENV_HOME directory");
         std::fs::create_dir_all(&devenv_home_gc)
             .expect("Failed to create DEVENV_HOME_GC directory");
-        std::fs::create_dir_all(&devenv_dot_gc).expect("Failed to create .devenv/gc directory");
 
         let nix = cnix::Nix::new(
             options.config.clone(),
@@ -119,7 +118,7 @@ impl Devenv {
             devenv_root.clone(),
         )
         .await
-        .unwrap(); // TODO: handle error
+        .expect("Failed to initialize Nix");
 
         Self {
             config: options.config,
@@ -175,16 +174,14 @@ impl Devenv {
                         file.write_all(path.contents())
                     })
                     .expect("Failed to append to existing file");
-            } else {
-                if target_path.exists() && !EXISTING_REQUIRED_FILES.contains(&filename) {
-                    if let Some(utf8_contents) = path.contents_utf8() {
-                        confirm_overwrite(&target_path, utf8_contents.to_string())?;
-                    } else {
-                        bail!("Failed to read file contents as UTF-8");
-                    }
+            } else if target_path.exists() && !EXISTING_REQUIRED_FILES.contains(&filename) {
+                if let Some(utf8_contents) = path.contents_utf8() {
+                    confirm_overwrite(&target_path, utf8_contents.to_string())?;
                 } else {
-                    std::fs::write(&target_path, path.contents()).expect("Failed to write file");
+                    bail!("Failed to read file contents as UTF-8");
                 }
+            } else {
+                std::fs::write(&target_path, path.contents()).expect("Failed to write file");
             }
         }
 
@@ -238,7 +235,7 @@ impl Devenv {
         cmd: &Option<String>,
         args: &[String],
     ) -> Result<Vec<String>> {
-        self.assemble(false)?;
+        self.assemble(false).await?;
         let env = self.get_dev_environment(false).await?;
 
         let mut develop_args = vec![
@@ -286,7 +283,7 @@ impl Devenv {
     }
 
     pub async fn update(&mut self, input_name: &Option<String>) -> Result<()> {
-        self.assemble(false)?;
+        self.assemble(false).await?;
 
         let msg = match input_name {
             Some(input_name) => format!("Updating devenv.lock with input {input_name}"),
@@ -310,7 +307,7 @@ impl Devenv {
         );
 
         async move {
-            self.assemble(false)?;
+            self.assemble(false).await?;
 
             let container_store_path = self
                 .nix
@@ -410,8 +407,8 @@ impl Devenv {
         .await
     }
 
-    pub fn repl(&mut self) -> Result<()> {
-        self.assemble(false)?;
+    pub async fn repl(&mut self) -> Result<()> {
+        self.assemble(false).await?;
         self.nix.repl()
     }
 
@@ -460,7 +457,7 @@ impl Devenv {
     }
 
     pub async fn search(&mut self, name: &str) -> Result<()> {
-        self.assemble(false)?;
+        self.assemble(false).await?;
 
         let build_options = cnix::Options {
             logging: false,
@@ -531,7 +528,7 @@ impl Devenv {
     }
 
     pub async fn tasks_run(&mut self, roots: Vec<String>) -> Result<()> {
-        self.assemble(false)?;
+        self.assemble(false).await?;
         if roots.is_empty() {
             bail!("No tasks specified.");
         }
@@ -569,7 +566,7 @@ impl Devenv {
     }
 
     pub async fn test(&mut self) -> Result<()> {
-        self.assemble(true)?;
+        self.assemble(true).await?;
 
         // collect tests
         let test_script = {
@@ -617,14 +614,14 @@ impl Devenv {
     }
 
     pub async fn info(&mut self) -> Result<()> {
-        self.assemble(false)?;
+        self.assemble(false).await?;
         let output = self.nix.metadata().await?;
         println!("{}", output);
         Ok(())
     }
 
     pub async fn build(&mut self, attributes: &[String]) -> Result<()> {
-        self.assemble(false)?;
+        self.assemble(false).await?;
         let attributes: Vec<String> = if attributes.is_empty() {
             // construct dotted names of all attributes that we need to build
             let build_output = self.nix.eval(&["build"]).await?;
@@ -671,7 +668,7 @@ impl Devenv {
         detach: &bool,
         log_to_file: &bool,
     ) -> Result<()> {
-        self.assemble(false)?;
+        self.assemble(false).await?;
         if !self.has_processes().await? {
             error!("No 'processes' option defined: https://devenv.sh/processes/");
             bail!("No processes defined");
@@ -791,7 +788,7 @@ impl Devenv {
         Ok(())
     }
 
-    pub fn assemble(&mut self, is_testing: bool) -> Result<()> {
+    pub async fn assemble(&mut self, is_testing: bool) -> Result<()> {
         if self.assembled {
             return Ok(());
         }
@@ -803,9 +800,13 @@ impl Devenv {
                 $ devenv init
             "});
         }
+
         fs::create_dir_all(&self.devenv_dot_gc)
             .unwrap_or_else(|_| panic!("Failed to create {}", self.devenv_dot_gc.display()));
 
+        // Initialise any Nix state
+        self.nix.assemble().await?;
+
         let mut flake_inputs = HashMap::new();
         for (input, attrs) in self.config.inputs.iter() {
             match config::FlakeInput::try_from(attrs) {
@@ -878,7 +879,7 @@ impl Devenv {
     }
 
     pub async fn get_dev_environment(&mut self, json: bool) -> Result<DevEnv> {
-        self.assemble(false)?;
+        self.assemble(false).await?;
 
         let gc_root = self.devenv_dot_gc.join("shell");
         let span = tracing::info_span!("building_shell", devenv.user_message = "Building shell",);

devenv/src/main.rs

@@ -152,7 +152,7 @@ async fn main() -> Result<()> {
         Commands::Search { name } => devenv.search(&name).await,
         Commands::Gc {} => devenv.gc(),
         Commands::Info {} => devenv.info().await,
-        Commands::Repl {} => devenv.repl(),
+        Commands::Repl {} => devenv.repl().await,
         Commands::Build { attributes } => devenv.build(&attributes).await,
         Commands::Update { name } => devenv.update(&name).await,
         Commands::Up { process, detach } => devenv.up(process.as_deref(), &detach, &detach).await,
@@ -170,7 +170,7 @@ async fn main() -> Result<()> {
         },
 
         // hidden
-        Commands::Assemble => devenv.assemble(false),
+        Commands::Assemble => devenv.assemble(false).await,
         Commands::PrintDevEnv { json } => devenv.print_dev_env(json).await,
         Commands::GenerateJSONSchema => {
             config::write_json_schema();