perf(tools): make dependency-mismatch execution 90% faster and ignore */>=9.0.0-alpha versions

scripts/beachball/shared.config.ts

@@ -24,7 +24,7 @@ export const config: typeof baseConfig & Required<Pick<BeachballConfig, 'changel
  const generators = [
  // Fixes any dependency mismatches caused by beachball scoping
  'dependency-mismatch',
- // Fixes unwanted pre-release dependency bumps caused by beachball - This needs to run last otherwise deps within apps will contain exact versions ( which dependency-mismatch generator update - TODO we need to fix it)
+ // Fixes unwanted pre-release dependency bumps caused by beachball
  'normalize-package-dependencies',
  ];
 

tools/generators/dependency-mismatch/index.spec.ts

@@ -13,6 +13,42 @@ describe('dependency-mismatch generator', () => {
  workspaceNpmScope = readNxJson(tree)?.npmScope as string;
  });
 
+ it(`should ignore dependencies that use * and >=9.0.0-alpha version range`, async () => {
+ const { readPackageJson: readTargetPackageJson } = setupDummyPackage(tree, {
+ name: 'public-docsite-v9',
+ version: '9.0.0',
+ dependencies: {
+ [`@${workspaceNpmScope}/react-one`]: '*',
+ [`@${workspaceNpmScope}/react-two`]: '>=9.0.0-alpha',
+ },
+ devDependencies: {},
+ peerDependencies: {},
+ });
+
+ setupDummyPackage(tree, {
+ name: 'react-one',
+ version: '0.2.33',
+ dependencies: {},
+ devDependencies: {},
+ peerDependencies: {},
+ });
+ setupDummyPackage(tree, {
+ name: 'react-two',
+ version: '0.1.12',
+ dependencies: {},
+ devDependencies: {},
+ peerDependencies: {},
+ });
+
+ await generator(tree);
+
+ const packageJson = readTargetPackageJson();
+ expect(packageJson.dependencies).toEqual({
+ '@proj/react-one': '*',
+ '@proj/react-two': '>=9.0.0-alpha',
+ });
+ });
+
  it('should fix dependency mismatch', async () => {
  const { readPackageJson: readTargetPackageJson } = setupDummyPackage(tree, {
  name: 'public-docsite-v9',

tools/generators/dependency-mismatch/index.ts

@@ -1,34 +1,18 @@
 import * as semver from 'semver';
-import { Tree, formatFiles, updateJson, readJson, readProjectConfiguration } from '@nrwl/devkit';
+import { Tree, formatFiles, updateJson, readJson, ProjectConfiguration, getProjects } from '@nrwl/devkit';
 
-import { getProjectConfig, getProjects, isPackageVersionPrerelease } from '../../utils';
+import { getProjectPaths, isPackageVersionPrerelease } from '../../utils';
 import type { PackageJson } from '../../types';
 
 export default async function (tree: Tree) {
  const projects = getProjects(tree);
 
- projects.forEach((_project, projectName) => {
- const config = getProjectConfig(tree, { packageName: projectName });
- const scope = getProjectScope(config);
+ projects.forEach(project => {
+ const projectPaths = getProjectPaths(project);
+ const scope = getProjectScope(project);
 
- updateJson(tree, config.paths.packageJson, (packageJson: PackageJson) => {
- if (packageJson.dependencies) {
- packageJson.dependencies = getUpdatedDependencies(tree, { dependencies: packageJson.dependencies, scope });
- }
-
- if (packageJson.devDependencies) {
- packageJson.devDependencies = getUpdatedDependencies(tree, {
- dependencies: packageJson.devDependencies,
- scope,
- });
- }
-
- if (packageJson.peerDependencies) {
- packageJson.peerDependencies = getUpdatedDependencies(tree, {
- dependencies: packageJson.peerDependencies,
- scope,
- });
- }
+ updateJson<PackageJson>(tree, projectPaths.packageJson, packageJson => {
+ updatedDependencies(tree, { allProjects: projects, packageJson, scope });
 
  return packageJson;
  });
@@ -37,56 +21,80 @@ export default async function (tree: Tree) {
  await formatFiles(tree);
 }
 
-function isProjectInWorkspace(tree: Tree, projectName: string) {
+function ensureIsInWorkspace(tree: Tree, projectName: string, allProjects: ReturnType<typeof getProjects>) {
  try {
- readProjectConfiguration(tree, projectName);
-
- return true;
- } catch (err: unknown) {
- return false;
+ return allProjects.get(projectName);
+ } catch {
+ return null;
  }
 }
 
-function getUpdatedDependencies(
+function updatedDependencies(
  tree: Tree,
- options: { dependencies: Record<string, string>; scope: ReturnType<typeof getProjectScope> },
+ options: {
+ allProjects: ReturnType<typeof getProjects>;
+ packageJson: PackageJson;
+ scope: ReturnType<typeof getProjectScope>;
+ },
 ) {
- const { dependencies, scope } = options;
- return Object.entries(dependencies).reduce((acc, [dependencyName, versionRange]) => {
- if (versionRange === '*') {
- return acc;
- }
+ const { packageJson, scope, allProjects } = options;
 
- if (!isProjectInWorkspace(tree, dependencyName)) {
- return acc;
- }
+ updateVersions(packageJson, 'dependencies');
+ updateVersions(packageJson, 'devDependencies');
+ updateVersions(packageJson, 'peerDependencies');
+
+ return packageJson;
 
- const minVersion = semver.minVersion(versionRange);
+ function updateVersions(json: PackageJson, depType: 'dependencies' | 'devDependencies' | 'peerDependencies') {
+ const ignoredVersionRanges = ['*', '>=9.0.0-alpha'];
 
- if (!minVersion) {
- return acc;
+ const deps = json[depType];
+ if (!deps) {
+ return;
  }
 
- const depPackageConfig = getProjectConfig(tree, { packageName: dependencyName });
- const depScope = getProjectScope(depPackageConfig);
+ for (const dependencyName in deps) {
+ if (!Object.prototype.hasOwnProperty.call(deps, dependencyName)) {
+ continue;
+ }
 
- const isNorthstarUnsupportedDepBump = scope.isReactNorthstarPackage && !depScope.isReactComponentsPackage;
- if (isNorthstarUnsupportedDepBump) {
- return acc;
- }
+  const versionRange = deps[dependencyName];
+  if (ignoredVersionRanges.indexOf(versionRange) !== -1) {
+  continue;
+  }
 
- const shouldHaveCaret = !isPackageVersionPrerelease(minVersion.raw) || versionRange[0] === '^';
+  const dependencyProjectConfig = ensureIsInWorkspace(tree, dependencyName, allProjects);
 
- acc[dependencyName] = `${shouldHaveCaret ? '^' : ''}${
- readJson<PackageJson>(tree, depPackageConfig.paths.packageJson).version
- }`;
+ if (!dependencyProjectConfig) {
+ continue;
+ }
+
+ const minVersion = semver.minVersion(versionRange);
+
+ if (!minVersion) {
+ continue;
+ }
+
+ const depPackagePaths = getProjectPaths(dependencyProjectConfig);
+ const depScope = getProjectScope(dependencyProjectConfig);
 
- return acc;
- }, dependencies);
+ const isNorthstarUnsupportedDepBump = scope.isReactNorthstarPackage && !depScope.isReactComponentsPackage;
+ if (isNorthstarUnsupportedDepBump) {
+ continue;
+ }
+
+ const shouldHaveCaret = !isPackageVersionPrerelease(minVersion.raw) || versionRange[0] === '^';
+ const depPackageJson = readJson<PackageJson>(tree, depPackagePaths.packageJson);
+
+ deps[dependencyName] = `${shouldHaveCaret ? '^' : ''}${depPackageJson.version}`;
+ }
+
+ return deps;
+ }
 }
 
-function getProjectScope(project: ReturnType<typeof getProjectConfig>) {
- const tags = project.projectConfig.tags ?? [];
+function getProjectScope(project: ProjectConfiguration) {
+ const tags = project.tags ?? [];
  const isReactPackage = tags.includes('v8');
  const isReactNorthstarPackage = tags.includes('react-northstar');
  const isReactComponentsPackage = tags.includes('vNext');

tools/utils.ts

@@ -85,6 +85,20 @@ export { updateJestConfig } from '@nrwl/jest/src/generators/jest-project/lib/upd
 export function getProjectConfig(tree: Tree, options: { packageName: string }) {
  const projectConfig = readProjectConfiguration(tree, options.packageName);
  const workspaceConfig = readNxJson(tree) ?? {};
+ const paths = getProjectPaths(projectConfig);
+
+ return {
+ projectConfig,
+ workspaceConfig,
+ /**
+ * package name without npmScope (@scopeName)
+ */
+ normalizedPkgName: options.packageName.replace(`@${workspaceConfig.npmScope}/`, ''),
+ paths,
+ };
+}
+
+export function getProjectPaths(projectConfig: ProjectConfiguration) {
  const paths = {
  configRoot: joinPathFragments(projectConfig.root, 'config'),
  packageJson: joinPathFragments(projectConfig.root, 'package.json'),
@@ -120,15 +134,7 @@ export function getProjectConfig(tree: Tree, options: { packageName: string }) {
  },
  };
 
- return {
- projectConfig,
- workspaceConfig,
- /**
- * package name without npmScope (@scopeName)
- */
- normalizedPkgName: options.packageName.replace(`@${workspaceConfig.npmScope}/`, ''),
- paths,
- };
+ return paths;
 }
 
 export const workspacePaths = {