Merge pull request #662 from charlespierce/volta_setup_shims

Regenerate shims on 'volta setup'

Author: charlespierce

crates/volta-core/src/shim.rs

@@ -1,11 +1,59 @@
 //! Provides utilities for modifying shims for 3rd-party executables
 
-use std::{fs, io};
+use std::collections::HashSet;
+use std::fs::{self, DirEntry, Metadata};
+use std::io;
+use std::path::Path;
 
 use crate::error::ErrorDetails;
-use crate::fs::symlink_file;
+use crate::fs::{read_dir_eager, symlink_file};
 use crate::layout::{volta_home, volta_install};
-use volta_fail::{throw, FailExt, Fallible};
+use log::debug;
+use volta_fail::{throw, FailExt, Fallible, ResultExt};
+
+pub fn regenerate_shims_for_dir(dir: &Path) -> Fallible<()> {
+    debug!("Rebuilding shims for directory: {}", dir.display());
+    for shim_name in get_shim_list_deduped(dir)?.iter() {
+        delete(shim_name)?;
+        create(shim_name)?;
+    }
+
+    Ok(())
+}
+
+fn get_shim_list_deduped(dir: &Path) -> Fallible<HashSet<String>> {
+    let contents = read_dir_eager(dir).with_context(|_| ErrorDetails::ReadDirError {
+        dir: dir.to_owned(),
+    })?;
+
+    #[cfg(unix)]
+    {
+        let mut shims: HashSet<String> = contents.filter_map(entry_to_shim_name).collect();
+        shims.insert("node".into());
+        shims.insert("npm".into());
+        shims.insert("npx".into());
+        shims.insert("yarn".into());
+        Ok(shims)
+    }
+
+    #[cfg(windows)]
+    {
+        // On Windows, the default shims are installed in Program Files, so we don't need to generate them here
+        Ok(contents.filter_map(entry_to_shim_name).collect())
+    }
+}
+
+fn entry_to_shim_name((entry, metadata): (DirEntry, Metadata)) -> Option<String> {
+    if metadata.file_type().is_symlink() {
+        entry
+            .path()
+            .file_stem()
+            .and_then(|stem| stem.to_str())
+            .map(|stem| stem.to_string())
+    } else {
+        None
+    }
+}
 
 #[derive(PartialEq)]
 pub enum ShimResult {

crates/volta-migrate/src/lib.rs

@@ -8,10 +8,7 @@
 //! need to be aware that they may be partially applied (if something fails in the process) and should be
 //! able to re-start gracefully from an interrupted migration
 
-use std::collections::HashSet;
 use std::convert::TryInto;
-use std::fs::{DirEntry, Metadata};
-use std::path::Path;
 
 mod empty;
 mod v0;
@@ -20,14 +17,10 @@ mod v1;
 use v0::V0;
 use v1::V1;
 
-use log::debug;
-use volta_core::error::ErrorDetails;
-use volta_core::fs::read_dir_eager;
 use volta_core::layout::volta_home;
 #[cfg(unix)]
 use volta_core::layout::volta_install;
-use volta_core::shim;
-use volta_fail::{Fallible, ResultExt};
+use volta_fail::Fallible;
 use volta_layout::v1::VoltaHome;
 
 /// Represents the state of the Volta directory at every point in the migration process
@@ -115,56 +108,11 @@ pub fn run_migration() -> Fallible<()> {
         state = match state {
             MigrationState::Empty(e) => MigrationState::V1(Box::new(e.try_into()?)),
             MigrationState::V0(zero) => MigrationState::V1(Box::new((*zero).try_into()?)),
-            MigrationState::V1(one) => {
-                regenerate_shims_for_dir(one.home.shim_dir())?;
+            MigrationState::V1(_) => {
                 break;
             }
         };
     }
 
     Ok(())
 }
-
-fn regenerate_shims_for_dir(dir: &Path) -> Fallible<()> {
-    debug!("Rebuilding shims");
-    for shim_name in get_shim_list_deduped(dir)?.iter() {
-        shim::delete(shim_name)?;
-        shim::create(shim_name)?;
-    }
-
-    Ok(())
-}
-
-fn get_shim_list_deduped(dir: &Path) -> Fallible<HashSet<String>> {
-    let contents = read_dir_eager(dir).with_context(|_| ErrorDetails::ReadDirError {
-        dir: dir.to_owned(),
-    })?;
-
-    #[cfg(unix)]
-    {
-        let mut shims: HashSet<String> = contents.filter_map(entry_to_shim_name).collect();
-        shims.insert("node".into());
-        shims.insert("npm".into());
-        shims.insert("npx".into());
-        shims.insert("yarn".into());
-        Ok(shims)
-    }
-
-    #[cfg(windows)]
-    {
-        // On Windows, the default shims are installed in Program Files, so we don't need to generate them here
-        Ok(contents.filter_map(entry_to_shim_name).collect())
-    }
-}
-
-fn entry_to_shim_name((entry, metadata): (DirEntry, Metadata)) -> Option<String> {
-    if metadata.file_type().is_symlink() {
-        entry
-            .path()
-            .file_stem()
-            .and_then(|stem| stem.to_str())
-            .map(|stem| stem.to_string())
-    } else {
-        None
-    }
-}

src/command/setup.rs

@@ -1,6 +1,8 @@
 use log::info;
 use structopt::StructOpt;
+use volta_core::layout::volta_home;
 use volta_core::session::{ActivityKind, Session};
+use volta_core::shim::regenerate_shims_for_dir;
 use volta_core::style::success_prefix;
 use volta_fail::{ExitCode, Fallible};
 
@@ -14,6 +16,7 @@ impl Command for Setup {
         session.add_event_start(ActivityKind::Setup);
 
         os::setup_environment()?;
+        regenerate_shims_for_dir(volta_home()?.shim_dir())?;
 
         info!(
             "{} Setup complete. Open a new terminal to start using Volta!",

src/common.rs

@@ -2,6 +2,7 @@ use std::process::{Command, ExitStatus};
 
 use volta_core::error::ErrorDetails;
 use volta_core::layout::{volta_home, volta_install};
+use volta_core::shim::regenerate_shims_for_dir;
 use volta_fail::{ResultExt, VoltaError};
 
 pub enum Error {
@@ -19,6 +20,7 @@ pub fn ensure_layout() -> Result<(), Error> {
             .status()
             .with_context(|_| ErrorDetails::CouldNotStartMigration)
             .into_result()?;
+        regenerate_shims_for_dir(home.shim_dir()).map_err(Error::Volta)?;
     }
 
     Ok(())

tests/acceptance/migrations.rs

@@ -74,8 +74,7 @@ fn legacy_v0_volta_home_is_upgraded() {
     assert!(Sandbox::path_exists(".volta/layout.v1"));
 
     // shims should all be created
-    // NOTE: this doesn't work in Windows, because the shim directory
-    //       is stored in the Registry, and not accessible
+    // NOTE: this doesn't work in Windows, because the default shims are stored separately
     #[cfg(unix)]
     {
         assert!(Sandbox::shim_exists("node"));