fix(release): ensure dependents that are both direct and transitive are not bumped twice (#28878)

Author: JamesHenry

packages/js/src/generators/release-version/release-version.spec.ts

@@ -1757,6 +1757,139 @@ Valid values are: "auto", "", "~", "^", "="`,
           }
         `);
       });
+
+      it('should not double patch transitive dependents that are already direct dependents', async () => {
+        projectGraph = createWorkspaceWithPackageDependencies(tree, {
+          '@slateui/core': {
+            projectRoot: 'packages/core',
+            packageName: '@slateui/core',
+            version: '1.0.0',
+            packageJsonPath: 'packages/core/package.json',
+            localDependencies: [],
+          },
+          // buttons depends on core
+          '@slateui/buttons': {
+            projectRoot: 'packages/buttons',
+            packageName: '@slateui/buttons',
+            version: '1.0.0',
+            packageJsonPath: 'packages/buttons/package.json',
+            localDependencies: [
+              {
+                projectName: '@slateui/core',
+                dependencyCollection: 'dependencies',
+                version: '1.0.0',
+              },
+            ],
+          },
+          // forms depends on both core and buttons, making it both a direct and transitive dependent of core
+          '@slateui/forms': {
+            projectRoot: 'packages/forms',
+            packageName: '@slateui/forms',
+            version: '1.0.0',
+            packageJsonPath: 'packages/forms/package.json',
+            localDependencies: [
+              {
+                projectName: '@slateui/core',
+                dependencyCollection: 'dependencies',
+                version: '1.0.0',
+              },
+              {
+                projectName: '@slateui/buttons',
+                dependencyCollection: 'dependencies',
+                version: '1.0.0',
+              },
+            ],
+          },
+        });
+
+        expect(
+          await releaseVersionGenerator(tree, {
+            projects: [projectGraph.nodes['@slateui/core']],
+            releaseGroup: createReleaseGroup('independent'),
+            projectGraph,
+            // Bump core to 2.0.0, which will cause buttons and forms to be patched to 1.0.1
+            // This prevents a regression against an issue where forms would end up being patched twice to 1.0.2 in this scenario
+            specifier: '2.0.0',
+            currentVersionResolver: 'disk',
+            specifierSource: 'prompt',
+          })
+        ).toMatchInlineSnapshot(`
+          {
+            "callback": [Function],
+            "data": {
+              "@slateui/buttons": {
+                "currentVersion": "1.0.0",
+                "dependentProjects": [
+                  {
+                    "dependencyCollection": "dependencies",
+                    "rawVersionSpec": "1.0.0",
+                    "source": "@slateui/forms",
+                    "target": "@slateui/buttons",
+                    "type": "static",
+                  },
+                ],
+                "newVersion": "1.0.1",
+              },
+              "@slateui/core": {
+                "currentVersion": "1.0.0",
+                "dependentProjects": [
+                  {
+                    "dependencyCollection": "dependencies",
+                    "rawVersionSpec": "1.0.0",
+                    "source": "@slateui/buttons",
+                    "target": "@slateui/core",
+                    "type": "static",
+                  },
+                  {
+                    "dependencyCollection": "dependencies",
+                    "rawVersionSpec": "1.0.0",
+                    "source": "@slateui/forms",
+                    "target": "@slateui/core",
+                    "type": "static",
+                  },
+                ],
+                "newVersion": "2.0.0",
+              },
+              "@slateui/forms": {
+                "currentVersion": "1.0.0",
+                "dependentProjects": [],
+                "newVersion": "1.0.1",
+              },
+            },
+          }
+        `);
+
+        expect(readJson(tree, 'packages/core/package.json'))
+          .toMatchInlineSnapshot(`
+          {
+            "name": "@slateui/core",
+            "version": "2.0.0",
+          }
+        `);
+
+        expect(readJson(tree, 'packages/buttons/package.json'))
+          .toMatchInlineSnapshot(`
+          {
+            "dependencies": {
+              "@slateui/core": "2.0.0",
+            },
+            "name": "@slateui/buttons",
+            "version": "1.0.1",
+          }
+        `);
+
+        expect(readJson(tree, 'packages/forms/package.json'))
+          .toMatchInlineSnapshot(`
+          {
+            "dependencies": {
+              "@slateui/buttons": "1.0.1",
+              "@slateui/core": "2.0.0",
+            },
+            "name": "@slateui/forms",
+            "version": "1.0.1",
+          }
+        `);
+      });
     });
   });
 

packages/js/src/generators/release-version/release-version.ts

@@ -735,7 +735,13 @@ To fix this you will either need to add a package.json file at that location, or
           updateDependents === 'auto' &&
           options.releaseGroup.projectsRelationship === 'independent'
             ? allDependentProjects.length +
-              transitiveLocalPackageDependents.length -
+              // Only count transitive dependents that aren't already direct dependents
+              transitiveLocalPackageDependents.filter(
+                (transitive) =>
+                  !allDependentProjects.some(
+                    (direct) => direct.source === transitive.source
+                  )
+              ).length -
               // There are two entries per circular dep
               circularDependencies.size / 2
             : dependentProjectsInCurrentBatch.length;
@@ -895,6 +901,39 @@ To fix this you will either need to add a package.json file at that location, or
         }
       }
       for (const transitiveDependentProject of transitiveLocalPackageDependents) {
+        const isAlreadyDirectDependent = allDependentProjects.some(
+          (dep) => dep.source === transitiveDependentProject.source
+        );
+        if (isAlreadyDirectDependent) {
+          // Don't continue directly in this scenario - we still need to update the dependency version
+          // but we don't want to bump the project's own version as it will end up being double patched
+          const dependencyProjectName = transitiveDependentProject.target;
+          const dependencyPackageRoot = projectNameToPackageRootMap.get(
+            dependencyProjectName
+          );
+          if (!dependencyPackageRoot) {
+            throw new Error(
+              `The project "${dependencyProjectName}" does not have a packageRoot available. Please report this issue on https://github.com/nrwl/nx`
+            );
+          }
+          const dependencyPackageJsonPath = joinPathFragments(
+            dependencyPackageRoot,
+            'package.json'
+          );
+          const dependencyPackageJson = readJson(
+            tree,
+            dependencyPackageJsonPath
+          );
+
+          updateDependentProjectAndAddToVersionData({
+            dependentProject: transitiveDependentProject,
+            dependencyPackageName: dependencyPackageJson.name,
+            newDependencyVersion: dependencyPackageJson.version,
+            forceVersionBump: false, // Never bump version for direct dependents
+          });
+          continue;
+        }
+
         // Check if the transitive dependent originates from a circular dependency
         const isFromCircularDependency = circularDependencies.has(
           `${transitiveDependentProject.source}:${transitiveDependentProject.target}`