fetch and pass correct approval scopes for the app when building the UI extension payload

Author: alexanderMontague

bin/get-graphql-schemas.js

@@ -170,7 +170,7 @@ async function fetchFiles() {
  */
 async function fetchFilesFromLocal() {
   for (const schema of schemas) {
-    const localRepoDirectory = execSync(`/opt/dev/bin/dev cd --no-chdir ${schema.repo}`).toString().split('/areas')[0].trim()
+    const localRepoDirectory = execSync(`/opt/dev/bin/dev cd --no-chdir ${schema.repo === 'world' ? '//' : schema.repo}`).toString().split('/areas')[0].trim()
     const sourcePath = path.join(localRepoDirectory, schema.pathToFile)
     console.log('Copying', sourcePath, 'to', schema.localPath)
     fs.copyFileSync(sourcePath, schema.localPath)

packages/app/src/cli/api/graphql/app-management/generated/active-app-release-from-api-key.ts

@@ -13,7 +13,7 @@ export type ActiveAppReleaseFromApiKeyQuery = {
     id: string
     key: string
     organizationId: string
-    activeRoot: {clientCredentials: {secrets: {key: string}[]}}
+    activeRoot: {grantedShopifyApprovalScopes: string[]; clientCredentials: {secrets: {key: string}[]}}
     activeRelease: {
       id: string
       version: {
@@ -131,6 +131,7 @@ export const ActiveAppReleaseFromApiKey = {
                     ],
                   },
                 },
+                {kind: 'Field', name: {kind: 'Name', value: 'grantedShopifyApprovalScopes'}},
               ],
             },
           },

packages/app/src/cli/api/graphql/app-management/generated/active-app-release.ts

@@ -13,7 +13,7 @@ export type ActiveAppReleaseQuery = {
     id: string
     key: string
     organizationId: string
-    activeRoot: {clientCredentials: {secrets: {key: string}[]}}
+    activeRoot: {grantedShopifyApprovalScopes: string[]; clientCredentials: {secrets: {key: string}[]}}
     activeRelease: {
       id: string
       version: {
@@ -35,7 +35,7 @@ export type AppVersionInfoFragment = {
   id: string
   key: string
   organizationId: string
-  activeRoot: {clientCredentials: {secrets: {key: string}[]}}
+  activeRoot: {grantedShopifyApprovalScopes: string[]; clientCredentials: {secrets: {key: string}[]}}
   activeRelease: {
     id: string
     version: {
@@ -130,6 +130,7 @@ export const AppVersionInfoFragmentDoc = {
                     ],
                   },
                 },
+                {kind: 'Field', name: {kind: 'Name', value: 'grantedShopifyApprovalScopes'}},
               ],
             },
           },
@@ -293,6 +294,7 @@ export const ActiveAppRelease = {
                     ],
                   },
                 },
+                {kind: 'Field', name: {kind: 'Name', value: 'grantedShopifyApprovalScopes'}},
               ],
             },
           },

packages/app/src/cli/api/graphql/app-management/queries/active-app-release.graphql

@@ -14,14 +14,15 @@ fragment AppVersionInfo on App {
         key
       }
     }
+    grantedShopifyApprovalScopes
   }
   activeRelease {
     id
     version {
       name
-        appModules {
-          ...ReleasedAppModule
-        }
+      appModules {
+        ...ReleasedAppModule
+      }
     }
   }
 }

packages/app/src/cli/utilities/developer-platform-client/app-management-client.ts

@@ -342,7 +342,6 @@ export class AppManagementClient implements DeveloperPlatformClient {
   async appFromIdentifiers(apiKey: string): Promise<OrganizationApp | undefined> {
     const {app} = await this.activeAppVersionRawResult(apiKey)
     const {name, appModules} = app.activeRelease.version
-    const appAccessModule = appModules.find((mod) => mod.specification.externalIdentifier === 'app_access')
     const appHomeModule = appModules.find((mod) => mod.specification.externalIdentifier === 'app_home')
     const apiSecretKeys = app.activeRoot.clientCredentials.secrets.map((secret) => ({secret: secret.key}))
     return {
@@ -351,7 +350,7 @@ export class AppManagementClient implements DeveloperPlatformClient {
       apiKey: app.key,
       apiSecretKeys,
       organizationId: String(numberFromGid(app.organizationId)),
-      grantedScopes: (appAccessModule?.config?.scopes as string[] | undefined) ?? [],
+      grantedScopes: app.activeRoot.grantedShopifyApprovalScopes,
       applicationUrl: appHomeModule?.config?.app_url as string | undefined,
       flags: [],
       developerPlatformClient: this,