feat: add a prompt before runing a real migration

sanity-io · Jan 24, 2024 · eec64c4 · eec64c4
1 parent 471ecef
commit eec64c4
Showing 1 changed file with 60 additions and 39 deletions.
diff --git a/packages/sanity/src/_internal/cli/commands/migration/runMigrationCommand.ts b/packages/sanity/src/_internal/cli/commands/migration/runMigrationCommand.ts
@@ -15,6 +15,7 @@ import {
 } from '@sanity/migrate'
 import {SanityDocument} from '@sanity/types'
 import {Mutation} from '@bjoerge/mutiny'
+import {debug} from '../../debug'
 import {format, formatMutation} from './utils/mutationFormatter'
 
 const helpText = `
@@ -145,46 +146,66 @@ const createMigrationCommand: CliCommandDefinition<CreateFlags> = {
       apiVersion: 'v2024-01-09',
     } as const
 
-    const spinner = output.spinner('Running migration…').start()
-    await (dry
-      ? dryRun({api: apiConfig}, migration, context)
-      : run(
-          {
-            api: apiConfig,
-            concurrency,
-            onProgress(progress) {
-              if (progress.done) {
-                spinner.text = `Migration "${migrationName}" completed.
-
-Project id:  ${chalk.bold(projectId)}
-Dataset:     ${chalk.bold(dataset)}
-
-${progress.documents} documents processed.
-${progress.mutations} mutations generated.
-${chalk.green(progress.completedTransactions.length)} transactions committed.`
-                spinner.stopAndPersist({symbol: chalk.green('✔')})
-                return
-              }
-
-              ;['', ...progress.currentMutations].forEach((mutation) => {
-                spinner.text = `Running migration "${migrationName}"…
-
-Project id:     ${chalk.bold(projectId)}
-Dataset:        ${chalk.bold(dataset)}
-Document type:  ${chalk.bold(migration.documentType)}
-
-${progress.documents} documents processed…
-${progress.mutations} mutations generated…
-${chalk.blue(progress.pending)} requests pending…
-${chalk.green(progress.completedTransactions.length)} transactions committed.
-
-${mutation && !progress.done ? `» ${chalk.grey(formatMutation(chalk, mutation as Mutation))}` : ''}`
-              })
-            },
+    if (dry) {
+      const spinner = output.spinner(`Running migration "${migrationName}" in dry mode`).start()
+      await dryRun({api: apiConfig}, migration, context)
+
+      spinner.stop()
+    } else {
+      const response = await prompt.single<boolean>({
+        message: `This migration will run on the ${chalk.yellow(
+          chalk.bold(apiConfig.dataset),
+        )} dataset in ${chalk.yellow(chalk.bold(apiConfig.projectId))} project. Are you sure?`,
+        type: 'confirm',
+      })
+
+      if (response === false) {
+        debug('User aborted migration')
+        return
+      }
+
+      const spinner = output.spinner(`Running migration "${migrationName}"`).start()
+
+      await run(
+        {
+          api: apiConfig,
+          concurrency,
+          onProgress(progress) {
+            if (progress.done) {
+              spinner.text = `Migration "${migrationName}" completed.
+
+  Project id:  ${chalk.bold(projectId)}
+  Dataset:     ${chalk.bold(dataset)}
+
+  ${progress.documents} documents processed.
+  ${progress.mutations} mutations generated.
+  ${chalk.green(progress.completedTransactions.length)} transactions committed.`
+              spinner.stopAndPersist({symbol: chalk.green('✔')})
+              return
+            }
+
+            ;['', ...progress.currentMutations].forEach((mutation) => {
+              spinner.text = `Running migration "${migrationName}"…
+
+  Project id:     ${chalk.bold(projectId)}
+  Dataset:        ${chalk.bold(dataset)}
+  Document type:  ${chalk.bold(migration.documentType)}
+
+  ${progress.documents} documents processed…
+  ${progress.mutations} mutations generated…
+  ${chalk.blue(progress.pending)} requests pending…
+  ${chalk.green(progress.completedTransactions.length)} transactions committed.
+
+  ${
+    mutation && !progress.done ? `» ${chalk.grey(formatMutation(chalk, mutation as Mutation))}` : ''
+  }`
+            })
           },
-          migration,
-        ))
-    spinner.stop()
+        },
+        migration,
+      )
+      spinner.stop()
+    }
   },
 }