chore: clean up dfx canister create output (#4080)

* change canister creation to spinners

* keep spinners and logs from interfering with each other

* Spinner for wallet creation

Author: adamspofford-dfinity

Cargo.lock

@@ -1 +1,5 @@
-too-many-arguments-threshold = 16
+too-many-arguments-threshold = 16
+
+[[disallowed-types]]
+path = "indicatif::ProgressBar"
+reason = "use env.new_spinner() for log compatibility"

clippy.toml

@@ -182,9 +182,9 @@ teardown() {
   dfx_start
   dfx canister create --all --no-wallet
   assert_command dfx deploy
-  assert_not_contains "Creating a wallet canister"
+  assert_not_contains "Created a wallet canister"
   assert_command dfx identity get-wallet
-  assert_contains "Creating a wallet canister"
+  assert_contains "Created a wallet canister"
 }
 
 @test "can deploy gzip wasm" {

e2e/tests-dfx/deploy.bash

@@ -1,29 +1,15 @@
 #[cfg(windows)]
 use crate::config::directories::project_dirs;
 use crate::error::cache::{
-    DeleteCacheError, EnsureCacheVersionsDirError, GetBinaryCommandPathError, GetCacheRootError,
-    GetVersionFromCachePathError, IsCacheInstalledError, ListCacheVersionsError,
+    DeleteCacheError, EnsureCacheVersionsDirError, GetCacheRootError, GetVersionFromCachePathError,
+    IsCacheInstalledError, ListCacheVersionsError,
 };
 #[cfg(not(windows))]
 use crate::foundation::get_user_home;
 use crate::fs::composite::ensure_dir_exists;
 use semver::Version;
 use std::path::{Path, PathBuf};
 
-pub trait Cache {
-    fn version_str(&self) -> String;
-    fn is_installed(&self) -> Result<bool, IsCacheInstalledError>;
-    fn delete(&self) -> Result<(), DeleteCacheError>;
-    fn get_binary_command_path(
-        &self,
-        binary_name: &str,
-    ) -> Result<PathBuf, GetBinaryCommandPathError>;
-    fn get_binary_command(
-        &self,
-        binary_name: &str,
-    ) -> Result<std::process::Command, GetBinaryCommandPathError>;
-}
-
 pub fn get_cache_root() -> Result<PathBuf, GetCacheRootError> {
     let cache_root = std::env::var_os("DFX_CACHE_ROOT");
     // dirs-next is not used for *nix to preserve existing paths

src/dfx-core/src/config/cache.rs

@@ -74,7 +74,7 @@ ic-utils.workspace = true
 ic-wasm = "0.8.0"
 icrc-ledger-types = "0.1.5"
 idl2json = "0.10.1"
-indicatif = "0.16.0"
+indicatif = "0.17.0"
 itertools.workspace = true
 json-patch = "1.0.0"
 keyring.workspace = true

src/dfx/Cargo.toml

@@ -44,7 +44,9 @@ pub fn start_btc_adapter_actor(
     shutdown_controller: Addr<ShutdownController>,
     btc_adapter_pid_file_path: PathBuf,
 ) -> DfxResult<Recipient<BtcAdapterReadySubscribe>> {
-    let btc_adapter_path = env.get_cache().get_binary_command_path("ic-btc-adapter")?;
+    let btc_adapter_path = env
+        .get_cache()
+        .get_binary_command_path(env, "ic-btc-adapter")?;
 
     let actor_config = btc_adapter::Config {
         btc_adapter_path,
@@ -69,7 +71,7 @@ pub fn start_canister_http_adapter_actor(
 ) -> DfxResult<Recipient<CanisterHttpAdapterReadySubscribe>> {
     let adapter_path = env
         .get_cache()
-        .get_binary_command_path("ic-https-outcalls-adapter")?;
+        .get_binary_command_path(env, "ic-https-outcalls-adapter")?;
 
     let actor_config = canister_http_adapter::Config {
         adapter_path,
@@ -133,8 +135,8 @@ pub fn start_replica_actor(
     canister_http_adapter_ready_subscribe: Option<Recipient<CanisterHttpAdapterReadySubscribe>>,
 ) -> DfxResult<Addr<Replica>> {
     // get binary path
-    let replica_path = env.get_cache().get_binary_command_path("replica")?;
-    let ic_starter_path = env.get_cache().get_binary_command_path("ic-starter")?;
+    let replica_path = env.get_cache().get_binary_command_path(env, "replica")?;
+    let ic_starter_path = env.get_cache().get_binary_command_path(env, "ic-starter")?;
 
     setup_replica_env(local_server_descriptor, &replica_config)?;
     let replica_pid_path = local_server_descriptor.replica_pid_path();
@@ -169,7 +171,7 @@ pub fn start_pocketic_proxy_actor(
     pocketic_proxy_pid_path: PathBuf,
     pocketic_proxy_port_path: PathBuf,
 ) -> DfxResult<Addr<PocketIcProxy>> {
-    let pocketic_proxy_path = env.get_cache().get_binary_command_path("pocket-ic")?;
+    let pocketic_proxy_path = env.get_cache().get_binary_command_path(env, "pocket-ic")?;
     let actor_config = pocketic_proxy::Config {
         logger: Some(env.get_logger().clone()),
         port_ready_subscribe,
@@ -190,7 +192,7 @@ pub fn start_pocketic_actor(
     shutdown_controller: Addr<ShutdownController>,
     pocketic_port_path: PathBuf,
 ) -> DfxResult<Addr<PocketIc>> {
-    let pocketic_path = env.get_cache().get_binary_command_path("pocket-ic")?;
+    let pocketic_path = env.get_cache().get_binary_command_path(env, "pocket-ic")?;
 
     // Touch the port file. This ensures it is empty prior to
     // handing it over to PocketIC. If we read the file and it has

src/dfx/src/actors/mod.rs

@@ -1,4 +1,4 @@
-use crate::config::cache::DiskBasedCache;
+use crate::config::cache::VersionCache;
 use crate::lib::agent::create_anonymous_agent_environment;
 use crate::lib::builders::BuildConfig;
 use crate::lib::environment::Environment;
@@ -44,7 +44,7 @@ pub fn exec(env: &dyn Environment, opts: CanisterBuildOpts) -> DfxResult {
 
     // Check the cache. This will only install the cache if there isn't one installed
     // already.
-    DiskBasedCache::install(&env.get_cache().version_str())?;
+    VersionCache::install(&env, &env.get_cache().version_str())?;
 
     let build_mode_check = opts.check;
 
@@ -90,7 +90,7 @@ pub fn exec(env: &dyn Environment, opts: CanisterBuildOpts) -> DfxResult {
             .with_build_mode_check(build_mode_check)
             .with_canisters_to_build(canisters_to_build)
             .with_env_file(env_file);
-    runtime.block_on(canister_pool.build_or_fail(logger, &build_config))?;
+    runtime.block_on(canister_pool.build_or_fail(&env, logger, &build_config))?;
 
     Ok(())
 }

src/dfx/src/commands/build.rs

@@ -1,4 +1,4 @@
-use crate::config::cache::DiskBasedCache;
+use crate::config::cache::VersionCache;
 use crate::lib::environment::Environment;
 use crate::lib::error::{DfxError, DfxResult};
 use clap::Parser;
@@ -9,6 +9,6 @@ use clap::Parser;
 pub struct CacheInstall {}
 
 pub fn exec(env: &dyn Environment, _opts: CacheInstall) -> DfxResult {
-    DiskBasedCache::force_install(&env.get_cache().version_str()).map_err(DfxError::from)?;
+    VersionCache::force_install(env, &env.get_cache().version_str()).map_err(DfxError::from)?;
     Ok(())
 }

src/dfx/src/commands/cache/install.rs

@@ -1,5 +1,5 @@
 use crate::commands::DfxCommand;
-use crate::config::cache::DiskBasedCache;
+use crate::config::cache::VersionCache;
 use crate::lib::environment::Environment;
 use crate::lib::error::{DfxError, DfxResult};
 use anyhow::bail;
@@ -30,7 +30,7 @@ pub struct InstallOpts {
 pub fn exec(env: &dyn Environment, opts: InstallOpts) -> DfxResult<()> {
     // creating an `extensions` directory in an otherwise empty cache directory would
     // cause the cache to be considered "installed" and later commands would fail
-    DiskBasedCache::install(&env.get_cache().version_str())?;
+    VersionCache::install(env, &env.get_cache().version_str())?;
     let spinner = env.new_spinner(format!("Installing extension: {}", opts.name).into());
     let mgr = env.get_extension_manager();
     let effective_extension_name = opts.install_as.clone().unwrap_or_else(|| opts.name.clone());

src/dfx/src/commands/extension/install.rs

@@ -1,4 +1,4 @@
-use crate::config::cache::DiskBasedCache;
+use crate::config::cache::VersionCache;
 use crate::lib::agent::create_anonymous_agent_environment;
 use crate::lib::builders::BuildConfig;
 use crate::lib::environment::Environment;
@@ -28,7 +28,7 @@ pub fn exec(env: &dyn Environment, opts: GenerateOpts) -> DfxResult {
 
     // Check the cache. This will only install the cache if there isn't one installed
     // already.
-    DiskBasedCache::install(&env.get_cache().version_str())?;
+    VersionCache::install(&env, &env.get_cache().version_str())?;
 
     // Option can be None which means generate types for all canisters
     let canisters_to_load = config
@@ -73,11 +73,11 @@ pub fn exec(env: &dyn Environment, opts: GenerateOpts) -> DfxResult {
         let canister_pool_build = CanisterPool::load(&env, true, &build_dependees)?;
         slog::info!(log, "Building canisters before generate for Motoko");
         let runtime = Runtime::new().expect("Unable to create a runtime");
-        runtime.block_on(canister_pool_build.build_or_fail(log, &build_config))?;
+        runtime.block_on(canister_pool_build.build_or_fail(&env, log, &build_config))?;
     }
 
     for canister in canister_pool_load.canisters_to_build(&generate_config) {
-        canister.generate(log, &canister_pool_load, &generate_config)?;
+        canister.generate(&env, log, &canister_pool_load, &generate_config)?;
     }
 
     Ok(())