Merge pull request #6087 from Shopify/add-confirmation-to-export

add confirmation step to exports

Author: odacrem

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

@@ -0,0 +1,34 @@
+import {confirmExportPrompt} from './confirm_export.js'
+import {renderConfirmationPrompt} from '@shopify/cli-kit/node/ui'
+import {describe, expect, vi, test} from 'vitest'
+
+vi.mock('@shopify/cli-kit/node/ui')
+
+describe('confirmExportPrompt', () => {
+  test('returns true when user confirms', async () => {
+    const toFile = 'data.sqlite'
+    const fromStore = 'shop.myshopify.com'
+    const message = `Export data from ${fromStore} to ${toFile}?`
+    const confirmationMessage = 'Yes, export'
+    const cancellationMessage = 'Cancel'
+
+    vi.mocked(renderConfirmationPrompt).mockResolvedValue(true)
+
+    const result = await confirmExportPrompt(fromStore, toFile)
+
+    expect(renderConfirmationPrompt).toHaveBeenCalledWith({
+      message,
+      confirmationMessage,
+      cancellationMessage,
+    })
+    expect(result).toBe(true)
+  })
+
+  test('returns false when user cancels', async () => {
+    const toFile = 'export.sqlite'
+    const fromStore = 'test-shop.myshopify.com'
+    vi.mocked(renderConfirmationPrompt).mockResolvedValue(false)
+    const result = await confirmExportPrompt(fromStore, toFile)
+    expect(result).toBe(false)
+  })
+})

packages/store/src/prompts/confirm_export.ts

@@ -0,0 +1,9 @@
+import {renderConfirmationPrompt} from '@shopify/cli-kit/node/ui'
+
+export async function confirmExportPrompt(fromStore: string, toFile: string): Promise<boolean> {
+  return renderConfirmationPrompt({
+    message: `Export data from ${fromStore} to ${toFile}?`,
+    confirmationMessage: 'Yes, export',
+    cancellationMessage: 'Cancel',
+  })
+}

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

@@ -58,7 +58,12 @@ describe('renderExportResult', () => {
     renderExportResult(sourceShop, exportOperation)
 
     expect(renderSuccess).toHaveBeenCalledWith({
-      body: ['Export operation from', {info: 'source-shop.myshopify.com'}, 'complete'],
+      body: [
+        'Export operation from',
+        {info: 'source-shop.myshopify.com'},
+        'complete',
+        {link: {label: 'export file available for download', url: 'https://example.com/results'}},
+      ],
     })
     expect(renderWarning).not.toHaveBeenCalled()
   })

packages/store/src/prompts/export_results.ts

