Merge pull request #6378 from Shopify/show-org-ids

Show org ids when there are duplicated names

Author: gonzaloriestra

.changeset/heavy-berries-notice.md

@@ -0,0 +1,5 @@
+---
+'@shopify/app': patch
+---
+
+Show IDs next to organization names when there are duplicates

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

@@ -30,12 +30,14 @@ import {AppAccessSpecIdentifier} from '../../models/extensions/specifications/ap
 import {MinimalAppIdentifiers} from '../../models/organization.js'
 import {CreateAssetUrl} from '../../api/graphql/app-management/generated/create-asset-url.js'
 import {SourceExtension} from '../../api/graphql/app-management/generated/types.js'
+import {ListOrganizations} from '../../api/graphql/business-platform-destinations/generated/organizations.js'
 import {describe, expect, test, vi} from 'vitest'
 import {CLI_KIT_VERSION} from '@shopify/cli-kit/common/version'
 import {fetch} from '@shopify/cli-kit/node/http'
 import {
   businessPlatformOrganizationsRequest,
   businessPlatformOrganizationsRequestDoc,
+  businessPlatformRequestDoc,
 } from '@shopify/cli-kit/node/api/business-platform'
 import {appManagementRequestDoc} from '@shopify/cli-kit/node/api/app-management'
 import {BugError} from '@shopify/cli-kit/node/error'
@@ -1528,3 +1530,124 @@ describe('appExtensionRegistrations', () => {
     })
   })
 })
+
+describe('organizations', () => {
+  test('returns empty array when currentUserAccount is null', async () => {
+    // Given
+    const client = new AppManagementClient()
+    client.businessPlatformToken = () => Promise.resolve('business-platform-token')
+
+    vi.mocked(businessPlatformRequestDoc).mockResolvedValueOnce({
+      currentUserAccount: null,
+    })
+
+    // When
+    const result = await client.organizations()
+
+    // Then
+    expect(result).toEqual([])
+    expect(businessPlatformRequestDoc).toHaveBeenCalledWith(
+      expect.objectContaining({
+        query: ListOrganizations,
+        token: 'business-platform-token',
+      }),
+    )
+  })
+
+  test('returns organizations with unique names', async () => {
+    // Given
+    const client = new AppManagementClient()
+    client.businessPlatformToken = () => Promise.resolve('business-platform-token')
+    const mockResponse = {
+      currentUserAccount: {
+        uuid: 'user-123',
+        organizationsWithAccessToDestination: {
+          nodes: [
+            {id: 'Z2lkOi8vQnVzaW5lc3NQbGF0Zm9ybS9Pcmdhbml6YXRpb24vMQ==', name: 'Org One'},
+            {id: 'Z2lkOi8vQnVzaW5lc3NQbGF0Zm9ybS9Pcmdhbml6YXRpb24vMg==', name: 'Org Two'},
+            {id: 'Z2lkOi8vQnVzaW5lc3NQbGF0Zm9ybS9Pcmdhbml6YXRpb24vMw==', name: 'Org Three'},
+          ],
+        },
+      },
+    }
+    vi.mocked(businessPlatformRequestDoc).mockResolvedValueOnce(mockResponse)
+
+    // When
+    const result = await client.organizations()
+
+    // Then
+    expect(result).toEqual([
+      {id: '1', businessName: 'Org One', source: 'BusinessPlatform'},
+      {id: '2', businessName: 'Org Two', source: 'BusinessPlatform'},
+      {id: '3', businessName: 'Org Three', source: 'BusinessPlatform'},
+    ])
+  })
+
+  test('appends ID to businessName when organizations have duplicate names', async () => {
+    // Given
+    const client = new AppManagementClient()
+    client.businessPlatformToken = () => Promise.resolve('business-platform-token')
+    const mockResponse = {
+      currentUserAccount: {
+        uuid: 'user-123',
+        organizationsWithAccessToDestination: {
+          nodes: [
+            {id: 'Z2lkOi8vQnVzaW5lc3NQbGF0Zm9ybS9Pcmdhbml6YXRpb24vMQ==', name: 'My Org'},
+            {id: 'Z2lkOi8vQnVzaW5lc3NQbGF0Zm9ybS9Pcmdhbml6YXRpb24vMg==', name: 'My Org'},
+            {id: 'Z2lkOi8vQnVzaW5lc3NQbGF0Zm9ybS9Pcmdhbml6YXRpb24vMw==', name: 'Other Org'},
+            {id: 'Z2lkOi8vQnVzaW5lc3NQbGF0Zm9ybS9Pcmdhbml6YXRpb24vNA==', name: 'My Org'},
+          ],
+        },
+      },
+    }
+    vi.mocked(businessPlatformRequestDoc).mockResolvedValueOnce(mockResponse)
+
+    // When
+    const result = await client.organizations()
+
+    // Then
+    expect(result).toEqual([
+      {
+        id: '1',
+        businessName: 'My Org (1)',
+        source: 'BusinessPlatform',
+      },
+      {
+        id: '2',
+        businessName: 'My Org (2)',
+        source: 'BusinessPlatform',
+      },
+      {
+        id: '3',
+        businessName: 'Other Org (3)',
+        source: 'BusinessPlatform',
+      },
+      {
+        id: '4',
+        businessName: 'My Org (4)',
+        source: 'BusinessPlatform',
+      },
+    ])
+  })
+
+  test('returns empty array when organizationsWithAccessToDestination is empty', async () => {
+    // Given
+    const client = new AppManagementClient()
+    client.businessPlatformToken = () => Promise.resolve('business-platform-token')
+    const mockResponse = {
+      currentUserAccount: {
+        uuid: 'user-123',
+        organizationsWithAccessToDestination: {
+          nodes: [],
+        },
+      },
+    }
+    vi.mocked(businessPlatformRequestDoc).mockResolvedValueOnce(mockResponse)
+
+    // When
+    const result = await client.organizations()
+
+    // Then
+    expect(result).toEqual([])
+  })
+})

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

@@ -361,9 +361,12 @@ export class AppManagementClient implements DeveloperPlatformClient {
   async organizations(): Promise<Organization[]> {
     const organizationsResult = await this.businessPlatformRequest({query: ListOrganizations})
     if (!organizationsResult.currentUserAccount) return []
-    return organizationsResult.currentUserAccount.organizationsWithAccessToDestination.nodes.map((org) => ({
+    const orgs = organizationsResult.currentUserAccount.organizationsWithAccessToDestination.nodes
+    const uniqueNames = new Set(orgs.map((org) => org.name))
+    const duplicatedNames = uniqueNames.size < orgs.length
+    return orgs.map((org) => ({
       id: idFromEncodedGid(org.id),
-      businessName: `${org.name} (Dev Dashboard)`,
+      businessName: duplicatedNames ? `${org.name} (${idFromEncodedGid(org.id)})` : org.name,
       source: this.organizationSource,
     }))
   }