Warn user if root package tag fallback is used

Author: mcmire

src/fs.ts

@@ -5,6 +5,12 @@ import {
 } from '@metamask/action-utils';
 import { wrapError, isErrorWithCode } from './misc-utils';
 
+/**
+ * Represents a writeable stream, such as that represented by `process.stdout`
+ * or `process.stderr`, or a fake one provided in tests.
+ */
+export type WriteStreamLike = Pick<fs.WriteStream, 'write'>;
+
 /**
  * Reads the file at the given path, assuming its content is encoded as UTF-8.
  *

src/package.test.ts

@@ -3,11 +3,13 @@ import path from 'path';
 import { when } from 'jest-when';
 import * as autoChangelog from '@metamask/auto-changelog';
 import { SemVer } from 'semver';
+import { MockWritable } from 'stdio-mock';
 import { withSandbox } from '../tests/helpers';
 import {
   buildMockPackage,
   buildMockProject,
   buildMockManifest,
+  createNoopWriteStream,
 } from '../tests/unit/helpers';
 import {
   readMonorepoRootPackage,
@@ -67,34 +69,31 @@ describe('package', () => {
       });
     });
 
-    it('throws if a tag matching the current version does not exist', async () => {
+    it("flags the package as having been changed since its latest release if a tag matching the current version exists and changes have been made to the package's directory since the tag", async () => {
       jest
         .spyOn(packageManifestModule, 'readPackageManifest')
         .mockResolvedValue({
           unvalidated: {},
           validated: buildMockManifest({
-            name: 'some-package',
             version: new SemVer('1.0.0'),
           }),
         });
       when(jest.spyOn(repoModule, 'hasChangesInDirectorySinceGitTag'))
         .calledWith('/path/to/project', '/path/to/package', 'v1.0.0')
         .mockResolvedValue(true);
 
-      const promiseForPkg = readMonorepoRootPackage({
+      const pkg = await readMonorepoRootPackage({
         packageDirectoryPath: '/path/to/package',
         projectDirectoryPath: '/path/to/project',
-        projectTagNames: ['some-tag'],
+        projectTagNames: ['v1.0.0'],
       });
 
-      await expect(promiseForPkg).rejects.toThrow(
-        new Error(
-          'The package some-package has no Git tag for its current version 1.0.0 (expected "v1.0.0"), so this tool is unable to determine whether it should be included in this release. You will need to create a tag for this package in order to proceed.',
-        ),
-      );
+      expect(pkg).toMatchObject({
+        hasChangesSinceLatestRelease: true,
+      });
     });
 
-    it("flags the package as having been changed since its latest release if a tag matching the current version exists and changes have been made to the package's directory since the tag", async () => {
+    it("does not flag the package as having been changed since its latest release if a tag matching the current version exists, but changes have not been made to the package's directory since the tag", async () => {
       jest
         .spyOn(packageManifestModule, 'readPackageManifest')
         .mockResolvedValue({
@@ -105,7 +104,7 @@ describe('package', () => {
         });
       when(jest.spyOn(repoModule, 'hasChangesInDirectorySinceGitTag'))
         .calledWith('/path/to/project', '/path/to/package', 'v1.0.0')
-        .mockResolvedValue(true);
+        .mockResolvedValue(false);
 
       const pkg = await readMonorepoRootPackage({
         packageDirectoryPath: '/path/to/package',
@@ -114,11 +113,11 @@ describe('package', () => {
       });
 
       expect(pkg).toMatchObject({
-        hasChangesSinceLatestRelease: true,
+        hasChangesSinceLatestRelease: false,
       });
     });
 
-    it("does not flag the package as having been changed since its latest release if a tag matching the current version exists, but changes have not been made to the package's directory since the tag", async () => {
+    it('flags the package as having been changed since its latest release if a tag matching the current version does not exist', async () => {
       jest
         .spyOn(packageManifestModule, 'readPackageManifest')
         .mockResolvedValue({
@@ -127,45 +126,49 @@ describe('package', () => {
             version: new SemVer('1.0.0'),
           }),
         });
-      when(jest.spyOn(repoModule, 'hasChangesInDirectorySinceGitTag'))
-        .calledWith('/path/to/project', '/path/to/package', 'v1.0.0')
-        .mockResolvedValue(false);
 
       const pkg = await readMonorepoRootPackage({
         packageDirectoryPath: '/path/to/package',
         projectDirectoryPath: '/path/to/project',
-        projectTagNames: ['v1.0.0'],
+        projectTagNames: [],
       });
 
       expect(pkg).toMatchObject({
-        hasChangesSinceLatestRelease: false,
+        hasChangesSinceLatestRelease: true,
       });
     });
 
-    it('flags the package as having been changed since its latest release if a tag matching the current version does not exist', async () => {
+    it('throws if a tag matching the current version does not exist', async () => {
       jest
         .spyOn(packageManifestModule, 'readPackageManifest')
         .mockResolvedValue({
           unvalidated: {},
           validated: buildMockManifest({
+            name: '@scope/workspace-package',
             version: new SemVer('1.0.0'),
           }),
         });
+      when(jest.spyOn(repoModule, 'hasChangesInDirectorySinceGitTag'))
+        .calledWith('/path/to/project', '/path/to/package', 'v1.0.0')
+        .mockResolvedValue(true);
 
-      const pkg = await readMonorepoRootPackage({
+      const promiseForPkg = readMonorepoRootPackage({
         packageDirectoryPath: '/path/to/package',
         projectDirectoryPath: '/path/to/project',
-        projectTagNames: [],
+        projectTagNames: ['some-tag'],
       });
 
-      expect(pkg).toMatchObject({
-        hasChangesSinceLatestRelease: true,
-      });
+      await expect(promiseForPkg).rejects.toThrow(
+        new Error(
+          'The package @scope/workspace-package has no Git tag for its current version 1.0.0 (expected "v1.0.0"), so this tool is unable to determine whether it should be included in this release. You will need to create a tag for this package in order to proceed.',
+        ),
+      );
     });
   });
 
   describe('readMonorepoWorkspacePackage', () => {
     it('returns information about the file structure of the package located at the given directory', async () => {
+      const stderr = createNoopWriteStream();
       jest
         .spyOn(packageManifestModule, 'readPackageManifest')
         .mockResolvedValue({
@@ -179,6 +182,7 @@ describe('package', () => {
         projectTagNames: [],
         rootPackageName: 'root-package',
         rootPackageVersion: new SemVer('5.0.0'),
+        stderr,
       });
 
       expect(pkg).toMatchObject({
@@ -191,6 +195,7 @@ describe('package', () => {
     it('returns information about the manifest (in both unvalidated and validated forms)', async () => {
       const unvalidatedManifest = {};
       const validatedManifest = buildMockManifest();
+      const stderr = createNoopWriteStream();
       when(jest.spyOn(packageManifestModule, 'readPackageManifest'))
         .calledWith('/path/to/package/package.json')
         .mockResolvedValue({
@@ -204,6 +209,7 @@ describe('package', () => {
         projectTagNames: [],
         rootPackageName: 'root-package',
         rootPackageVersion: new SemVer('5.0.0'),
+        stderr,
       });
 
       expect(pkg).toMatchObject({
@@ -212,58 +218,32 @@ describe('package', () => {
       });
     });
 
-    it('throws if a tag matching the current version does not exist', async () => {
-      const unvalidatedManifest = {};
-      const validatedManifest = buildMockManifest({
-        name: 'workspace-package',
-        version: new SemVer('1.0.0'),
-      });
-      when(jest.spyOn(packageManifestModule, 'readPackageManifest'))
-        .calledWith('/path/to/package/package.json')
-        .mockResolvedValue({
-          unvalidated: unvalidatedManifest,
-          validated: validatedManifest,
-        });
-
-      const promiseForPkg = readMonorepoWorkspacePackage({
-        packageDirectoryPath: '/path/to/package',
-        projectDirectoryPath: '/path/to/project',
-        projectTagNames: ['some-tag'],
-        rootPackageName: 'root-package',
-        rootPackageVersion: new SemVer('5.0.0'),
-      });
-
-      await expect(promiseForPkg).rejects.toThrow(
-        new Error(
-          'The workspace package workspace-package has no Git tag for its current version 1.0.0 (expected "[email protected]"), and the root package root-package has no Git tag for its current version 5.0.0 (expected "v5.0.0"), so this tool is unable to determine whether the workspace package should be included in this release. You will need to create tags for both of these packages in order to proceed.',
-        ),
-      );
-    });
-
     it("flags the package as having been changed since its latest release if a tag matching the package name + version exists and changes have been made to the package's directory since the tag", async () => {
+      const stderr = createNoopWriteStream();
       jest
         .spyOn(packageManifestModule, 'readPackageManifest')
         .mockResolvedValue({
           unvalidated: {},
           validated: buildMockManifest({
-            name: '@scope/some-package',
+            name: '@scope/workspace-package',
             version: new SemVer('1.0.0'),
           }),
         });
       when(jest.spyOn(repoModule, 'hasChangesInDirectorySinceGitTag'))
         .calledWith(
           '/path/to/project',
           '/path/to/package',
-          '@scope/some[email protected]',
+          '@scope/workspace[email protected]',
         )
         .mockResolvedValue(true);
 
       const pkg = await readMonorepoWorkspacePackage({
         packageDirectoryPath: '/path/to/package',
         projectDirectoryPath: '/path/to/project',
-        projectTagNames: ['@scope/some[email protected]'],
+        projectTagNames: ['@scope/workspace[email protected]'],
         rootPackageName: 'root-package',
         rootPackageVersion: new SemVer('5.0.0'),
+        stderr,
       });
 
       expect(pkg).toMatchObject({
@@ -272,29 +252,31 @@ describe('package', () => {
     });
 
     it("does not flag the package as having been changed since its latest release if a tag matching the package name + version exists, but changes have not been made to the package's directory since the tag", async () => {
+      const stderr = createNoopWriteStream();
       jest
         .spyOn(packageManifestModule, 'readPackageManifest')
         .mockResolvedValue({
           unvalidated: {},
           validated: buildMockManifest({
-            name: '@scope/some-package',
+            name: '@scope/workspace-package',
             version: new SemVer('1.0.0'),
           }),
         });
       when(jest.spyOn(repoModule, 'hasChangesInDirectorySinceGitTag'))
         .calledWith(
           '/path/to/project',
           '/path/to/package',
-          '@scope/some[email protected]',
+          '@scope/workspace[email protected]',
         )
         .mockResolvedValue(false);
 
       const pkg = await readMonorepoWorkspacePackage({
         packageDirectoryPath: '/path/to/package',
         projectDirectoryPath: '/path/to/project',
-        projectTagNames: ['@scope/some[email protected]'],
+        projectTagNames: ['@scope/workspace[email protected]'],
         rootPackageName: 'root-package',
         rootPackageVersion: new SemVer('5.0.0'),
+        stderr,
       });
 
       expect(pkg).toMatchObject({
@@ -303,11 +285,13 @@ describe('package', () => {
     });
 
     it("flags the package as having been changed since its latest release if a tag matching 'v' + the root package version exists instead of the package name + version, and changes have been made to the package's directory since the tag", async () => {
+      const stderr = createNoopWriteStream();
       jest
         .spyOn(packageManifestModule, 'readPackageManifest')
         .mockResolvedValue({
           unvalidated: {},
           validated: buildMockManifest({
+            name: '@scope/workspace-package',
             version: new SemVer('1.0.0'),
           }),
         });
@@ -321,6 +305,7 @@ describe('package', () => {
         projectTagNames: ['v5.0.0'],
         rootPackageName: 'root-package',
         rootPackageVersion: new SemVer('5.0.0'),
+        stderr,
       });
 
       expect(pkg).toMatchObject({
@@ -329,6 +314,7 @@ describe('package', () => {
     });
 
     it("does not flag the package as having been changed since its latest release if a tag matching 'v' + the root package version exists instead of the package name + version, but changes have not been made to the package's directory since the tag", async () => {
+      const stderr = createNoopWriteStream();
       jest
         .spyOn(packageManifestModule, 'readPackageManifest')
         .mockResolvedValue({
@@ -347,14 +333,16 @@ describe('package', () => {
         projectTagNames: ['v5.0.0'],
         rootPackageName: 'root-package',
         rootPackageVersion: new SemVer('5.0.0'),
+        stderr,
       });
 
       expect(pkg).toMatchObject({
         hasChangesSinceLatestRelease: false,
       });
     });
 
-    it("flags the package as having been changed since its latest release if a tag matching neither the package name + version nor 'v' + the root package version exists", async () => {
+    it('flags the package as having been changed since its latest release if the project has no tags', async () => {
+      const stderr = createNoopWriteStream();
       jest
         .spyOn(packageManifestModule, 'readPackageManifest')
         .mockResolvedValue({
@@ -370,12 +358,67 @@ describe('package', () => {
         projectTagNames: [],
         rootPackageName: 'root-package',
         rootPackageVersion: new SemVer('5.0.0'),
+        stderr,
       });
 
       expect(pkg).toMatchObject({
         hasChangesSinceLatestRelease: true,
       });
     });
+
+    it("prints a warning if a tag matching 'v' + the root package version exists instead of the package name + version", async () => {
+      const stderr = new MockWritable();
+      when(jest.spyOn(packageManifestModule, 'readPackageManifest'))
+        .calledWith('/path/to/package/package.json')
+        .mockResolvedValue({
+          unvalidated: {},
+          validated: buildMockManifest({
+            name: '@scope/workspace-package',
+            version: new SemVer('1.0.0'),
+          }),
+        });
+
+      await readMonorepoWorkspacePackage({
+        packageDirectoryPath: '/path/to/package',
+        projectDirectoryPath: '/path/to/project',
+        projectTagNames: ['v5.0.0'],
+        rootPackageName: 'root-package',
+        rootPackageVersion: new SemVer('5.0.0'),
+        stderr,
+      });
+
+      expect(stderr.data()).toStrictEqual([
+        'WARNING: Could not determine changes for workspace package @scope/workspace-package version 1.0.0 based on Git tag "@scope/[email protected]"; using tag for root package root-package version 5.0.0, "v5.0.0", instead.\n',
+      ]);
+    });
+
+    it("throws if the project has tags, but neither a tag matching the package name + version nor 'v' + the root package version exists", async () => {
+      const stderr = createNoopWriteStream();
+      when(jest.spyOn(packageManifestModule, 'readPackageManifest'))
+        .calledWith('/path/to/package/package.json')
+        .mockResolvedValue({
+          unvalidated: {},
+          validated: buildMockManifest({
+            name: '@scope/workspace-package',
+            version: new SemVer('1.0.0'),
+          }),
+        });
+
+      const promise = readMonorepoWorkspacePackage({
+        packageDirectoryPath: '/path/to/package',
+        projectDirectoryPath: '/path/to/project',
+        projectTagNames: ['some-tag'],
+        rootPackageName: 'root-package',
+        rootPackageVersion: new SemVer('5.0.0'),
+        stderr,
+      });
+
+      await expect(promise).rejects.toThrow(
+        new Error(
+          'The current release of workspace package @scope/workspace-package, 1.0.0, has no corresponding Git tag "@scope/[email protected]", and the current release of root package root-package, 5.0.0, has no tag "v5.0.0". Hence, this tool is unable to know whether the workspace package changed and should be included in this release. You will need to create tags for both of these packages in order to proceed.',
+        ),
+      );
+    });
   });
 
   describe('updatePackage', () => {