feat(core): provide default value for max cache size (#30351)

<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
The max cache size is disabled by default

## Expected Behavior
Max cache size is set to 10% of the current disk by default, and can be
disabled by specifying 0. Information about this shows up in `nx
report`.

<img width="331" alt="image"
src="https://github.com/user-attachments/assets/ee937101-9915-49d1-b3f1-c2f0d929c140"
/>


## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #

Author: AgentEnder

Cargo.lock

@@ -43,6 +43,7 @@ swc_common = "0.31.16"
 swc_ecma_parser = { version = "0.137.1", features = ["typescript"] }
 swc_ecma_visit = "0.93.0"
 swc_ecma_ast = "0.107.0"
+sysinfo = "0.33.1"
 rand = "0.9.0"
 [target.'cfg(windows)'.dependencies]
 winapi = { version = "0.3", features = ["fileapi"] }

packages/nx/Cargo.toml

@@ -29,6 +29,14 @@ import {
   createNxKeyLicenseeInformation,
 } from '../../utils/nx-key';
 import { type NxKey } from '@nx/key';
+import {
+  DbCache,
+  dbCacheEnabled,
+  formatCacheSize,
+  parseMaxCacheSize,
+} from '../../tasks-runner/cache';
+import { getDefaultMaxCacheSize } from '../../native';
+import { cacheDir } from '../../utils/cache-directory';
 
 const nxPackageJson = readJsonFile<typeof import('../../../package.json')>(
   join(__dirname, '../../../package.json')
@@ -75,6 +83,7 @@ export async function reportHandler() {
     outOfSyncPackageGroup,
     projectGraphError,
     nativeTarget,
+    cache,
   } = await getReportData();
 
   const fields = [
@@ -191,6 +200,15 @@ export async function reportHandler() {
     }
   }
 
+  if (cache) {
+    bodyLines.push(LINE_SEPARATOR);
+    bodyLines.push(
+      `Cache Usage: ${formatCacheSize(cache.used)} / ${
+        cache.max === 0 ? '∞' : formatCacheSize(cache.max)
+      }`
+    );
+  }
+
   if (outOfSyncPackageGroup) {
     bodyLines.push(LINE_SEPARATOR);
     bodyLines.push(
@@ -241,6 +259,10 @@ export interface ReportData {
   };
   projectGraphError?: Error | null;
   nativeTarget: string | null;
+  cache: {
+    max: number;
+    used: number;
+  } | null;
 }
 
 export async function getReportData(): Promise<ReportData> {
@@ -281,6 +303,16 @@ export async function getReportData(): Promise<ReportData> {
     }
   }
 
+  let cache = dbCacheEnabled(nxJson)
+    ? {
+        max:
+          nxJson.maxCacheSize !== undefined
+            ? parseMaxCacheSize(nxJson.maxCacheSize)
+            : getDefaultMaxCacheSize(cacheDir),
+        used: new DbCache({ nxCloudRemoteCache: null }).getUsedCacheSpace(),
+      }
+    : null;
+
   return {
     pm,
     nxKey,
@@ -294,6 +326,7 @@ export async function getReportData(): Promise<ReportData> {
     outOfSyncPackageGroup,
     projectGraphError,
     nativeTarget: native ? native.getBinaryTarget() : null,
+    cache,
   };
 }
 

packages/nx/src/command-line/report/report.ts

@@ -6,6 +6,7 @@ use fs_extra::remove_items;
 use napi::bindgen_prelude::*;
 use regex::Regex;
 use rusqlite::params;
+use sysinfo::Disks;
 use tracing::trace;
 
 use crate::native::cache::expand_outputs::_expand_outputs;
@@ -29,7 +30,7 @@ pub struct NxCache {
     cache_path: PathBuf,
     db: External<NxDbConnection>,
     link_task_details: bool,
-    max_cache_size: Option<i64>,
+    max_cache_size: i64,
 }
 
 #[napi]
@@ -47,6 +48,8 @@ impl NxCache {
         create_dir_all(&cache_path)?;
         create_dir_all(cache_path.join("terminalOutputs"))?;
 
+        let max_cache_size = max_cache_size.unwrap_or(0);
+
         let r = Self {
             db: db_connection,
             workspace_root: PathBuf::from(workspace_root),
@@ -207,48 +210,63 @@ impl NxCache {
             "INSERT OR REPLACE INTO cache_outputs (hash, code, size) VALUES (?1, ?2, ?3)",
             params![hash, code, size],
         )?;
-        if self.max_cache_size.is_some() {
+        if self.max_cache_size != 0 {
             self.ensure_cache_size_within_limit()?
         }
         Ok(())
     }
 
+    #[napi]
+    pub fn get_cache_size(&self) -> anyhow::Result<i64> {
+        self.db
+            .query_row("SELECT SUM(size) FROM cache_outputs", [], |row| {
+                row.get::<_, Option<i64>>(0)
+                    // If there are no cache entries, the result is
+                    // a single row with a NULL value. This would look like:
+                    // Ok(None). We need to convert this to Ok(0).
+                    .transpose()
+                    .unwrap_or(Ok(0))
+            })
+            // The query_row returns an Result<Option<T>> to account for
+            // a query that returned no rows. This isn't possible when using
+            // SUM, so we can safely unwrap the Option, but need to transpose
+            // to access it. The result represents a db error or mapping error.
+            .transpose()
+            .unwrap_or(Ok(0))
+    }
+
     fn ensure_cache_size_within_limit(&self) -> anyhow::Result<()> {
-        if let Some(user_specified_max_cache_size) = self.max_cache_size {
-            let buffer_amount = (0.1 * user_specified_max_cache_size as f64) as i64;
-            let target_cache_size = user_specified_max_cache_size - buffer_amount;
-
-            let full_cache_size = self
-                .db
-                .query_row("SELECT SUM(size) FROM cache_outputs", [], |row| {
-                    row.get::<_, i64>(0)
-                })?
-                .unwrap_or(0);
-            if user_specified_max_cache_size < full_cache_size {
-                let mut cache_size = full_cache_size;
-                let mut stmt = self.db.prepare(
-                    "SELECT hash, size FROM cache_outputs ORDER BY accessed_at ASC LIMIT 100",
-                )?;
-                'outer: while cache_size > target_cache_size {
-                    let rows = stmt.query_map([], |r| {
-                        let hash: String = r.get(0)?;
-                        let size: i64 = r.get(1)?;
-                        Ok((hash, size))
-                    })?;
-                    for row in rows {
-                        if let Ok((hash, size)) = row {
-                            cache_size -= size;
-                            self.db.execute(
-                                "DELETE FROM cache_outputs WHERE hash = ?1",
-                                params![hash],
-                            )?;
-                            remove_items(&[self.cache_path.join(&hash)])?;
-                        }
-                        // We've deleted enough cache entries to be under the
-                        // target cache size, stop looking for more.
-                        if cache_size < target_cache_size {
-                            break 'outer;
-                        }
+        // 0 is equivalent to being unlimited.
+        if self.max_cache_size == 0 {
+            return Ok(());
+        }
+        let user_specified_max_cache_size = self.max_cache_size;
+        let buffer_amount = (0.1 * user_specified_max_cache_size as f64) as i64;
+        let target_cache_size = user_specified_max_cache_size - buffer_amount;
+
+        let full_cache_size = self.get_cache_size()?;
+        if user_specified_max_cache_size < full_cache_size {
+            let mut cache_size = full_cache_size;
+            let mut stmt = self.db.prepare(
+                "SELECT hash, size FROM cache_outputs ORDER BY accessed_at ASC LIMIT 100",
+            )?;
+            'outer: while cache_size > target_cache_size {
+                let rows = stmt.query_map([], |r| {
+                    let hash: String = r.get(0)?;
+                    let size: i64 = r.get(1)?;
+                    Ok((hash, size))
+                })?;
+                for row in rows {
+                    if let Ok((hash, size)) = row {
+                        cache_size -= size;
+                        self.db
+                            .execute("DELETE FROM cache_outputs WHERE hash = ?1", params![hash])?;
+                        remove_items(&[self.cache_path.join(&hash)])?;
+                    }
+                    // We've deleted enough cache entries to be under the
+                    // target cache size, stop looking for more.
+                    if cache_size < target_cache_size {
+                        break 'outer;
                     }
                 }
             }
@@ -346,6 +364,21 @@ impl NxCache {
     }
 }
 
+#[napi]
+fn get_default_max_cache_size(cache_path: String) -> i64 {
+    let disks = Disks::new_with_refreshed_list();
+    let cache_path = PathBuf::from(cache_path);
+
+    for disk in disks.list() {
+        if cache_path.starts_with(disk.mount_point()) {
+            return (disk.total_space() as f64 * 0.1) as i64;
+        }
+    }
+
+    // Default to 100gb
+    100 * 1024 * 1024 * 1024
+}
+
 fn try_and_retry<T, F>(mut f: F) -> anyhow::Result<T>
 where
     F: FnMut() -> anyhow::Result<T>,

packages/nx/src/native/cache/cache.rs

@@ -42,6 +42,7 @@ export declare class NxCache {
   put(hash: string, terminalOutput: string, outputs: Array<string>, code: number): void
   applyRemoteCacheResults(hash: string, result: CachedResult, outputs: Array<string>): void
   getTaskOutputsPath(hash: string): string
+  getCacheSize(): number
   copyFilesFromCache(cachedResult: CachedResult, outputs: Array<string>): number
   removeOldCacheRecords(): void
   checkCacheFsInSync(): boolean
@@ -166,6 +167,8 @@ export declare export function findImports(projectFileMap: Record<string, Array<
 
 export declare export function getBinaryTarget(): string
 
+export declare export function getDefaultMaxCacheSize(cachePath: string): number
+
 /**
  * Expands the given outputs into a list of existing files.
  * This is used when hashing outputs

packages/nx/src/native/index.d.ts

@@ -379,6 +379,7 @@ module.exports.EventType = nativeBinding.EventType
 module.exports.expandOutputs = nativeBinding.expandOutputs
 module.exports.findImports = nativeBinding.findImports
 module.exports.getBinaryTarget = nativeBinding.getBinaryTarget
+module.exports.getDefaultMaxCacheSize = nativeBinding.getDefaultMaxCacheSize
 module.exports.getFilesForOutputs = nativeBinding.getFilesForOutputs
 module.exports.getTransformableOutputs = nativeBinding.getTransformableOutputs
 module.exports.hashArray = nativeBinding.hashArray