Merge pull request #6076 from Shopify/download-result-file-from-copy

Add download link to copy operation results

Author: odacrem

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

@@ -105,7 +105,7 @@ export interface BulkDataOperationByIdResponse {
           remoteOperationStatus: string
           totalObjectCount: number
           completedObjectCount: number
-          url: string
+          url?: string
         }[]
       }
     }

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

@@ -1,10 +1,10 @@
 import {renderCopyResult} from './copy_result.js'
+import {renderOperationResult} from './operation_result.js'
 import {Shop} from '../apis/destinations/index.js'
 import {BulkDataOperationByIdResponse} from '../apis/organizations/types.js'
-import {renderWarning, renderSuccess} from '@shopify/cli-kit/node/ui'
 import {describe, expect, vi, test} from 'vitest'
 
-vi.mock('@shopify/cli-kit/node/ui')
+vi.mock('./operation_result.js')
 
 describe('renderCopyResult', () => {
   const sourceShop: Shop = {
@@ -31,167 +31,34 @@ describe('renderCopyResult', () => {
     organizationId: 'org2',
   }
 
-  test('renders success when no errors', () => {
-    const copyOperation: BulkDataOperationByIdResponse = {
-      organization: {
-        name: 'Test Organization',
-        bulkData: {
-          operation: {
-            id: 'bulk-op-1',
-            operationType: 'COPY',
-            status: 'COMPLETED',
-            sourceStore: {
-              id: '1',
-              name: 'Source Store',
-            },
-            targetStore: {
-              id: '2',
-              name: 'Target Store',
-            },
-            storeOperations: [
-              {
-                id: 'op1',
-                store: {
-                  id: '1',
-                  name: 'Store 1',
-                },
-                remoteOperationType: 'EXPORT',
-                remoteOperationStatus: 'COMPLETED',
-                totalObjectCount: 100,
-                completedObjectCount: 100,
-                url: 'https://example.com/results',
-              },
-            ],
+  const mockOperation: BulkDataOperationByIdResponse = {
+    organization: {
+      name: 'Test Organization',
+      bulkData: {
+        operation: {
+          id: 'bulk-op-1',
+          operationType: 'COPY',
+          status: 'COMPLETED',
+          sourceStore: {
+            id: '1',
+            name: 'Source Store',
           },
-        },
-      },
-    }
-
-    renderCopyResult(sourceShop, targetShop, copyOperation)
-
-    expect(renderSuccess).toHaveBeenCalledWith({
-      body: [
-        'Copy operation from',
-        {info: 'source-shop.myshopify.com'},
-        'to',
-        {info: 'target-shop.myshopify.com'},
-        'complete',
-      ],
-    })
-    expect(renderWarning).not.toHaveBeenCalled()
-  })
-
-  test('renders warning when errors exist', () => {
-    const copyOperation: BulkDataOperationByIdResponse = {
-      organization: {
-        name: 'Test Organization',
-        bulkData: {
-          operation: {
-            id: 'bulk-op-1',
-            operationType: 'COPY',
-            status: 'COMPLETED',
-            sourceStore: {
-              id: '1',
-              name: 'Source Store',
-            },
-            targetStore: {
-              id: '2',
-              name: 'Target Store',
-            },
-            storeOperations: [
-              {
-                id: 'op1',
-                store: {
-                  id: '1',
-                  name: 'Store 1',
-                },
-                remoteOperationType: 'EXPORT',
-                remoteOperationStatus: 'FAILED',
-                totalObjectCount: 100,
-                completedObjectCount: 50,
-                url: 'https://example.com/results',
-              },
-            ],
-          },
-        },
-      },
-    }
-
-    renderCopyResult(sourceShop, targetShop, copyOperation)
-
-    expect(renderWarning).toHaveBeenCalledWith({
-      body: [
-        'Copy operation from',
-        {info: 'source-shop.myshopify.com'},
-        'to',
-        {info: 'target-shop.myshopify.com'},
-        'completed with',
-        {error: 'errors'},
-      ],
-    })
-    expect(renderSuccess).not.toHaveBeenCalled()
-  })
-
-  test('renders warning when some operations fail', () => {
-    const copyOperation: BulkDataOperationByIdResponse = {
-      organization: {
-        name: 'Test Organization',
-        bulkData: {
-          operation: {
-            id: 'bulk-op-1',
-            operationType: 'COPY',
-            status: 'COMPLETED',
-            sourceStore: {
-              id: '1',
-              name: 'Source Store',
-            },
-            targetStore: {
-              id: '2',
-              name: 'Target Store',
-            },
-            storeOperations: [
-              {
-                id: 'op1',
-                store: {
-                  id: '1',
-                  name: 'Store 1',
-                },
-                remoteOperationType: 'EXPORT',
-                remoteOperationStatus: 'COMPLETED',
-                totalObjectCount: 100,
-                completedObjectCount: 100,
-                url: 'https://example.com/results1',
-              },
-              {
-                id: 'op2',
-                store: {
-                  id: '2',
-                  name: 'Store 2',
-                },
-                remoteOperationType: 'IMPORT',
-                remoteOperationStatus: 'FAILED',
-                totalObjectCount: 100,
-                completedObjectCount: 50,
-                url: 'https://example.com/results2',
-              },
-            ],
+          targetStore: {
+            id: '2',
+            name: 'Target Store',
           },
+          storeOperations: [],
         },
       },
-    }
+    },
+  }
 
-    renderCopyResult(sourceShop, targetShop, copyOperation)
+  test('calls renderOperationResult with correct base message', () => {
+    renderCopyResult(sourceShop, targetShop, mockOperation)
 
-    expect(renderWarning).toHaveBeenCalledWith({
-      body: [
-        'Copy operation from',
-        {info: 'source-shop.myshopify.com'},
-        'to',
-        {info: 'target-shop.myshopify.com'},
-        'completed with',
-        {error: 'errors'},
-      ],
-    })
-    expect(renderSuccess).not.toHaveBeenCalled()
+    expect(renderOperationResult).toHaveBeenCalledWith(
+      ['Copy operation from', {info: 'source-shop.myshopify.com'}, 'to', {info: 'target-shop.myshopify.com'}],
+      mockOperation,
+    )
   })
 })

packages/store/src/prompts/copy_result.ts

@@ -1,27 +1,13 @@
+import {renderOperationResult} from './operation_result.js'
 import {Shop} from '../apis/destinations/index.js'
 import {BulkDataOperationByIdResponse} from '../apis/organizations/types.js'
-import {Token, renderWarning, renderSuccess} from '@shopify/cli-kit/node/ui'
+import {Token} from '@shopify/cli-kit/node/ui'
 
 export function renderCopyResult(
   sourceShop: Shop,
   targetShop: Shop,
   copyOperation: BulkDataOperationByIdResponse,
 ): void {
   const msg: Token[] = [`Copy operation from`, {info: sourceShop.domain}, `to`, {info: targetShop.domain}]
-
-  const storeOperations = copyOperation.organization.bulkData.operation.storeOperations
-  const hasErrors = storeOperations.some((op) => op.remoteOperationStatus === 'FAILED')
-
-  if (hasErrors) {
-    msg.push(`completed with`)
-    msg.push({error: `errors`})
-    renderWarning({
-      body: msg,
-    })
-  } else {
-    msg.push('complete')
-    renderSuccess({
-      body: msg,
-    })
-  }
+  renderOperationResult(msg, copyOperation)
 }