Merge pull request #6091 from Shopify/rz-shop-id-for-api

Use shopId to route Organization API requests

Author: odacrem

packages/store/src/apis/admin/index.ts

@@ -1,4 +1,6 @@
+import {Shop} from './types.js'
 import {StagedUploadsCreate} from '../../cli/api/graphql/admin/generated/staged_uploads_create.js'
+import {ShopDetails} from '../../cli/api/graphql/admin/generated/shop_details.js'
 import {adminRequestDoc} from '@shopify/cli-kit/node/api/admin'
 import {ensureAuthenticatedAdmin} from '@shopify/cli-kit/node/session'
 import type {
@@ -7,6 +9,8 @@ import type {
 } from '../../cli/api/graphql/admin/generated/staged_uploads_create.js'
 import type {StagedUploadInput} from '../../cli/api/graphql/admin/generated/types.js'
 
+import type {ShopDetailsQuery, ShopDetailsQueryVariables} from '../../cli/api/graphql/admin/generated/shop_details.js'
+
 export async function createStagedUploadAdmin(
   storeFqdn: string,
   input: StagedUploadInput[],
@@ -23,3 +27,12 @@ export async function createStagedUploadAdmin(
 }
 
 export type {StagedUploadInput} from '../../cli/api/graphql/admin/generated/types.js'
+
+export async function getShopDetails(storeDomain: string): Promise<Shop> {
+  const adminSession = await ensureAuthenticatedAdmin(`https://${storeDomain}`)
+  const response = await adminRequestDoc<ShopDetailsQuery, ShopDetailsQueryVariables>({
+    query: ShopDetails,
+    session: adminSession,
+  })
+  return response.shop
+}

packages/store/src/apis/admin/types.ts

@@ -0,0 +1,4 @@
+export interface Shop {
+  id: string
+  name: string
+}

packages/store/src/apis/organizations/index.ts

@@ -18,7 +18,7 @@ import {GraphQLVariables, graphqlRequest, CacheOptions, UnauthorizedHandler} fro
 import {businessPlatformFqdn} from '@shopify/cli-kit/node/context/fqdn'
 
 export async function organizationsRequest<T>(
-  organizationId: string,
+  shopId: string,
   query: string,
   token: string,
   variables?: GraphQLVariables,
@@ -27,9 +27,8 @@ export async function organizationsRequest<T>(
 ): Promise<T> {
   const api = 'BusinessPlatform'
   const fqdn = await businessPlatformFqdn()
-  const decodedOrganizationGid = Buffer.from(organizationId, 'base64').toString('utf-8')
-  const numericOrganizationId = decodedOrganizationGid.split('/').pop()
-  const url = `https://${fqdn}/organizations/api/unstable/organization/${numericOrganizationId}/graphql`
+  const numericShopId = shopId.split('/').pop()
+  const url = `https://${fqdn}/organizations/api/unstable/shop/${numericShopId}/graphql`
 
   return graphqlRequest<T>({
     token,
@@ -43,7 +42,7 @@ export async function organizationsRequest<T>(
 }
 
 export async function startBulkDataStoreCopy(
-  organizationId: string,
+  shopId: string,
   sourceShopDomain: string,
   targetShopDomain: string,
   resourceConfigs: ResourceConfigs,
@@ -71,7 +70,7 @@ export async function startBulkDataStoreCopy(
   }
 
   return organizationsRequest<BulkDataStoreCopyStartResponse>(
-    organizationId,
+    shopId,
     bulkDataStoreCopyStartMutation,
     token,
     {
@@ -83,7 +82,7 @@ export async function startBulkDataStoreCopy(
 }
 
 export async function startBulkDataStoreExport(
-  organizationId: string,
+  shopId: string,
   sourceShopDomain: string,
   token: string,
   unauthorizedHandler?: UnauthorizedHandler,
@@ -95,7 +94,7 @@ export async function startBulkDataStoreExport(
   }
 
   return organizationsRequest<BulkDataStoreExportStartResponse>(
-    organizationId,
+    shopId,
     bulkDataStoreExportStartMutation,
     token,
     {
@@ -107,7 +106,7 @@ export async function startBulkDataStoreExport(
 }
 
 export async function startBulkDataStoreImport(
-  organizationId: string,
+  shopId: string,
   targetShopDomain: string,
   importUrl: string,
   resourceConfigs: ResourceConfigs,
@@ -133,7 +132,7 @@ export async function startBulkDataStoreImport(
   }
 
   return organizationsRequest<BulkDataStoreImportStartResponse>(
-    organizationId,
+    shopId,
     bulkDataStoreImportStartMutation,
     token,
     {
@@ -145,13 +144,13 @@ export async function startBulkDataStoreImport(
 }
 
 export async function pollBulkDataOperation(
-  organizationId: string,
+  shopId: string,
   operationId: string,
   token: string,
   unauthorizedHandler?: UnauthorizedHandler,
 ): Promise<BulkDataOperationByIdResponse> {
   return organizationsRequest<BulkDataOperationByIdResponse>(
-    organizationId,
+    shopId,
     bulkDataOperationByIdQuery,
     token,
     {

packages/store/src/cli/api/graphql/admin/generated/shop_details.ts

@@ -0,0 +1,36 @@
+/* eslint-disable @typescript-eslint/consistent-type-definitions, @typescript-eslint/naming-convention, @typescript-eslint/ban-types, @typescript-eslint/no-duplicate-type-constituents, @typescript-eslint/no-redundant-type-constituents, @nx/enforce-module-boundaries */
+import * as Types from './types.js'
+
+import {TypedDocumentNode as DocumentNode} from '@graphql-typed-document-node/core'
+
+export type ShopDetailsQueryVariables = Types.Exact<{[key: string]: never}>
+
+export type ShopDetailsQuery = {shop: {id: string; name: string}}
+
+export const ShopDetails = {
+  kind: 'Document',
+  definitions: [
+    {
+      kind: 'OperationDefinition',
+      operation: 'query',
+      name: {kind: 'Name', value: 'ShopDetails'},
+      selectionSet: {
+        kind: 'SelectionSet',
+        selections: [
+          {
+            kind: 'Field',
+            name: {kind: 'Name', value: 'shop'},
+            selectionSet: {
+              kind: 'SelectionSet',
+              selections: [
+                {kind: 'Field', name: {kind: 'Name', value: 'id'}},
+                {kind: 'Field', name: {kind: 'Name', value: 'name'}},
+                {kind: 'Field', name: {kind: 'Name', value: '__typename'}},
+              ],
+            },
+          },
+        ],
+      },
+    },
+  ],
+} as unknown as DocumentNode<ShopDetailsQuery, ShopDetailsQueryVariables>

packages/store/src/cli/api/graphql/admin/queries/shop_details.graphql

@@ -0,0 +1,6 @@
+query ShopDetails {
+  shop {
+    id
+    name
+  }
+}

packages/store/src/commands/store/copy.test.ts

@@ -4,7 +4,6 @@ import {StoreExportOperation} from '../../services/store/operations/store-export
 import {StoreImportOperation} from '../../services/store/operations/store-import.js'
 import {ApiClient} from '../../services/store/api/api-client.js'
 import {MockApiClient} from '../../services/store/mock/mock-api-client.js'
-import {ensureOrgHasBulkDataAccess} from '../../services/store/utils/store-utils.js'
 import {describe, vi, expect, test, beforeEach} from 'vitest'
 import {Config, loadHelpClass} from '@oclif/core'
 
@@ -14,9 +13,6 @@ vi.mock('../../services/store/operations/store-export.js')
 vi.mock('../../services/store/operations/store-import.js')
 vi.mock('../../services/store/api/api-client.js')
 vi.mock('../../services/store/mock/mock-api-client.js')
-vi.mock('../../services/store/utils/store-utils.js', () => ({
-  ensureOrgHasBulkDataAccess: vi.fn().mockResolvedValue(true),
-}))
 vi.mock('@oclif/core', async () => {
   const actual = await vi.importActual('@oclif/core')
   return {
@@ -58,21 +54,16 @@ describe('Copy', () => {
       () =>
         ({
           ensureAuthenticatedBusinessPlatform: vi.fn().mockResolvedValue('mock-session'),
-          fetchOrganizations: vi.fn().mockResolvedValue(mockOrganizations),
         } as any),
     )
 
     vi.mocked(MockApiClient).mockImplementation(
       () =>
         ({
           ensureAuthenticatedBusinessPlatform: vi.fn().mockResolvedValue('mock-session'),
-          fetchOrganizations: vi.fn().mockResolvedValue(mockOrganizations),
         } as any),
     )
 
-    // Reset the mock for ensureOrgHasBulkDataAccess to default to true
-    vi.mocked(ensureOrgHasBulkDataAccess).mockResolvedValue(true)
-
     vi.mocked(StoreCopyOperation).mockImplementation(
       () =>
         ({

packages/store/src/commands/store/copy.ts

@@ -8,7 +8,6 @@ import {StoreExportOperation} from '../../services/store/operations/store-export
 import {StoreImportOperation} from '../../services/store/operations/store-import.js'
 import {ApiClient} from '../../services/store/api/api-client.js'
 import {MockApiClient} from '../../services/store/mock/mock-api-client.js'
-import {Organization} from '../../apis/destinations/index.js'
 import {globalFlags} from '@shopify/cli-kit/node/cli'
 import {joinPath, cwd} from '@shopify/cli-kit/node/path'
 import {loadHelpClass} from '@oclif/core'
@@ -35,7 +34,6 @@ export default class Copy extends BaseBDCommand {
     // Check access for all organizations first
     const apiClient = this.flags.mock ? new MockApiClient() : new ApiClient()
     const bpSession = await apiClient.ensureAuthenticatedBusinessPlatform()
-    const allOrgs = await apiClient.fetchOrganizations(bpSession)
 
     const {'from-store': fromStore, 'to-store': toStore, 'from-file': fromFile} = this.flags
     let {'to-file': toFile} = this.flags
@@ -51,25 +49,20 @@ export default class Copy extends BaseBDCommand {
       toFile = joinPath(cwd(), `${storeDomain}-export-${Date.now()}.sqlite`)
     }
 
-    const operation = this.getOperation(operationMode, bpSession, apiClient, allOrgs)
+    const operation = this.getOperation(operationMode, bpSession, apiClient)
     const source = fromStore ?? fromFile
     const destination = toStore ?? toFile
     await operation.execute(source as string, destination as string, this.flags)
   }
 
-  private getOperation(
-    mode: OperationMode,
-    bpSession: string,
-    apiClient: ApiClient | MockApiClient,
-    orgs: Organization[],
-  ) {
+  private getOperation(mode: OperationMode, bpSession: string, apiClient: ApiClient | MockApiClient) {
     switch (mode) {
       case OperationMode.StoreCopy:
-        return new StoreCopyOperation(bpSession, apiClient, orgs)
+        return new StoreCopyOperation(bpSession, apiClient)
       case OperationMode.StoreExport:
-        return new StoreExportOperation(bpSession, apiClient, orgs)
+        return new StoreExportOperation(bpSession, apiClient)
       case OperationMode.StoreImport:
-        return new StoreImportOperation(bpSession, apiClient, orgs)
+        return new StoreImportOperation(bpSession, apiClient)
       default:
         throw new Error(`Unknown operation mode: ${mode}`)
     }

packages/store/src/prompts/copy_result.test.ts

@@ -54,12 +54,12 @@ describe('renderCopyResult', () => {
   }
 
   test('calls renderOperationResult with correct base message', () => {
-    renderCopyResult(sourceShop, targetShop, mockOperation)
+    renderCopyResult(sourceShop.domain, targetShop.domain, mockOperation)
 
     expect(renderOperationResult).toHaveBeenCalledWith(
       [{subdued: 'From:'}, 'source-shop.myshopify.com', {subdued: '\nTo:  '}, 'target-shop.myshopify.com'],
       mockOperation,
-      targetShop,
+      targetShop.domain,
     )
   })
 })

packages/store/src/prompts/copy_result.ts

@@ -1,13 +1,12 @@
 import {renderOperationResult} from './operation_result.js'
-import {Shop} from '../apis/destinations/index.js'
 import {BulkDataOperationByIdResponse} from '../apis/organizations/types.js'
 import {Token} from '@shopify/cli-kit/node/ui'
 
 export function renderCopyResult(
-  sourceShop: Shop,
-  targetShop: Shop,
+  sourceShopDomain: string,
+  targetShopDomain: string,
   copyOperation: BulkDataOperationByIdResponse,
 ): void {
-  const msg: Token[] = [{subdued: 'From:'}, sourceShop.domain, {subdued: '\nTo:  '}, targetShop.domain]
-  renderOperationResult(msg, copyOperation, targetShop)
+  const msg: Token[] = [{subdued: 'From:'}, sourceShopDomain, {subdued: '\nTo:  '}, targetShopDomain]
+  renderOperationResult(msg, copyOperation, targetShopDomain)
 }

packages/store/src/prompts/export_results.test.ts

@@ -55,7 +55,7 @@ describe('renderExportResult', () => {
       },
     }
 
-    renderExportResult(sourceShop, exportOperation)
+    renderExportResult(sourceShop.domain, exportOperation)
 
     expect(renderSuccess).toHaveBeenCalledWith({
       body: [
@@ -104,7 +104,7 @@ describe('renderExportResult', () => {
       },
     }
 
-    renderExportResult(sourceShop, exportOperation)
+    renderExportResult(sourceShop.domain, exportOperation)
 
     expect(renderWarning).toHaveBeenCalledWith({
       body: ['Export operation from', {info: 'source-shop.myshopify.com'}, 'completed with', {error: 'errors'}],
@@ -160,7 +160,7 @@ describe('renderExportResult', () => {
       },
     }
 
-    renderExportResult(sourceShop, exportOperation)
+    renderExportResult(sourceShop.domain, exportOperation)
 
     expect(renderWarning).toHaveBeenCalledWith({
       body: ['Export operation from', {info: 'source-shop.myshopify.com'}, 'completed with', {error: 'errors'}],