Skip to content

Add erroring for when variables are given for a BulkOps query #6622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ericlee878 merged 1 commit into from
Nov 20, 2025
Merged

Add erroring for when variables are given for a BulkOps query #6622

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion packages/app/src/cli/services/bulk-operations/execute-bulk-operation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {AppLinkedInterface} from '../../models/app/app.js'
import {renderSuccess, renderInfo, renderWarning} from '@shopify/cli-kit/node/ui'
import {outputContent, outputToken} from '@shopify/cli-kit/node/output'
import {ensureAuthenticatedAdmin} from '@shopify/cli-kit/node/session'
import {AbortError} from '@shopify/cli-kit/node/error'
import {parse} from 'graphql'

interface ExecuteBulkOperationInput {
Expand All @@ -23,7 +24,14 @@ export async function executeBulkOperation(input: ExecuteBulkOperationInput): Pr

const adminSession = await ensureAuthenticatedAdmin(storeFqdn)

const bulkOperationResponse = isMutation(query)
const operationIsMutation = isMutation(query)
if (!operationIsMutation && variables) {
throw new AbortError(
outputContent`The ${outputToken.yellow('--variables')} flag can only be used with mutations, not queries.`,
)
}

const bulkOperationResponse = operationIsMutation
? await runBulkOperationMutation({adminSession, query, variables})
: await runBulkOperationQuery({adminSession, query})

Expand Down
1 change: 1 addition & 0 deletions packages/app/src/cli/services/bulk-operations/run-query.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export async function runBulkOperationQuery(
options: BulkOperationRunQueryOptions,
): Promise<BulkOperationRunQueryMutation['bulkOperationRunQuery']> {
const {adminSession, query} = options

const response = await adminRequestDoc<BulkOperationRunQueryMutation, {query: string}>({
query: BulkOperationRunQuery,
session: adminSession,
Expand Down