feat(core): lock graph creation when running in another process

docs/generated/devkit/README.md

@@ -20,6 +20,7 @@ It only uses language primitives and immutable objects
 ### Classes
 
 - [AggregateCreateNodesError](../../devkit/documents/AggregateCreateNodesError)
+- [StaleProjectGraphCacheError](../../devkit/documents/StaleProjectGraphCacheError)
 
 ### Interfaces
 

docs/generated/devkit/StaleProjectGraphCacheError.md

@@ -0,0 +1,144 @@
+# Class: StaleProjectGraphCacheError
+
+## Hierarchy
+
+- `Error`
+
+  ↳ **`StaleProjectGraphCacheError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](../../devkit/documents/StaleProjectGraphCacheError#constructor)
+
+### Properties
+
+- [cause](../../devkit/documents/StaleProjectGraphCacheError#cause): unknown
+- [message](../../devkit/documents/StaleProjectGraphCacheError#message): string
+- [name](../../devkit/documents/StaleProjectGraphCacheError#name): string
+- [stack](../../devkit/documents/StaleProjectGraphCacheError#stack): string
+- [prepareStackTrace](../../devkit/documents/StaleProjectGraphCacheError#preparestacktrace): Function
+- [stackTraceLimit](../../devkit/documents/StaleProjectGraphCacheError#stacktracelimit): number
+
+### Methods
+
+- [captureStackTrace](../../devkit/documents/StaleProjectGraphCacheError#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new StaleProjectGraphCacheError**(): [`StaleProjectGraphCacheError`](../../devkit/documents/StaleProjectGraphCacheError)
+
+#### Returns
+
+[`StaleProjectGraphCacheError`](../../devkit/documents/StaleProjectGraphCacheError)
+
+#### Overrides
+
+Error.constructor
+
+## Properties
+
+### cause
+
+• `Optional` **cause**: `unknown`
+
+#### Inherited from
+
+Error.cause
+
+---
+
+### message
+
+• **message**: `string`
+
+#### Inherited from
+
+Error.message
+
+---
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+Error.name
+
+---
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+Error.stack
+
+---
+
+### prepareStackTrace
+
+▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+Optional override for formatting stack traces
+
+**`See`**
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Type declaration
+
+▸ (`err`, `stackTraces`): `any`
+
+##### Parameters
+
+| Name          | Type         |
+| :------------ | :----------- |
+| `err`         | `Error`      |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`any`
+
+#### Inherited from
+
+Error.prepareStackTrace
+
+---
+
+### stackTraceLimit
+
+▪ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+Error.stackTraceLimit
+
+## Methods
+
+### captureStackTrace
+
+▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name              | Type       |
+| :---------------- | :--------- |
+| `targetObject`    | `object`   |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+Error.captureStackTrace

docs/generated/devkit/readCachedProjectGraph.md

@@ -1,9 +1,15 @@
 # Function: readCachedProjectGraph
 
-▸ **readCachedProjectGraph**(): [`ProjectGraph`](../../devkit/documents/ProjectGraph)
+▸ **readCachedProjectGraph**(`minimumComputedAt?`): [`ProjectGraph`](../../devkit/documents/ProjectGraph)
 
 Synchronously reads the latest cached copy of the workspace's ProjectGraph.
 
+#### Parameters
+
+| Name                 | Type     | Description                                                                    |
+| :------------------- | :------- | :----------------------------------------------------------------------------- |
+| `minimumComputedAt?` | `number` | The minimum timestamp that the cached ProjectGraph must have been computed at. |
+
 #### Returns
 
 [`ProjectGraph`](../../devkit/documents/ProjectGraph)

docs/generated/packages/devkit/documents/nx_devkit.md

@@ -20,6 +20,7 @@ It only uses language primitives and immutable objects
 ### Classes
 
 - [AggregateCreateNodesError](../../devkit/documents/AggregateCreateNodesError)
+- [StaleProjectGraphCacheError](../../devkit/documents/StaleProjectGraphCacheError)
 
 ### Interfaces
 

packages/devkit/src/executors/parse-target-string.ts

@@ -40,7 +40,7 @@ export function parseTargetString(
   targetString: string,
   projectGraphOrCtx?: ProjectGraph | ExecutorContext
 ): Target {
-  let projectGraph =
+  let projectGraph: ProjectGraph =
     projectGraphOrCtx && 'projectGraph' in projectGraphOrCtx
       ? projectGraphOrCtx.projectGraph
       : (projectGraphOrCtx as ProjectGraph);

packages/nx/Cargo.toml

@@ -74,3 +74,5 @@ assert_fs = "1.0.10"
 # This is only used for unit tests
 swc_ecma_dep_graph = "0.109.1"
 tempfile = "3.13.0"
+# We only explicitly use tokio for async tests
+tokio = "1.38.0"

packages/nx/bin/nx.ts

@@ -21,7 +21,7 @@ import { performance } from 'perf_hooks';
 import { setupWorkspaceContext } from '../src/utils/workspace-context';
 import { daemonClient } from '../src/daemon/client/client';
 import { removeDbConnections } from '../src/utils/db-connection';
-import { signalToCode } from '../src/utils/exit-codes';
+import { registerCleanupFn } from '../src/utils/cleanup';
 
 function main() {
   if (
@@ -276,26 +276,8 @@ const getLatestVersionOfNx = ((fn: () => string) => {
   return () => cache || (cache = fn());
 })(_getLatestVersionOfNx);
 
-function nxCleanup(signal?: NodeJS.Signals) {
+registerCleanupFn(() => {
   removeDbConnections();
-  if (signal) {
-    process.exit(signalToCode(signal));
-  } else {
-    process.exit();
-  }
-}
-
-process.on('exit', () => {
-  nxCleanup();
-});
-process.on('SIGINT', () => {
-  nxCleanup('SIGINT');
-});
-process.on('SIGTERM', () => {
-  nxCleanup('SIGTERM');
-});
-process.on('SIGHUP', () => {
-  nxCleanup('SIGHUP');
 });
 
 main();

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

@@ -57,6 +57,7 @@ import { ConfigurationSourceMaps } from '../../project-graph/utils/project-confi
 import { createTaskHasher } from '../../hasher/create-task-hasher';
 import { ProjectGraphError } from '../../project-graph/error-types';
 import { isNxCloudUsed } from '../../utils/nx-cloud-utils';
+import { registerCleanupFn } from '../../utils/cleanup';
 
 export interface GraphError {
   message: string;
@@ -667,14 +668,9 @@ async function startServer(
     }
   });
 
-  const handleTermination = async (exitCode: number) => {
-    if (unregisterFileWatcher) {
-      unregisterFileWatcher();
-    }
-    process.exit(exitCode);
-  };
-  process.on('SIGINT', () => handleTermination(128 + 2));
-  process.on('SIGTERM', () => handleTermination(128 + 15));
+  if (unregisterFileWatcher) {
+    registerCleanupFn(() => unregisterFileWatcher);
+  }
 
   return new Promise<{ app: Server; url: URL }>((res) => {
     app.listen(port, host, () => {

packages/nx/src/daemon/server/project-graph-incremental-recomputation.ts

@@ -299,7 +299,12 @@ async function processFilesAndCreateAndSerializeProjectGraph(
         };
       }
     }
-
+    writeCache(
+      g.projectFileMapCache,
+      g.projectGraph,
+      projectConfigurationsResult.sourceMaps,
+      errors
+    );
     if (errors.length > 0) {
       return {
         error: new DaemonProjectGraphError(
@@ -316,7 +321,6 @@ async function processFilesAndCreateAndSerializeProjectGraph(
         serializedSourceMaps: null,
       };
     } else {
-      writeCache(g.projectFileMapCache, g.projectGraph);
       return g;
     }
   } catch (err) {

packages/nx/src/devkit-exports.ts

@@ -59,7 +59,10 @@ export type {
   ProjectsMetadata,
 } from './project-graph/plugins';
 
-export { AggregateCreateNodesError } from './project-graph/error-types';
+export {
+  AggregateCreateNodesError,
+  StaleProjectGraphCacheError,
+} from './project-graph/error-types';
 
 export { createNodesFromFiles } from './project-graph/plugins';
 

packages/nx/src/executors/run-commands/run-commands.impl.ts

@@ -9,11 +9,11 @@ import {
   PseudoTerminal,
   PseudoTtyProcess,
 } from '../../tasks-runner/pseudo-terminal';
-import { signalToCode } from '../../utils/exit-codes';
 import {
   loadAndExpandDotEnvFile,
   unloadDotEnvFile,
 } from '../../tasks-runner/task-env';
+import { registerCleanupFn } from '../../utils/cleanup';
 
 export const LARGE_BUFFER = 1024 * 1000000;
 let pseudoTerminal: PseudoTerminal | null;
@@ -640,40 +640,16 @@ function registerProcessListener() {
     });
   });
 
-  // Terminate any task processes on exit
-  process.on('exit', () => {
+  registerCleanupFn((signal) => {
     childProcesses.forEach((p) => {
       if ('connected' in p ? p.connected : p.isAlive) {
-        p.kill();
-      }
-    });
-  });
-  process.on('SIGINT', () => {
-    childProcesses.forEach((p) => {
-      if ('connected' in p ? p.connected : p.isAlive) {
-        p.kill('SIGTERM');
-      }
-    });
-    // we exit here because we don't need to write anything to cache.
-    process.exit(signalToCode('SIGINT'));
-  });
-  process.on('SIGTERM', () => {
-    childProcesses.forEach((p) => {
-      if ('connected' in p ? p.connected : p.isAlive) {
-        p.kill('SIGTERM');
-      }
-    });
-    // no exit here because we expect child processes to terminate which
-    // will store results to the cache and will terminate this process
-  });
-  process.on('SIGHUP', () => {
-    childProcesses.forEach((p) => {
-      if ('connected' in p ? p.connected : p.isAlive) {
-        p.kill('SIGTERM');
+        if (signal) {
+          p.kill(signal);
+        } else {
+          p.kill();
+        }
       }
     });
-    // no exit here because we expect child processes to terminate which
-    // will store results to the cache and will terminate this process
   });
 }
 

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

@@ -13,6 +13,15 @@ export declare class ChildProcess {
   onOutput(callback: (message: string) => void): void
 }
 
+export declare class FileLock {
+  locked: boolean
+  constructor(lockFilePath: string)
+  unlock(): void
+  check(): boolean
+  wait(): Promise<void>
+  lock(): void
+}
+
 export declare class HashPlanner {
   constructor(nxJson: NxJson, projectGraph: ExternalObject<ProjectGraph>)
   getPlans(taskIds: Array<string>, taskGraph: TaskGraph): Record<string, string[]>

packages/nx/src/native/native-bindings.js

@@ -362,6 +362,7 @@ if (!nativeBinding) {
 }
 
 module.exports.ChildProcess = nativeBinding.ChildProcess
+module.exports.FileLock = nativeBinding.FileLock
 module.exports.HashPlanner = nativeBinding.HashPlanner
 module.exports.ImportResult = nativeBinding.ImportResult
 module.exports.NxCache = nativeBinding.NxCache