Merge pull request #6290 from Shopify/dev_platform_migration_doc_links

Add documentation links to migration-related banners

Author: gonzaloriestra

packages/app/src/cli/prompts/uid-mapping-error.ts

@@ -0,0 +1,28 @@
+import {AbortError} from '@shopify/cli-kit/node/error'
+
+export function throwUidMappingError() {
+  const message = ['Your app has extensions which need to be assigned', {command: 'uid'}, 'identifiers.']
+  const nextStep = [
+    'You must first map IDs to your existing extensions by running',
+    {command: 'shopify app deploy'},
+    'interactively, without',
+    {command: '--force'},
+    ', to finish the migration.',
+  ]
+  const customSection = {
+    title: 'Reference',
+    body: {
+      list: {
+        items: [
+          {
+            link: {
+              label: 'Migrating from the Partner Dashboard',
+              url: 'https://shopify.dev/docs/apps/build/dev-dashboard/migrate-from-partners',
+            },
+          },
+        ],
+      },
+    },
+  }
+  throw new AbortError(message, undefined, [nextStep], [customSection])
+}

packages/app/src/cli/services/context/breakdown-extensions.ts

@@ -20,10 +20,10 @@ import {ExtensionSpecification} from '../../models/extensions/specification.js'
 import {rewriteConfiguration} from '../app/write-app-configuration-file.js'
 import {AppConfigurationUsedByCli} from '../../models/extensions/specifications/types/app_config.js'
 import {removeTrailingSlash} from '../../models/extensions/specifications/validation/common.js'
+import {throwUidMappingError} from '../../prompts/uid-mapping-error.js'
 import {deepCompare, deepDifference} from '@shopify/cli-kit/common/object'
 import {encodeToml} from '@shopify/cli-kit/node/toml'
 import {zod} from '@shopify/cli-kit/node/schema'
-import {AbortError} from '@shopify/cli-kit/node/error'
 
 export interface ConfigExtensionIdentifiersBreakdown {
   existingFieldNames: string[]
@@ -68,15 +68,7 @@ export async function extensionsIdentifiersDeployBreakdown(options: EnsureDeploy
     const unMigratedextensions = remoteExtensionsRegistrations.app.extensionRegistrations.filter((ext) => !ext.id)
 
     if (unMigratedextensions.length > 0) {
-      const message = ['Your app has extensions which need to be assigned', {command: 'uid'}, 'identifiers.']
-      const nextSteps = [
-        'You must first map IDs to your existing extensions by running',
-        {command: 'shopify app deploy'},
-        'interactively, without',
-        {command: '--force'},
-        'to finish the migration.',
-      ]
-      throw new AbortError(message, nextSteps)
+      throwUidMappingError()
     }
   }
 

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

@@ -656,6 +656,18 @@ describe('deploy', () => {
             "• Commit to source control to ensure your extension IDs aren't regenerated on the next deploy.",
           ],
         },
+        {
+          title: 'Reference',
+          body: [
+            '• ',
+            {
+              link: {
+                label: 'Migrating from the Partner Dashboard',
+                url: 'https://shopify.dev/docs/apps/build/dev-dashboard/migrate-from-partners',
+              },
+            },
+          ],
+        },
       ],
     })
   })

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

@@ -331,7 +331,21 @@ async function outputCompletionMessage({
     }
 
     body.push("• Commit to source control to ensure your extension IDs aren't regenerated on the next deploy.")
-    customSections = [{title: 'Next steps', body}]
+    customSections = [
+      {title: 'Next steps', body},
+      {
+        title: 'Reference',
+        body: [
+          '• ',
+          {
+            link: {
+              label: 'Migrating from the Partner Dashboard',
+              url: 'https://shopify.dev/docs/apps/build/dev-dashboard/migrate-from-partners',
+            },
+          },
+        ],
+      },
+    ]
   }
 
   if (release) {

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

@@ -37,6 +37,7 @@ import {AppConfigurationUsedByCli} from '../models/extensions/specifications/typ
 import {RemoteAwareExtensionSpecification} from '../models/extensions/specification.js'
 import {ports} from '../constants.js'
 import {generateCertificate} from '../utilities/mkcert.js'
+import {throwUidMappingError} from '../prompts/uid-mapping-error.js'
 import {Config} from '@oclif/core'
 import {AbortController} from '@shopify/cli-kit/node/abort'
 import {checkPortAvailability, getAvailableTCPPort} from '@shopify/cli-kit/node/tcp'
@@ -248,15 +249,7 @@ export async function blockIfMigrationIncomplete(devConfig: DevConfig) {
       .filter((extension) => extension.type.toLowerCase() !== 'webhook_subscription')
       .every((extension) => extension.id)
   ) {
-    const message = ['Your app has extensions which need to be assigned', {command: 'uid'}, 'identifiers.']
-    const nextSteps = [
-      'You must first map IDs to your existing extensions by running',
-      {command: 'shopify app deploy'},
-      'interactively, without',
-      {command: '--force'},
-      'to finish the migration.',
-    ]
-    throw new AbortError(message, nextSteps)
+    throwUidMappingError()
   }
 }