Report business platform ID instead of partner ID when relevant

Shopify · Dec 17, 2024 · 6a6802a · 6a6802a
1 parent a15cffc
commit 6a6802a
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 6 deletions.
diff --git a/packages/app/src/cli/models/app/app.test-data.ts b/packages/app/src/cli/models/app/app.test-data.ts
@@ -18,6 +18,7 @@ import {
   OrganizationApp,
   MinimalOrganizationApp,
   AppApiKeyAndOrgId,
+  OrganizationSource,
 } from '../organization.js'
 import {RemoteSpecification} from '../../api/graphql/extension_specifications.js'
 import {ExtensionInstance} from '../extensions/extension-instance.js'
@@ -176,6 +177,7 @@ export function testOrganization(): Organization {
   return {
     id: '1',
     businessName: 'org1',
+    source: OrganizationSource.BusinessPlatform,
   }
 }
 

diff --git a/packages/app/src/cli/services/app-context.test.ts b/packages/app/src/cli/services/app-context.test.ts
@@ -232,7 +232,7 @@ describe('linkedAppContext', () => {
       const meta = metadata.getAllPublicMetadata()
       expect(meta).toEqual(
         expect.objectContaining({
-          partner_id: tryParseInt(mockRemoteApp.organizationId),
+          business_platform_id: tryParseInt(mockOrganization.id),
           api_key: mockRemoteApp.apiKey,
           cmd_app_reset_used: false,
         }),

diff --git a/packages/app/src/cli/services/app-context.ts b/packages/app/src/cli/services/app-context.ts
@@ -3,7 +3,7 @@ import {getCachedAppInfo, setCachedAppInfo} from './local-storage.js'
 import {fetchSpecifications} from './generate/fetch-extension-specifications.js'
 import link from './app/config/link.js'
 import {fetchOrgFromId} from './dev/fetch.js'
-import {Organization, OrganizationApp} from '../models/organization.js'
+import {Organization, OrganizationApp, OrganizationSource} from '../models/organization.js'
 import {DeveloperPlatformClient, selectDeveloperPlatformClient} from '../utilities/developer-platform-client.js'
 import {getAppConfigurationState, loadAppUsingConfigurationState} from '../models/app/loader.js'
 import {RemoteAwareExtensionSpecification} from '../models/extensions/specification.js'
@@ -97,14 +97,21 @@ export async function linkedAppContext({
     setCachedAppInfo({appId: remoteApp.apiKey, title: remoteApp.title, directory, orgId: remoteApp.organizationId})
   }
 
-  await logMetadata(remoteApp, forceRelink)
+  await logMetadata(remoteApp, organization, forceRelink)
 
   return {app: localApp, remoteApp, developerPlatformClient, specifications, organization}
 }
 
-async function logMetadata(app: {organizationId: string; apiKey: string}, resetUsed: boolean) {
+async function logMetadata(app: {apiKey: string}, organization: Organization, resetUsed: boolean) {
+  let organizationInfo: {partner_id?: number; business_platform_id?: number}
+  if (organization.source === OrganizationSource.BusinessPlatform) {
+    organizationInfo = {business_platform_id: tryParseInt(organization.id)}
+  } else {
+    organizationInfo = {partner_id: tryParseInt(organization.id)}
+  }
+
   await metadata.addPublicMetadata(() => ({
-    partner_id: tryParseInt(app.organizationId),
+    ...organizationInfo,
     api_key: app.apiKey,
     cmd_app_reset_used: resetUsed,
   }))

diff --git a/packages/cli-kit/src/public/node/monorail.ts b/packages/cli-kit/src/public/node/monorail.ts
@@ -29,6 +29,7 @@ export interface Schemas {
       env_plugin_installed_all?: Optional<string>
     }
     public: {
+      business_platform_id?: Optional<number>
       partner_id?: Optional<number>
       command: string
       project_type?: Optional<string>

diff --git a/packages/cli-kit/src/public/node/plugins.ts b/packages/cli-kit/src/public/node/plugins.ts
@@ -28,7 +28,7 @@ export async function fanoutHooks<TPluginMap extends HookReturnsPerPlugin, TEven
   return Object.fromEntries(res.successes.map(({result, plugin}) => [plugin.name, result])) as any
 }
 
-type AppSpecificMonorailFields = PickByPrefix<MonorailEventPublic, 'app_', 'project_type' | 'api_key' | 'partner_id'> &
+type AppSpecificMonorailFields = PickByPrefix<MonorailEventPublic, 'app_', 'project_type' | 'api_key' | 'partner_id' | 'business_platform_id' > &
   PickByPrefix<MonorailEventPublic, 'cmd_extensions_'> &
   PickByPrefix<MonorailEventPublic, 'cmd_scaffold_'>