chore(graph): refactor migration type checks

Author: ndcunningham

graph/migrate/src/lib/components/automatic-migration.tsx

@@ -6,9 +6,7 @@ import type { MigrationsJsonMetadata } from 'nx/src/command-line/migrate/migrate
 import { useSelector } from '@xstate/react';
 import {
   currentMigrationHasChanges,
-  currentMigrationHasFailed,
-  currentMigrationHasSucceeded,
-  currentMigrationIsStopped,
+  getCurrentMigrationType,
 } from '../state/automatic/selectors';
 import { MigrationTimeline } from './migration-timeline';
 import { Interpreter } from 'xstate';
@@ -46,15 +44,18 @@ export function AutomaticMigration(props: {
     (migration) => migration.id === currentMigration?.id
   );
 
-  const currentMigrationFailed = useSelector(props.actor, (state) =>
-    currentMigrationHasFailed(state.context)
+  const currentMigrationFailed = useSelector(
+    props.actor,
+    (state) => getCurrentMigrationType(state.context) === 'failed'
   );
 
-  const isCurrentMigrationStopped = useSelector(props.actor, (state) =>
-    currentMigrationIsStopped(state.context)
+  const isCurrentMigrationStopped = useSelector(
+    props.actor,
+    (state) => getCurrentMigrationType(state.context) === 'stopped'
   );
-  const currentMigrationSuccess = useSelector(props.actor, (state) =>
-    currentMigrationHasSucceeded(state.context)
+  const currentMigrationSuccess = useSelector(
+    props.actor,
+    (state) => getCurrentMigrationType(state.context) === 'successful'
   );
 
   const currentMigrationChanges = useSelector(props.actor, (state) =>

graph/migrate/src/lib/components/migration-card.tsx

@@ -28,11 +28,8 @@ import type {
 import { useSelector } from '@xstate/react';
 import {
   currentMigrationHasChanges,
-  isMigrationFailed,
+  getMigrationType,
   isMigrationRunning,
-  isMigrationSkipped,
-  isMigrationStopped,
-  isMigrationSuccessful,
 } from '../state/automatic/selectors';
 
 export interface MigrationCardHandle {
@@ -127,17 +124,21 @@ export const MigrationCard = forwardRef<
   const nextSteps =
     migrationResult?.type === 'successful' ? migrationResult.nextSteps : [];
 
-  const isSucceeded = useSelector(actor, (state) =>
-    isMigrationSuccessful(state.context, migration.id)
+  const isSucceeded = useSelector(
+    actor,
+    (state) => getMigrationType(state.context, migration.id) === 'successful'
   );
-  const isFailed = useSelector(actor, (state) =>
-    isMigrationFailed(state.context, migration.id)
+  const isFailed = useSelector(
+    actor,
+    (state) => getMigrationType(state.context, migration.id) === 'failed'
   );
-  const isSkipped = useSelector(actor, (state) =>
-    isMigrationSkipped(state.context, migration.id)
+  const isSkipped = useSelector(
+    actor,
+    (state) => getMigrationType(state.context, migration.id) === 'skipped'
   );
-  const isStopped = useSelector(actor, (state) =>
-    isMigrationStopped(state.context, migration.id)
+  const isStopped = useSelector(
+    actor,
+    (state) => getMigrationType(state.context, migration.id) === 'stopped'
   );
   const hasChanges = useSelector(actor, (state) =>
     currentMigrationHasChanges(state.context)

graph/migrate/src/lib/components/migration-timeline.tsx

@@ -27,10 +27,7 @@ import type {
 } from '../state/automatic/types';
 import { useSelector } from '@xstate/react';
 import {
-  isMigrationFailed,
-  isMigrationSkipped,
-  isMigrationStopped,
-  isMigrationSuccessful,
+  getMigrationType,
   isMigrationRunning,
 } from '../state/automatic/selectors';
 
@@ -599,21 +596,25 @@ function MigrationStateCircle({
   let textColor = '';
   let Icon = null;
 
-  const isSkipped = useSelector(actor, (state) =>
-    isMigrationSkipped(state.context, migration.id)
+  const isSkipped = useSelector(
+    actor,
+    (state) => getMigrationType(state.context, migration.id) === 'skipped'
   );
 
   const isRunning = useSelector(actor, (state) =>
     isMigrationRunning(state.context, migration.id)
   );
-  const isStopped = useSelector(actor, (state) =>
-    isMigrationStopped(state.context, migration.id)
+  const isStopped = useSelector(
+    actor,
+    (state) => getMigrationType(state.context, migration.id) === 'stopped'
   );
-  const isFailed = useSelector(actor, (state) =>
-    isMigrationFailed(state.context, migration.id)
+  const isFailed = useSelector(
+    actor,
+    (state) => getMigrationType(state.context, migration.id) === 'failed'
   );
-  const isSuccess = useSelector(actor, (state) =>
-    isMigrationSuccessful(state.context, migration.id)
+  const isSuccess = useSelector(
+    actor,
+    (state) => getMigrationType(state.context, migration.id) === 'successful'
   );
   // Check if this migration is in the completed migrations
 

graph/migrate/src/lib/migrate.tsx

@@ -17,10 +17,7 @@ import {
   MigrationSettingsPanel,
   AutomaticMigration,
 } from './components';
-import {
-  currentMigrationIsStopped,
-  currentMigrationHasFailed,
-} from './state/automatic/selectors';
+import { getCurrentMigrationType } from './state/automatic/selectors';
 
 export interface MigrateUIProps {
   migrations: MigrationDetailsWithId[];
@@ -86,11 +83,13 @@ export function MigrateUI(props: MigrateUIProps) {
   const isDone = useSelector(actor, (state) => state.matches('done'));
   const isInit = useSelector(actor, (state) => state.matches('init'));
   const isRunning = useSelector(actor, (state) => state.matches('running'));
-  const isCurrentMigrationStopped = useSelector(actor, (state) =>
-    currentMigrationIsStopped(state.context)
+  const isCurrentMigrationStopped = useSelector(
+    actor,
+    (state) => getCurrentMigrationType(state.context) === 'stopped'
   );
-  const isCurrentMigrationFailed = useSelector(actor, (state) =>
-    currentMigrationHasFailed(state.context)
+  const isCurrentMigrationFailed = useSelector(
+    actor,
+    (state) => getCurrentMigrationType(state.context) === 'failed'
   );
 
   const isNeedReview = useSelector(actor, (state) =>

graph/migrate/src/lib/state/automatic/guards.ts

@@ -1,33 +1,32 @@
 import { AutomaticMigrationState } from './types';
 import {
+  getCurrentMigrationType,
   currentMigrationCanLeaveReview,
   currentMigrationHasChanges,
-  currentMigrationHasFailed,
-  currentMigrationHasSucceeded,
-  currentMigrationIsSkipped,
   currentMigrationIsRunning,
 } from './selectors';
 
 export const guards = {
   canStartRunningCurrentMigration: (ctx: AutomaticMigrationState) => {
+    const type = getCurrentMigrationType(ctx);
     return (
       !!ctx.currentMigration &&
       !currentMigrationIsRunning(ctx) &&
-      !currentMigrationIsSkipped(ctx) &&
+      !(type === 'skipped') &&
       // Allow running if migration is not completed
       // stopped migrations can be restarted via the UI, Nx-console will handle the state change
-      !currentMigrationHasFailed(ctx) &&
+      !(type === 'failed') &&
       !currentMigrationHasChanges(ctx)
     );
   },
 
   currentMigrationIsDone: (ctx: AutomaticMigrationState) => {
+    const type = getCurrentMigrationType(ctx);
     return (
       !!ctx.currentMigration &&
       !currentMigrationIsRunning(ctx) &&
-      ((currentMigrationHasSucceeded(ctx) &&
-        currentMigrationCanLeaveReview(ctx)) ||
-        currentMigrationIsSkipped(ctx))
+      ((type === 'successful' && currentMigrationCanLeaveReview(ctx)) ||
+        type === 'skipped')
     );
   },
 

graph/migrate/src/lib/state/automatic/selectors.ts

@@ -16,83 +16,36 @@ export function findFirstIncompleteMigration(
   );
 }
 
-export function currentMigrationHasSucceeded(ctx: AutomaticMigrationState) {
-  if (!ctx.currentMigration) {
-    return false;
-  }
-  return isMigrationSuccessful(ctx, ctx.currentMigration.id);
-}
-
-export function currentMigrationHasChanges(ctx: AutomaticMigrationState) {
-  if (!ctx.currentMigration) {
-    return false;
-  }
-  const completed =
-    ctx.nxConsoleMetadata?.completedMigrations?.[ctx.currentMigration?.id];
-  return (
-    completed?.type === 'successful' &&
-    (completed.changedFiles?.length ?? 0) > 0
-  );
-}
-
-export function isMigrationSuccessful(
-  ctx: AutomaticMigrationState,
-  migrationId: string
-) {
-  return (
-    ctx.nxConsoleMetadata?.completedMigrations?.[migrationId]?.type ===
-    'successful'
-  );
-}
-
-export function isMigrationFailed(
+export function getMigrationType(
   ctx: AutomaticMigrationState,
   migrationId: string
 ) {
-  return (
-    ctx.nxConsoleMetadata?.completedMigrations?.[migrationId]?.type === 'failed'
-  );
+  return ctx.nxConsoleMetadata?.completedMigrations?.[migrationId]?.type;
 }
 
-export function isMigrationSkipped(
-  ctx: AutomaticMigrationState,
-  migrationId: string
-) {
-  return (
-    ctx.nxConsoleMetadata?.completedMigrations?.[migrationId]?.type ===
-    'skipped'
-  );
+export function getCurrentMigrationType(ctx: AutomaticMigrationState) {
+  if (!ctx.currentMigration) return undefined;
+  return getMigrationType(ctx, ctx.currentMigration.id);
 }
 
-export function isMigrationStopped(
+export function getMigrationCompletedData(
   ctx: AutomaticMigrationState,
   migrationId: string
 ) {
-  return (
-    ctx.nxConsoleMetadata?.completedMigrations?.[migrationId]?.type ===
-    'stopped'
-  );
-}
-
-export function currentMigrationIsSkipped(ctx: AutomaticMigrationState) {
-  if (!ctx.currentMigration) {
-    return false;
-  }
-  return isMigrationSkipped(ctx, ctx.currentMigration.id);
+  return ctx.nxConsoleMetadata?.completedMigrations?.[migrationId];
 }
 
-export function currentMigrationHasFailed(ctx: AutomaticMigrationState) {
-  if (!ctx.currentMigration) {
-    return false;
-  }
-  return isMigrationFailed(ctx, ctx.currentMigration.id);
+export function getCurrentMigrationCompletedData(ctx: AutomaticMigrationState) {
+  if (!ctx.currentMigration) return undefined;
+  return getMigrationCompletedData(ctx, ctx.currentMigration.id);
 }
 
-export function currentMigrationIsStopped(ctx: AutomaticMigrationState) {
-  if (!ctx.currentMigration) {
-    return false;
-  }
-  return isMigrationStopped(ctx, ctx.currentMigration.id);
+export function currentMigrationHasChanges(ctx: AutomaticMigrationState) {
+  const completed = getCurrentMigrationCompletedData(ctx);
+  return (
+    completed?.type === 'successful' &&
+    (completed.changedFiles?.length ?? 0) > 0
+  );
 }
 
 export function currentMigrationIsReviewed(ctx: AutomaticMigrationState) {
@@ -103,10 +56,11 @@ export function currentMigrationIsReviewed(ctx: AutomaticMigrationState) {
 }
 
 export function currentMigrationCanLeaveReview(ctx: AutomaticMigrationState) {
+  const type = getCurrentMigrationType(ctx);
   return (
     currentMigrationIsReviewed(ctx) ||
-    currentMigrationIsSkipped(ctx) ||
-    (currentMigrationHasSucceeded(ctx) && !currentMigrationHasChanges(ctx))
+    type === 'skipped' ||
+    (type === 'successful' && !currentMigrationHasChanges(ctx))
   );
 }
 
@@ -120,8 +74,6 @@ export function isMigrationRunning(
 }
 
 export function currentMigrationIsRunning(ctx: AutomaticMigrationState) {
-  if (!ctx.currentMigration) {
-    return false;
-  }
+  if (!ctx.currentMigration) return false;
   return isMigrationRunning(ctx, ctx.currentMigration.id);
 }