Add progress bar to install command (#1028)

.changeset/show-download-progress.md

@@ -0,0 +1,5 @@
+---
+"fnm": minor
+---
+
+Show a progress bar when downloading and extracting node

Cargo.toml

@@ -30,11 +30,13 @@ sysinfo = "0.29.3"
 thiserror = "1.0.44"
 clap_complete = "4.3.1"
 anyhow = "1.0.71"
+indicatif = "0.17.6"
 
 [dev-dependencies]
 pretty_assertions = "1.4.0"
 duct = "0.13.6"
 test-log = "0.2.12"
+http = "0.2.9"
 
 [build-dependencies]
 embed-resource = "1.8.0"

docs/commands.md

@@ -216,6 +216,9 @@ Options:
       --latest
           Install latest version
 
+      --no-progress
+          Do not display a progress bar
+
       --log-level <LOG_LEVEL>
           The log level of fnm commands
 

src/commands/install.rs

@@ -3,6 +3,7 @@ use crate::alias::create_alias;
 use crate::arch::get_safe_arch;
 use crate::config::FnmConfig;
 use crate::downloader::{install_node_dist, Error as DownloaderError};
+use crate::log_level::LogLevel;
 use crate::lts::LtsType;
 use crate::outln;
 use crate::remote_node_index;
@@ -25,6 +26,10 @@ pub struct Install {
     /// Install latest version
     #[clap(long, conflicts_with_all = &["version", "lts"])]
     pub latest: bool,
+
+    /// Do not display a progress bar
+    #[clap(long)]
+    pub no_progress: bool,
 }
 
 impl Install {
@@ -34,16 +39,19 @@ impl Install {
                 version: v,
                 lts: false,
                 latest: false,
+                no_progress: _,
             } => Ok(v),
             Self {
                 version: None,
                 lts: true,
                 latest: false,
+                no_progress: _,
             } => Ok(Some(UserVersion::Full(Version::Lts(LtsType::Latest)))),
             Self {
                 version: None,
                 lts: false,
                 latest: true,
+                no_progress: _,
             } => Ok(Some(UserVersion::Full(Version::Latest))),
             _ => Err(Error::TooManyVersionsProvided),
         }
@@ -56,6 +64,8 @@ impl Command for Install {
     fn apply(self, config: &FnmConfig) -> Result<(), Self::Error> {
         let current_dir = std::env::current_dir().unwrap();
 
+        let show_progress = !self.no_progress && config.log_level().is_writable(&LogLevel::Info);
+
         let current_version = self
             .version()?
             .or_else(|| get_user_version_for_directory(current_dir, config))
@@ -131,6 +141,7 @@ impl Command for Install {
             &config.node_dist_mirror,
             config.installations_dir(),
             safe_arch,
+            show_progress,
         ) {
             Err(err @ DownloaderError::VersionAlreadyInstalled { .. }) => {
                 outln!(config, Error, "{} {}", "warning:".bold().yellow(), err);
@@ -225,6 +236,7 @@ mod tests {
             version: UserVersion::from_str("12.0.0").ok(),
             lts: false,
             latest: false,
+            no_progress: true,
         }
         .apply(&config)
         .expect("Can't install");
@@ -250,6 +262,7 @@ mod tests {
             version: None,
             lts: false,
             latest: true,
+            no_progress: true,
         }
         .apply(&config)
         .expect("Can't install");

src/downloader.rs

@@ -2,8 +2,11 @@ use crate::arch::Arch;
 use crate::archive;
 use crate::archive::{Error as ExtractError, Extract};
 use crate::directory_portal::DirectoryPortal;
+use crate::progress::ResponseProgress;
 use crate::version::Version;
+use indicatif::ProgressDrawTarget;
 use log::debug;
+use std::io::Read;
 use std::path::Path;
 use std::path::PathBuf;
 use thiserror::Error;
@@ -63,10 +66,7 @@ fn download_url(base_url: &Url, version: &Version, arch: &Arch) -> Url {
     .unwrap()
 }
 
-pub fn extract_archive_into<P: AsRef<Path>>(
-    path: P,
-    response: crate::http::Response,
-) -> Result<(), Error> {
+fn extract_archive_into(path: impl AsRef<Path>, response: impl Read) -> Result<(), Error> {
     #[cfg(unix)]
     let extractor = archive::TarXz::new(response);
     #[cfg(windows)]
@@ -81,6 +81,7 @@ pub fn install_node_dist<P: AsRef<Path>>(
     node_dist_mirror: &Url,
     installations_dir: P,
     arch: &Arch,
+    show_progress: bool,
 ) -> Result<(), Error> {
     let installation_dir = PathBuf::from(installations_dir.as_ref()).join(version.v_str());
 
@@ -109,7 +110,14 @@ pub fn install_node_dist<P: AsRef<Path>>(
     }
 
     debug!("Extracting response...");
-    extract_archive_into(&portal, response)?;
+    if show_progress {
+        extract_archive_into(
+            &portal,
+            ResponseProgress::new(response, ProgressDrawTarget::stderr()),
+        )?;
+    } else {
+        extract_archive_into(&portal, response)?;
+    }
     debug!("Extraction completed");
 
     let installed_directory = std::fs::read_dir(&portal)?
@@ -171,7 +179,8 @@ mod tests {
         let version = Version::parse("12.0.0").unwrap();
         let arch = Arch::X64;
         let node_dist_mirror = Url::parse("https://nodejs.org/dist/").unwrap();
-        install_node_dist(&version, &node_dist_mirror, path, &arch).expect("Can't install Node 12");
+        install_node_dist(&version, &node_dist_mirror, path, &arch, false)
+            .expect("Can't install Node 12");
 
         let mut location_path = path.join(version.v_str()).join("installation");
 

src/main.rs

@@ -22,6 +22,7 @@ mod installed_versions;
 mod lts;
 mod package_json;
 mod path_ext;
+mod progress;
 mod remote_node_index;
 mod shell;
 mod system_info;