Initial Setup: Bulk Operations Infrastructure for Shopify CLI #6588

ericlee878 · 2025-11-08T00:51:54Z

Summary
This PR lays the groundwork for the shopify app execute command in the Shopify CLI. It creates the minimal foundations of the BulkOps CLI that future PRs will build upon. By minimal foundations, we implemented just the query (not mutation), asynchronous CLI command (no synchronous progress bar), output to STDOUT (no output file). We just wanted the skeleton of the CLI command, so that future PRs could work on extending different parts of this command in parallel.

Implementation Details

The packages/app/src/cli/commands/app/execute.ts file runs the main command. It calls on other service files.
The packages/app/src/cli/api/graphql/admin-bulk-operations.ts file is a service file that stores the queries and data structures. For mutations in the future, we should add their respective queries and data structures here.
The packages/app/src/cli/services/bulk-operation-run-query.ts file holds the query-specific function that holds the logic that calls the BulkOperation Query API.

GraphQL Codegen Setup for Bulk Operations

Added GraphQL code generation configuration for the bulk-operations API to enable type-safe GraphQL operations.

Changes:

Added bulkOperations project to graphql.config.ts pointing to admin_schema.graphql
Added corresponding codegen tasks to packages/app/project.json
Run pnpm graphql-codegen to generate TypeScript types from GraphQL queries/mutations

This codegen allows us to have a type-safe GraphQL operations with compile-time checks that could be automatically regenerated if we change the GraphQL API.

Testing

Follow the instructions here to setup a test app
Go here and create a store (if not already have one).
Use the command pnpm shopify app execute --path=<path to test app> --query="{products{edges{node{id title handle}}}}"
Get the BulkOps id that is returned and run this query in Services Internal.

SELECT * from bulk_operations where id = <gid>;

Yours should pop up. Mine was in shard 239 (for reference).

Unit tests were not added for the execute-bulk-operation.ts file yet because the task it was doing is currently very trivial. The main functionality of this file will come when the mutations are implemented (next PR coming!) so I will add unit tests for this file then.

ericlee878 · 2025-11-08T00:52:13Z

Initial Setup: Bulk Operations Infrastructure for Shopify CLI #6588 : 2 dependent PRs (#6595 , #6596 ) 👈 (View in Graphite)
main

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

github-actions · 2025-11-08T00:57:37Z

Coverage report

St.^❔	Category	Percentage	Covered / Total
🟡	Statements	79.24% (+0.01% 🔼)	13601/17165
🟡	Branches	73.13% (+0.02% 🔼)	6637/9076
🟡	Functions	79.37% (-0% 🔻)	3508/4420
🟡	Lines	79.59% (+0.01% 🔼)	12846/16140

Show new covered files 🐣

St.^❔	File	Statements	Branches	Functions	Lines
🟢	`...` / bulk-operation-run-query.ts	100%	100%	100%	100%
🟢	`...` / execute-bulk-operation.ts	100%	83.33%	100%	100%
🟢	`...` / run-query.ts	100%	100%	100%	100%

Test suite run success

3359 tests passing in 1376 suites.

Report generated by 🧪jest coverage report action from 3784bae

github-actions · 2025-11-10T20:27:17Z

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.

packages/app/src/cli/api/graphql/admin-bulk-operations.ts

ericlee878 · 2025-11-10T23:52:39Z

https://github.com/shop/issues-api-foundations/issues/1066

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

…k-operations directory in services directory

isaacroldan · 2025-11-14T09:56:37Z

packages/app/src/cli/flags.ts

+  query: Flags.string({
+    char: 'q',
+    description: 'The GraphQL query, as a string.',
+    env: 'SHOPIFY_FLAG_QUERY',
+    required: true,
+  }),


Would be nice if this query can also be passed as standard input, so that you can do:

shopify app execute --query 'your query' // or echo 'your query' | shopify app execute // or cat query.txt | shopify app execute

the last one, being able to run a query from a file is super useful for this case where queries can be complex!

This is the same pattern that shopify app function run uses.
That would mean this flag is not required and you will need to validate manually that either the flag or stdin are present.

What do you think?

Sounds like a good idea to me. @nickwesselman One thing - would we still need a separate --variable-file flag with this?

This is definitely a good idea, we should align with @nickwesselman on which pattern to follow. I'd argue that we can keep this out of scope for this PR though, and just make a ticket to improve this in a followup?

Yeah for sure, I like this in function run and it's a nice one-liner approach for simple queries. Let's log this as a follow up.

Ticket created for this

isaacroldan · 2025-11-14T10:00:57Z

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

