Merge pull request #6333 from Shopify/08-28-fix_config_flag_handling_in_config_link

Fix configName flag handling in config:link

Author: plvaldes

packages/app/src/cli/services/app/config/link.test.ts

@@ -1683,6 +1683,85 @@ use_legacy_install_flow = true
 [auth]
 redirect_urls = [ "https://example.com/callback1" ]
 
+[webhooks]
+api_version = "2023-07"
+
+  [[webhooks.subscriptions]]
+  topics = [ "products/create" ]
+  uri = "https://my-app.com/webhooks"
+
+[pos]
+embedded = false
+`
+      expect(content).toEqual(expectedContent)
+    })
+  })
+
+  test('existing config is respected when isNewApp is true, config is current and client_id is not the same as remote app and config name is provided', async () => {
+    await inTemporaryDirectory(async (tmp) => {
+      // Given
+      const developerPlatformClient = buildDeveloperPlatformClient()
+      const options: LinkOptions = {
+        directory: tmp,
+        developerPlatformClient,
+        isNewApp: true,
+        configName: 'staging',
+      }
+      const localApp = {
+        configuration: {
+          path: joinPath(tmp, 'shopify.app.staging.toml'),
+          name: 'my app',
+          client_id: 'invalid_client_id_from_template',
+          webhooks: {
+            api_version: '2023-04',
+            subscriptions: [{topics: ['products/create'], uri: 'https://my-app.com/webhooks'}],
+          },
+          application_url: 'https://myapp.com',
+          build: {
+            automatically_update_urls_on_dev: true,
+            dev_store_url: 'my-store.myshopify.com',
+            include_config_on_deploy: true,
+          },
+          access_scopes: {
+            scopes: 'write_products',
+          },
+        } as CurrentAppConfiguration,
+      }
+
+      vi.mocked(loadApp).mockResolvedValue(await mockApp(tmp, localApp, [], 'current'))
+      vi.mocked(fetchOrCreateOrganizationApp).mockResolvedValue(mockRemoteApp({developerPlatformClient}))
+      const remoteConfiguration = {
+        ...DEFAULT_REMOTE_CONFIGURATION,
+        handle: 'handle',
+      }
+      vi.mocked(fetchAppRemoteConfiguration).mockResolvedValue(remoteConfiguration)
+
+      // When
+      await link(options)
+
+      // Then
+      const content = await readFile(joinPath(tmp, 'shopify.app.staging.toml'))
+      const expectedContent = `# Learn more about configuring your app at https://shopify.dev/docs/apps/tools/cli/configuration
+
+client_id = "12345"
+name = "app1"
+handle = "handle"
+application_url = "https://example.com"
+embedded = true
+
+[build]
+automatically_update_urls_on_dev = true
+dev_store_url = "my-store.myshopify.com"
+include_config_on_deploy = true
+
+[access_scopes]
+# Learn more at https://shopify.dev/docs/apps/tools/cli/configuration#access_scopes
+scopes = "write_products"
+use_legacy_install_flow = true
+
+[auth]
+redirect_urls = [ "https://example.com/callback1" ]
+
 [webhooks]
 api_version = "2023-07"
 

packages/app/src/cli/services/app/config/link.ts

@@ -45,7 +45,6 @@ export interface LinkOptions {
   appId?: string
   organizationId?: string
   configName?: string
-  baseConfigName?: string
   developerPlatformClient?: DeveloperPlatformClient
   isNewApp?: boolean
 }
@@ -178,7 +177,7 @@ async function getAppCreationDefaultsFromLocalApp(options: LinkOptions): Promise
       specifications: await loadLocalExtensionsSpecifications(),
       directory: options.directory,
       mode: 'report',
-      userProvidedConfigName: options.baseConfigName,
+      userProvidedConfigName: options.configName,
       remoteFlags: undefined,
     })
 
@@ -253,7 +252,7 @@ async function loadLocalAppOptions(
       specifications,
       directory: options.directory,
       mode: 'report',
-      userProvidedConfigName: options.baseConfigName,
+      userProvidedConfigName: options.configName,
       remoteFlags,
     })
     const configuration = app.configuration
@@ -321,14 +320,15 @@ async function loadConfigurationFileName(
     format: 'legacy' | 'current'
   },
 ): Promise<AppConfigurationFileName> {
-  // If the user has already selected a config name, use that
-  const cache = getCachedCommandInfo()
-  if (cache?.selectedToml) return cache.selectedToml as AppConfigurationFileName
-
+  // config name from the options takes precedence over everything else
   if (options.configName) {
     return getAppConfigurationFileName(options.configName)
   }
 
+  // otherwise, use the cached config name if it exists
+  const cache = getCachedCommandInfo()
+  if (cache?.selectedToml) return cache.selectedToml as AppConfigurationFileName
+
   if (localAppInfo.format === 'legacy') {
     return configurationFileNames.app
   }