Support catalog versions (#1128)

Author: ecraig12345

change/beachball-f8093666-92cd-40ff-a1ec-4adae794e0a2.json

@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "Support catalog versions",
+  "packageName": "beachball",
+  "email": "elcraig@microsoft.com",
+  "dependentChangeType": "patch"
+}

package.json

@@ -60,7 +60,7 @@
     "prompts": "^2.4.2",
     "semver": "^7.0.0",
     "toposort": "^2.0.2",
-    "workspace-tools": "^0.40.0",
+    "workspace-tools": "^0.40.2",
     "yargs-parser": "^21.0.0"
   },
   "devDependencies": {

src/__e2e__/bump.test.ts

@@ -17,6 +17,7 @@ import { createCommandContext } from '../monorepo/createCommandContext';
 import type { CommandContext } from '../types/CommandContext';
 import type { BumpInfo } from '../types/BumpInfo';
 import { deepFreeze } from '../__fixtures__/object';
+import { catalogsToYaml, type Catalogs } from 'workspace-tools';
 
 //
 // These tests use git repos and are slow, so besides a few basic scenarios, this file should
@@ -446,10 +447,11 @@ describe('bump command', () => {
   it('bumps dependents with workspace: deps', async () => {
     const monorepo: RepoFixture['folders'] = {
       packages: {
-        'pkg-1': { version: '1.0.0' },
+        // Include some external deps to make sure nothing weird happens there
+        'pkg-1': { version: '1.0.0', dependencies: { extra: '~1.2.3' } },
         'pkg-2': { version: '1.0.0', dependencies: { 'pkg-1': 'workspace:~' } },
         // this workspace version will be updated
-        'pkg-3': { version: '1.0.0', dependencies: { 'pkg-2': 'workspace:^1.0.0' } },
+        'pkg-3': { version: '1.0.0', dependencies: { 'pkg-2': 'workspace:^1.0.0', other: 'npm:lodash' } },
       },
     };
     repositoryFactory = new RepositoryFactory({ folders: monorepo });
@@ -467,12 +469,15 @@ describe('bump command', () => {
     const packageInfos = getPackageInfos(parsedOptions);
 
     // All the dependent packages are bumped despite the workspace: dep specs
-    expect(packageInfos['pkg-1'].version).toBe('1.1.0');
+    expect(packageInfos['pkg-1']).toEqual({ ...originalPackageInfos['pkg-1'], version: '1.1.0' });
     // workspace:~ range isn't changed
     expect(packageInfos['pkg-2']).toEqual({ ...originalPackageInfos['pkg-2'], version: '1.0.1' });
-    expect(packageInfos['pkg-2'].version).toBe('1.0.1');
     // workspace: range with number is updated
-    expect(packageInfos['pkg-3'].dependencies).toEqual({ 'pkg-2': 'workspace:^1.0.1' });
+    expect(packageInfos['pkg-3']).toEqual({
+      ...originalPackageInfos['pkg-3'],
+      version: '1.0.1',
+      dependencies: { 'pkg-2': 'workspace:^1.0.1', other: 'npm:lodash' },
+    });
 
     expect(readChangelogJson(repo.pathTo('packages/pkg-1'))).not.toBeNull();
     const pkg3Changelog = readChangelogJson(repo.pathTo('packages/pkg-3'));
@@ -485,6 +490,48 @@ describe('bump command', () => {
     expect(readChangelogJson(repo.pathTo('packages/pkg-2'))).toBeNull();
   });
 
+  it('bumps dependents with catalog: deps', async () => {
+    const monorepo: RepoFixture['folders'] = {
+      packages: {
+        'pkg-1': { version: '1.0.0' },
+        'pkg-2': { version: '1.0.0', dependencies: { 'pkg-1': 'catalog:' } },
+        'pkg-3': { version: '1.0.0', dependencies: { 'pkg-2': 'catalog:' } },
+      },
+    };
+    const catalogs: Catalogs = {
+      default: { 'pkg-1': 'workspace:~', 'pkg-2': 'workspace:^1.0.0' },
+    };
+    repositoryFactory = new RepositoryFactory({
+      folders: monorepo,
+      // This isn't currently read by bump() but should be present for completeness
+      extraFiles: { '.yarnrc.yml': catalogsToYaml(catalogs) },
+    });
+    repo = repositoryFactory.cloneRepository();
+
+    const { options, parsedOptions } = getOptions({
+      bumpDeps: true,
+    });
+    generateChangeFiles([{ packageName: 'pkg-1', type: 'minor' }], options);
+    repo.push();
+
+    // The bumpInfo object is covered by the similar test in bumpInMemory.test.ts
+    const { originalPackageInfos } = await bumpWrapper(parsedOptions);
+
+    const packageInfos = getPackageInfos(parsedOptions);
+
+    // All the dependent packages are bumped despite the catalog: dep specs
+    expect(packageInfos['pkg-1'].version).toBe('1.1.0');
+    // catalog: ranges aren't changed
+    expect(packageInfos['pkg-2']).toEqual({ ...originalPackageInfos['pkg-2'], version: '1.0.1' });
+    expect(packageInfos['pkg-3']).toEqual({ ...originalPackageInfos['pkg-3'], version: '1.0.1' });
+
+    expect(readChangelogJson(repo.pathTo('packages/pkg-1'))).not.toBeNull();
+    // Current behavior: dependentChangedBy misses catalog: deps, so there are no changelog entries
+    // https://github.com/microsoft/beachball/issues/981
+    expect(readChangelogJson(repo.pathTo('packages/pkg-2'))).toBeNull();
+    expect(readChangelogJson(repo.pathTo('packages/pkg-3'))).toBeNull();
+  });
+
   // Explicit tests for sync/async hooks aren't necessary, especially since these are slow tests.
   // Async is slightly trickier, so test that.
   it('calls prebump/postbump hooks', async () => {

src/__e2e__/publishE2E.test.ts

@@ -1,12 +1,12 @@
 import { describe, expect, it, afterEach, jest } from '@jest/globals';
 import fs from 'fs';
 import path from 'path';
-import { addGitObserver, clearGitObservers } from 'workspace-tools';
+import { addGitObserver, catalogsToYaml, clearGitObservers, type Catalogs } from 'workspace-tools';
 import { generateChangeFiles, getChangeFiles } from '../__fixtures__/changeFiles';
 import { defaultBranchName, defaultRemoteBranchName } from '../__fixtures__/gitDefaults';
 import { initMockLogs } from '../__fixtures__/mockLogs';
 import type { Repository } from '../__fixtures__/repository';
-import { type PackageJsonFixture, RepositoryFactory } from '../__fixtures__/repositoryFactory';
+import { type PackageJsonFixture, type RepoFixture, RepositoryFactory } from '../__fixtures__/repositoryFactory';
 import { publish } from '../commands/publish';
 import type { ParsedOptions, RepoOptions } from '../types/BeachballOptions';
 import { _mockNpmPublish, initNpmMock } from '../__fixtures__/mockNpm';
@@ -62,6 +62,7 @@ describe('publish command (e2e)', () => {
     deepFreezeProperties(context.bumpInfo);
     deepFreezeProperties(context.originalPackageInfos);
     await publish(parsedOptions.options, context);
+    return context;
   }
 
   afterEach(() => {
@@ -334,6 +335,77 @@ describe('publish command (e2e)', () => {
     expect(newPackageInfos.foo.version).toBe('1.0.0');
   });
 
+  // Combine workspace/catalog/file cases since these tests are slow
+  it('publishes packages with workspace: and catalog: deps and replaces versions', async () => {
+    const monorepo: RepoFixture['folders'] = {
+      packages: {
+        // Include some external deps to make sure nothing weird happens there
+        'pkg-1': { version: '1.0.0', dependencies: { extra: '~1.2.3' } },
+        'pkg-2': { version: '1.0.0', dependencies: { 'pkg-1': 'workspace:~', react: 'catalog:react18' } },
+        'pkg-3': { version: '1.0.0', dependencies: { 'pkg-2': 'workspace:^1.0.0', other: 'npm:lodash' } },
+        'pkg-4': {
+          version: '1.0.0',
+          dependencies: { 'pkg-1': 'catalog:' },
+          devDependencies: { 'pkg-2': 'file:../pkg-2' },
+        },
+      },
+    };
+    const catalogs: Catalogs = {
+      default: { 'pkg-1': 'workspace:~' }, // only yarn supports workspace: inside catalog
+      named: { react18: { react: '^18.0.0' } },
+    };
+    repositoryFactory = new RepositoryFactory({
+      folders: monorepo,
+      extraFiles: { '.yarnrc.yml': catalogsToYaml(catalogs) },
+    });
+    repo = repositoryFactory.cloneRepository();
+
+    const { options, parsedOptions } = getOptions({ bumpDeps: true, fetch: false });
+    generateChangeFiles([{ packageName: 'pkg-1', type: 'minor' }], options);
+    repo.push();
+
+    const { originalPackageInfos } = await publishWrapper(parsedOptions);
+    repo.checkout(defaultBranchName);
+    repo.pull();
+
+    expect(repo.getCurrentTags()).toEqual(['pkg-1_v1.1.0', 'pkg-2_v1.0.1', 'pkg-3_v1.0.1', 'pkg-4_v1.0.1']);
+
+    // All the dependent packages are bumped despite the workspace: dep specs.
+    // The literal workspace: specs are preserved in git.
+    const packageInfos = getPackageInfos(parsedOptions);
+    expect(packageInfos['pkg-1']).toEqual({ ...originalPackageInfos['pkg-1'], version: '1.1.0' });
+    // workspace:~ and catalog: ranges aren't changed
+    expect(packageInfos['pkg-2']).toEqual({ ...originalPackageInfos['pkg-2'], version: '1.0.1' });
+    expect(packageInfos['pkg-2'].version).toBe('1.0.1');
+    // workspace: range with number is updated
+    expect(packageInfos['pkg-3']).toEqual({
+      ...originalPackageInfos['pkg-3'],
+      version: '1.0.1',
+      dependencies: { 'pkg-2': 'workspace:^1.0.1', other: 'npm:lodash' },
+    });
+    // catalog: range isn't changed
+    expect(packageInfos['pkg-4']).toEqual({ ...originalPackageInfos['pkg-4'], version: '1.0.1' });
+
+    // The changelogs are adequately covered by the similar bump test.
+
+    // Verify that the published packages have the actual resolved versions
+    expect(npmMock.getPublishedPackage('pkg-1')).toMatchObject({ version: '1.1.0' });
+    expect(npmMock.getPublishedPackage('pkg-2')).toMatchObject({
+      version: '1.0.1',
+      dependencies: { 'pkg-1': '~1.1.0', react: '^18.0.0' },
+    });
+    expect(npmMock.getPublishedPackage('pkg-3')).toMatchObject({
+      version: '1.0.1',
+      dependencies: { 'pkg-2': '^1.0.1', other: 'npm:lodash' },
+    });
+    expect(npmMock.getPublishedPackage('pkg-4')).toMatchObject({
+      version: '1.0.1',
+      dependencies: { 'pkg-1': '~1.1.0' },
+      // file: deps aren't currently replaced (definitely fine for dev deps, questionable for prod)
+      devDependencies: { 'pkg-2': 'file:../pkg-2' },
+    });
+  });
+
   // These tests are slow, so combine pre and post hooks
   it('respects prepublish/postpublish hooks', async () => {
     repositoryFactory = new RepositoryFactory('monorepo');
@@ -499,6 +571,7 @@ describe('publish command (e2e)', () => {
   });
 
   // Just test postpublish (prepublish should have the same logic)
+  // TODO: possibly move to in-memory test
   it('respects concurrency limit for publish hooks', async () => {
     const packagesToPublish = ['pkg1', 'pkg2', 'pkg3', 'pkg4'];
     type ExtraPackageJsonFixture = PackageJsonFixture & { customAfterPublish?: { notify: string } };

src/__fixtures__/repository.ts

@@ -187,7 +187,7 @@ ${gitResult.stderr.toString()}`);
     return result.stdout.trim();
   }
 
-  /** Get tags pointing to the current HEAD commit */
+  /** Get sorted list of tags pointing to the current HEAD commit */
   getCurrentTags(): string[] {
     const tagsResult = this.git(['tag', '--points-at', 'HEAD']);
     const trimmedResult = tagsResult.stdout.trim();

src/__fixtures__/repositoryFactory.ts

@@ -51,6 +51,12 @@ export type RepoFixture = {
 
   /** Description to include in the temp folder name */
   tempDescription?: string;
+
+  /**
+   * Mapping from extra file relative path to contents.
+   * (A `yarn.lock` file is written automatically.)
+   */
+  extraFiles?: Record<string, string>;
 };
 
 /** Repo fixture with all required props filled out */
@@ -233,6 +239,14 @@ export class RepositoryFactory {
           writeJson(path.join(pkgFolder, 'package.json'), packageJson);
         }
       }
+
+      if (fixture.extraFiles) {
+        for (const [relativePath, contents] of Object.entries(fixture.extraFiles)) {
+          const fullPath = tmpRepo.pathTo(parentFolder, relativePath);
+          fs.mkdirSync(path.dirname(fullPath), { recursive: true });
+          fs.writeFileSync(fullPath, contents);
+        }
+      }
     }
     tmpRepo.commitAll(`committing fixture`);
 

src/__tests__/bump/bumpInMemory.test.ts

@@ -289,9 +289,9 @@ describe('bumpInMemory', () => {
     const { bumpInfo, originalPackageInfos } = gatherBumpInfoWrapper({
       packageFolders: {
         'pkg-1': { version: '1.0.0' },
-        'pkg-2': { version: '1.0.0', dependencies: { 'pkg-1': 'workspace:~' } },
+        'pkg-2': { version: '1.0.0', dependencies: { 'pkg-1': 'workspace:~', extra: '~1.2.3' } },
         // this workspace version will be updated
-        'pkg-3': { version: '1.0.0', dependencies: { 'pkg-2': 'workspace:^1.0.0' } },
+        'pkg-3': { version: '1.0.0', dependencies: { 'pkg-2': 'workspace:^1.0.0', other: 'npm:lodash' } },
       },
       repoOptions: { bumpDeps: true },
       changes: ['pkg-1'],
@@ -312,9 +312,41 @@ describe('bumpInMemory', () => {
     expect(packageInfos['pkg-1'].version).toBe('1.1.0');
     // workspace:~ range isn't changed
     expect(packageInfos['pkg-2']).toEqual({ ...originalPackageInfos['pkg-2'], version: '1.0.1' });
-    expect(packageInfos['pkg-2'].version).toBe('1.0.1');
     // workspace: range with number is updated
-    expect(packageInfos['pkg-3'].dependencies).toEqual({ 'pkg-2': 'workspace:^1.0.1' });
+    expect(packageInfos['pkg-3'].dependencies).toEqual({ 'pkg-2': 'workspace:^1.0.1', other: 'npm:lodash' });
+  });
+
+  it('bumps dependents with catalog: deps', () => {
+    const { bumpInfo, originalPackageInfos } = gatherBumpInfoWrapper({
+      // Say there's a catalog like this:
+      // catalog:
+      //   pkg-1: workspace:~
+      //   pkg-2: workspace:^1.0.0
+      packageFolders: {
+        'pkg-1': { version: '1.0.0' },
+        // both of these are detected as dependent bumps but currently missed from changelog
+        'pkg-2': { version: '1.0.0', dependencies: { 'pkg-1': 'catalog:' } },
+        'pkg-3': { version: '1.0.0', dependencies: { 'pkg-2': 'catalog:' } },
+      },
+      repoOptions: { bumpDeps: true },
+      changes: ['pkg-1'],
+    });
+
+    const { packageInfos, modifiedPackages, calculatedChangeTypes, dependentChangedBy } = bumpInfo;
+    expect(modifiedPackages).toEqual(new Set(['pkg-1', 'pkg-2', 'pkg-3']));
+    expect(calculatedChangeTypes).toEqual({ 'pkg-1': 'minor', 'pkg-2': 'patch', 'pkg-3': 'patch' });
+    expect(dependentChangedBy).toEqual({
+      // Current behavior: dependentChangedBy misses all catalog: deps pointing to workspace: versions
+      // https://github.com/microsoft/beachball/issues/981
+      // 'pkg-2': new Set(['pkg-1']),
+      // 'pkg-3': new Set(['pkg-2']),
+    });
+
+    // All the dependent packages are bumped despite the catalog: dep specs
+    expect(packageInfos['pkg-1'].version).toBe('1.1.0');
+    // catalog: ranges aren't changed
+    expect(packageInfos['pkg-2']).toEqual({ ...originalPackageInfos['pkg-2'], version: '1.0.1' });
+    expect(packageInfos['pkg-3']).toEqual({ ...originalPackageInfos['pkg-3'], version: '1.0.1' });
   });
 
   it('bumps to prerelease using prefix, and uses prerelease version for dependents', () => {

src/__tests__/bump/bumpMinSemverRange.test.ts

@@ -3,74 +3,74 @@ import { bumpMinSemverRange } from '../../bump/bumpMinSemverRange';
 
 describe('bumpMinSemverRange', () => {
   it('preserves *', () => {
-    const result = bumpMinSemverRange('1.0.0', '*');
+    const result = bumpMinSemverRange({ newVersion: '1.0.0', currentRange: '*' });
     expect(result).toBe('*');
   });
 
   it('preserves file: protocol with relative path', () => {
-    const result = bumpMinSemverRange('1.0.0', 'file:../local-package');
+    const result = bumpMinSemverRange({ newVersion: '1.0.0', currentRange: 'file:../local-package' });
     expect(result).toBe('file:../local-package');
   });
 
   it('preserves file: protocol with absolute path', () => {
-    const result = bumpMinSemverRange('1.0.0', 'file:/absolute/path/to/package');
+    const result = bumpMinSemverRange({ newVersion: '1.0.0', currentRange: 'file:/absolute/path/to/package' });
     expect(result).toBe('file:/absolute/path/to/package');
   });
 
   it('preserves catalog: protocol', () => {
-    let result = bumpMinSemverRange('1.0.0', 'catalog:');
+    let result = bumpMinSemverRange({ newVersion: '1.0.0', currentRange: 'catalog:' });
     expect(result).toBe('catalog:');
-    result = bumpMinSemverRange('1.0.0', 'catalog:foo');
+    result = bumpMinSemverRange({ newVersion: '1.0.0', currentRange: 'catalog:foo' });
     expect(result).toBe('catalog:foo');
   });
 
   it.each(['~', '^'])('preserves %s and bumps to new version', prefix => {
-    const result = bumpMinSemverRange('1.3.0', `${prefix}1.2.0`);
+    const result = bumpMinSemverRange({ newVersion: '1.3.0', currentRange: `${prefix}1.2.0` });
     expect(result).toBe(`${prefix}1.3.0`);
   });
 
   it('returns range from new version to next major with >=', () => {
-    const result = bumpMinSemverRange('1.3.0', '>=1.2.0 <2.0.0');
+    const result = bumpMinSemverRange({ newVersion: '1.3.0', currentRange: '>=1.2.0 <2.0.0' });
     expect(result).toBe('>=1.3.0 <2.0.0');
   });
 
   it('returns range from new version to next major with >', () => {
-    const result = bumpMinSemverRange('1.3.0', '>1.2.0 <2.0.0');
+    const result = bumpMinSemverRange({ newVersion: '1.3.0', currentRange: '>1.2.0 <2.0.0' });
     expect(result).toBe('>=1.3.0 <2.0.0');
   });
 
   it('returns range from new version to next major with -', () => {
-    const result = bumpMinSemverRange('1.3.0', '1.2.0 - 2.0.0');
+    const result = bumpMinSemverRange({ newVersion: '1.3.0', currentRange: '1.2.0 - 2.0.0' });
     expect(result).toBe('1.3.0 - 2.0.0');
   });
 
   it.each(['workspace:*', 'workspace:~', 'workspace:^'])('preserves %s', workspaceVersion => {
-    const result = bumpMinSemverRange('1.3.0', workspaceVersion);
+    const result = bumpMinSemverRange({ newVersion: '1.3.0', currentRange: workspaceVersion });
     expect(result).toBe(workspaceVersion);
   });
 
   it('bumps workspace:~x.y.z to workspace range with new version', () => {
-    const result = bumpMinSemverRange('1.2.1', 'workspace:~1.2.0');
+    const result = bumpMinSemverRange({ newVersion: '1.2.1', currentRange: 'workspace:~1.2.0' });
     expect(result).toBe('workspace:~1.2.1');
   });
 
   it('bumps workspace:^x.y.z to workspace range with new version', () => {
-    const result = bumpMinSemverRange('1.3.0', 'workspace:^1.2.0');
+    const result = bumpMinSemverRange({ newVersion: '1.3.0', currentRange: 'workspace:^1.2.0' });
     expect(result).toBe('workspace:^1.3.0');
   });
 
   it('uses the new version for exact version match', () => {
-    const result = bumpMinSemverRange('1.3.0', '1.2.0');
+    const result = bumpMinSemverRange({ newVersion: '1.3.0', currentRange: '1.2.0' });
     expect(result).toBe('1.3.0');
   });
 
   it('uses the new version if unknown non-semver format', () => {
-    const result = bumpMinSemverRange('1.3.0', '#1.2.0');
+    const result = bumpMinSemverRange({ newVersion: '1.3.0', currentRange: '#1.2.0' });
     expect(result).toBe('1.3.0');
   });
 
   it('preserves unrecognized range if new version satisfies it', () => {
-    const result = bumpMinSemverRange('1.3.0', '1');
+    const result = bumpMinSemverRange({ newVersion: '1.3.0', currentRange: '1' });
     expect(result).toBe('1');
   });
 });