Merge pull request #6185 from Shopify/07-21-add_org_id_as_variable_in_some_queries

dmerand · web-flow · commit 717e83bf3f3c · 2025-08-04T19:10:21.000Z
Add organization_id to the variables of some queries/mutations
diff --git a/packages/app/src/cli/api/graphql/app-management/generated/active-app-release-from-api-key.ts b/packages/app/src/cli/api/graphql/app-management/generated/active-app-release-from-api-key.ts
@@ -12,6 +12,7 @@ export type ActiveAppReleaseFromApiKeyQuery = {
   app: {
     id: string
     key: string
+    organizationId: string
     activeRoot: {clientCredentials: {secrets: {key: string}[]}}
     activeRelease: {
       id: string
@@ -104,6 +105,7 @@ export const ActiveAppReleaseFromApiKey = {
         selections: [
           {kind: 'Field', name: {kind: 'Name', value: 'id'}},
           {kind: 'Field', name: {kind: 'Name', value: 'key'}},
+          {kind: 'Field', name: {kind: 'Name', value: 'organizationId'}},
           {
             kind: 'Field',
             name: {kind: 'Name', value: 'activeRoot'},
diff --git a/packages/app/src/cli/api/graphql/app-management/generated/active-app-release.ts b/packages/app/src/cli/api/graphql/app-management/generated/active-app-release.ts
@@ -12,6 +12,7 @@ export type ActiveAppReleaseQuery = {
   app: {
     id: string
     key: string
+    organizationId: string
     activeRoot: {clientCredentials: {secrets: {key: string}[]}}
     activeRelease: {
       id: string
@@ -32,6 +33,7 @@ export type ActiveAppReleaseQuery = {
 export type AppVersionInfoFragment = {
   id: string
   key: string
+  organizationId: string
   activeRoot: {clientCredentials: {secrets: {key: string}[]}}
   activeRelease: {
     id: string
@@ -100,6 +102,7 @@ export const AppVersionInfoFragmentDoc = {
         selections: [
           {kind: 'Field', name: {kind: 'Name', value: 'id'}},
           {kind: 'Field', name: {kind: 'Name', value: 'key'}},
+          {kind: 'Field', name: {kind: 'Name', value: 'organizationId'}},
           {
             kind: 'Field',
             name: {kind: 'Name', value: 'activeRoot'},
@@ -260,6 +263,7 @@ export const ActiveAppRelease = {
         selections: [
           {kind: 'Field', name: {kind: 'Name', value: 'id'}},
           {kind: 'Field', name: {kind: 'Name', value: 'key'}},
+          {kind: 'Field', name: {kind: 'Name', value: 'organizationId'}},
           {
             kind: 'Field',
             name: {kind: 'Name', value: 'activeRoot'},
diff --git a/packages/app/src/cli/api/graphql/app-management/generated/create-app.ts b/packages/app/src/cli/api/graphql/app-management/generated/create-app.ts
@@ -6,6 +6,7 @@ import {TypedDocumentNode as DocumentNode} from '@graphql-typed-document-node/co
 
 export type CreateAppMutationVariables = Types.Exact<{
   initialVersion: Types.AppVersionInput
+  organizationId: Types.Scalars['ID']['input']
 }>
 
 export type CreateAppMutation = {
@@ -28,6 +29,11 @@ export const CreateApp = {
           variable: {kind: 'Variable', name: {kind: 'Name', value: 'initialVersion'}},
           type: {kind: 'NonNullType', type: {kind: 'NamedType', name: {kind: 'Name', value: 'AppVersionInput'}}},
         },
+        {
+          kind: 'VariableDefinition',
+          variable: {kind: 'Variable', name: {kind: 'Name', value: 'organizationId'}},
+          type: {kind: 'NonNullType', type: {kind: 'NamedType', name: {kind: 'Name', value: 'ID'}}},
+        },
       ],
       selectionSet: {
         kind: 'SelectionSet',
@@ -41,6 +47,11 @@ export const CreateApp = {
                 name: {kind: 'Name', value: 'initialVersion'},
                 value: {kind: 'Variable', name: {kind: 'Name', value: 'initialVersion'}},
               },
+              {
+                kind: 'Argument',
+                name: {kind: 'Name', value: 'organizationId'},
+                value: {kind: 'Variable', name: {kind: 'Name', value: 'organizationId'}},
+              },
             ],
             selectionSet: {
               kind: 'SelectionSet',
diff --git a/packages/app/src/cli/api/graphql/app-management/generated/create-asset-url.ts b/packages/app/src/cli/api/graphql/app-management/generated/create-asset-url.ts
@@ -5,6 +5,7 @@ import {TypedDocumentNode as DocumentNode} from '@graphql-typed-document-node/co
 
 export type CreateAssetUrlMutationVariables = Types.Exact<{
   sourceExtension: Types.SourceExtension
+  organizationId: Types.Scalars['ID']['input']
 }>
 
 export type CreateAssetUrlMutation = {
@@ -27,6 +28,11 @@ export const CreateAssetUrl = {
           variable: {kind: 'Variable', name: {kind: 'Name', value: 'sourceExtension'}},
           type: {kind: 'NonNullType', type: {kind: 'NamedType', name: {kind: 'Name', value: 'SourceExtension'}}},
         },
+        {
+          kind: 'VariableDefinition',
+          variable: {kind: 'Variable', name: {kind: 'Name', value: 'organizationId'}},
+          type: {kind: 'NonNullType', type: {kind: 'NamedType', name: {kind: 'Name', value: 'ID'}}},
+        },
       ],
       selectionSet: {
         kind: 'SelectionSet',
@@ -40,6 +46,11 @@ export const CreateAssetUrl = {
                 name: {kind: 'Name', value: 'sourceExtension'},
                 value: {kind: 'Variable', name: {kind: 'Name', value: 'sourceExtension'}},
               },
+              {
+                kind: 'Argument',
+                name: {kind: 'Name', value: 'organizationId'},
+                value: {kind: 'Variable', name: {kind: 'Name', value: 'organizationId'}},
+              },
             ],
             selectionSet: {
               kind: 'SelectionSet',
diff --git a/packages/app/src/cli/api/graphql/app-management/generated/specifications.ts b/packages/app/src/cli/api/graphql/app-management/generated/specifications.ts
@@ -3,7 +3,9 @@ import * as Types from './types.js'
 
 import {TypedDocumentNode as DocumentNode} from '@graphql-typed-document-node/core'
 
-export type FetchSpecificationsQueryVariables = Types.Exact<{[key: string]: never}>
+export type FetchSpecificationsQueryVariables = Types.Exact<{
+  organizationId: Types.Scalars['ID']['input']
+}>
 
 export type FetchSpecificationsQuery = {
   specifications: {
@@ -25,12 +27,26 @@ export const FetchSpecifications = {
       kind: 'OperationDefinition',
       operation: 'query',
       name: {kind: 'Name', value: 'fetchSpecifications'},
+      variableDefinitions: [
+        {
+          kind: 'VariableDefinition',
+          variable: {kind: 'Variable', name: {kind: 'Name', value: 'organizationId'}},
+          type: {kind: 'NonNullType', type: {kind: 'NamedType', name: {kind: 'Name', value: 'ID'}}},
+        },
+      ],
       selectionSet: {
         kind: 'SelectionSet',
         selections: [
           {
             kind: 'Field',
             name: {kind: 'Name', value: 'specifications'},
+            arguments: [
+              {
+                kind: 'Argument',
+                name: {kind: 'Name', value: 'organizationId'},
+                value: {kind: 'Variable', name: {kind: 'Name', value: 'organizationId'}},
+              },
+            ],
             selectionSet: {
               kind: 'SelectionSet',
               selections: [
diff --git a/packages/app/src/cli/api/graphql/app-management/queries/active-app-release.graphql b/packages/app/src/cli/api/graphql/app-management/queries/active-app-release.graphql
@@ -7,6 +7,7 @@ query activeAppRelease($appId: ID!) {
 fragment AppVersionInfo on App {
   id
   key
+  organizationId
   activeRoot {
     clientCredentials {
       secrets {
diff --git a/packages/app/src/cli/api/graphql/app-management/queries/create-app.graphql b/packages/app/src/cli/api/graphql/app-management/queries/create-app.graphql
@@ -1,5 +1,5 @@
-mutation CreateApp($initialVersion: AppVersionInput!) {
-  appCreate(initialVersion: $initialVersion) {
+mutation CreateApp($initialVersion: AppVersionInput!, $organizationId: ID!) {
+  appCreate(initialVersion: $initialVersion, organizationId: $organizationId) {
     app {
       id
       key
diff --git a/packages/app/src/cli/api/graphql/app-management/queries/create-asset-url.graphql b/packages/app/src/cli/api/graphql/app-management/queries/create-asset-url.graphql
@@ -1,5 +1,5 @@
-mutation CreateAssetURL($sourceExtension: SourceExtension!) {
-  appRequestSourceUploadUrl(sourceExtension: $sourceExtension) {
+mutation CreateAssetURL($sourceExtension: SourceExtension!, $organizationId: ID!) {
+  appRequestSourceUploadUrl(sourceExtension: $sourceExtension, organizationId: $organizationId) {
     sourceUploadUrl
     userErrors {
       field
diff --git a/packages/app/src/cli/api/graphql/app-management/queries/specifications.graphql b/packages/app/src/cli/api/graphql/app-management/queries/specifications.graphql
@@ -1,5 +1,5 @@
-query fetchSpecifications {
-  specifications {
+query fetchSpecifications($organizationId: ID!) {
+  specifications(organizationId: $organizationId) {
     name
     identifier
     externalIdentifier
diff --git a/packages/app/src/cli/utilities/developer-platform-client/app-management-client.test.ts b/packages/app/src/cli/utilities/developer-platform-client/app-management-client.test.ts
@@ -3,7 +3,7 @@ import {
   GatedExtensionTemplate,
   allowedTemplates,
   diffAppModules,
-  encodedGidFromOrganizationId,
+  encodedGidFromOrganizationIdForBP,
   encodedGidFromShopId,
   versionDeepLink,
 } from './app-management-client.js'
@@ -151,7 +151,7 @@ describe('templateSpecifications', () => {
     vi.mocked(fetch).mockImplementation(mockedFetch)
     const mockedFetchFlagsResponse: OrganizationBetaFlagsQuerySchema = {
       organization: {
-        id: encodedGidFromOrganizationId(orgApp.organizationId),
+        id: encodedGidFromOrganizationIdForBP(orgApp.organizationId),
         flag_allowedFlag: true,
       },
     }
@@ -178,7 +178,7 @@ describe('templateSpecifications', () => {
     vi.mocked(fetch).mockImplementation(mockedFetch)
     const mockedFetchFlagsResponse: OrganizationBetaFlagsQuerySchema = {
       organization: {
-        id: encodedGidFromOrganizationId(orgApp.organizationId),
+        id: encodedGidFromOrganizationIdForBP(orgApp.organizationId),
         flag_allowedFlag: true,
         flag_notAllowedFlag: false,
       },
@@ -203,7 +203,7 @@ describe('templateSpecifications', () => {
     }`,
       token: 'business-platform-token',
       organizationId: orgApp.organizationId,
-      variables: {organizationId: encodedGidFromOrganizationId(orgApp.organizationId)},
+      variables: {organizationId: encodedGidFromOrganizationIdForBP(orgApp.organizationId)},
       unauthorizedHandler: {
         type: 'token_refresh',
         handler: expect.any(Function),
@@ -227,7 +227,7 @@ describe('templateSpecifications', () => {
     vi.mocked(fetch).mockImplementation(mockedFetch)
     const mockedFetchFlagsResponse: OrganizationBetaFlagsQuerySchema = {
       organization: {
-        id: encodedGidFromOrganizationId(orgApp.organizationId),
+        id: encodedGidFromOrganizationIdForBP(orgApp.organizationId),
         flag_allowedFlag: true,
       },
     }
@@ -417,6 +417,7 @@ describe('createApp', () => {
       query: CreateApp,
       token: 'token',
       variables: {
+        organizationId: 'gid://shopify/Organization/1',
         initialVersion: {
           source: {
             name: 'app-name',
@@ -506,6 +507,7 @@ describe('createApp', () => {
       query: CreateApp,
       token: 'token',
       variables: {
+        organizationId: 'gid://shopify/Organization/1',
         initialVersion: {
           source: {
             name: 'app-name',
diff --git a/packages/app/src/cli/utilities/developer-platform-client/app-management-client.ts b/packages/app/src/cli/utilities/developer-platform-client/app-management-client.ts
@@ -371,7 +371,7 @@ export class AppManagementClient implements DeveloperPlatformClient {
   }
 
   async orgFromId(orgId: string): Promise<Organization | undefined> {
-    const base64Id = encodedGidFromOrganizationId(orgId)
+    const base64Id = encodedGidFromOrganizationIdForBP(orgId)
     const variables = {organizationId: base64Id}
     const organizationResult = await this.businessPlatformRequest({
       query: FindOrganizations,
@@ -429,7 +429,8 @@ export class AppManagementClient implements DeveloperPlatformClient {
 
   async specifications({organizationId}: MinimalAppIdentifiers): Promise<RemoteSpecification[]> {
     const query = FetchSpecifications
-    const result = await this.appManagementRequest({organizationId, query})
+    const variables = {organizationId: gidFromOrganizationIdForShopify(organizationId)}
+    const result = await this.appManagementRequest({organizationId, query, variables})
     return result.specifications.map(
       (spec): RemoteSpecification => ({
         name: spec.name,
@@ -503,7 +504,7 @@ export class AppManagementClient implements DeveloperPlatformClient {
         .sort()
         .at(-1) ?? 'unstable'
 
-    const variables = createAppVars(options, apiVersion)
+    const variables = createAppVars(options, org.id, apiVersion)
 
     const mutation = CreateApp
     const result = await this.appManagementRequest({
@@ -692,7 +693,10 @@ export class AppManagementClient implements DeveloperPlatformClient {
   }
 
   async generateSignedUploadUrl({organizationId}: MinimalAppIdentifiers): Promise<AssetUrlSchema> {
-    const variables = {sourceExtension: 'BR' as SourceExtension}
+    const variables = {
+      sourceExtension: 'BR' as SourceExtension,
+      organizationId: gidFromOrganizationIdForShopify(organizationId),
+    }
     const result = await this.appManagementRequest({
       organizationId,
       query: CreateAssetUrl,
@@ -1069,7 +1073,7 @@ export class AppManagementClient implements DeveloperPlatformClient {
     allBetaFlags: string[],
   ): Promise<{[flag: (typeof allBetaFlags)[number]]: boolean}> {
     const variables: OrganizationBetaFlagsQueryVariables = {
-      organizationId: encodedGidFromOrganizationId(organizationId),
+      organizationId: encodedGidFromOrganizationIdForBP(organizationId),
     }
     const flagsResult = await businessPlatformOrganizationsRequest<OrganizationBetaFlagsQuerySchema>({
       query: organizationBetaFlagsQuery(allBetaFlags),
@@ -1171,7 +1175,11 @@ interface AppVersionSourceUrl {
 const MAGIC_URL = 'https://shopify.dev/apps/default-app-home'
 const MAGIC_REDIRECT_URL = 'https://shopify.dev/apps/default-app-home/api/auth'
 
-function createAppVars(options: CreateAppOptions, apiVersion?: string): CreateAppMutationVariables {
+function createAppVars(
+  options: CreateAppOptions,
+  organizationId: string,
+  apiVersion: string,
+): CreateAppMutationVariables {
   const {isLaunchable, scopesArray, name} = options
   const source: AppVersionSource = {
     source: {
@@ -1206,18 +1214,28 @@ function createAppVars(options: CreateAppOptions, apiVersion?: string): CreateAp
     },
   }
 
-  return {initialVersion: {source: source.source as unknown as JsonMapType}}
+  return {
+    initialVersion: {source: source.source as unknown as JsonMapType},
+    organizationId: gidFromOrganizationIdForShopify(organizationId),
+  }
 }
 
 // Business platform uses base64-encoded GIDs, while App Management uses
 // just the integer portion of that ID. These functions convert between the two.
 
 // 1234 => gid://organization/Organization/1234 => base64
-export function encodedGidFromOrganizationId(id: string): string {
-  const gid = `gid://organization/Organization/${id}`
+export function encodedGidFromOrganizationIdForBP(id: string): string {
+  const num = id.startsWith('gid://') ? numberFromGid(id) : Number(id)
+  const gid = `gid://organization/Organization/${num}`
   return Buffer.from(gid).toString('base64')
 }
 
+// App Managament uses a different GID format than Business Platform for organizationId.
+function gidFromOrganizationIdForShopify(id: string): string {
+  const num = id.startsWith('gid://') ? numberFromGid(id) : Number(id)
+  return `gid://shopify/Organization/${num}`
+}
+
 // 1234 => gid://organization/ShopifyShop/1234 => base64
 export function encodedGidFromShopId(id: string): string {
   const gid = `gid://organization/ShopifyShop/${id}`
