-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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.
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
feat(core): lock graph creation when running in another process #29408
Open
AgentEnder
wants to merge
3
commits into
master
Choose a base branch
from
file-lock-graph
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,128 @@ | ||
use std::fs::{self, File}; | ||
use std::io; | ||
use std::path::Path; | ||
use std::time::Duration; | ||
|
||
#[napi] | ||
#[derive(Clone)] | ||
pub struct FileLock { | ||
#[napi] | ||
pub locked: bool, | ||
|
||
lock_file_path: String, | ||
} | ||
|
||
#[napi] | ||
impl FileLock { | ||
#[napi(constructor)] | ||
pub fn new(lock_file_path: String) -> Self { | ||
let locked = Path::new(&lock_file_path).exists(); | ||
Self { | ||
locked, | ||
lock_file_path, | ||
} | ||
} | ||
|
||
#[napi] | ||
pub fn lock(&mut self) -> anyhow::Result<()> { | ||
if self.locked { | ||
anyhow::bail!("File {} is already locked", self.lock_file_path) | ||
} | ||
|
||
let _ = File::create(&self.lock_file_path)?; | ||
self.locked = true; | ||
Ok(()) | ||
} | ||
|
||
#[napi] | ||
pub fn unlock(&mut self) -> anyhow::Result<()> { | ||
if !self.locked { | ||
anyhow::bail!("File {} is not locked", self.lock_file_path) | ||
} | ||
fs::remove_file(&self.lock_file_path).or_else(|err| { | ||
if err.kind() == io::ErrorKind::NotFound { | ||
Ok(()) | ||
} else { | ||
Err(err) | ||
} | ||
})?; | ||
self.locked = false; | ||
Ok(()) | ||
} | ||
|
||
#[napi] | ||
pub async fn wait(&self) -> Result<(), napi::Error> { | ||
if !self.locked { | ||
return Ok(()); | ||
} | ||
|
||
loop { | ||
if !self.locked || !Path::new(&self.lock_file_path).exists() { | ||
break Ok(()); | ||
} | ||
std::thread::sleep(Duration::from_millis(2)); | ||
} | ||
} | ||
} | ||
|
||
// Ensure the lock file is removed when the FileLock is dropped | ||
impl Drop for FileLock { | ||
fn drop(&mut self) { | ||
if self.locked { | ||
let _ = self.unlock(); | ||
} | ||
} | ||
} | ||
|
||
#[cfg(test)] | ||
mod test { | ||
use super::*; | ||
|
||
use assert_fs::prelude::*; | ||
use assert_fs::TempDir; | ||
|
||
#[test] | ||
fn test_new_lock() { | ||
let tmp_dir = TempDir::new().unwrap(); | ||
let lock_file = tmp_dir.child("test_lock_file"); | ||
let lock_file_path = lock_file.path().to_path_buf(); | ||
let lock_file_path_str = lock_file_path.into_os_string().into_string().unwrap(); | ||
let mut file_lock = FileLock::new(lock_file_path_str); | ||
assert_eq!(file_lock.locked, false); | ||
let _ = file_lock.lock(); | ||
assert_eq!(file_lock.locked, true); | ||
assert!(lock_file.exists()); | ||
let _ = file_lock.unlock(); | ||
assert_eq!(lock_file.exists(), false); | ||
} | ||
|
||
#[tokio::test] | ||
async fn test_wait() { | ||
let tmp_dir = TempDir::new().unwrap(); | ||
let lock_file = tmp_dir.child("test_lock_file"); | ||
let lock_file_path = lock_file.path().to_path_buf(); | ||
let lock_file_path_str = lock_file_path.into_os_string().into_string().unwrap(); | ||
let mut file_lock = FileLock::new(lock_file_path_str); | ||
let _ = file_lock.lock(); | ||
let file_lock_clone = file_lock.clone(); | ||
let wait_fut = async move { | ||
let _ = file_lock_clone.wait().await; | ||
}; | ||
let _ = tokio::runtime::Runtime::new().unwrap().block_on(wait_fut); | ||
assert_eq!(file_lock.locked, false); | ||
assert_eq!(lock_file.exists(), false); | ||
} | ||
|
||
#[test] | ||
fn test_drop() { | ||
let tmp_dir = TempDir::new().unwrap(); | ||
let lock_file = tmp_dir.child("test_lock_file"); | ||
let lock_file_path = lock_file.path().to_path_buf(); | ||
let lock_file_path_str = lock_file_path.into_os_string().into_string().unwrap(); | ||
{ | ||
let mut file_lock = FileLock::new(lock_file_path_str.clone()); | ||
let _ = file_lock.lock(); | ||
} | ||
assert_eq!(lock_file.exists(), false); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,6 +25,7 @@ import { | |
import { | ||
readFileMapCache, | ||
readProjectGraphCache, | ||
readSourceMapsCache, | ||
writeCache, | ||
} from './nx-deps-cache'; | ||
import { ConfigurationResult } from './utils/project-configuration-utils'; | ||
|
@@ -34,6 +35,10 @@ import { | |
} from './utils/retrieve-workspace-files'; | ||
import { getPlugins } from './plugins/get-plugins'; | ||
import { logger } from '../utils/logger'; | ||
import { FileLock } from '../native'; | ||
import { join } from 'path'; | ||
import { workspaceDataDirectory } from '../utils/cache-directory'; | ||
import { DelayedSpinner } from '../utils/delayed-spinner'; | ||
|
||
/** | ||
* Synchronously reads the latest cached copy of the workspace's ProjectGraph. | ||
|
@@ -167,7 +172,7 @@ export async function buildProjectGraphAndSourceMapsWithoutDaemon() { | |
throw new ProjectGraphError(errors, projectGraph, sourceMaps); | ||
} else { | ||
if (cacheEnabled) { | ||
writeCache(projectFileMapCache, projectGraph); | ||
writeCache(projectFileMapCache, projectGraph, sourceMaps); | ||
} | ||
return { projectGraph, sourceMaps }; | ||
} | ||
|
@@ -206,6 +211,20 @@ export function handleProjectGraphError(opts: { exitOnError: boolean }, e) { | |
} | ||
} | ||
|
||
async function readCachedGraphAndHydrateFileMap() { | ||
const graph = readCachedProjectGraph(); | ||
const projectRootMap = Object.fromEntries( | ||
Object.entries(graph.nodes).map(([project, { data }]) => [ | ||
data.root, | ||
project, | ||
]) | ||
); | ||
const { allWorkspaceFiles, fileMap, rustReferences } = | ||
await retrieveWorkspaceFiles(workspaceRoot, projectRootMap); | ||
hydrateFileMap(fileMap, allWorkspaceFiles, rustReferences); | ||
return graph; | ||
} | ||
|
||
/** | ||
* Computes and returns a ProjectGraph. | ||
* | ||
|
@@ -235,18 +254,8 @@ export async function createProjectGraphAsync( | |
): Promise<ProjectGraph> { | ||
if (process.env.NX_FORCE_REUSE_CACHED_GRAPH === 'true') { | ||
try { | ||
const graph = readCachedProjectGraph(); | ||
const projectRootMap = Object.fromEntries( | ||
Object.entries(graph.nodes).map(([project, { data }]) => [ | ||
data.root, | ||
project, | ||
]) | ||
); | ||
const { allWorkspaceFiles, fileMap, rustReferences } = | ||
await retrieveWorkspaceFiles(workspaceRoot, projectRootMap); | ||
hydrateFileMap(fileMap, allWorkspaceFiles, rustReferences); | ||
return graph; | ||
// If no cached graph is found, we will fall through to the normal flow | ||
return readCachedGraphAndHydrateFileMap(); | ||
} catch (e) { | ||
logger.verbose('Unable to use cached project graph', e); | ||
} | ||
|
@@ -267,6 +276,47 @@ export async function createProjectGraphAndSourceMapsAsync( | |
performance.mark('create-project-graph-async:start'); | ||
|
||
if (!daemonClient.enabled()) { | ||
const lock = new FileLock( | ||
join(workspaceDataDirectory, 'project-graph.lock') | ||
); | ||
|
||
function cleanupFileLock() { | ||
try { | ||
lock.unlock(); | ||
} catch {} | ||
} | ||
|
||
process.on('exit', cleanupFileLock); | ||
|
||
if (lock.locked) { | ||
logger.verbose( | ||
'Waiting for graph construction in another process to complete' | ||
); | ||
const spinner = new DelayedSpinner( | ||
'Waiting for graph construction in another process to complete' | ||
); | ||
await lock.wait(); | ||
spinner.cleanup(); | ||
|
||
// Note: This will currently throw if any of the caches are missing... | ||
// It would be nice if one of the processes that was waiting for the lock | ||
// could pick up the slack and build the graph if it's missing, but | ||
// we wouldn't want either of the below to happen: | ||
// - All of the waiting processes to build the graph | ||
// - Even one of the processes building the graph on a legitimate error | ||
|
||
const sourceMaps = readSourceMapsCache(); | ||
if (!sourceMaps) { | ||
throw new Error( | ||
'The project graph was computed in another process, but the source maps are missing.' | ||
); | ||
} | ||
return { | ||
projectGraph: await readCachedGraphAndHydrateFileMap(), | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This should throw an error if the graph is in a bad state |
||
sourceMaps, | ||
}; | ||
} | ||
lock.lock(); | ||
try { | ||
const res = await buildProjectGraphAndSourceMapsWithoutDaemon(); | ||
performance.measure( | ||
|
@@ -293,6 +343,8 @@ export async function createProjectGraphAndSourceMapsAsync( | |
return res; | ||
} catch (e) { | ||
handleProjectGraphError(opts, e); | ||
} finally { | ||
lock.unlock(); | ||
} | ||
} else { | ||
try { | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We might not need this