introduce --version flag to bulk operations CLI

Author: jordanverasamy

packages/app/src/cli/commands/app/bulk/execute.ts

@@ -52,6 +52,7 @@ export default class BulkExecute extends AppLinkedCommand {
       variableFile: flags['variable-file'],
       watch: flags.watch,
       outputFile: flags['output-file'],
+      version: flags.version,
     })
 
     return {app: appContextResult.app}

packages/app/src/cli/flags.ts

@@ -72,4 +72,8 @@ export const bulkOperationFlags = {
     description: 'The file path where results should be written. If not specified, results will be written to STDOUT.',
     env: 'SHOPIFY_FLAG_OUTPUT_FILE',
   }),
+  version: Flags.string({
+    description: 'The API version to use for the bulk operation. If not specified, uses the latest stable version.',
+    env: 'SHOPIFY_FLAG_VERSION',
+  }),
 }

packages/app/src/cli/services/bulk-operations/execute-bulk-operation.test.ts

@@ -75,6 +75,7 @@ describe('executeBulkOperation', () => {
     expect(runBulkOperationQuery).toHaveBeenCalledWith({
       adminSession: mockAdminSession,
       query,
+      version: undefined,
     })
     expect(runBulkOperationMutation).not.toHaveBeenCalled()
   })
@@ -96,6 +97,7 @@ describe('executeBulkOperation', () => {
     expect(runBulkOperationQuery).toHaveBeenCalledWith({
       adminSession: mockAdminSession,
       query,
+      version: undefined,
     })
     expect(runBulkOperationMutation).not.toHaveBeenCalled()
   })
@@ -118,6 +120,7 @@ describe('executeBulkOperation', () => {
       adminSession: mockAdminSession,
       query: mutation,
       variablesJsonl: undefined,
+      version: undefined,
     })
     expect(runBulkOperationQuery).not.toHaveBeenCalled()
   })
@@ -142,6 +145,54 @@ describe('executeBulkOperation', () => {
       adminSession: mockAdminSession,
       query: mutation,
       variablesJsonl: '{"input":{"id":"gid://shopify/Product/123","tags":["test"]}}',
+      version: undefined,
+    })
+  })
+
+  test('passes version parameter to runBulkOperationQuery when version is provided', async () => {
+    const query = '{ products { edges { node { id } } } }'
+    const version = '2025-01'
+    const mockResponse: BulkOperationRunQueryMutation['bulkOperationRunQuery'] = {
+      bulkOperation: createdBulkOperation,
+      userErrors: [],
+    }
+    vi.mocked(runBulkOperationQuery).mockResolvedValue(mockResponse)
+
+    await executeBulkOperation({
+      remoteApp: mockRemoteApp,
+      storeFqdn,
+      query,
+      version,
+    })
+
+    expect(runBulkOperationQuery).toHaveBeenCalledWith({
+      adminSession: mockAdminSession,
+      query,
+      version,
+    })
+  })
+
+  test('passes version parameter to runBulkOperationMutation when version is provided', async () => {
+    const mutation = 'mutation productUpdate($input: ProductInput!) { productUpdate(input: $input) { product { id } } }'
+    const version = '2025-01'
+    const mockResponse: BulkOperationRunMutationMutation['bulkOperationRunMutation'] = {
+      bulkOperation: createdBulkOperation,
+      userErrors: [],
+    }
+    vi.mocked(runBulkOperationMutation).mockResolvedValue(mockResponse)
+
+    await executeBulkOperation({
+      remoteApp: mockRemoteApp,
+      storeFqdn,
+      query: mutation,
+      version,
+    })
+
+    expect(runBulkOperationMutation).toHaveBeenCalledWith({
+      adminSession: mockAdminSession,
+      query: mutation,
+      variablesJsonl: undefined,
+      version,
     })
   })
 
@@ -269,6 +320,7 @@ describe('executeBulkOperation', () => {
         adminSession: mockAdminSession,
         query: mutation,
         variablesJsonl: variables.join('\n'),
+        version: undefined,
       })
     })
   })

packages/app/src/cli/services/bulk-operations/execute-bulk-operation.ts

@@ -19,6 +19,7 @@ interface ExecuteBulkOperationInput {
   variableFile?: string
   watch?: boolean
   outputFile?: string
+  version?: string
 }
 
 async function parseVariablesToJsonl(variables?: string[], variableFile?: string): Promise<string | undefined> {
@@ -39,7 +40,7 @@ async function parseVariablesToJsonl(variables?: string[], variableFile?: string
 }
 
 export async function executeBulkOperation(input: ExecuteBulkOperationInput): Promise<void> {
-  const {remoteApp, storeFqdn, query, variables, variableFile, outputFile, watch = false} = input
+  const {remoteApp, storeFqdn, query, variables, variableFile, outputFile, watch = false, version} = input
 
   renderInfo({
     headline: 'Starting bulk operation.',
@@ -56,8 +57,8 @@ export async function executeBulkOperation(input: ExecuteBulkOperationInput): Pr
   validateGraphQLDocument(query, variablesJsonl)
 
   const bulkOperationResponse = isMutation(query)
-    ? await runBulkOperationMutation({adminSession, query, variablesJsonl})
-    : await runBulkOperationQuery({adminSession, query})
+    ? await runBulkOperationMutation({adminSession, query, variablesJsonl, version})
+    : await runBulkOperationQuery({adminSession, query, version})
 
   if (bulkOperationResponse?.userErrors?.length) {
     const errorMessages = bulkOperationResponse.userErrors

packages/app/src/cli/services/bulk-operations/run-mutation.ts

@@ -11,12 +11,13 @@ interface BulkOperationRunMutationOptions {
   adminSession: AdminSession
   query: string
   variablesJsonl?: string
+  version?: string
 }
 
 export async function runBulkOperationMutation(
   options: BulkOperationRunMutationOptions,
 ): Promise<BulkOperationRunMutationMutation['bulkOperationRunMutation']> {
-  const {adminSession, query: mutation, variablesJsonl} = options
+  const {adminSession, query: mutation, variablesJsonl, version} = options
 
   const stagedUploadPath = await stageFile({
     adminSession,
@@ -30,6 +31,7 @@ export async function runBulkOperationMutation(
       mutation,
       stagedUploadPath,
     },
+    version,
   })
 
   return response.bulkOperationRunMutation

packages/app/src/cli/services/bulk-operations/run-query.ts

@@ -8,17 +8,19 @@ import {AdminSession} from '@shopify/cli-kit/node/session'
 interface BulkOperationRunQueryOptions {
   adminSession: AdminSession
   query: string
+  version?: string
 }
 
 export async function runBulkOperationQuery(
   options: BulkOperationRunQueryOptions,
 ): Promise<BulkOperationRunQueryMutation['bulkOperationRunQuery']> {
-  const {adminSession, query} = options
+  const {adminSession, query, version} = options
 
   const response = await adminRequestDoc<BulkOperationRunQueryMutation, {query: string}>({
     query: BulkOperationRunQuery,
     session: adminSession,
     variables: {query},
+    version,
   })
 
   return response.bulkOperationRunQuery

packages/cli/oclif.manifest.json

@@ -202,6 +202,14 @@
           "name": "verbose",
           "type": "boolean"
         },
+        "version": {
+          "description": "The API version to use for the bulk operation. If not specified, uses the latest stable version.",
+          "env": "SHOPIFY_FLAG_VERSION",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "name": "version",
+          "type": "option"
+        },
         "watch": {
           "allowNo": false,
           "description": "Wait for bulk operation results before exiting.",