Merge pull request #6755 from Shopify/jtv/bulk-mutations-require-variables

Update `app bulk execute` to fail if given a mutation document but no variables

Author: jordanverasamy

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

@@ -134,6 +134,7 @@ describe('executeBulkOperation', () => {
 
   test('runs mutation operation when GraphQL document starts with mutation', async () => {
     const mutation = 'mutation productUpdate($input: ProductInput!) { productUpdate(input: $input) { product { id } } }'
+    const variables = ['{"input":{"id":"gid://shopify/Product/123"}}']
     const mockResponse: BulkOperationRunMutationMutation['bulkOperationRunMutation'] = {
       bulkOperation: createdBulkOperation,
       userErrors: [],
@@ -145,12 +146,13 @@ describe('executeBulkOperation', () => {
       remoteApp: mockRemoteApp,
       store: mockStore,
       query: mutation,
+      variables,
     })
 
     expect(runBulkOperationMutation).toHaveBeenCalledWith({
       adminSession: mockAdminSession,
       query: mutation,
-      variablesJsonl: undefined,
+      variablesJsonl: '{"input":{"id":"gid://shopify/Product/123"}}',
       version: BULK_OPERATIONS_MIN_API_VERSION,
     })
     expect(runBulkOperationQuery).not.toHaveBeenCalled()
@@ -327,6 +329,22 @@ describe('executeBulkOperation', () => {
     })
   })
 
+  test('throws error when mutation is provided without variables', async () => {
+    const mutation = 'mutation productUpdate($input: ProductInput!) { productUpdate(input: $input) { product { id } } }'
+
+    await expect(
+      executeBulkOperation({
+        organization: mockOrganization,
+        remoteApp: mockRemoteApp,
+        store: mockStore,
+        query: mutation,
+      }),
+    ).rejects.toThrow('Bulk mutations require variables')
+
+    expect(runBulkOperationQuery).not.toHaveBeenCalled()
+    expect(runBulkOperationMutation).not.toHaveBeenCalled()
+  })
+
   test('uses watchBulkOperation (not quickWatchBulkOperation) when watch flag is true', async () => {
     const query = '{ products { edges { node { id } } } }'
     const initialResponse: BulkOperationRunQueryMutation['bulkOperationRunQuery'] = {

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

@@ -216,10 +216,15 @@ function resultsContainUserErrors(results: string): boolean {
   })
 }
 
-/**
- * Validates bulk operation-specific constraints for variables.
- */
 function validateBulkOperationVariables(graphqlOperation: string, variablesJsonl?: string): void {
+  if (isMutation(graphqlOperation) && !variablesJsonl) {
+    throw new AbortError(
+      outputContent`Bulk mutations require variables. Provide a JSONL file with ${outputToken.yellow(
+        '--variable-file',
+      )} or individual JSON objects with ${outputToken.yellow('--variables')}.`,
+    )
+  }
+
   if (!isMutation(graphqlOperation) && variablesJsonl) {
     throw new AbortError(
       outputContent`The ${outputToken.yellow('--variables')} and ${outputToken.yellow(