Add post-deploy message for extensions migration to Dev Dash

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,14 @@ 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) {
+    const missingUids = activeAppVersion.appModuleVersions.some((version) => !version.registrationUuid)
+    didMigrateExtensionsToDevDash = missingUids
+  }
+
+  return {identifiers, didMigrateExtensionsToDevDash}
 }
 
 interface ShouldOrPromptIncludeConfigDeployOptions {

packages/app/src/cli/services/deploy.test.ts

@@ -18,6 +18,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, renderSuccess, renderTasks, renderTextPrompt, Task} from '@shopify/cli-kit/node/ui'
 import {formatPackageManagerCommand} from '@shopify/cli-kit/node/output'
@@ -44,6 +45,7 @@ vi.mock('@shopify/cli-kit/node/ui')
 vi.mock('@shopify/cli-kit/node/crypto')
 vi.mock('../validators/extensions.js')
 vi.mock('./context/prompts')
+vi.mock('../utilities/app/config/getTomls.js')
 
 beforeEach(() => {
   // this is needed because using importActual to mock the ui module
@@ -400,6 +402,7 @@ describe('deploy', () => {
     // Then
     expect(renderSuccess).toHaveBeenCalledWith({
       headline: 'New version released to users.',
+      customSections: [],
       body: [
         {
           link: {
@@ -433,6 +436,7 @@ describe('deploy', () => {
     // Then
     expect(renderInfo).toHaveBeenCalledWith({
       headline: 'New version created, but not released.',
+      customSections: [],
       body: [
         {
           link: {
@@ -466,6 +470,7 @@ describe('deploy', () => {
     // Then
     expect(renderSuccess).toHaveBeenCalledWith({
       headline: 'New version created.',
+      customSections: [],
       body: [
         {
           link: {
@@ -484,6 +489,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 {
@@ -499,6 +543,7 @@ interface TestDeployBundleInput {
   commitReference?: string
   appToDeploy?: AppInterface
   developerPlatformClient: DeveloperPlatformClient
+  didMigrateExtensionsToDevDash?: boolean
 }
 
 async function testDeployBundle({
@@ -509,6 +554,7 @@ async function testDeployBundle({
   commitReference,
   appToDeploy,
   developerPlatformClient,
+  didMigrateExtensionsToDevDash = false,
 }: TestDeployBundleInput) {
   // Given
   const extensionsPayload: {[key: string]: string} = {}
@@ -526,7 +572,10 @@ async function testDeployBundle({
     extensionsNonUuidManaged: extensionsNonUuidPayload,
   }
 
-  vi.mocked(ensureDeployContext).mockResolvedValue(identifiers)
+  vi.mocked(ensureDeployContext).mockResolvedValue({
+    identifiers,
+    didMigrateExtensionsToDevDash,
+  })
 
   vi.mocked(uploadExtensionsBundle).mockResolvedValue({
     validationErrors: [],

packages/app/src/cli/services/deploy.ts

@@ -6,12 +6,13 @@ import {AppLinkedInterface} from '../models/app/app.js'
 import {updateAppIdentifiers} from '../models/app/identifiers.js'
 import {DeveloperPlatformClient} from '../utilities/developer-platform-client.js'
 import {Organization, OrganizationApp} from '../models/organization.js'
+import {getTomls} from '../utilities/app/config/getTomls.js'
 import {renderInfo, renderSuccess, renderTasks} 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 type {Task} from '@shopify/cli-kit/node/ui'
+import type {AlertCustomSection, Task} from '@shopify/cli-kit/node/ui'
 
 export interface DeployOptions {
   /** The app to be built and uploaded */
@@ -53,7 +54,7 @@ interface TasksContext {
 export async function deploy(options: DeployOptions) {
   const {app, remoteApp, developerPlatformClient, noRelease} = options
 
-  const identifiers = await ensureDeployContext({...options, developerPlatformClient})
+  const {identifiers, didMigrateExtensionsToDevDash} = await ensureDeployContext({...options, developerPlatformClient})
   const release = !noRelease
   const apiKey = remoteApp.apiKey
 
@@ -128,6 +129,7 @@ export async function deploy(options: DeployOptions) {
       app,
       release,
       uploadExtensionsBundleResult,
+      didMigrateExtensionsToDevDash,
     })
 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -147,30 +149,61 @@ 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])
+
+    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: tomlsWithoutCurrent,
+            },
+          },
+          "• Commit to source control to ensure your extension IDs aren't regenerated on the next deploy.",
+        ],
+      },
+    ]
+  }
+
   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',