feat: warn on empty cache (#9236)

### Description

Warns if cache payload consists of just the log file and output globs
are specified.

### Testing Instructions

Turns out all of our test fixtures have empty outputs so we get a lot of
these warnings in tests

crates/turborepo-lib/src/run/cache.rs

@@ -4,8 +4,9 @@ use std::{
     time::Duration,
 };
 
+use itertools::Itertools;
 use tokio::sync::oneshot;
-use tracing::{debug, error};
+use tracing::{debug, error, log::warn};
 use turbopath::{
     AbsoluteSystemPath, AbsoluteSystemPathBuf, AnchoredSystemPath, AnchoredSystemPathBuf,
 };
@@ -47,6 +48,7 @@ pub enum Error {
 pub struct RunCache {
     task_output_logs: Option<OutputLogsMode>,
     cache: AsyncCache,
+    warnings: Arc<Mutex<Vec<String>>>,
     reads_disabled: bool,
     writes_disabled: bool,
     repo_root: AbsoluteSystemPathBuf,
@@ -80,6 +82,7 @@ impl RunCache {
         RunCache {
             task_output_logs,
             cache,
+            warnings: Default::default(),
             reads_disabled: opts.skip_reads,
             writes_disabled: opts.skip_writes,
             repo_root: repo_root.to_owned(),
@@ -122,12 +125,18 @@ impl RunCache {
             log_file_path,
             daemon_client: self.daemon_client.clone(),
             ui: self.ui,
+            warnings: self.warnings.clone(),
         }
     }
 
     pub async fn shutdown_cache(
         &self,
     ) -> Result<(Arc<Mutex<UploadMap>>, oneshot::Receiver<()>), CacheError> {
+        if let Ok(warnings) = self.warnings.lock() {
+            for warning in warnings.iter().sorted() {
+                warn!("{}", warning);
+            }
+        }
         // Ignore errors coming from cache already shutting down
         self.cache.start_shutdown().await
     }
@@ -144,6 +153,7 @@ pub struct TaskCache {
     daemon_client: Option<DaemonClient<DaemonConnector>>,
     ui: ColorConfig,
     task_id: TaskId<'static>,
+    warnings: Arc<Mutex<Vec<String>>>,
 }
 
 impl TaskCache {
@@ -360,6 +370,18 @@ impl TaskCache {
             globwalk::WalkType::All,
         )?;
 
+        // If we're only caching the log output, *and* output globs are not empty,
+        // we should warn the user
+        if files_to_be_cached.len() == 1 && !self.repo_relative_globs.is_empty() {
+            let _ = self.warnings.lock().map(|mut warnings| {
+                warnings.push(format!(
+                    "no output files found for task {}. Please check your `outputs` key in \
+                     `turbo.json`",
+                    self.task_id
+                ))
+            });
+        }
+
         let mut relative_paths = files_to_be_cached
             .into_iter()
             .map(|path| {

crates/turborepo-lib/src/task_graph/mod.rs

@@ -23,6 +23,9 @@ pub struct TaskOutputs {
 }
 
 impl TaskOutputs {
+    pub fn is_empty(&self) -> bool {
+        self.inclusions.is_empty() && self.exclusions.is_empty()
+    }
     pub fn validated_inclusions(&self) -> Result<Vec<ValidatedGlob>, GlobError> {
         self.inclusions
             .iter()

turborepo-tests/integration/tests/affected.t

@@ -30,6 +30,7 @@ Validate that we only run `my-app#build` with change not committed
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task my-app#build. Please check your `outputs` key in `turbo.json`
 
 
 Do the same thing with the `ls` command
@@ -80,6 +81,7 @@ Validate that we only run `my-app#build` with change not committed
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task my-app#build. Please check your `outputs` key in `turbo.json`
 
 Do the same thing with the `ls` command
   $ ${TURBO} ls --affected

turborepo-tests/integration/tests/filter-run.t

@@ -40,6 +40,8 @@ Setup
   Cached:    0 cached, 2 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task my-app#build. Please check your `outputs` key in `turbo.json`
+   WARNING  no output files found for task util#build. Please check your `outputs` key in `turbo.json`
 
 Non existent package name should error
   $ ${TURBO} run build --filter="foo" --output-logs none

turborepo-tests/integration/tests/global-deps.t

@@ -12,6 +12,7 @@ Run a build
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task my-app#build. Please check your `outputs` key in `turbo.json`
 
   $ echo "new text" > global_deps/foo.txt
   $ ${TURBO} build -F my-app --output-logs=hash-only
@@ -24,6 +25,7 @@ Run a build
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task my-app#build. Please check your `outputs` key in `turbo.json`
   $ echo "Submit a PR!" >> global_deps/CONTRIBUTING.md
   $ ${TURBO} build -F my-app --output-logs=hash-only
   \xe2\x80\xa2 Packages in scope: my-app (esc)

turborepo-tests/integration/tests/global-env.t

@@ -14,6 +14,7 @@ Setup
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task util#build. Please check your `outputs` key in `turbo.json`
 # run again and ensure there's a cache hit
   $ ${TURBO} run build --filter=util --output-logs=hash-only
   \xe2\x80\xa2 Packages in scope: util (esc)
@@ -36,6 +37,7 @@ Setup
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task util#build. Please check your `outputs` key in `turbo.json`
 # set env var with "THASH" and ensure cache miss
   $ SOMETHING_THASH_YES=hi ${TURBO} run build --filter=util --output-logs=hash-only
   \xe2\x80\xa2 Packages in scope: util (esc)
@@ -58,6 +60,7 @@ Setup
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task util#build. Please check your `outputs` key in `turbo.json`
 # THASH deprecation doesn't break --dry=json
   $ SOMETHING_THASH_YES=hi ${TURBO} run build --filter=util --dry=json | jq -r '.tasks[0].environmentVariables.global[0]'
   null

turborepo-tests/integration/tests/lockfile-aware-caching/berry.t

@@ -14,6 +14,7 @@ Populate cache
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task a#build. Please check your `outputs` key in `turbo.json`
   $ ${TURBO} build --filter=b
   \xe2\x80\xa2 Packages in scope: b (esc)
   \xe2\x80\xa2 Running build in 1 packages (esc)
@@ -25,6 +26,7 @@ Populate cache
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task b#build. Please check your `outputs` key in `turbo.json`
 
 Bump dependency for b and rebuild
 Only b should have a cache miss
@@ -53,6 +55,7 @@ Only b should have a cache miss
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task b#build. Please check your `outputs` key in `turbo.json`
 Add lockfile changes to a commit
   $ git add . && git commit -m "bump lockfile" --quiet
 Only root and b should be rebuilt since only the deps for b had a version bump
@@ -76,6 +79,7 @@ Bump of root workspace invalidates all packages
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task a#build. Please check your `outputs` key in `turbo.json`
   $ ${TURBO} build  --filter=b
   \xe2\x80\xa2 Packages in scope: b (esc)
   \xe2\x80\xa2 Running build in 1 packages (esc)
@@ -87,6 +91,7 @@ Bump of root workspace invalidates all packages
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task b#build. Please check your `outputs` key in `turbo.json`
 Add lockfile changes to a commit
   $ git add . && git commit -m "global lockfile change" --quiet
 Everything should be rebuilt as a dependency of the root package got bumped

turborepo-tests/integration/tests/lockfile-aware-caching/npm.t

@@ -18,6 +18,7 @@ Populate cache
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task a#build. Please check your `outputs` key in `turbo.json`
   $ ${TURBO} build --filter=b
   \xe2\x80\xa2 Packages in scope: b (esc)
   \xe2\x80\xa2 Running build in 1 packages (esc)
@@ -33,6 +34,7 @@ Populate cache
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task b#build. Please check your `outputs` key in `turbo.json`
 
 Bump dependency for b and rebuild
 Only b should have a cache miss
@@ -69,6 +71,7 @@ Only b should have a cache miss
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task b#build. Please check your `outputs` key in `turbo.json`
 Add lockfile changes to a commit
   $ git add . && git commit -m "bump lockfile" --quiet
 Only root and b should be rebuilt since only the deps for b had a version bump
@@ -96,6 +99,7 @@ Bump of root workspace invalidates all packages
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task a#build. Please check your `outputs` key in `turbo.json`
   $ ${TURBO} build  --filter=b
   \xe2\x80\xa2 Packages in scope: b (esc)
   \xe2\x80\xa2 Running build in 1 packages (esc)
@@ -111,6 +115,7 @@ Bump of root workspace invalidates all packages
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task b#build. Please check your `outputs` key in `turbo.json`
 Add lockfile changes to a commit
   $ git add . && git commit -m "global lockfile change" --quiet
 Everything should be rebuilt as a dependency of the root package got bumped

turborepo-tests/integration/tests/lockfile-aware-caching/pnpm.t

@@ -18,6 +18,7 @@ Populate cache
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task a#build. Please check your `outputs` key in `turbo.json`
   $ ${TURBO} build --filter=b
   \xe2\x80\xa2 Packages in scope: b (esc)
   \xe2\x80\xa2 Running build in 1 packages (esc)
@@ -33,6 +34,7 @@ Populate cache
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task b#build. Please check your `outputs` key in `turbo.json`
 
 Bump dependency for b and rebuild
 Only b should have a cache miss
@@ -69,6 +71,7 @@ Only b should have a cache miss
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task b#build. Please check your `outputs` key in `turbo.json`
 Add lockfile changes to a commit
   $ git add . && git commit -m "bump pnpm-lock" --quiet
 Only root and b should be rebuilt since only the deps for b had a version bump
@@ -96,6 +99,7 @@ Bump of root workspace invalidates all packages
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task a#build. Please check your `outputs` key in `turbo.json`
   $ ${TURBO} build  --filter=b
   \xe2\x80\xa2 Packages in scope: b (esc)
   \xe2\x80\xa2 Running build in 1 packages (esc)
@@ -111,6 +115,7 @@ Bump of root workspace invalidates all packages
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task b#build. Please check your `outputs` key in `turbo.json`
 Add lockfile changes to a commit
   $ git add . && git commit -m "global lockfile change" --quiet
 Everything should be rebuilt as a dependency of the root package got bumped

turborepo-tests/integration/tests/lockfile-aware-caching/yarn.t

@@ -18,6 +18,7 @@ Populate cache
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task a#build. Please check your `outputs` key in `turbo.json`
   $ ${TURBO} build --filter=b
   \xe2\x80\xa2 Packages in scope: b (esc)
   \xe2\x80\xa2 Running build in 1 packages (esc)
@@ -33,6 +34,7 @@ Populate cache
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task b#build. Please check your `outputs` key in `turbo.json`
 
 Bump dependency for b and rebuild
 Only b should have a cache miss
@@ -69,6 +71,7 @@ Only b should have a cache miss
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task b#build. Please check your `outputs` key in `turbo.json`
 Add lockfile changes to a commit
   $ git add . && git commit -m "bump lockfile" --quiet
 Only root and b should be rebuilt since only the deps for b had a version bump
@@ -96,6 +99,7 @@ Bump of root workspace invalidates all packages
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task a#build. Please check your `outputs` key in `turbo.json`
   $ ${TURBO} build  --filter=b
   \xe2\x80\xa2 Packages in scope: b (esc)
   \xe2\x80\xa2 Running build in 1 packages (esc)
@@ -111,6 +115,7 @@ Bump of root workspace invalidates all packages
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task b#build. Please check your `outputs` key in `turbo.json`
 Add lockfile changes to a commit
   $ git add . && git commit -m "global lockfile change" --quiet
 Everything should be rebuilt as a dependency of the root package got bumped

turborepo-tests/integration/tests/persistent-dependencies/6-topological-unimplemented.t

@@ -28,3 +28,4 @@
   Cached:    0 cached, 1 total
     Time:\s+[.0-9]+m?s  (re)
 
+   WARNING  no output files found for task app-a#dev. Please check your `outputs` key in `turbo.json`

turborepo-tests/integration/tests/pkg-inference.t

@@ -17,3 +17,4 @@ Setup
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task util#build. Please check your `outputs` key in `turbo.json`

turborepo-tests/integration/tests/prune/composable-config.t

@@ -22,5 +22,6 @@ Make sure that the internal util package is part of the prune output
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task docs#new-task. Please check your `outputs` key in `turbo.json`
 
 

turborepo-tests/integration/tests/run-caching/cache-state.t

@@ -11,6 +11,9 @@ Run a build to get a local cache.
   Cached:    0 cached, 2 total
     Time:\s+[.0-9]+m?s  (re)
 
+   WARNING  no output files found for task my-app#build. Please check your `outputs` key in `turbo.json`
+   WARNING  no output files found for task util#build. Please check your `outputs` key in `turbo.json`
+
 
 Do a dry run so we can see the state of the cache
   $ ${TURBO} run build --dry=json > dry.json

turborepo-tests/integration/tests/run-caching/excluded-inputs/excluded-inputs.t

@@ -20,6 +20,7 @@ Running build for my-app succeeds
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task my-app#build. Please check your `outputs` key in `turbo.json`
 Update exluded file and try again
   $ echo "new excluded value" > apps/my-app/excluded.txt
   $ ${TURBO} run build --filter=my-app

turborepo-tests/integration/tests/run-caching/global-deps.t

@@ -11,6 +11,7 @@ Run a build to get a local cache.
   Cached:    0 cached, 1 total
     Time:\s+[.0-9]+m?s  (re)
 
+   WARNING  no output files found for task my-app#build. Please check your `outputs` key in `turbo.json`
 
 Run again to get cache hit
   $ SOME_ENV_VAR=hi ${TURBO} run build --output-logs=none --filter=my-app
@@ -33,3 +34,4 @@ Run again without env var to get cache miss
   Cached:    0 cached, 1 total
     Time:\s+[.0-9]+m?s  (re)
 
+   WARNING  no output files found for task my-app#build. Please check your `outputs` key in `turbo.json`

turborepo-tests/integration/tests/run-caching/root-deps.t

@@ -16,6 +16,7 @@ Warm the cache
   Cached:    0 cached, 1 total
     Time:\s+[.0-9]+m?s  (re)
 
+   WARNING  no output files found for task another#build. Please check your `outputs` key in `turbo.json`
 
 Confirm cache hit
   $ ${TURBO} build --filter=another --output-logs=hash-only
@@ -43,6 +44,7 @@ All tasks should be a cache miss, even ones that don't depend on changed package
   Cached:    0 cached, 1 total
     Time:\s+[.0-9]+m?s  (re)
 
+   WARNING  no output files found for task another#build. Please check your `outputs` key in `turbo.json`
 
 Verify that all packages are in scope on a internal root dep change
   $ ${TURBO} build --filter='[HEAD]' --dry=json | jq '.packages'

turborepo-tests/integration/tests/run-logging/errors-only.t

@@ -13,6 +13,7 @@ Setup
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task app-a#build. Please check your `outputs` key in `turbo.json`
 
 
 
@@ -28,6 +29,7 @@ Setup
   Cached:    0 cached, 1 total
     Time:\s*[\.0-9]+m?s  (re)
 
+   WARNING  no output files found for task app-a#buildsuccess. Please check your `outputs` key in `turbo.json`
 
 
 # [x] error exit