centralize GraphQL validation

Author: nickwesselman

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

@@ -5,12 +5,7 @@ import {formatBulkOperationStatus} from './format-bulk-operation-status.js'
 import {downloadBulkOperationResults} from './download-bulk-operation-results.js'
 import {extractBulkOperationId} from './bulk-operation-status.js'
 import {BULK_OPERATIONS_MIN_API_VERSION} from './constants.js'
-import {
-  createAdminSessionAsApp,
-  validateSingleOperation,
-  formatOperationInfo,
-  resolveApiVersion,
-} from '../graphql/common.js'
+import {createAdminSessionAsApp, formatOperationInfo, resolveApiVersion} from '../graphql/common.js'
 import {OrganizationApp, Organization} from '../../models/organization.js'
 import {renderSuccess, renderInfo, renderError, renderWarning, TokenItem} from '@shopify/cli-kit/node/ui'
 import {outputContent, outputToken, outputResult} from '@shopify/cli-kit/node/output'
@@ -71,7 +66,7 @@ export async function executeBulkOperation(input: ExecuteBulkOperationInput): Pr
 
   const variablesJsonl = await parseVariablesToJsonl(variables, variableFile)
 
-  validateGraphQLDocument(query, variablesJsonl)
+  validateBulkOperationVariables(query, variablesJsonl)
 
   renderInfo({
     headline: 'Starting bulk operation.',
@@ -208,9 +203,10 @@ function resultsContainUserErrors(results: string): boolean {
   })
 }
 
-function validateGraphQLDocument(graphqlOperation: string, variablesJsonl?: string): void {
-  validateSingleOperation(graphqlOperation)
-
+/**
+ * Validates bulk operation-specific constraints for variables.
+ */
+function validateBulkOperationVariables(graphqlOperation: string, variablesJsonl?: string): void {
   if (!isMutation(graphqlOperation) && variablesJsonl) {
     throw new AbortError(
       outputContent`The ${outputToken.yellow('--variables')} and ${outputToken.yellow(

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

@@ -1,9 +1,4 @@
-import {
-  createAdminSessionAsApp,
-  validateSingleOperation,
-  resolveApiVersion,
-  formatOperationInfo,
-} from './graphql/common.js'
+import {createAdminSessionAsApp, resolveApiVersion, formatOperationInfo} from './graphql/common.js'
 import {OrganizationApp, Organization} from '../models/organization.js'
 import {renderSuccess, renderError, renderInfo, renderSingleTask} from '@shopify/cli-kit/node/ui'
 import {outputContent, outputToken, outputResult} from '@shopify/cli-kit/node/output'
@@ -89,8 +84,6 @@ export async function executeOperation(input: ExecuteOperationInput): Promise<vo
 
   const parsedVariables = await parseVariables(variables, variableFile)
 
-  validateSingleOperation(query)
-
   try {
     const result = await renderSingleTask({
       title: outputContent`Executing GraphQL operation`,

packages/app/src/cli/utilities/execute-command-helpers.test.ts

@@ -1,14 +1,18 @@
 import {prepareAppStoreContext, prepareExecuteContext} from './execute-command-helpers.js'
 import {linkedAppContext} from '../services/app-context.js'
 import {storeContext} from '../services/store-context.js'
-import {readStdinString} from '@shopify/cli-kit/node/system'
+import {validateSingleOperation} from '../services/graphql/common.js'
 import {readFile, fileExists} from '@shopify/cli-kit/node/fs'
+import {readStdinString} from '@shopify/cli-kit/node/system'
 import {describe, test, expect, vi, beforeEach} from 'vitest'
 
 vi.mock('../services/app-context.js')
 vi.mock('../services/store-context.js')
-vi.mock('@shopify/cli-kit/node/system')
 vi.mock('@shopify/cli-kit/node/fs')
+vi.mock('@shopify/cli-kit/node/system')
+vi.mock('../services/graphql/common.js', () => ({
+  validateSingleOperation: vi.fn(),
+}))
 
 describe('prepareAppStoreContext', () => {
   const mockFlags = {
@@ -206,4 +210,10 @@ describe('prepareExecuteContext', () => {
     expect(readStdinString).toHaveBeenCalled()
     expect(result.query).toBe(stdinQuery)
   })
+
+  test('validates GraphQL query using validateSingleOperation', async () => {
+    await prepareExecuteContext(mockFlags)
+
+    expect(validateSingleOperation).toHaveBeenCalledWith(mockFlags.query)
+  })
 })

packages/app/src/cli/utilities/execute-command-helpers.ts

@@ -1,5 +1,6 @@
 import {linkedAppContext, LoadedAppContextOutput} from '../services/app-context.js'
 import {storeContext} from '../services/store-context.js'
+import {validateSingleOperation} from '../services/graphql/common.js'
 import {OrganizationStore} from '../models/organization.js'
 import {readStdinString} from '@shopify/cli-kit/node/system'
 import {AbortError} from '@shopify/cli-kit/node/error'
@@ -54,7 +55,7 @@ export async function prepareAppStoreContext(flags: AppStoreContextFlags): Promi
 
 /**
  * Prepares the execution context for GraphQL operations.
- * Handles query input from flag, file, or stdin, and sets up app and store contexts.
+ * Handles query input from flag, file, or stdin, validates GraphQL syntax, and sets up app and store contexts.
  *
  * @param flags - Command flags containing configuration options.
  * @param commandName - Name of the command for error messages (e.g., 'execute', 'bulk execute').
@@ -87,6 +88,9 @@ export async function prepareExecuteContext(
     )
   }
 
+  // Validate GraphQL syntax and ensure single operation
+  validateSingleOperation(query)
+
   const {appContextResult, store} = await prepareAppStoreContext(flags)
 
   return {query, appContextResult, store}