feat: warn when no local turbo found (#8356)

### Description Warn a user if they do not have a local turbo install as it might be an incorrect version for their project. ### Testing Instructions ``` [0 olszewski@Chriss-MacBook-Pro] /tmp/foo $ turbo_dev --version 2.0.2-canary.1 [0 olszewski@Chriss-MacBook-Pro] /tmp/foo $ pnpm rm turbo Packages: -2 -- Progress: resolved 1, reused 1, downloaded 0, added 0, done dependencies: - turbo 2.0.2-canary.1 Done in 366ms [0 olszewski@Chriss-MacBook-Pro] /tmp/foo $ turbo_dev --version No local turbo found. Using global turbo version 2.0.2-canary.1 2.0.2-canary.1 ``` Integration tests show that the disabled env flag works. (Otherwise they would all have this warning) --------- Co-authored-by: Anthony Shew <[email protected]>
vercel · Jun 6, 2024 · 4471f2d · 4471f2d
1 parent 29aeaf0
commit 4471f2d
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 1 deletion.
diff --git a/crates/turborepo-lib/src/shim.rs b/crates/turborepo-lib/src/shim.rs
@@ -28,6 +28,8 @@ use turborepo_ui::UI;
 
 use crate::{cli, get_version, spawn_child, tracing::TurboSubscriber};
 
+const TURBO_GLOBAL_WARNING_DISABLED: &str = "TURBO_GLOBAL_WARNING_DISABLED";
+
 #[derive(Debug, Error, Diagnostic)]
 #[error("cannot have multiple `--cwd` flags in command")]
 #[diagnostic(code(turbo::shim::multiple_cwd))]
@@ -595,14 +597,20 @@ fn run_correct_turbo(
  spawn_local_turbo(&repo_state, turbo_state, shim_args)
  }
  } else {
- try_check_for_updates(&shim_args, get_version());
+ let version = get_version();
+ try_check_for_updates(&shim_args, version);
  // cli::run checks for this env var, rather than an arg, so that we can support
  // calling old versions without passing unknown flags.
  env::set_var(
  cli::INVOCATION_DIR_ENV_VAR,
  shim_args.invocation_dir.as_path(),
  );
  debug!("Running command as global turbo");
+ let should_warn_on_global = env::var(TURBO_GLOBAL_WARNING_DISABLED)
+ .map_or(true, |disable| !matches!(disable.as_str(), "1" | "true"));
+ if should_warn_on_global {
+ eprintln!("No locally installed `turbo` found. Using version: {version}.");
+ }
  Ok(cli::run(Some(repo_state), subscriber, ui)?)
  }
 }

diff --git a/turborepo-tests/helpers/setup.sh b/turborepo-tests/helpers/setup.sh
@@ -11,4 +11,5 @@ fi
 
 # disable the first-run telemetry message
 export TURBO_TELEMETRY_MESSAGE_DISABLED=1
+export TURBO_GLOBAL_WARNING_DISABLED=1
 TURBO=${MONOREPO_ROOT_DIR}/target/debug/turbo${EXT}
diff --git a/turborepo-tests/helpers/setup_integration_test.sh b/turborepo-tests/helpers/setup_integration_test.sh
@@ -36,6 +36,7 @@ else
 fi
 
 export TURBO_TELEMETRY_MESSAGE_DISABLED=1
+export TURBO_GLOBAL_WARNING_DISABLED=1
 export TURBO=${MONOREPO_ROOT_DIR}/target/debug/turbo${EXT}
 
 # Undo the set -eo pipefail at the top of this script

diff --git a/turborepo-tests/integration/tests/lockfile-aware-caching/setup.sh b/turborepo-tests/integration/tests/lockfile-aware-caching/setup.sh
@@ -1,5 +1,6 @@
 #!/bin/bash
 
+export TURBO_GLOBAL_WARNING_DISABLED=1
 SCRIPT_DIR=$(dirname ${BASH_SOURCE[0]})
 TARGET_DIR=$1
 FIXTURE_DIR=$2

diff --git a/turborepo-tests/integration/tests/prune/resolutions.t b/turborepo-tests/integration/tests/prune/resolutions.t
@@ -1,6 +1,7 @@
 Setup
  $ . ${TESTDIR}/../../../helpers/setup.sh
  $ . ${TESTDIR}/../../../helpers/copy_fixture.sh $(pwd) berry_resolutions ${TESTDIR}/../../fixtures
+ $ export TURBO_GLOBAL_WARNING_DISABLED=1
 
 Prune a
 We expect to no longer have the non-resolved is-odd descriptor and

diff --git a/turborepo-tests/integration/tests/prune/yarn-pnp.t b/turborepo-tests/integration/tests/prune/yarn-pnp.t
@@ -1,6 +1,7 @@
 Setup
  $ . ${TESTDIR}/../../../helpers/setup.sh
  $ . ${TESTDIR}/../../../helpers/copy_fixture.sh $(pwd) berry_resolutions ${TESTDIR}/../../fixtures
+ $ export TURBO_GLOBAL_WARNING_DISABLED=1
 Remove linker override
  $ rm .yarnrc.yml
 Prune the project