Record business_platform_id not partner_id in remaining cases

packages/app/src/cli/commands/app/env/pull.ts

@@ -30,14 +30,14 @@ export default class EnvPull extends AppCommand {
   public async run(): Promise<AppCommandOutput> {
     const {flags} = await this.parse(EnvPull)
 
-    const {app, remoteApp} = await linkedAppContext({
+    const {app, remoteApp, organization} = await linkedAppContext({
       directory: flags.path,
       clientId: flags['client-id'],
       forceRelink: flags.reset,
       userProvidedConfigName: flags.config,
     })
     const envFile = joinPath(app.directory, flags['env-file'] ?? getDotEnvFileName(app.configuration.path))
-    outputInfo(await pullEnv({app, remoteApp, envFile}))
+    outputInfo(await pullEnv({app, remoteApp, organization, envFile}))
     return {app}
   }
 }

packages/app/src/cli/commands/app/env/show.ts

@@ -19,13 +19,13 @@ export default class EnvShow extends AppCommand {
 
   public async run(): Promise<AppCommandOutput> {
     const {flags} = await this.parse(EnvShow)
-    const {app, remoteApp} = await linkedAppContext({
+    const {app, remoteApp, organization} = await linkedAppContext({
       directory: flags.path,
       clientId: flags['client-id'],
       forceRelink: flags.reset,
       userProvidedConfigName: flags.config,
     })
-    outputInfo(await showEnv(app, remoteApp))
+    outputInfo(await showEnv(app, remoteApp, organization))
     return {app}
   }
 }

packages/app/src/cli/commands/app/info.ts

@@ -33,15 +33,15 @@ export default class AppInfo extends AppCommand {
   public async run(): Promise<AppCommandOutput> {
     const {flags} = await this.parse(AppInfo)
 
-    const {app, remoteApp, developerPlatformClient} = await linkedAppContext({
+    const {app, remoteApp, organization, developerPlatformClient} = await linkedAppContext({
       directory: flags.path,
       clientId: flags['client-id'],
       forceRelink: flags.reset,
       userProvidedConfigName: flags.config,
       unsafeReportMode: true,
     })
     outputInfo(
-      await info(app, remoteApp, {
+      await info(app, remoteApp, organization, {
         format: (flags.json ? 'json' : 'text') as Format,
         webEnv: flags['web-env'],
         configName: flags.config,

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

@@ -1318,6 +1318,7 @@ export function testDeveloperPlatformClient(stubs: Partial<DeveloperPlatformClie
     requiresOrganization: false,
     supportsAtomicDeployments: false,
     supportsDevSessions: stubs.supportsDevSessions ?? false,
+    organizationSource: OrganizationSource.BusinessPlatform,
     session: () => Promise.resolve(testPartnersUserSession),
     refreshToken: () => Promise.resolve(testPartnersUserSession.token),
     accountInfo: () => Promise.resolve(testPartnersUserSession.accountInfo),
@@ -1378,7 +1379,12 @@ export function testDeveloperPlatformClient(stubs: Partial<DeveloperPlatformClie
       retVal[
         key as keyof Omit<
           DeveloperPlatformClient,
-          'requiresOrganization' | 'supportsAtomicDeployments' | 'clientName' | 'webUiName' | 'supportsDevSessions'
+          | 'requiresOrganization'
+          | 'supportsAtomicDeployments'
+          | 'clientName'
+          | 'webUiName'
+          | 'supportsDevSessions'
+          | 'organizationSource'
         >
       ] = vi.fn().mockImplementation(value)
     }

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

@@ -87,7 +87,7 @@ export default async function link(options: LinkOptions, shouldRenderSuccess = t
     format: localAppOptions.configFormat,
   })
 
-  await logMetadataForLoadedContext(remoteApp)
+  await logMetadataForLoadedContext(remoteApp, developerPlatformClient.organizationSource)
 
   // Finally, merge the remote app's configuration with the local app's configuration, and write it to the filesystem
   const mergedAppConfiguration = await overwriteLocalConfigFileWithRemoteAppConfiguration({

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

@@ -4,12 +4,10 @@ import {
   testApp,
   testAppWithConfig,
   testDeveloperPlatformClient,
-  testOrganizationApp,
 } from '../../../models/app/app.test-data.js'
 import {getAppConfigurationFileName, loadAppConfiguration} from '../../../models/app/loader.js'
 import {clearCurrentConfigFile, setCachedAppInfo} from '../../local-storage.js'
 import {selectConfigFile} from '../../../prompts/config.js'
-import {appFromIdentifiers, logMetadataForLoadedContext} from '../../context.js'
 import {describe, expect, test, vi} from 'vitest'
 import {inTemporaryDirectory, writeFileSync} from '@shopify/cli-kit/node/fs'
 import {joinPath} from '@shopify/cli-kit/node/path'
@@ -22,8 +20,6 @@ vi.mock('../../../models/app/loader.js')
 vi.mock('@shopify/cli-kit/node/ui')
 vi.mock('../../context.js')
 
-const REMOTE_APP = testOrganizationApp()
-
 describe('use', () => {
   test('clears currentConfiguration when reset is true', async () => {
     await inTemporaryDirectory(async (tmp) => {
@@ -289,31 +285,6 @@ describe('use', () => {
       expect(setCachedAppInfo).toHaveBeenCalledWith({directory, configFile: 'shopify.app.something.toml'})
     })
   })
-
-  test('logs metadata', async () => {
-    await inTemporaryDirectory(async (directory) => {
-      // Given
-      const {configuration} = testApp({}, 'current')
-      const {schema: configSchema} = await buildVersionedAppSchema()
-      vi.mocked(loadAppConfiguration).mockResolvedValue({
-        directory,
-        configuration,
-        configSchema,
-        specifications: [],
-        remoteFlags: [],
-      })
-      vi.mocked(getAppConfigurationFileName).mockReturnValue('shopify.app.something.toml')
-      vi.mocked(appFromIdentifiers).mockResolvedValue(REMOTE_APP)
-      createConfigFile(directory, 'shopify.app.something.toml')
-      const options = {directory, configName: 'something', developerPlatformClient: testDeveloperPlatformClient()}
-
-      // When
-      await use(options)
-
-      // Then
-      expect(logMetadataForLoadedContext).toHaveBeenNthCalledWith(1, {apiKey: REMOTE_APP.apiKey, organizationId: '0'})
-    })
-  })
 })
 
 function createConfigFile(tmp: string, fileName: string) {

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

@@ -2,7 +2,6 @@ import {getAppConfigurationFileName, loadAppConfiguration} from '../../../models
 import {clearCurrentConfigFile, setCachedAppInfo} from '../../local-storage.js'
 import {selectConfigFile} from '../../../prompts/config.js'
 import {AppConfiguration, CurrentAppConfiguration, isCurrentAppSchema} from '../../../models/app/app.js'
-import {logMetadataForLoadedContext} from '../../context.js'
 import {DeveloperPlatformClient} from '../../../utilities/developer-platform-client.js'
 import {AbortError} from '@shopify/cli-kit/node/error'
 import {fileExists} from '@shopify/cli-kit/node/fs'
@@ -60,8 +59,6 @@ export default async function use({
     })
   }
 
-  await logMetadata(configuration)
-
   return configFileName
 }
 
@@ -100,10 +97,3 @@ async function getConfigFileName(directory: string, configName?: string): Promis
   }
   return selectConfigFile(directory)
 }
-
-async function logMetadata(configuration: CurrentAppConfiguration) {
-  await logMetadataForLoadedContext({
-    organizationId: configuration.organization_id || '0',
-    apiKey: configuration.client_id,
-  })
-}

packages/app/src/cli/services/app/env/pull.test.ts

@@ -1,12 +1,18 @@
 import {pullEnv} from './pull.js'
 import {AppInterface, AppLinkedInterface} from '../../../models/app/app.js'
 import {testApp, testOrganizationApp} from '../../../models/app/app.test-data.js'
-import {OrganizationApp} from '../../../models/organization.js'
+import {Organization, OrganizationApp, OrganizationSource} from '../../../models/organization.js'
 import {describe, expect, vi, beforeEach, test} from 'vitest'
 import * as file from '@shopify/cli-kit/node/fs'
 import {resolvePath, joinPath} from '@shopify/cli-kit/node/path'
 import {unstyled, stringifyMessage} from '@shopify/cli-kit/node/output'
 
+const ORG1: Organization = {
+  id: '1',
+  businessName: 'My Org',
+  source: OrganizationSource.BusinessPlatform,
+}
+
 describe('env pull', () => {
   let app: AppLinkedInterface
   let remoteApp: OrganizationApp
@@ -23,7 +29,7 @@ describe('env pull', () => {
 
       // When
       const filePath = resolvePath(tmpDir, '.env')
-      const result = await pullEnv({app, remoteApp, envFile: filePath})
+      const result = await pullEnv({app, remoteApp, organization: ORG1, envFile: filePath})
 
       // Then
       expect(file.writeFile).toHaveBeenCalledWith(
@@ -49,7 +55,7 @@ describe('env pull', () => {
       vi.spyOn(file, 'writeFile')
 
       // When
-      const result = await pullEnv({app, remoteApp, envFile: filePath})
+      const result = await pullEnv({app, remoteApp, organization: ORG1, envFile: filePath})
 
       // Then
       expect(file.writeFile).toHaveBeenCalledWith(
@@ -83,7 +89,7 @@ describe('env pull', () => {
       vi.spyOn(file, 'writeFile')
 
       // When
-      const result = await pullEnv({app, remoteApp, envFile: filePath})
+      const result = await pullEnv({app, remoteApp, organization: ORG1, envFile: filePath})
 
       // Then
       expect(file.writeFile).not.toHaveBeenCalled()

packages/app/src/cli/services/app/env/pull.ts

@@ -2,7 +2,7 @@ import {AppLinkedInterface, getAppScopes} from '../../../models/app/app.js'
 
 import {logMetadataForLoadedContext} from '../../context.js'
 
-import {OrganizationApp} from '../../../models/organization.js'
+import {Organization, OrganizationApp} from '../../../models/organization.js'
 import {patchEnvFile} from '@shopify/cli-kit/node/dot-env'
 import {diffLines} from 'diff'
 import {fileExists, readFile, writeFile} from '@shopify/cli-kit/node/fs'
@@ -11,11 +11,12 @@ import {OutputMessage, outputContent, outputToken} from '@shopify/cli-kit/node/o
 interface PullEnvOptions {
   app: AppLinkedInterface
   remoteApp: OrganizationApp
+  organization: Organization
   envFile: string
 }
 
-export async function pullEnv({app, remoteApp, envFile}: PullEnvOptions): Promise<OutputMessage> {
-  await logMetadataForLoadedContext(remoteApp)
+export async function pullEnv({app, remoteApp, organization, envFile}: PullEnvOptions): Promise<OutputMessage> {
+  await logMetadataForLoadedContext(remoteApp, organization.source)
 
   const updatedValues = {
     SHOPIFY_API_KEY: remoteApp.apiKey,

packages/app/src/cli/services/app/env/show.test.ts

@@ -27,13 +27,12 @@ describe('env show', () => {
       source: OrganizationSource.BusinessPlatform,
       apps: {nodes: []},
     }
-    const organizationApp = testOrganizationApp()
 
     vi.mocked(fetchOrganizations).mockResolvedValue([organization])
     vi.mocked(selectOrganizationPrompt).mockResolvedValue(organization)
 
     // When
-    const result = await showEnv(app, remoteApp)
+    const result = await showEnv(app, remoteApp, organization)
 
     // Then
     expect(file.writeFile).not.toHaveBeenCalled()

packages/app/src/cli/services/app/env/show.ts

@@ -1,16 +1,25 @@
 import {AppInterface, getAppScopes} from '../../../models/app/app.js'
-import {OrganizationApp} from '../../../models/organization.js'
+import {Organization, OrganizationApp} from '../../../models/organization.js'
 import {logMetadataForLoadedContext} from '../../context.js'
 import {OutputMessage, outputContent, outputToken} from '@shopify/cli-kit/node/output'
 
 type Format = 'json' | 'text'
 
-export async function showEnv(app: AppInterface, remoteApp: OrganizationApp): Promise<OutputMessage> {
-  return outputEnv(app, remoteApp, 'text')
+export async function showEnv(
+  app: AppInterface,
+  remoteApp: OrganizationApp,
+  organization: Organization,
+): Promise<OutputMessage> {
+  return outputEnv(app, remoteApp, organization, 'text')
 }
 
-export async function outputEnv(app: AppInterface, remoteApp: OrganizationApp, format: Format): Promise<OutputMessage> {
-  await logMetadataForLoadedContext(remoteApp)
+export async function outputEnv(
+  app: AppInterface,
+  remoteApp: OrganizationApp,
+  organization: Organization,
+  format: Format,
+): Promise<OutputMessage> {
+  await logMetadataForLoadedContext(remoteApp, organization.source)
 
   if (format === 'json') {
     return outputContent`${outputToken.json({

packages/app/src/cli/services/context.ts

@@ -14,7 +14,7 @@ import {
   AppLinkedInterface,
 } from '../models/app/app.js'
 import {Identifiers, updateAppIdentifiers, getAppIdentifiers} from '../models/app/identifiers.js'
-import {Organization, OrganizationApp, OrganizationStore} from '../models/organization.js'
+import {Organization, OrganizationApp, OrganizationSource, OrganizationStore} from '../models/organization.js'
 import metadata from '../metadata.js'
 import {getAppConfigurationFileName} from '../models/app/loader.js'
 import {ExtensionInstance} from '../models/extensions/extension-instance.js'
@@ -246,7 +246,7 @@ export async function fetchOrCreateOrganizationApp(
   })
   remoteApp.developerPlatformClient = developerPlatformClient
 
-  await logMetadataForLoadedContext({organizationId: remoteApp.organizationId, apiKey: remoteApp.apiKey})
+  await logMetadataForLoadedContext(remoteApp, developerPlatformClient.organizationSource)
 
   return remoteApp
 }
@@ -345,9 +345,15 @@ export function renderCurrentlyUsedConfigInfo({
   })
 }
 
-export async function logMetadataForLoadedContext(app: {organizationId: string; apiKey: string}) {
+export async function logMetadataForLoadedContext(
+  app: {apiKey: string; organizationId: string},
+  organizationSource: OrganizationSource,
+) {
+  const orgIdKey = organizationSource === OrganizationSource.BusinessPlatform ? 'business_platform_id' : 'partner_id'
+  const organizationInfo = {[orgIdKey]: tryParseInt(app.organizationId)}
+
   await metadata.addPublicMetadata(() => ({
-    partner_id: tryParseInt(app.organizationId),
+    ...organizationInfo,
     api_key: app.apiKey,
   }))
 }

packages/app/src/cli/services/info.test.ts

@@ -88,7 +88,7 @@ describe('info', () => {
       vi.mocked(checkForNewVersion).mockResolvedValue(latestVersion)
 
       // When
-      const result = stringifyMessage(await info(app, remoteApp, infoOptions()))
+      const result = stringifyMessage(await info(app, remoteApp, ORG1, infoOptions()))
       // Then
       expect(unstyled(result)).toMatch(`Shopify CLI       ${CLI_KIT_VERSION}`)
     })
@@ -101,7 +101,7 @@ describe('info', () => {
       vi.mocked(checkForNewVersion).mockResolvedValue(undefined)
 
       // When
-      const result = stringifyMessage(await info(app, remoteApp, infoOptions()))
+      const result = stringifyMessage(await info(app, remoteApp, ORG1, infoOptions()))
       // Then
       expect(unstyled(result)).toMatch(`Shopify CLI       ${CLI_KIT_VERSION}`)
       expect(unstyled(result)).not.toMatch('CLI reminder')
@@ -116,7 +116,7 @@ describe('info', () => {
       vi.mocked(selectOrganizationPrompt).mockResolvedValue(ORG1)
 
       // When
-      const result = await info(app, remoteApp, {...infoOptions(), webEnv: true})
+      const result = await info(app, remoteApp, ORG1, {...infoOptions(), webEnv: true})
 
       // Then
       expect(unstyled(stringifyMessage(result))).toMatchInlineSnapshot(`
@@ -136,7 +136,7 @@ describe('info', () => {
       vi.mocked(selectOrganizationPrompt).mockResolvedValue(ORG1)
 
       // When
-      const result = await info(app, remoteApp, {...infoOptions(), format: 'json', webEnv: true})
+      const result = await info(app, remoteApp, ORG1, {...infoOptions(), format: 'json', webEnv: true})
 
       // Then
       expect(unstyled(stringifyMessage(result))).toMatchInlineSnapshot(`
@@ -184,7 +184,7 @@ describe('info', () => {
       vi.mocked(selectOrganizationPrompt).mockResolvedValue(ORG1)
 
       // When
-      const result = await info(app, remoteApp, infoOptions())
+      const result = await info(app, remoteApp, ORG1, infoOptions())
 
       // Then
       expect(result).toContain('Extensions with errors')
@@ -222,7 +222,7 @@ describe('info', () => {
       vi.mocked(selectOrganizationPrompt).mockResolvedValue(ORG1)
 
       // When
-      const result = await info(app, remoteApp, infoOptions())
+      const result = await info(app, remoteApp, ORG1, infoOptions())
 
       // Then
       expect(result).toContain('📂 handle-for-extension-1')
@@ -253,7 +253,7 @@ describe('info', () => {
       vi.mocked(selectOrganizationPrompt).mockResolvedValue(ORG1)
 
       // When
-      const result = await info(app, remoteApp, {format: 'json', webEnv: false, developerPlatformClient})
+      const result = await info(app, remoteApp, ORG1, {format: 'json', webEnv: false, developerPlatformClient})
 
       // Then
       expect(result).toBeInstanceOf(TokenizedString)