fix(core): catch workspace validity check errors (#23138)

<!-- 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` -->

## Current Behavior
<!-- This is the behavior we have today -->
Errors thrown by `assertWorkspaceValidity` aren't handled and lead to
the nx process' exit

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->
Errors are properly caught and handled with the ability to recover a
partial project graph like other errors.

Author: MaxKless

packages/nx/src/project-graph/build-project-graph.ts

@@ -38,8 +38,10 @@ import {
   AggregateProjectGraphError,
   CreateMetadataError,
   isAggregateProjectGraphError,
+  isWorkspaceValidityError,
   ProcessDependenciesError,
   ProcessProjectGraphError,
+  WorkspaceValidityError,
 } from './error-types';
 import {
   ConfigurationSourceMaps,
@@ -96,9 +98,22 @@ export async function buildProjectGraphUsingProjectFileMap(
     projects[project.name] = project;
   }
 
+  const errors: Array<
+    | CreateMetadataError
+    | ProcessDependenciesError
+    | ProcessProjectGraphError
+    | WorkspaceValidityError
+  > = [];
+
   const nxJson = readNxJson();
   const projectGraphVersion = '6.0';
-  assertWorkspaceValidity(projects, nxJson);
+  try {
+    assertWorkspaceValidity(projects, nxJson);
+  } catch (e) {
+    if (isWorkspaceValidityError(e)) {
+      errors.push(e);
+    }
+  }
   const packageJsonDeps = readCombinedDeps();
   const rootTsConfig = readRootTsConfig();
 
@@ -125,27 +140,44 @@ export async function buildProjectGraphUsingProjectFileMap(
     };
   }
 
-  const context = createContext(
-    projects,
-    nxJson,
-    externalNodes,
-    fileMap,
-    filesToProcess
-  );
-  let projectGraph = await buildProjectGraphUsingContext(
-    externalNodes,
-    context,
-    cachedFileData,
-    projectGraphVersion,
-    plugins,
-    sourceMap
-  );
-  const projectFileMapCache = createProjectFileMapCache(
-    nxJson,
-    packageJsonDeps,
-    fileMap,
-    rootTsConfig
-  );
+  let projectGraph: ProjectGraph;
+  let projectFileMapCache: FileMapCache;
+  try {
+    const context = createContext(
+      projects,
+      nxJson,
+      externalNodes,
+      fileMap,
+      filesToProcess
+    );
+    projectGraph = await buildProjectGraphUsingContext(
+      externalNodes,
+      context,
+      cachedFileData,
+      projectGraphVersion,
+      plugins,
+      sourceMap
+    );
+    projectFileMapCache = createProjectFileMapCache(
+      nxJson,
+      packageJsonDeps,
+      fileMap,
+      rootTsConfig
+    );
+  } catch (e) {
+    // we need to include the workspace validity errors in the final error
+    if (isAggregateProjectGraphError(e)) {
+      errors.push(...e.errors);
+      throw new AggregateProjectGraphError(errors, e.partialProjectGraph);
+    } else {
+      throw e;
+    }
+  }
+
+  if (errors.length > 0) {
+    throw new AggregateProjectGraphError(errors, projectGraph);
+  }
+
   return {
     projectGraph,
     projectFileMapCache,

packages/nx/src/project-graph/error-types.ts

@@ -15,6 +15,7 @@ export class ProjectGraphError extends Error {
     | ProjectsWithConflictingNamesError
     | ProcessDependenciesError
     | ProcessProjectGraphError
+    | WorkspaceValidityError
   >;
   readonly #partialProjectGraph: ProjectGraph;
   readonly #partialSourceMaps: ConfigurationSourceMaps;
@@ -28,6 +29,7 @@ export class ProjectGraphError extends Error {
       | ProcessDependenciesError
       | ProcessProjectGraphError
       | CreateMetadataError
+      | WorkspaceValidityError
     >,
     partialProjectGraph: ProjectGraph,
     partialSourceMaps: ConfigurationSourceMaps
@@ -219,6 +221,24 @@ export class ProcessDependenciesError extends Error {
     this.stack = `${this.message}\n  ${cause.stack.split('\n').join('\n  ')}`;
   }
 }
+export class WorkspaceValidityError extends Error {
+  constructor(public message: string) {
+    message = `Configuration Error\n${message}`;
+    super(message);
+    this.name = this.constructor.name;
+  }
+}
+
+export function isWorkspaceValidityError(
+  e: unknown
+): e is WorkspaceValidityError {
+  return (
+    e instanceof WorkspaceValidityError ||
+    (typeof e === 'object' &&
+      'name' in e &&
+      e?.name === WorkspaceValidityError.name)
+  );
+}
 
 export class ProcessProjectGraphError extends Error {
   constructor(public readonly pluginName: string, { cause }) {
@@ -236,7 +256,10 @@ export class ProcessProjectGraphError extends Error {
 export class AggregateProjectGraphError extends Error {
   constructor(
     public readonly errors: Array<
-      CreateMetadataError | ProcessDependenciesError | ProcessProjectGraphError
+      | CreateMetadataError
+      | ProcessDependenciesError
+      | ProcessProjectGraphError
+      | WorkspaceValidityError
     >,
     public readonly partialProjectGraph: ProjectGraph
   ) {

packages/nx/src/utils/assert-workspace-validity.ts

@@ -3,6 +3,7 @@ import { NxJsonConfiguration } from '../config/nx-json';
 import { findMatchingProjects } from './find-matching-projects';
 import { output } from './output';
 import { ProjectGraphProjectNode } from '../config/project-graph';
+import { WorkspaceValidityError } from '../devkit-internals';
 
 export function assertWorkspaceValidity(
   projects: Record<string, ProjectConfiguration>,
@@ -99,7 +100,7 @@ export function assertWorkspaceValidity(
       .join('\n\n');
   }
 
-  throw new Error(`Configuration Error\n${message}`);
+  throw new WorkspaceValidityError(message);
 }
 
 function detectAndSetInvalidProjectGlobValues(