fix(core): fix workspace validation for implicitDependencies that are… (

#17825) (cherry picked from commit c0508e3)
nrwl · Jun 28, 2023 · 09f8a8d · 09f8a8d
1 parent 0b57d42
commit 09f8a8d
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 22 deletions.
diff --git a/packages/nx/src/utils/assert-workspace-validity.spec.ts b/packages/nx/src/utils/assert-workspace-validity.spec.ts
@@ -30,17 +30,18 @@ describe('assertWorkspaceValidity', () => {
 
   it('should throw for an invalid project-level implicit dependency', () => {
     mockWorkspaceJson.projects.app2.implicitDependencies = ['invalidproj'];
-
-    try {
-      assertWorkspaceValidity(mockWorkspaceJson, {});
-      fail('should not reach');
-    } catch (e) {
-      expect(e.message).toContain(
-        'The following implicitDependencies point to non-existent project(s)'
-      );
-      expect(e.message).toContain('invalidproj');
-      expect(e.message).toContain('invalidproj');
-    }
+    mockWorkspaceJson.projects.lib1.implicitDependencies = '*';
+
+    expect(() => assertWorkspaceValidity(mockWorkspaceJson, {}))
+      .toThrowErrorMatchingInlineSnapshot(`
+      "Configuration Error
+      The following implicitDependencies should be an array of strings:
+        lib1.implicitDependencies: "*"
+
+      The following implicitDependencies point to non-existent project(s):
+        app2
+          invalidproj"
+    `);
   });
 
   it('should throw for an invalid project-level implicit dependency with glob', () => {

diff --git a/packages/nx/src/utils/assert-workspace-validity.ts b/packages/nx/src/utils/assert-workspace-validity.ts
@@ -38,10 +38,26 @@ export function assertWorkspaceValidity(
     });
   }
 
+  const projectsWithNonArrayImplicitDependencies = new Map<string, unknown>();
+
   projectNames
     .filter((projectName) => {
       const project = projects[projectName];
-      return !!project.implicitDependencies;
+
+      // Report if for whatever reason, a project is configured to use implicitDependencies but it is not an array
+      if (
+        !!project.implicitDependencies &&
+        !Array.isArray(project.implicitDependencies)
+      ) {
+        projectsWithNonArrayImplicitDependencies.set(
+          projectName,
+          project.implicitDependencies
+        );
+      }
+      return (
+        !!project.implicitDependencies &&
+        Array.isArray(project.implicitDependencies)
+      );
     })
     .reduce((map, projectName) => {
       const project = projects[projectName];
@@ -55,19 +71,38 @@ export function assertWorkspaceValidity(
       return map;
     }, invalidImplicitDependencies);
 
-  if (invalidImplicitDependencies.size === 0) {
+  if (
+    projectsWithNonArrayImplicitDependencies.size === 0 &&
+    invalidImplicitDependencies.size === 0
+  ) {
+    // No issues
     return;
   }
 
-  let message = `The following implicitDependencies point to non-existent project(s):\n`;
-  message += [...invalidImplicitDependencies.keys()]
-    .map((key) => {
-      const projectNames = invalidImplicitDependencies.get(key);
-      return `  ${key}\n${projectNames
-        .map((projectName) => `    ${projectName}`)
-        .join('\n')}`;
-    })
-    .join('\n\n');
+  let message = '';
+
+  if (projectsWithNonArrayImplicitDependencies.size > 0) {
+    message += `The following implicitDependencies should be an array of strings:\n`;
+    projectsWithNonArrayImplicitDependencies.forEach(
+      (implicitDependencies, projectName) => {
+        message += `  ${projectName}.implicitDependencies: "${implicitDependencies}"\n`;
+      }
+    );
+    message += '\n';
+  }
+
+  if (invalidImplicitDependencies.size > 0) {
+    message += `The following implicitDependencies point to non-existent project(s):\n`;
+    message += [...invalidImplicitDependencies.keys()]
+      .map((key) => {
+        const projectNames = invalidImplicitDependencies.get(key);
+        return `  ${key}\n${projectNames
+          .map((projectName) => `    ${projectName}`)
+          .join('\n')}`;
+      })
+      .join('\n\n');
+  }
+
   throw new Error(`Configuration Error\n${message}`);
 }