Add prompt before applying migration

packages/app/src/cli/models/app/app.ts

@@ -16,6 +16,7 @@ import {ApplicationURLs} from '../../services/dev/urls.js'
 import appHomeSpec from '../extensions/specifications/app_config_app_home.js'
 import appProxySpec from '../extensions/specifications/app_config_app_proxy.js'
 import {replaceScopesWithRequiredScopesInToml} from '../../services/app/patch-app-configuration-file.js'
+import {confirmApplyPendingMigrations} from '../../prompts/deprecation-warnings.js'
 import {ZodObjectOf, zod} from '@shopify/cli-kit/node/schema'
 import {DotEnvFile} from '@shopify/cli-kit/node/dot-env'
 import {getDependencies, PackageManager, readAndParsePackageJson} from '@shopify/cli-kit/node/node-package-manager'
@@ -25,6 +26,7 @@ import {AbortError} from '@shopify/cli-kit/node/error'
 import {normalizeDelimitedString} from '@shopify/cli-kit/common/string'
 import {JsonMapType} from '@shopify/cli-kit/node/toml'
 import {getArrayRejectingUndefined} from '@shopify/cli-kit/common/array'
+import {renderText, renderSuccess} from '@shopify/cli-kit/node/ui'
 
 // Schemas for loading app configuration
 
@@ -319,7 +321,8 @@ type AppConstructor<
 export class App<
   TConfig extends AppConfiguration = AppConfiguration,
   TModuleSpec extends ExtensionSpecification = ExtensionSpecification,
-> implements AppInterface<TConfig, TModuleSpec> {
+> implements AppInterface<TConfig, TModuleSpec>
+{
   name: string
   idEnvironmentVariableName: 'SHOPIFY_API_KEY' = 'SHOPIFY_API_KEY' as const
   directory: string
@@ -424,12 +427,25 @@ export class App<
   }
 
   async migratePendingSchemaChanges() {
-    await this.migrateScopesToRequiredScopes()
-    await Promise.all([this.realExtensions.map((ext) => ext.migratePendingSchemaChanges())])
+    const pendingMigrations = this.getPendingMigrationMessages()
+    if (pendingMigrations.length > 0) {
+      const shouldMigrate = await confirmApplyPendingMigrations(pendingMigrations)
+      if (shouldMigrate) {
+        await this.migrateScopesToRequiredScopes()
+        await Promise.all([this.realExtensions.map((ext) => ext.migratePendingSchemaChanges())])
+        renderSuccess({headline: 'Migration completed locally, run `shopify app deploy` to push the changes.'})
+      }
+    }
+  }
+
+  getPendingMigrationMessages(): string[] {
+    return this.realExtensions.map((ext) => ext.pendingSchemaChanges()).flat()
   }
 
   async migrateScopesToRequiredScopes() {
     if (isCurrentAppSchema(this.configuration) && this.configuration.access_scopes?.scopes) {
+      renderText({text: 'Migration: Replacing `scopes` with `required_scopes` locally.'})
+
       const accessConfig = this.configuration as {
         access_scopes: {scopes?: string; required_scopes?: string[]}
       }

packages/app/src/cli/models/extensions/extension-instance.ts

@@ -225,6 +225,11 @@
     return this.specification.migratePendingSchemaChanges(this)
   }
 
+  pendingSchemaChanges(): string[] {
+    if (!this.specification.pendingSchemaChanges) return []
+    return this.specification.pendingSchemaChanges(this)
+  }
+
   buildValidation(): Promise<void> {
     if (!this.specification.buildValidation) return Promise.resolve()
     return this.specification.buildValidation(this)
@@ -269,7 +274,7 @@
   }
 
   hasExtensionPointTarget(target: string): boolean {
     return this.specification.hasExtensionPointTarget?.(this.configuration, target) || false
   }
 
   // Functions specific properties

packages/app/src/cli/models/extensions/specification.ts

@@ -73,6 +73,7 @@ export interface ExtensionSpecification<TConfiguration extends BaseConfigType =
   hasExtensionPointTarget?(config: TConfiguration, target: string): boolean
   appModuleFeatures: (config?: TConfiguration) => ExtensionFeature[]
   migratePendingSchemaChanges?: (extension: ExtensionInstance<TConfiguration>) => Promise<void>
+  pendingSchemaChanges?: (extension: ExtensionInstance<TConfiguration>) => string[]
   getDevSessionActionUpdateMessage?: (
     config: TConfiguration,
     appConfig: CurrentAppConfiguration,
@@ -235,6 +236,7 @@ export function createConfigExtensionSpecification<TConfiguration extends BaseCo
     storeFqdn: string,
   ) => Promise<string>
   migratePendingSchemaChanges?: (extension: ExtensionInstance<TConfiguration>) => Promise<void>
+  pendingSchemaChanges?: (extension: ExtensionInstance<TConfiguration>) => string[]
 }): ExtensionSpecification<TConfiguration> {
   const appModuleFeatures = spec.appModuleFeatures ?? (() => [])
   return createExtensionSpecification({
@@ -249,6 +251,7 @@ export function createConfigExtensionSpecification<TConfiguration extends BaseCo
     uidStrategy: spec.uidStrategy ?? 'single',
     getDevSessionActionUpdateMessage: spec.getDevSessionActionUpdateMessage,
     migratePendingSchemaChanges: spec.migratePendingSchemaChanges,
+    pendingSchemaChanges: spec.pendingSchemaChanges,
   })
 }
 

packages/app/src/cli/models/extensions/specifications/app_config_app_access.ts

@@ -5,7 +5,6 @@ import {ExtensionInstance} from '../extension-instance.js'
 import {outputContent, outputToken} from '@shopify/cli-kit/node/output'
 import {normalizeDelimitedString} from '@shopify/cli-kit/common/string'
 import {zod} from '@shopify/cli-kit/node/schema'
-import {AbortError} from '@shopify/cli-kit/node/error'
 
 const AppAccessSchema = zod.object({
   access: zod
@@ -56,6 +55,9 @@ const appAccessSpec = createConfigExtensionSpecification({
   migratePendingSchemaChanges: async (extension) => {
     return migrateScopesToRequiredScopes(extension)
   },
+  pendingSchemaChanges: (extension) => {
+    return pendingSchemaChanges(extension)
+  },
 })
 
 async function migrateScopesToRequiredScopes(extension: ExtensionInstance) {
@@ -71,4 +73,17 @@ async function migrateScopesToRequiredScopes(extension: ExtensionInstance) {
   }
 }
 
+function pendingSchemaChanges(extension: ExtensionInstance): string[] {
+  const accessConfig = extension.configuration as {
+    access_scopes?: {scopes?: string}
+  }
+
+  const migrationMessages = []
+  if (accessConfig.access_scopes?.scopes) {
+    migrationMessages.push('Replace `scopes(string)` with `required_scopes(string array)`.')
+  }
+
+  return migrationMessages
+}
+
 export default appAccessSpec

packages/app/src/cli/prompts/deprecation-warnings.ts

@@ -9,3 +9,13 @@ export async function showApiKeyDeprecationWarning() {
     body: ['The flag', {command: 'api-key'}, 'has been deprecated in favor of', {command: 'client-id'}],
   })
 }
+
+export async function confirmApplyPendingMigrations(migrations: string[]): Promise<boolean> {
+  return renderConfirmationPrompt({
+    message: `There are pending migrations, would you like to apply them now?`,
+    infoTable: {'': migrations},
+    confirmationMessage: 'Yes, apply migrations',
+    cancellationMessage: 'No, apply migrations later',
+    defaultValue: true,
+  })
+}