fix(cli): dry run migrations updating stories (#324)

Fixes WDX-162
Fixes #323

Author: maoberlehner

packages/cli/src/commands/migrations/run/index.test.ts

@@ -23,11 +23,15 @@ vi.mock('../../../utils', async () => {
   };
 });
 
-// Mock the actions
-vi.mock('./actions', () => ({
-  readMigrationFiles: vi.fn(),
-  getMigrationFunction: vi.fn(),
-}));
+// Mock actions
+vi.mock('./actions', async () => {
+  const actual = await vi.importActual<typeof import('./actions')>('./actions');
+  return {
+    applyMigrationToAllBlocks: actual.applyMigrationToAllBlocks,
+    readMigrationFiles: vi.fn(),
+    getMigrationFunction: vi.fn(),
+  };
+});
 
 vi.mock('../../stories/actions', () => ({
   fetchStories: vi.fn(),
@@ -170,16 +174,12 @@ describe('migrations run command - streaming approach', () => {
     // Verify that getMigrationFunction was called
     expect(getMigrationFunction).toHaveBeenCalledWith('migration-component.js', '12345', undefined);
 
-    // In the new streaming approach, updateStory is only called if the migration actually changes content
-    // Since our mock migration function doesn't actually change the content hash, updateStory won't be called
-    // This is the correct behavior - only stories with actual changes should be updated
-
     // Verify that progress bars were displayed (konsola.info should be called for summaries)
     expect(konsola.info).toHaveBeenCalledWith(
       expect.stringContaining('Migration Results:'),
     );
     expect(konsola.info).toHaveBeenCalledWith(
-      expect.stringContaining('No stories required updates'),
+      expect.stringContaining('Update Results: 1 stories updated.'),
     );
   });
 
@@ -309,6 +309,9 @@ describe('migrations run command - streaming approach', () => {
     // Verify that getMigrationFunction was called
     expect(getMigrationFunction).toHaveBeenCalledWith('migration-component.js', '12345', undefined);
 
+    expect(konsola.warn).toHaveBeenCalledWith(
+      expect.stringContaining('DRY RUN MODE ENABLED: No changes will be made.'),
+    );
     // Verify that updateStory was NOT called (since it's a dry run)
     expect(updateStory).not.toHaveBeenCalled();
 

packages/cli/src/commands/migrations/run/index.ts

@@ -25,6 +25,9 @@ migrationsCommand.command('run [componentName]')
   .option('--publish <publish>', 'Options for publication mode: all | published | published-with-changes')
   .action(async (componentName: string | undefined, options: MigrationsRunOptions) => {
     konsola.title(`${commands.MIGRATIONS}`, colorPalette.MIGRATIONS, componentName ? `Running migrations for component ${componentName}...` : 'Running migrations...');
+    if (options.dryRun) {
+      konsola.warn(`DRY RUN MODE ENABLED: No changes will be made.\n`);
+    }
 
     // Global options
     const verbose = program.opts().verbose;

packages/cli/src/commands/migrations/run/streams/update-stream.ts

@@ -89,9 +89,9 @@ export class UpdateStream extends Writable {
         payload.publish = 1;
       }
 
-      const updatedStory = await updateStory(this.options.space, storyId, payload);
-
-      if (updatedStory) {
+      const updatedStory = !this.options.dryRun && await updateStory(this.options.space, storyId, payload);
+      const isStoryUpdated = Boolean(updatedStory);
+      if (isStoryUpdated || this.options.dryRun) {
         this.results.successful.push({ storyId, name: storyName });
         this.results.totalProcessed++;
         this.options.onProgress?.(this.results.totalProcessed);