Skip to content

fix: Fix workspace graph caching. Avoid unnecessary plugin calls. #2602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
milesj merged 7 commits into from
Jul 8, 2026
Merged

fix: Fix workspace graph caching. Avoid unnecessary plugin calls. #2602

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8b689f6
First pass.
milesj Jul 7, 2026
6b36d2a
Better caching.
milesj Jul 7, 2026
0bd26b4
Polish.
milesj Jul 7, 2026
b81f750
Fixes.
milesj Jul 7, 2026
400e781
Add caching to async.
milesj Jul 8, 2026
d5ff80c
Enable.
milesj Jul 8, 2026
6fafeda
Bump.
milesj Jul 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .moon/workspace.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ pipeline:

experiments:
asyncAffectedTracking: true
asyncGraphBuilding: true
# asyncGraphBuilding: true
casOutputsCache: true
Comment thread
milesj marked this conversation as resolved.
nativeFileHashing: true

Expand Down
4 changes: 2 additions & 2 deletions crates/app/src/watchers/workspace_watcher.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use moon_common::path::WorkspaceRelativePath;
use moon_config::WorkspaceProjects;
use moon_daemon::AtomicDaemonState;
use moon_file_watcher::*;
use moon_workspace::{STATE_GRAPH_FILE_NAME, STATE_PROJECTS_FILE_NAME};
use moon_workspace::{STATE_CACHE_FILE_NAME, STATE_GRAPH_FILE_NAME};
use proto_core::ProtoEnvironment;
use regex::Regex;
use starbase_utils::fs;
Expand Down Expand Up @@ -133,7 +133,7 @@ impl WorkspaceWatcher {
let cache_engine = self.session.get_cache_engine()?;

fs::remove_file(cache_engine.state.resolve_path(STATE_GRAPH_FILE_NAME))?;
fs::remove_file(cache_engine.state.resolve_path(STATE_PROJECTS_FILE_NAME))?;
fs::remove_file(cache_engine.state.resolve_path(STATE_CACHE_FILE_NAME))?;

// Rebuild the graphs in a background thread
self.graph_handle = Some(self.session.rebuild_graphs(Arc::clone(state)));
Expand Down
207 changes: 163 additions & 44 deletions crates/project-graph/tests/project_graph_test.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ use moon_task::{Target, TaskFileInput, TaskFileOutput, TaskGlobInput};
use moon_test_utils::{
MoonSandbox, WorkspaceGraph, WorkspaceMockOptions, WorkspaceMocker, create_moon_sandbox,
};
use moon_workspace::WorkspaceProjectsCacheState;
use petgraph::prelude::*;
use moon_workspace::WorkspaceGraphCacheState;
use rustc_hash::FxHashMap;
use starbase_sandbox::assert_snapshot;
use starbase_utils::{fs, json, string_vec};
Expand Down Expand Up @@ -345,10 +344,9 @@ mod project_graph {

mod cache {
use super::*;
use moon_workspace::ProjectBuildData;

const CACHE_PATH: &str = ".moon/cache/states/workspaceGraph.json";
const STATE_PATH: &str = ".moon/cache/states/projectsBuildDataV1.json";
const STATE_PATH: &str = ".moon/cache/states/workspaceGraphStateV1.json";

async fn do_generate(root: &Path) -> WorkspaceGraph {
let mock = create_workspace_mocker(root);
Expand Down Expand Up @@ -415,46 +413,10 @@ mod project_graph {
})
.await;

let state: WorkspaceProjectsCacheState =
let state: WorkspaceGraphCacheState =
json::read_file(sandbox.path().join(STATE_PATH)).unwrap();

assert_eq!(
state.projects,
FxHashMap::from_iter([
(
Id::raw("a"),
ProjectBuildData {
node_index: Some(NodeIndex::from(1)),
source: "a".into(),
..Default::default()
}
),
(
Id::raw("b"),
ProjectBuildData {
node_index: Some(NodeIndex::from(2)),
source: "b".into(),
..Default::default()
}
),
(
Id::raw("c"),
ProjectBuildData {
node_index: Some(NodeIndex::from(3)),
source: "c".into(),
..Default::default()
}
),
(
Id::raw("d"),
ProjectBuildData {
node_index: Some(NodeIndex::from(0)),
source: "d".into(),
..Default::default()
}
),
])
);
assert!(!state.last_hash.as_str().is_empty());

assert!(
sandbox
Expand All @@ -474,13 +436,13 @@ mod project_graph {
})
.await;

let state1: WorkspaceProjectsCacheState =
let state1: WorkspaceGraphCacheState =
json::read_file(sandbox.path().join(STATE_PATH)).unwrap();

func(&sandbox);
do_generate(sandbox.path()).await;

let state2: WorkspaceProjectsCacheState =
let state2: WorkspaceGraphCacheState =
json::read_file(sandbox.path().join(STATE_PATH)).unwrap();

assert_ne!(state1.last_hash, state2.last_hash);
Expand Down Expand Up @@ -531,6 +493,163 @@ mod project_graph {
.await;
}
}

mod plugins {
use super::*;

// Written by the `tc-tier1` test plugin when `extend_project_graph`
// is called, allowing us to detect if/when it was invoked
const MARKER_PATH: &str = ".moon/cache/tcExtendProjectGraph";

async fn do_generate_with_plugins(root: &Path) -> WorkspaceGraph {
let mock = WorkspaceMocker::new(root)
.load_default_configs()
.with_default_projects()
.with_test_toolchains()
.with_inherited_tasks();
let cache_engine = mock.mock_cache_engine();

mock.mock_workspace_graph_with_options(WorkspaceMockOptions {
cache: Some(cache_engine),
..Default::default()
})
.await
}

async fn build_plugins_cached_graph(func: impl FnOnce(&MoonSandbox)) -> MoonSandbox {
let sandbox = create_moon_sandbox("dependencies");
sandbox.enable_git();

func(&sandbox);

do_generate_with_plugins(sandbox.path()).await;

sandbox
}

async fn test_plugins_invalidate(
setup: impl FnOnce(&MoonSandbox),
mutate: impl FnOnce(&MoonSandbox),
) {
let sandbox = build_plugins_cached_graph(setup).await;

let state1: WorkspaceGraphCacheState =
json::read_file(sandbox.path().join(STATE_PATH)).unwrap();

mutate(&sandbox);
do_generate_with_plugins(sandbox.path()).await;

let state2: WorkspaceGraphCacheState =
json::read_file(sandbox.path().join(STATE_PATH)).unwrap();

assert_ne!(state1.last_hash, state2.last_hash);
}

#[tokio::test(flavor = "multi_thread")]
async fn skips_extend_project_graph_on_cache_hit() {
let sandbox = build_plugins_cached_graph(|_| {}).await;
let marker = sandbox.path().join(MARKER_PATH);

// Called on the initial build
assert!(marker.exists());

fs::remove_file(&marker).unwrap();

// But not on a warm cache
do_generate_with_plugins(sandbox.path()).await;

assert!(!marker.exists());
}

#[tokio::test(flavor = "multi_thread")]
async fn calls_extend_project_graph_on_cache_miss() {
let sandbox = build_plugins_cached_graph(|_| {}).await;
let marker = sandbox.path().join(MARKER_PATH);

fs::remove_file(&marker).unwrap();

// Invalidate by changing a project config
sandbox.create_file("a/moon.yml", "# Changes");

do_generate_with_plugins(sandbox.path()).await;

assert!(marker.exists());
}

#[tokio::test(flavor = "multi_thread")]
async fn resolves_plugin_aliases_on_cache_hit() {
let sandbox = build_plugins_cached_graph(|sandbox| {
sandbox.create_file("a/tc.cfg", "a-alias");
})
.await;

// Warm run, uses the cached graph
let graph = do_generate_with_plugins(sandbox.path()).await;

assert_eq!(graph.get_project("a-alias").unwrap().id, Id::raw("a"));
}

#[tokio::test(flavor = "multi_thread")]
async fn invalidates_with_new_manifest_file() {
test_plugins_invalidate(
|_| {},
|sandbox| {
sandbox.create_file("a/tc.cfg", "a-alias");
},
)
.await;
}

#[tokio::test(flavor = "multi_thread")]
async fn invalidates_with_changed_manifest_file() {
test_plugins_invalidate(
|sandbox| {
sandbox.create_file("a/tc.cfg", "a-alias");
},
|sandbox| {
sandbox.create_file("a/tc.cfg", "a-alias-changed");
},
)
.await;
}

#[tokio::test(flavor = "multi_thread")]
async fn invalidates_with_removed_manifest_file() {
test_plugins_invalidate(
|sandbox| {
sandbox.create_file("a/tc.cfg", "a-alias");
},
|sandbox| {
fs::remove_file(sandbox.path().join("a/tc.cfg")).unwrap();
},
)
.await;
}

#[tokio::test(flavor = "multi_thread")]
async fn invalidates_with_new_root_lock_file() {
test_plugins_invalidate(
|_| {},
|sandbox| {
sandbox.create_file("tc.lock", "v1");
},
)
.await;
}

#[tokio::test(flavor = "multi_thread")]
async fn invalidates_with_changed_root_lock_file() {
test_plugins_invalidate(
|sandbox| {
sandbox.create_file("tc.lock", "v1");
},
|sandbox| {
sandbox.create_file("tc.lock", "v2");
},
)
.await;
}
}
}

mod cycles {
Expand Down
Loading
Loading