fix(core): projectName should not be interpolated as undefined (#23145)

<!-- 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
Tokens are interpolated into arguments while merging things into the
root map. Unfortunately, this means `{projectName}` is sometimes
interpolated as `undefined` because the project's name isn't known yet.

## Expected Behavior
Tokens are interpolated after the root map has been constructed, but
still during `createProjectConfigurations` s.t. we can know that we have
final project configurations afterwards.

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

Fixes #

Author: AgentEnder

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

@@ -12,7 +12,7 @@ export class ProjectGraphError extends Error {
     | MergeNodesError
     | CreateMetadataError
     | ProjectsWithNoNameError
-    | ProjectsWithConflictingNamesError
+    | MultipleProjectsWithSameNameError
     | ProcessDependenciesError
     | ProcessProjectGraphError
     | WorkspaceValidityError
@@ -25,7 +25,7 @@ export class ProjectGraphError extends Error {
       | CreateNodesError
       | MergeNodesError
       | ProjectsWithNoNameError
-      | ProjectsWithConflictingNamesError
+      | MultipleProjectsWithSameNameError
       | ProcessDependenciesError
       | ProcessProjectGraphError
       | CreateMetadataError
@@ -73,9 +73,9 @@ export class ProjectGraphError extends Error {
   }
 }
 
-export class ProjectsWithConflictingNamesError extends Error {
+export class MultipleProjectsWithSameNameError extends Error {
   constructor(
-    conflicts: Map<string, string[]>,
+    public conflicts: Map<string, string[]>,
     public projects: Record<string, ProjectConfiguration>
   ) {
     super(
@@ -92,20 +92,38 @@ export class ProjectsWithConflictingNamesError extends Error {
   }
 }
 
-export function isProjectsWithConflictingNamesError(
+export class ProjectWithExistingNameError extends Error {
+  constructor(public projectName: string, public projectRoot: string) {
+    super(`The project "${projectName}" is defined in multiple locations.`);
+    this.name = this.constructor.name;
+  }
+}
+
+export function isProjectWithExistingNameError(
   e: unknown
-): e is ProjectsWithConflictingNamesError {
+): e is ProjectWithExistingNameError {
   return (
-    e instanceof ProjectsWithConflictingNamesError ||
+    e instanceof ProjectWithExistingNameError ||
     (typeof e === 'object' &&
       'name' in e &&
-      e?.name === ProjectsWithConflictingNamesError.prototype.name)
+      e?.name === ProjectWithExistingNameError.name)
+  );
+}
+
+export function isMultipleProjectsWithSameNameError(
+  e: unknown
+): e is MultipleProjectsWithSameNameError {
+  return (
+    e instanceof MultipleProjectsWithSameNameError ||
+    (typeof e === 'object' &&
+      'name' in e &&
+      e?.name === MultipleProjectsWithSameNameError.name)
   );
 }
 
 export class ProjectsWithNoNameError extends Error {
   constructor(
-    projectRoots: string[],
+    public projectRoots: string[],
     public projects: Record<string, ProjectConfiguration>
   ) {
     super(
@@ -124,7 +142,25 @@ export function isProjectsWithNoNameError(
     e instanceof ProjectsWithNoNameError ||
     (typeof e === 'object' &&
       'name' in e &&
-      e?.name === ProjectsWithNoNameError.prototype.name)
+      e?.name === ProjectsWithNoNameError.name)
+  );
+}
+
+export class ProjectWithNoNameError extends Error {
+  constructor(public projectRoot: string) {
+    super(`The project in ${projectRoot} has no name provided.`);
+    this.name = this.constructor.name;
+  }
+}
+
+export function isProjectWithNoNameError(
+  e: unknown
+): e is ProjectWithNoNameError {
+  return (
+    e instanceof ProjectWithNoNameError ||
+    (typeof e === 'object' &&
+      'name' in e &&
+      e?.name === ProjectWithNoNameError.name)
   );
 }
 
@@ -134,7 +170,7 @@ export class ProjectConfigurationsError extends Error {
       | MergeNodesError
       | CreateNodesError
       | ProjectsWithNoNameError
-      | ProjectsWithConflictingNamesError
+      | MultipleProjectsWithSameNameError
     >,
     public readonly partialProjectConfigurationsResult: ConfigurationResult
   ) {
@@ -143,6 +179,17 @@ export class ProjectConfigurationsError extends Error {
   }
 }
 
+export function isProjectConfigurationsError(
+  e: unknown
+): e is ProjectConfigurationsError {
+  return (
+    e instanceof ProjectConfigurationsError ||
+    (typeof e === 'object' &&
+      'name' in e &&
+      e?.name === ProjectConfigurationsError.name)
+  );
+}
+
 export class CreateNodesError extends Error {
   file: string;
   pluginName: string;
@@ -275,7 +322,7 @@ export function isAggregateProjectGraphError(
     e instanceof AggregateProjectGraphError ||
     (typeof e === 'object' &&
       'name' in e &&
-      e?.name === AggregateProjectGraphError.prototype.name)
+      e?.name === AggregateProjectGraphError.name)
   );
 }
 
@@ -284,7 +331,7 @@ export function isCreateMetadataError(e: unknown): e is CreateMetadataError {
     e instanceof CreateMetadataError ||
     (typeof e === 'object' &&
       'name' in e &&
-      e?.name === CreateMetadataError.prototype.name)
+      e?.name === CreateMetadataError.name)
   );
 }
 

packages/nx/src/project-graph/utils/project-configuration-utils.spec.ts

@@ -15,6 +15,8 @@ import {
 } from './project-configuration-utils';
 import { NxPluginV2 } from '../plugins';
 import { LoadedNxPlugin } from '../plugins/internal-api';
+import { dirname } from 'path';
+import { isProjectConfigurationsError } from '../error-types';
 
 describe('project-configuration-utils', () => {
   describe('target merging', () => {
@@ -573,7 +575,6 @@ describe('project-configuration-utils', () => {
           "root": "libs/lib-a",
           "targets": {
             "build": {
-              "configurations": {},
               "executor": "nx:run-commands",
               "options": {
                 "command": "tsc",
@@ -727,9 +728,8 @@ describe('project-configuration-utils', () => {
       expect(targets.echo).toMatchInlineSnapshot(`
         {
           "command": "echo lib-a",
-          "configurations": {},
           "options": {
-            "cwd": "libs/lib-a",
+            "cwd": "{projectRoot}",
           },
         }
       `);
@@ -1594,6 +1594,49 @@ describe('project-configuration-utils', () => {
       ],
     };
 
+    const fakeTargetsPlugin: NxPluginV2 = {
+      name: 'fake-targets-plugin',
+      createNodes: [
+        'libs/*/project.json',
+        (projectJsonPath) => {
+          const root = dirname(projectJsonPath);
+          return {
+            projects: {
+              [root]: {
+                root,
+                targets: {
+                  build: {
+                    executor: 'nx:run-commands',
+                    options: {
+                      command: 'echo {projectName} @ {projectRoot}',
+                    },
+                  },
+                },
+              },
+            },
+          };
+        },
+      ],
+    };
+
+    const sameNamePlugin: NxPluginV2 = {
+      name: 'same-name-plugin',
+      createNodes: [
+        'libs/*/project.json',
+        (projectJsonPath) => {
+          const root = dirname(projectJsonPath);
+          return {
+            projects: {
+              [root]: {
+                root,
+                name: 'same-name',
+              },
+            },
+          };
+        },
+      ],
+    };
+
     it('should create nodes for files matching included patterns only', async () => {
       const projectConfigurations = await createProjectConfigurations(
         undefined,
@@ -1663,6 +1706,72 @@ describe('project-configuration-utils', () => {
         },
       });
     });
+
+    it('should normalize targets', async () => {
+      const { projects } = await createProjectConfigurations(
+        undefined,
+        {},
+        ['libs/a/project.json'],
+        [
+          new LoadedNxPlugin(fakeTargetsPlugin, 'fake-targets-plugin'),
+          new LoadedNxPlugin(fakeTagPlugin, 'fake-tag-plugin'),
+        ]
+      );
+      expect(projects['libs/a'].targets.build).toMatchInlineSnapshot(`
+        {
+          "configurations": {},
+          "executor": "nx:run-commands",
+          "options": {
+            "command": "echo a @ libs/a",
+          },
+        }
+      `);
+    });
+
+    it('should validate that project names are unique', async () => {
+      const error = await createProjectConfigurations(
+        undefined,
+        {},
+        ['libs/a/project.json', 'libs/b/project.json', 'libs/c/project.json'],
+        [new LoadedNxPlugin(sameNamePlugin, 'same-name-plugin')]
+      ).catch((e) => e);
+      const isErrorType = isProjectConfigurationsError(error);
+      expect(isErrorType).toBe(true);
+      if (isErrorType) {
+        expect(error.errors).toMatchInlineSnapshot(`
+          [
+            [MultipleProjectsWithSameNameError: The following projects are defined in multiple locations:
+          - same-name: 
+            - libs/a
+            - libs/b
+            - libs/c
+
+          To fix this, set a unique name for each project in a project.json inside the project's root. If the project does not currently have a project.json, you can create one that contains only a name.],
+          ]
+        `);
+      }
+    });
+
+    it('should validate that projects have a name', async () => {
+      const error = await createProjectConfigurations(
+        undefined,
+        {},
+        ['libs/a/project.json', 'libs/b/project.json', 'libs/c/project.json'],
+        [new LoadedNxPlugin(fakeTargetsPlugin, 'fake-targets-plugin')]
+      ).catch((e) => e);
+      const isErrorType = isProjectConfigurationsError(error);
+      expect(isErrorType).toBe(true);
+      if (isErrorType) {
+        expect(error.errors).toMatchInlineSnapshot(`
+          [
+            [ProjectsWithNoNameError: The projects in the following directories have no name provided:
+            - libs/a
+            - libs/b
+            - libs/c],
+          ]
+        `);
+      }
+    });
   });
 });