+  const result = bulkOperationResponse?.bulkOperation
+  if (result) {


Shouldn't we show a specific error if there is no result here?

Future ticket

ericlee878 changed the title ~~app connection setup step 1~~ Connect app in BulkOperation CLI to BulkOperation API Nov 8, 2025

ericlee878 changed the title ~~Connect app in BulkOperation CLI to BulkOperation API~~ Initial Setup: Bulk Operations Infrastructure for Shopify CLI Nov 8, 2025

ericlee878 force-pushed the 11-07-implement_simple_bulk_query branch 2 times, most recently from b8f02df to 747c9e6 Compare November 8, 2025 01:31

jordanverasamy force-pushed the 11-07-implement_simple_bulk_query branch from 3879d74 to efc1388 Compare November 10, 2025 18:13

ericlee878 force-pushed the 11-07-implement_simple_bulk_query branch 3 times, most recently from 70c6f47 to 446c3cf Compare November 10, 2025 20:24

ericlee878 marked this pull request as ready for review November 10, 2025 20:27

ericlee878 requested review from a team as code owners November 10, 2025 20:27

jordanverasamy approved these changes Nov 10, 2025

View reviewed changes

jordanverasamy reviewed Nov 10, 2025

View reviewed changes

packages/app/src/cli/api/graphql/admin-bulk-operations.ts Outdated Show resolved Hide resolved

jordanverasamy mentioned this pull request Nov 11, 2025

[Bulk Operations CLI] show live progress updates when --watch is provided #6595

Merged

ericlee878 force-pushed the 11-07-implement_simple_bulk_query branch from 446c3cf to 9e9ebed Compare November 11, 2025 00:49

ericlee878 requested a review from jordanverasamy November 11, 2025 00:50

jordanverasamy force-pushed the 11-07-implement_simple_bulk_query branch from 9e9ebed to 446c3cf Compare November 11, 2025 01:06

ericlee878 force-pushed the 11-07-implement_simple_bulk_query branch 3 times, most recently from 3eef16f to e0c10b0 Compare November 11, 2025 02:34

ericlee878 mentioned this pull request Nov 11, 2025

Implement mutation support for BulkOps CLI command #6596

Merged

isaacroldan reviewed Nov 11, 2025

View reviewed changes

packages/app/src/cli/commands/app/execute.ts Outdated Show resolved Hide resolved

ericlee878 force-pushed the 11-07-implement_simple_bulk_query branch 4 times, most recently from 2ef312a to f813e73 Compare November 12, 2025 23:04

jordanverasamy approved these changes Nov 13, 2025

View reviewed changes

ericlee878 added 2 commits November 12, 2025 16:42

minimal foundations of the BulkOps CLI that future PRs will build upon

28223f4

refactor with generated GraphQL types

05a5da9

ericlee878 force-pushed the 11-07-implement_simple_bulk_query branch from 4024e20 to a6645ff Compare November 13, 2025 00:58

refactor: extract bulk operation logic into service class; create bul…

3784bae

…k-operations directory in services directory

ericlee878 force-pushed the 11-07-implement_simple_bulk_query branch from a6645ff to 3784bae Compare November 13, 2025 01:09

jordanverasamy force-pushed the 11-07-implement_simple_bulk_query branch from 3784bae to 2b6b260 Compare November 13, 2025 18:19

ericlee878 force-pushed the 11-07-implement_simple_bulk_query branch from 2b6b260 to 3784bae Compare November 14, 2025 00:26

jordanverasamy force-pushed the 11-07-implement_simple_bulk_query branch from 3784bae to 2b6b260 Compare November 14, 2025 00:35

ericlee878 force-pushed the 11-07-implement_simple_bulk_query branch from 2b6b260 to 3784bae Compare November 14, 2025 00:54

jordanverasamy force-pushed the 11-07-implement_simple_bulk_query branch from 3784bae to 2b6b260 Compare November 14, 2025 01:19

ericlee878 force-pushed the 11-07-implement_simple_bulk_query branch from 2b6b260 to 3784bae Compare November 14, 2025 07:27

ericlee878 mentioned this pull request Nov 14, 2025

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

Merged

isaacroldan reviewed Nov 14, 2025

View reviewed changes

isaacroldan approved these changes Nov 14, 2025

View reviewed changes

ericlee878 added this pull request to the merge queue Nov 14, 2025

Merged via the queue into main with commit 45fe1ee Nov 14, 2025
94 checks passed

ericlee878 deleted the 11-07-implement_simple_bulk_query branch November 14, 2025 21:13

ericlee878 added the #gsd: 47715 label Nov 14, 2025

This was referenced Nov 18, 2025

Add GraphQL Operation Validation for Bulk Operations CLI #6632

Merged

Add --variable-file flag for bulk operation mutations #6636

Merged

Use ensureAuthenticatedAdminAsApp in shopify app execute #6643

Merged

This was referenced Nov 21, 2025

Remove unused field selections from BulkOperation GraphQL documents #6655

Merged

Introduce --output-file flag, write bulk operation results to STDOUT or a file #6656

Merged

This was referenced Nov 24, 2025

Add stdin support for shopify app execute #6663

Merged

BugError added for unexpected response from BulkOps API #6666

Merged

This was referenced Nov 25, 2025

Implement shopify app bulk status subcommand #6667

Merged

If --id is not provided to shopify app bulk status, show all bulk operations #6668

Merged

		const result = bulkOperationResponse?.bulkOperation
		if (result) {

Initial Setup: Bulk Operations Infrastructure for Shopify CLI #6588

Initial Setup: Bulk Operations Infrastructure for Shopify CLI #6588

Uh oh!

Conversation

ericlee878 commented Nov 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ericlee878 commented Nov 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Nov 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage report

Test suite run success

Uh oh!

github-actions bot commented Nov 10, 2025

Uh oh!

Uh oh!

ericlee878 commented Nov 10, 2025

Uh oh!

Uh oh!

isaacroldan Nov 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ericlee878 Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

jordanverasamy Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

nickwesselman Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

ericlee878 Nov 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

isaacroldan Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

ericlee878 Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ericlee878 commented Nov 8, 2025 •

edited

Loading

ericlee878 commented Nov 8, 2025 •

edited

Loading

github-actions bot commented Nov 8, 2025 •

edited

Loading

isaacroldan Nov 14, 2025 •

edited

Loading

ericlee878 Nov 14, 2025 •

edited

Loading