Merge pull request #6178 from Shopify/07-29-show_post-deploy_message_with_migration_next_steps

gonzaloriestra · web-flow · commit 97e013424f73 · 2025-08-05T12:53:47.000Z
Show post-deploy message with migration next steps
diff --git a/packages/app/src/cli/services/context.test.ts b/packages/app/src/cli/services/context.test.ts
@@ -575,6 +575,98 @@ describe('ensureDeployContext', () => {
     })
     unsetAppConfigValueSpy.mockRestore()
   })
+
+  test('sets didMigrateExtensionsToDevDash to true when app modules are missing registration IDs', async () => {
+    // Given
+    const app = testAppWithConfig({config: {client_id: APP2.apiKey}})
+    const identifiers = {
+      app: APP2.apiKey,
+      extensions: {},
+      extensionIds: {},
+      extensionsNonUuidManaged: {},
+    }
+    vi.mocked(ensureDeploymentIdsPresence).mockResolvedValue(identifiers)
+    vi.mocked(getAppConfigurationFileName).mockReturnValue('shopify.app.toml')
+
+    const activeAppVersion = {
+      appModuleVersions: [
+        {registrationId: 'id-1', registrationUuid: 'uuid-1', type: 'app_access', registrationTitle: 'module-1'},
+        {registrationId: '', registrationUuid: 'uuid-2', type: 'pos_ui_extension', registrationTitle: 'module-2'},
+        {
+          registrationId: 'id-3',
+          registrationUuid: 'uuid-3',
+          type: 'checkout_ui_extension',
+          registrationTitle: 'module-3',
+        },
+      ],
+    }
+
+    const developerPlatformClient = buildDeveloperPlatformClient({
+      supportsAtomicDeployments: true,
+      activeAppVersion: () => Promise.resolve(activeAppVersion),
+    })
+
+    // When
+    const result = await ensureDeployContext({
+      app,
+      remoteApp: APP2,
+      organization: ORG1,
+      reset: false,
+      force: false,
+      noRelease: false,
+      developerPlatformClient,
+      skipBuild: false,
+    })
+
+    // Then
+    expect(result.didMigrateExtensionsToDevDash).toBe(true)
+  })
+
+  test('sets didMigrateExtensionsToDevDash to false when all app modules have registration IDs', async () => {
+    // Given
+    const app = testAppWithConfig({config: {client_id: APP2.apiKey}})
+    const identifiers = {
+      app: APP2.apiKey,
+      extensions: {},
+      extensionIds: {},
+      extensionsNonUuidManaged: {},
+    }
+    vi.mocked(ensureDeploymentIdsPresence).mockResolvedValue(identifiers)
+    vi.mocked(getAppConfigurationFileName).mockReturnValue('shopify.app.toml')
+
+    const activeAppVersion = {
+      appModuleVersions: [
+        {registrationId: 'id-1', registrationUuid: 'uuid-1', type: 'app_access', registrationTitle: 'module-1'},
+        {registrationId: 'id-2', registrationUuid: 'uuid-2', type: 'pos_ui_extension', registrationTitle: 'module-2'},
+        {
+          registrationId: 'id-3',
+          registrationUuid: 'uuid-3',
+          type: 'checkout_ui_extension',
+          registrationTitle: 'module-3',
+        },
+      ],
+    }
+
+    const developerPlatformClient = buildDeveloperPlatformClient({
+      supportsAtomicDeployments: true,
+      activeAppVersion: () => Promise.resolve(activeAppVersion),
+    })
+
+    // When
+    const result = await ensureDeployContext({
+      app,
+      remoteApp: APP2,
+      organization: ORG1,
+      reset: false,
+      force: false,
+      noRelease: false,
+      developerPlatformClient,
+      skipBuild: false,
+    })
+
+    // Then
+    expect(result.didMigrateExtensionsToDevDash).toBe(false)
+  })
 })
 
 describe('ensureThemeExtensionDevContext', () => {
diff --git a/packages/app/src/cli/services/context.ts b/packages/app/src/cli/services/context.ts
@@ -128,6 +128,11 @@ export async function ensureThemeExtensionDevContext(
   return registration
 }
 
+interface EnsureDeployContextResult {
+  identifiers: Identifiers
+  didMigrateExtensionsToDevDash: boolean
+}
+
 /**
  * Make sure there is a valid context to execute `deploy`
  * That means we have a valid session, organization and app.
@@ -140,7 +145,7 @@ export async function ensureThemeExtensionDevContext(
  * @param developerPlatformClient - The client to access the platform API
  * @returns The selected org, app and dev store
  */
-export async function ensureDeployContext(options: DeployOptions): Promise<Identifiers> {
+export async function ensureDeployContext(options: DeployOptions): Promise<EnsureDeployContextResult> {
   const {reset, force, noRelease, app, remoteApp, developerPlatformClient, organization} = options
   const activeAppVersion = await developerPlatformClient.activeAppVersion(remoteApp)
 
@@ -160,7 +165,13 @@ export async function ensureDeployContext(options: DeployOptions): Promise<Ident
 
   await updateAppIdentifiers({app, identifiers, command: 'deploy', developerPlatformClient})
 
-  return identifiers
+  // if the current active app version is missing user_identifiers in some app module, then we are migrating to dev dash
+  let didMigrateExtensionsToDevDash = false
+  if (developerPlatformClient.supportsAtomicDeployments && activeAppVersion) {
+    didMigrateExtensionsToDevDash = activeAppVersion.appModuleVersions.some((version) => !version.registrationId)
+  }
+
+  return {identifiers, didMigrateExtensionsToDevDash}
 }
 
 interface ShouldOrPromptIncludeConfigDeployOptions {
diff --git a/packages/app/src/cli/services/deploy.test.ts b/packages/app/src/cli/services/deploy.test.ts
@@ -21,6 +21,7 @@ import {AppInterface, AppLinkedInterface} from '../models/app/app.js'
 import {OrganizationApp} from '../models/organization.js'
 import {DeveloperPlatformClient} from '../utilities/developer-platform-client.js'
 import {PosSpecIdentifier} from '../models/extensions/specifications/app_config_point_of_sale.js'
+import {getTomls} from '../utilities/app/config/getTomls.js'
 import {beforeEach, describe, expect, vi, test} from 'vitest'
 import {
   renderInfo,
@@ -59,6 +60,7 @@ vi.mock('./context/prompts')
 vi.mock('./import-extensions.js')
 vi.mock('./fetch-extensions.js')
 vi.mock('../models/app/loader.js')
+vi.mock('../utilities/app/config/getTomls.js')
 
 beforeEach(() => {
   // this is needed because using importActual to mock the ui module
@@ -418,6 +420,7 @@ describe('deploy', () => {
     // Then
     expect(renderSuccess).toHaveBeenCalledWith({
       headline: 'New version released to users.',
+      customSections: [],
       body: [
         {
           link: {
@@ -451,6 +454,7 @@ describe('deploy', () => {
     // Then
     expect(renderInfo).toHaveBeenCalledWith({
       headline: 'New version created, but not released.',
+      customSections: [],
       body: [
         {
           link: {
@@ -493,6 +497,7 @@ describe('deploy', () => {
         },
         '\nversion message',
       ],
+      customSections: [],
       nextSteps: [
         [
           'Run',
@@ -502,6 +507,45 @@ describe('deploy', () => {
       ],
     })
   })
+
+  test('shows a custom section when migrating extensions to dev dash', async () => {
+    // Given
+    const app = testAppLinked()
+
+    vi.mocked(getTomls).mockResolvedValue({
+      '111': 'shopify.app.prod.toml',
+      '222': 'shopify.app.stg.toml',
+    })
+
+    // When
+    await testDeployBundle({app, remoteApp, developerPlatformClient, didMigrateExtensionsToDevDash: true})
+
+    // Then
+    expect(renderSuccess).toHaveBeenCalledWith({
+      headline: 'New version released to users.',
+      body: [
+        {
+          link: {
+            label: 'unique-version-tag',
+            url: 'https://partners.shopify.com/0/apps/0/versions/1',
+          },
+        },
+        '',
+      ],
+      customSections: [
+        {
+          title: 'Next steps',
+          body: [
+            '• Map extension IDs to other copies of your app by running',
+            {command: formatPackageManagerCommand(app.packageManager, 'shopify app deploy')},
+            'for: ',
+            {list: {items: ['shopify.app.prod.toml', 'shopify.app.stg.toml']}},
+            "• Commit to source control to ensure your extension IDs aren't regenerated on the next deploy.",
+          ],
+        },
+      ],
+    })
+  })
 })
 
 interface TestDeployBundleInput {
@@ -517,6 +561,7 @@ interface TestDeployBundleInput {
   commitReference?: string
   appToDeploy?: AppInterface
   developerPlatformClient: DeveloperPlatformClient
+  didMigrateExtensionsToDevDash?: boolean
 }
 
 async function testDeployBundle({
@@ -527,6 +572,7 @@ async function testDeployBundle({
   commitReference,
   appToDeploy,
   developerPlatformClient,
+  didMigrateExtensionsToDevDash = false,
 }: TestDeployBundleInput) {
   // Given
   const extensionsPayload: {[key: string]: string} = {}
@@ -544,7 +590,7 @@ async function testDeployBundle({
     extensionsNonUuidManaged: extensionsNonUuidPayload,
   }
 
-  vi.mocked(ensureDeployContext).mockResolvedValue(identifiers)
+  vi.mocked(ensureDeployContext).mockResolvedValue({identifiers, didMigrateExtensionsToDevDash})
 
   vi.mocked(uploadExtensionsBundle).mockResolvedValue({
     validationErrors: [],
diff --git a/packages/app/src/cli/services/deploy.ts b/packages/app/src/cli/services/deploy.ts
@@ -10,13 +10,14 @@ import {DeveloperPlatformClient} from '../utilities/developer-platform-client.js
 import {Organization, OrganizationApp} from '../models/organization.js'
 import {reloadApp} from '../models/app/loader.js'
 import {ExtensionRegistration} from '../api/graphql/all_app_extension_registrations.js'
+import {getTomls} from '../utilities/app/config/getTomls.js'
 import {renderInfo, renderSuccess, renderTasks, renderConfirmationPrompt, isTTY} from '@shopify/cli-kit/node/ui'
 import {mkdir} from '@shopify/cli-kit/node/fs'
 import {joinPath, dirname} from '@shopify/cli-kit/node/path'
 import {outputNewline, outputInfo, formatPackageManagerCommand} from '@shopify/cli-kit/node/output'
 import {getArrayRejectingUndefined} from '@shopify/cli-kit/common/array'
 import {AbortError, AbortSilentError} from '@shopify/cli-kit/node/error'
-import type {Task} from '@shopify/cli-kit/node/ui'
+import type {AlertCustomSection, Task, TokenItem} from '@shopify/cli-kit/node/ui'
 
 export interface DeployOptions {
   /** The app to be built and uploaded */
@@ -177,7 +178,11 @@ export async function deploy(options: DeployOptions) {
     force,
   })
 
-  const identifiers = await ensureDeployContext({...options, app, developerPlatformClient})
+  const {identifiers, didMigrateExtensionsToDevDash} = await ensureDeployContext({
+    ...options,
+    app,
+    developerPlatformClient,
+  })
   const release = !noRelease
   const apiKey = remoteApp.apiKey
 
@@ -252,6 +257,7 @@ export async function deploy(options: DeployOptions) {
       app,
       release,
       uploadExtensionsBundleResult,
+      didMigrateExtensionsToDevDash,
     })
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -271,30 +277,60 @@ async function outputCompletionMessage({
   app,
   release,
   uploadExtensionsBundleResult,
+  didMigrateExtensionsToDevDash,
 }: {
   app: AppLinkedInterface
   release: boolean
   uploadExtensionsBundleResult: UploadExtensionsBundleOutput
+  didMigrateExtensionsToDevDash: boolean
 }) {
   const linkAndMessage = [
     {link: {label: uploadExtensionsBundleResult.versionTag ?? 'version', url: uploadExtensionsBundleResult.location}},
     uploadExtensionsBundleResult.message ? `\n${uploadExtensionsBundleResult.message}` : '',
   ]
+  let customSections: AlertCustomSection[] = []
+  if (didMigrateExtensionsToDevDash) {
+    const tomls = await getTomls(app.directory)
+    const tomlsWithoutCurrent = Object.values(tomls).filter((toml) => toml !== tomls[app.configuration.client_id])
+
+    const body: TokenItem = []
+    if (tomlsWithoutCurrent.length > 0) {
+      body.push(
+        '• Map extension IDs to other copies of your app by running',
+        {
+          command: formatPackageManagerCommand(app.packageManager, 'shopify app deploy'),
+        },
+        'for: ',
+        {
+          list: {
+            items: tomlsWithoutCurrent,
+          },
+        },
+      )
+    }
+
+    body.push("• Commit to source control to ensure your extension IDs aren't regenerated on the next deploy.")
+    customSections = [{title: 'Next steps', body}]
+  }
+
   if (release) {
     return uploadExtensionsBundleResult.deployError
       ? renderInfo({
           headline: 'New version created, but not released.',
           body: [...linkAndMessage, `\n\n${uploadExtensionsBundleResult.deployError}`],
+          customSections,
         })
       : renderSuccess({
           headline: 'New version released to users.',
           body: linkAndMessage,
+          customSections,
         })
   }
 
   return renderSuccess({
     headline: 'New version created.',
     body: linkAndMessage,
+    customSections,
     nextSteps: [
       [
         'Run',
