refactor(semver): 🧹 tiddy up

Author: edbzn

packages/semver/src/executors/version/index.spec.ts

@@ -14,7 +14,7 @@ import * as git from './utils/git';
 import { executePostTargets } from './utils/post-target';
 import { tryBump } from './utils/try-bump';
 import * as workspace from './utils/workspace';
-import { getProjectDependencies } from './utils/get-project-dependencies';
+import { getDependencyRoots } from './utils/get-project-dependencies';
 
 jest.mock('child_process');
 jest.mock('standard-version', () => jest.fn());
@@ -38,10 +38,9 @@ describe('@jscutlery/semver:version', () => {
   const mockStandardVersion = standardVersion as jest.MockedFunction<
     typeof standardVersion
   >;
-  const mockGetProjectDependencies =
-    getProjectDependencies as jest.MockedFunction<
-      typeof getProjectDependencies
-    >;
+  const mockGetDependencyRoots = getDependencyRoots as jest.MockedFunction<
+    typeof getDependencyRoots
+  >;
   const mockExecutePostTargets = executePostTargets as jest.MockedFunction<
     typeof executePostTargets
   >;
@@ -83,6 +82,7 @@ describe('@jscutlery/semver:version', () => {
     jest.spyOn(git, 'addToStage').mockReturnValue(of(undefined));
 
     mockExecutePostTargets.mockReturnValue(of(undefined));
+    mockGetDependencyRoots.mockReturnValue(Promise.resolve([]));
 
     /* Mock a dependency, don't ask me which one. */
     mockExecFile.mockImplementation(
@@ -146,11 +146,13 @@ describe('@jscutlery/semver:version', () => {
     });
 
     it('should run standard-version independently on a project with dependencies', async () => {
-      mockGetProjectDependencies.mockReturnValue(
-        Promise.resolve(['lib1', 'lib2'])
+      mockGetDependencyRoots.mockReturnValue(
+        Promise.resolve(['/root/libs/lib1', '/root/libs/lib2'])
+      );
+      const { success } = await version(
+        { ...options, trackDeps: true },
+        context
       );
-      const tempOptions = { ...options, trackDeps: true };
-      const { success } = await version(tempOptions, context);
 
       expect(success).toBe(true);
       expect(mockTryBump).toBeCalledWith(
@@ -174,17 +176,11 @@ describe('@jscutlery/semver:version', () => {
     });
 
     it('should run standard-version independently on a project with failure on dependencies', async () => {
-      mockGetProjectDependencies.mockReturnValue(
-        Promise.reject('thrown error')
-      );
-      const tempOptions = { ...options, trackDeps: true };
-      let error;
-      try {
-        await version(tempOptions, context);
-      } catch (e) {
-        error = e;
-      }
-      expect(error).toEqual('thrown error');
+      mockGetDependencyRoots.mockReturnValue(Promise.reject('thrown error'));
+
+      expect(await version({ ...options, trackDeps: true }, context)).toEqual({
+        success: false,
+      });
       expect(logger.error).toBeCalledWith('Failed to determine dependencies.');
       expect(standardVersion).not.toBeCalled();
     });
@@ -466,7 +462,21 @@ describe('@jscutlery/semver:version', () => {
       );
 
       expect(success).toBe(true);
-      expect(mockExecutePostTargets).toBeCalled();
+      expect(mockExecutePostTargets).toBeCalledWith(
+        expect.objectContaining({
+          resolvableOptions: {
+            baseBranch: 'main',
+            dryRun: false,
+            noVerify: false,
+            notes: '',
+            project: 'a',
+            remote: 'origin',
+            tag: 'a-2.1.0',
+            tagPrefix: 'a-',
+            version: '2.1.0',
+          },
+        })
+      );
     });
 
     it('should handle post targets failure', async () => {

packages/semver/src/executors/version/index.ts

@@ -3,12 +3,8 @@ import { SchemaError } from '@nrwl/tao/src/shared/params';
 import { concat, defer, lastValueFrom, of } from 'rxjs';
 import { catchError, concatMap, reduce, switchMap } from 'rxjs/operators';
 
-import {
-  calculateChangelogChanges,
-  defaultHeader,
-  getChangelogPath,
-} from './utils/changelog';
-import { getProjectDependencies } from './utils/get-project-dependencies';
+import { calculateChangelogChanges, defaultHeader, getChangelogPath } from './utils/changelog';
+import { getDependencyRoots } from './utils/get-project-dependencies';
 import { tryPushToGitRemote } from './utils/git';
 import { executePostTargets } from './utils/post-target';
 import { resolveTagPrefix } from './utils/resolve-tag-prefix';
@@ -51,22 +47,20 @@ export default async function version(
     syncVersions,
   });
 
-  const projectRoot = getProjectRoot(context);
-
   let dependencyRoots: string[] = [];
-  if (trackDeps && !releaseAs) {
-    // Include any depended-upon libraries in determining the version bump.
-    try {
-      const dependencyLibs = await getProjectDependencies(projectName);
-      dependencyRoots = dependencyLibs.map(
-        (name) => context.workspace.projects[name].root
-      );
-    } catch (e) {
-      logger.error('Failed to determine dependencies.');
-      return Promise.reject(e);
-    }
+  try {
+    dependencyRoots = await getDependencyRoots({
+      projectName,
+      releaseAs,
+      trackDeps,
+      context,
+    });
+  } catch (e) {
+    logger.error('Failed to determine dependencies.');
+    return { success: false };
   }
 
+  const projectRoot = getProjectRoot(context);
   const newVersion$ = tryBump({
     preset,
     projectRoot,
@@ -80,7 +74,7 @@ export default async function version(
     switchMap((newVersion) => {
       if (newVersion == null) {
         logger.info('⏹ Nothing changed since last release.');
-        return of({ success: true });
+        return of({ success: true } as const);
       }
 
       const options: CommonVersionOptions = {
@@ -118,6 +112,13 @@ export default async function version(
         })
       );
 
+      /**
+       * 1. Calculate new version
+       * 2. Release (create changelog -> add to stage -> commit -> tag)
+       * 3. Calculate changelog changes
+       * 4. Push to Git
+       * 5. Run post targets
+       */
       return runStandardVersion$.pipe(
         calculateChangelogChanges({
           changelogHeader,
@@ -161,7 +162,7 @@ export default async function version(
           logger.error(error.stack ?? error.toString());
         }
 
-        return of({ success: false });
+        return of({ success: false } as const);
       })
     )
   );

packages/semver/src/executors/version/utils/get-project-dependencies.ts

@@ -1,7 +1,32 @@
 // The shape of the project graph is still subject to changes, but
 // can still be used, according to the NX devs. That's why we're
 // doing a deep import here.
-import { createProjectGraphAsync, ProjectGraphDependency } from '@nrwl/workspace/src/core/project-graph';
+import { createProjectGraphAsync } from '@nrwl/workspace/src/core/project-graph';
+
+import { ExecutorContext } from '@nrwl/devkit';
+import type { ProjectGraphDependency } from '@nrwl/workspace/src/core/project-graph';
+
+import type { VersionBuilderSchema } from '../schema';
+
+export async function getDependencyRoots({
+  trackDeps,
+  releaseAs,
+  projectName,
+  context,
+}: Required<Pick<VersionBuilderSchema, 'trackDeps'>> &
+  Pick<VersionBuilderSchema, 'releaseAs'> & {
+    projectName: string;
+    context: ExecutorContext;
+  }): Promise<string[]> {
+  if (trackDeps && !releaseAs) {
+    // Include any depended-upon libraries in determining the version bump.
+    return (await getProjectDependencies(projectName)).map(
+      (name) => context.workspace.projects[name].root
+    );
+  }
+
+  return [];
+}
 
 /**
  * Returns a list of in-repo dependencies based on NX's dependency graph.