Implement mutation support for BulkOps CLI command

[ericlee878]

Resolves: https://github.com/orgs/shop/projects/208/views/34?pane=issue&itemId=137773625&issue=shop%7Cissues-api-foundations%7C1069

Background
The basic setup of the BulkOps CLI command was done here. The basic command used BulkOps Query. We are implementing BulkOps Mutation in this PR.

Implementation Details

• We parse the query given to us in the flag to determine if the GraphQL command is a query or a mutation. Then, we do the respective GraphQL API call.

• Bulk operation CLI accept variables via the --variables flag in JSON format. However, the Shopify Admin API requires these variables to be uploaded as a JSONL file rather than passed inline. So, in the stage-file.ts file, we needed to:

    1. Create a staged upload target via `stagedUploadsCreate` mutation.
    2. Extract the variables from JSON format and put it in a JSONL file. 
    3. Upload the JSONL file to the temporary GCS URL from staged upload.
    4. Pass the staged upload key to `bulkOperationRunMutation`.
  

• There will be a future PR that deals with creating a --variable-file flag that links to a file containing the values for bulk mutations, in JSONL format.

• Used GraphQL code generation configuration for the bulkOperationRunMutation API and stagedUpload API. Ran pnpm graphql-codegen to generate TypeScript types from GraphQL queries/mutations

Architecture improvements:

• Authentication happens once at executeBulkOperation level via ensureAuthenticatedAdmin, then the session is passed down to runBulkOperationQuery and runBulkOperationMutation
• Command flags are spread directly into executeBulkOperation (...flags) instead of parsing individual properties.

Testing

• Setup
  1. Follow the instructions here to setup a test app
  2. Go here and create a store (if not already have one).
• Testing Mutation
  To test the mutation part of the CLI, run:

pnpm shopify app execute --path=<path to test app> --query='mutation productUpdate($input: ProductInput!) { productUpdate(input: $input) { product { id tags } userErrors { field message } } }' --variables='[{"input": {"id": "gid://shopify/Product/<product id>", "tags": ["bulk-test"]}}]'

[ericlee878]

• Add --variable-file flag for bulk operation mutations #6636
• Add GraphQL Operation Validation for Bulk Operations CLI #6632
• Add erroring for when variables are given for a BulkOps query #6622
• Implement mutation support for BulkOps CLI command #6596 👈 (View in Graphite)
• Initial Setup: Bulk Operations Infrastructure for Shopify CLI  #6588 : 1 other dependent PR (#6595 )
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[github-actions]

Coverage report

St.❔	Category	Percentage	Covered / Total
🟡	Statements	79.23% (+0.01% 🔼)	13636/17210
🟡	Branches	73.1% (-0.01% 🔻)	6648/9095
🟡	Functions	79.39% (+0.02% 🔼)	3517/4430
🟡	Lines	79.58% (+0% 🔼)	12879/16183

Show new covered files 🐣

St.❔	File	Statements	Branches	Functions	Lines
🟢	... / bulk-operation-run-mutation.ts	100%	100%	100%	100%
🟢	... / bulk-operation-run-query.ts	100%	100%	100%	100%
🟢	... / staged-uploads-create.ts	100%	100%	100%	100%
🟢	... / execute-bulk-operation.ts	100%	90%	100%	100%
🟢	... / run-mutation.ts	100%	100%	100%	100%
🟢	... / run-query.ts	100%	100%	100%	100%
🟡	... / stage-file.ts	74.29%	53.33%	85.71%	73.53%

Show files with reduced coverage 🔻

St.❔	File	Statements	Branches	Functions	Lines
🟢	... / ConcurrentOutput.tsx	98.36% (-1.64% 🔻)	92% (-4% 🔻)	100%	98.33% (-1.67% 🔻)

Test suite run success

3367 tests passing in 1380 suites.

Report generated by 🧪jest coverage report action from aad7af4

[github-actions]

We detected some changes at packages/*/src and there are no updates in the .changeset.
If the changes are user-facing, run pnpm changeset add to track your changes and include them in the next release CHANGELOG.

Caution

DO NOT create changesets for features which you do not wish to be included in the public changelog of the next CLI release.

[jordanverasamy]

Another pass! Looking really good. I like the changes to stageFile, thanks for being patient with me on those :)

[jordanverasamy]

Really nice work. I 🎩 and things are good. Looking forward to getting this in!

[jordanverasamy]

🎩 :

pnpm shopify app execute \
--path="../my-test-app/my-test-app" \
--query='mutation createProduct($productSet: ProductSetInput!) { productSet(synchronous: true, input: $productSet) { product { id } } }' \
--variables='{ "productSet": { "title": "Winter hat" } }' \
--variables='{ "productSet": { "title": "Winter coat" } }' \
--variables='{ "productSet": { "title": "Winter pants" } }'

[ericlee878]

Thanks for adding this!

[nickwesselman]

/snapit

[github-actions]

🫰✨ Thanks @nickwesselman! Your snapshot has been published to npm.

Test the snapshot by installing your package globally:

npm i -g --@shopify:registry=https://registry.npmjs.org @shopify/[email protected]

Caution

After installing, validate the version by running just shopify in your terminal.
If the versions don't match, you might have multiple global instances installed.
Use which shopify to find out which one you are running and uninstall it.

[nickwesselman]

The command namespace (shopify app bulk execute) and executing with the app's api key are important before merging this one 👍

[nickwesselman]

Mentioned elsewhere, but moving to bulk execute is OK as a follow up.

[ericlee878]

Mentioned elsewhere, but moving to bulk execute is OK as a follow up.

Follow up ticket

[nickwesselman]

I'm OK with my remaining requests as follow-ups