@@ -7,6 +7,7 @@ export function renderExportResult(sourceShop: Shop, exportOperation: BulkDataOp
 
   const storeOperations = exportOperation.organization.bulkData.operation.storeOperations
   const hasErrors = storeOperations.some((op) => op.remoteOperationStatus === 'FAILED')
+  const url = storeOperations[0]?.url
 
   if (hasErrors) {
     msg.push(`completed with`)
@@ -16,6 +17,10 @@ export function renderExportResult(sourceShop: Shop, exportOperation: BulkDataOp
     })
   } else {
     msg.push('complete')
+    if (url) {
+      const link = {link: {label: 'export file available for download', url}}
+      msg.push(link)
+    }
     renderSuccess({
       body: msg,
     })

packages/store/src/services/store/operations/store-export.test.ts

@@ -11,13 +11,15 @@ import {BulkDataStoreExportStartResponse, BulkDataOperationByIdResponse} from '.
 import {renderCopyInfo} from '../../../prompts/copy_info.js'
 import {renderExportResult} from '../../../prompts/export_results.js'
 import {ValidationError, OperationError, ErrorCodes} from '../errors/errors.js'
+import {confirmExportPrompt} from '../../../prompts/confirm_export.js'
 import {describe, vi, expect, test, beforeEach} from 'vitest'
 import {renderTasks} from '@shopify/cli-kit/node/ui'
 
 vi.mock('../utils/result-file-handler.js')
 vi.mock('@shopify/cli-kit/node/ui')
 vi.mock('../../../prompts/copy_info.js')
 vi.mock('../../../prompts/export_results.js')
+vi.mock('../../../prompts/confirm_export.js')
 
 describe('StoreExportOperation', () => {
   const mockBpSession = 'mock-bp-session-token'
@@ -55,9 +57,26 @@ describe('StoreExportOperation', () => {
     })
   })
 
+  test('should show confirm prompt before export', async () => {
+    vi.mocked(confirmExportPrompt).mockResolvedValue(true)
+    await operation.execute('source.myshopify.com', 'export.sqlite', {})
+
+    expect(confirmExportPrompt).toHaveBeenCalledWith('source.myshopify.com', 'export.sqlite')
+    expect(renderExportResult).toHaveBeenCalled()
+  })
+
+  test('should skip confirmation when --no-prompt flag is provided', async () => {
+    await operation.execute('source.myshopify.com', 'export.sqlite', {'no-prompt': true})
+
+    expect(confirmExportPrompt).not.toHaveBeenCalled()
+    expect(renderExportResult).toHaveBeenCalled()
+  })
+
   test('should successfully export data from source shop', async () => {
+    vi.mocked(confirmExportPrompt).mockResolvedValue(true)
     await operation.execute('source.myshopify.com', 'output.sqlite', {})
 
+    expect(confirmExportPrompt).toHaveBeenCalledWith('source.myshopify.com', 'output.sqlite')
     expect(renderCopyInfo).toHaveBeenCalledWith('Export Operation', 'source.myshopify.com', 'output.sqlite')
     expect(renderExportResult).toHaveBeenCalledWith(mockSourceShop, mockCompletedOperation)
     expect(mockResultFileHandler.promptAndHandleResultFile).toHaveBeenCalledWith(
@@ -81,7 +100,7 @@ describe('StoreExportOperation', () => {
       },
     ])
 
-    const promise = operation.execute('nonexistent.myshopify.com', 'output.sqlite', {})
+    const promise = operation.execute('nonexistent.myshopify.com', 'output.sqlite', {'no-prompt': true})
     await expect(promise).rejects.toThrow(ValidationError)
     await expect(promise).rejects.toMatchObject({
       code: ErrorCodes.SHOP_NOT_FOUND,
@@ -103,7 +122,7 @@ describe('StoreExportOperation', () => {
     const singleShopOrg: Organization = TEST_MOCK_DATA.singleShopOrganization
     mockApiClient.fetchOrganizations.mockResolvedValue([mockOrganization, singleShopOrg])
 
-    await operation.execute('source.myshopify.com', 'output.sqlite', {})
+    await operation.execute('source.myshopify.com', 'output.sqlite', {'no-prompt': true})
 
     expect(renderExportResult).toHaveBeenCalled()
   })
@@ -121,7 +140,7 @@ describe('StoreExportOperation', () => {
       return ctx
     })
 
-    const promise = operation.execute('source.myshopify.com', 'output.sqlite', {})
+    const promise = operation.execute('source.myshopify.com', 'output.sqlite', {'no-prompt': true})
     await expect(promise).rejects.toThrow(OperationError)
     await expect(promise).rejects.toMatchObject({
       operation: 'export',
@@ -153,7 +172,7 @@ describe('StoreExportOperation', () => {
       isComplete: true,
     })
 
-    const promise = operation.execute('source.myshopify.com', 'output.sqlite', {})
+    const promise = operation.execute('source.myshopify.com', 'output.sqlite', {'no-prompt': true})
     await expect(promise).rejects.toThrow(OperationError)
     await expect(promise).rejects.toMatchObject({
       operation: 'export',
@@ -181,7 +200,7 @@ describe('StoreExportOperation', () => {
       isComplete: true,
     })
 
-    const promise = operation.execute('source.myshopify.com', 'output.sqlite', {})
+    const promise = operation.execute('source.myshopify.com', 'output.sqlite', {'no-prompt': true})
     await expect(promise).rejects.toThrow(OperationError)
     await expect(promise).rejects.toMatchObject({
       operation: 'export',
@@ -218,7 +237,7 @@ describe('StoreExportOperation', () => {
       return ctx
     })
 
-    const promise = operation.execute('source.myshopify.com', 'output.sqlite', {})
+    const promise = operation.execute('source.myshopify.com', 'output.sqlite', {'no-prompt': true})
     await expect(promise).rejects.toThrow(OperationError)
     await expect(promise).rejects.toMatchObject({
       operation: 'export',

packages/store/src/services/store/operations/store-export.ts

@@ -10,7 +10,9 @@ import {BulkOperationTaskGenerator, BulkOperationContext} from '../utils/bulk-op
 import {renderCopyInfo} from '../../../prompts/copy_info.js'
 import {ValidationError, OperationError, ErrorCodes} from '../errors/errors.js'
 import {renderExportResult} from '../../../prompts/export_results.js'
+import {confirmExportPrompt} from '../../../prompts/confirm_export.js'
 import {Task, renderTasks} from '@shopify/cli-kit/node/ui'
+import {outputInfo} from '@shopify/cli-kit/node/output'
 
 export class StoreExportOperation implements StoreOperation {
   fromArg: string | undefined
@@ -32,6 +34,13 @@ export class StoreExportOperation implements StoreOperation {
     const sourceShop = findStore(fromStore, this.orgs)
     this.validateShop(sourceShop)
 
+    if (!flags['no-prompt']) {
+      if (!(await confirmExportPrompt(sourceShop.domain, toFile))) {
+        outputInfo('Exiting.')
+        process.exit(0)
+      }
+    }
+
     renderCopyInfo('Export Operation', sourceShop.domain, toFile)
     const exportOperation = await this.exportDataWithProgress(sourceShop.organizationId, sourceShop, this.bpSession)