Modify config update message for legacy install flow

Author: zzooeeyy

.changeset/poor-ghosts-mix.md

@@ -0,0 +1,5 @@
+---
+'@shopify/app': patch
+---
+
+Modify app access config update message for legacy install flow

packages/app/src/cli/models/app/app.test-data.ts

@@ -325,6 +325,7 @@ export async function testAppConfigExtensions(emptyConfig = false, directory?: s
 export async function testAppAccessConfigExtension(
   emptyConfig = false,
   directory?: string,
+  useLegacyInstallFlow = true,
 ): Promise<ExtensionInstance> {
   const configuration = emptyConfig
     ? ({} as unknown as BaseConfigType)
@@ -334,7 +335,7 @@ export async function testAppAccessConfigExtension(
         },
         access_scopes: {
           scopes: 'read_products,write_products',
-          use_legacy_install_flow: true,
+          use_legacy_install_flow: useLegacyInstallFlow,
         },
         auth: {
           redirect_urls: ['https://example.com/auth/callback'],

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

@@ -112,7 +112,7 @@ describe('app_config_app_access', () => {
       expect(result).toEqual(['Access scopes auto-granted: write_orders, read_inventory'])
     })
 
-    test('should return default message when no scopes are provided', async () => {
+    test('should return managed install flow empty scopes message when no access_scopes are provided', async () => {
       // Given
       const config = {
         auth: {
@@ -126,5 +126,114 @@ describe('app_config_app_access', () => {
       // Then
       expect(result).toEqual(['App has been installed'])
     })
+
+    test('should return legacy install flow message when use_legacy_install_flow is true', async () => {
+      // Given
+      const config = {
+        access_scopes: {
+          scopes: 'read_products,write_products',
+          use_legacy_install_flow: true,
+        },
+        auth: {
+          redirect_urls: ['https://example.com/auth/callback'],
+        },
+      }
+
+      // When
+      const result = await spec.getDevSessionUpdateMessages!(config)
+
+      // Then
+      expect(result).toEqual(['Using legacy install flow - access scopes are not auto-granted'])
+    })
+
+    test('should return legacy install flow message even with required_scopes when use_legacy_install_flow is true', async () => {
+      // Given
+      const config = {
+        access_scopes: {
+          required_scopes: ['write_orders', 'read_inventory'],
+          use_legacy_install_flow: true,
+        },
+        auth: {
+          redirect_urls: ['https://example.com/auth/callback'],
+        },
+      }
+
+      // When
+      const result = await spec.getDevSessionUpdateMessages!(config)
+
+      // Then
+      expect(result).toEqual(['Using legacy install flow - access scopes are not auto-granted'])
+    })
+
+    test('should return normal scopes message when use_legacy_install_flow is false', async () => {
+      // Given
+      const config = {
+        access_scopes: {
+          scopes: 'read_products,write_products',
+          use_legacy_install_flow: false,
+        },
+        auth: {
+          redirect_urls: ['https://example.com/auth/callback'],
+        },
+      }
+
+      // When
+      const result = await spec.getDevSessionUpdateMessages!(config)
+
+      // Then
+      expect(result).toEqual(['Access scopes auto-granted: read_products, write_products'])
+    })
+
+    test('should return legacy install flow message when both scopes and required_scopes are nil', async () => {
+      // Given
+      const config = {
+        access_scopes: {},
+        auth: {
+          redirect_urls: ['https://example.com/auth/callback'],
+        },
+      }
+
+      // When
+      const result = await spec.getDevSessionUpdateMessages!(config)
+
+      // Then
+      expect(result).toEqual(['Using legacy install flow - access scopes are not auto-granted'])
+    })
+
+    test('should handle empty string scopes', async () => {
+      // Given
+      const config = {
+        access_scopes: {
+          scopes: '',
+        },
+        auth: {
+          redirect_urls: ['https://example.com/auth/callback'],
+        },
+      }
+
+      // When
+      const result = await spec.getDevSessionUpdateMessages!(config)
+
+      // Then
+      expect(result).toEqual(['App has been installed'])
+    })
+
+    test('should handle empty array required_scopes', async () => {
+      // Given
+      const config = {
+        access_scopes: {
+          required_scopes: [],
+        },
+        auth: {
+          redirect_urls: ['https://example.com/auth/callback'],
+        },
+      }
+
+      // When
+      const result = await spec.getDevSessionUpdateMessages!(config)
+
+      // Then
+      expect(result).toEqual(['App has been installed'])
+    })
   })
 })

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

@@ -47,14 +47,22 @@ const appAccessSpec = createConfigExtensionSpecification({
   schema: AppAccessSchema,
   transformConfig: AppAccessTransformConfig,
   getDevSessionUpdateMessages: async (config) => {
+    const hasAccessModule = config.access_scopes !== undefined
+    const isLegacyInstallFlow = config.access_scopes?.use_legacy_install_flow === true
+    const hasNoScopes = config.access_scopes?.scopes == null && config.access_scopes?.required_scopes == null
+
+    if (isLegacyInstallFlow || (hasAccessModule && hasNoScopes)) {
+      return [`Using legacy install flow - access scopes are not auto-granted`]
+    }
+
     const scopesString = config.access_scopes?.scopes
       ? config.access_scopes.scopes
           .split(',')
           .map((scope) => scope.trim())
           .join(', ')
       : config.access_scopes?.required_scopes?.join(', ')
 
-    return [scopesString ? `Access scopes auto-granted: ${scopesString}` : `App has been installed`]
+    return scopesString ? [`Access scopes auto-granted: ${scopesString}`] : [`App has been installed`]
   },
   patchWithAppDevURLs: (config, urls) => {
     if (urls.redirectUrlWhitelist) {

packages/app/src/cli/services/dev/processes/dev-session/dev-session-process.test.ts

@@ -186,7 +186,7 @@ describe('pushUpdatesForDevSession', () => {
   test('handles scope changes and displays updated message', async () => {
     // Given
     vi.mocked(buildAppURLForWeb).mockResolvedValue('https://test.myshopify.com/admin/apps/test')
-    const appAccess = await testAppAccessConfigExtension()
+    const appAccess = await testAppAccessConfigExtension(false, undefined, false)
     const event = {extensionEvents: [{type: 'updated', extension: appAccess}], app}
     const contextSpy = vi.spyOn(outputContext, 'useConcurrentOutputContext')