Add progress bar to install command

.changeset/show-download-progress.md

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

Cargo.toml

@@ -30,6 +30,7 @@ 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"

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

@@ -25,6 +25,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 +38,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 +63,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;
+
         let current_version = self
             .version()?
             .or_else(|| get_user_version_for_directory(current_dir, config))
@@ -131,6 +140,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 +235,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 +261,7 @@ mod tests {
             version: None,
             lts: false,
             latest: true,
+            no_progress: true,
         }
         .apply(&config)
         .expect("Can't install");

src/downloader.rs

@@ -2,8 +2,10 @@ 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 log::debug;
+use std::io::Read;
 use std::path::Path;
 use std::path::PathBuf;
 use thiserror::Error;
@@ -63,10 +65,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<P: AsRef<Path>, R: Read>(path: P, response: R) -> Result<(), Error> {
     #[cfg(unix)]
     let extractor = archive::TarXz::new(response);
     #[cfg(windows)]
@@ -81,6 +80,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 +109,11 @@ 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))?;
+    } else {
+        extract_archive_into(&portal, response)?;
+    }
     debug!("Extraction completed");
 
     let installed_directory = std::fs::read_dir(&portal)?
@@ -171,7 +175,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;

src/progress.rs

@@ -0,0 +1,55 @@
+use std::io::Read;
+
+use indicatif::{ProgressBar, ProgressStyle};
+use reqwest::blocking::Response;
+
+pub struct ResponseProgress {
+    progress: Option<ProgressBar>,
+    response: Response,
+}
+
+fn make_progress_bar(size: u64) -> ProgressBar {
+    let bar = ProgressBar::new(size);
+
+    bar.set_style(
+        ProgressStyle::default_bar()
+            .template("[{elapsed_precise}] [{bar:40}] {bytes}/{total_bytes} ({bytes_per_sec}, {eta})")
+            .unwrap()
+            .progress_chars("#>-")
+    );
+
+    bar
+}
+
+impl ResponseProgress {
+    pub fn new(response: Response) -> Self {
+        Self {
+            progress: response.content_length().map(make_progress_bar),
+            response,
+        }
+    }
+
+    pub fn finish(&self) {
+        if let Some(ref bar) = self.progress {
+            bar.finish();
+        }
+    }
+}
+
+impl Read for ResponseProgress {
+    fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
+        let size = self.response.read(buf)?;
+
+        if let Some(ref bar) = self.progress {
+            bar.inc(size as u64);
+        }
+
+        Ok(size)
+    }
+}
+
+impl Drop for ResponseProgress {
+    fn drop(&mut self) {
+        self.finish()
+    }
+}