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

jordanverasamy · 2025-11-11T00:39:14Z

Issue: https://github.com/shop/issues-api-foundations/issues/1093

WHY are these changes introduced?

We want users to be able to pass a --watch flag, so they can monitor the progress and completion of their bulk operations directly from the CLI.

WHAT is this pull request doing?

Adds a new GraphQL query GetBulkOperationById to fetch the status and details of a bulk operation
Adds a new function watchBulkOperation that polls a bulk operation and displays live progress updates, using the new renderSingleTask async functionality added by Refactor renderSingleTask to allow an async process to update current status #6631
Adds a --watch flag to the app execute command that controls whether to use watchBulkOperation

How to test your changes?

Bulk queries

Verify that when --watch is provided, we see live updates printed to the terminal, then eventually a final screen when it finishes:

pnpm shopify app execute --path=<YOUR_TEST_APP> --query="{ products { edges { node { id } } } }" --watch

export-with-watch.mov

Next, verify that when --watch is not provided, the execute command prints some info about the bulk operation and returns right away, just like before this PR:

pnpm shopify app execute --path=<YOUR_TEST_APP> --query="{ products { edges { node { id } } } }"

export-without-watch.mov

Then do the same tests for bulk mutations:

Bulk mutations

With --watch:

pnpm shopify app execute \
--path=<YOUR_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" } }' \
--watch

import-with-watch.mov

Without --watch:

pnpm shopify app execute \
--path=<YOUR_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" } }' \

import-without-watch.mov

jordanverasamy · 2025-11-11T00:39:32Z

[Bulk Operations CLI] show live progress updates when --watch is provided #6595 : 2 dependent PRs (#6655 , #6656 ) 👈 (View in Graphite)
Initial Setup: Bulk Operations Infrastructure for Shopify CLI #6588 : 1 other dependent PR (#6596 )
main

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

github-actions · 2025-11-11T00:45:00Z

Coverage report

St.^❔	Category	Percentage	Covered / Total
🟡	Statements	79.28% (+0.05% 🔼)	13718/17303
🟡	Branches	73.2% (+0.09% 🔼)	6697/9149
🟡	Functions	79.41% (+0.04% 🔼)	3529/4444
🟡	Lines	79.64% (+0.06% 🔼)	12963/16276

Show new covered files 🐣

St.^❔	File	Statements	Branches	Functions	Lines
🟢	`...` / admin-as-app.ts	100%	100%	100%	100%
🟢	`...` / bulk-operation-run-mutation.ts	100%	100%	100%	100%
🟢	`...` / bulk-operation-run-query.ts	100%	100%	100%	100%
🟢	`...` / get-bulk-operation-by-id.ts	100%	100%	100%	100%
🟢	`...` / staged-uploads-create.ts	100%	100%	100%	100%
🟢	`...` / execute-bulk-operation.ts	97.92%	90.63%	100%	97.83%
🟢	`...` / format-bulk-operation-status.ts	100%	100%	100%	100%
🟢	`...` / run-mutation.ts	100%	100%	100%	100%
🟢	`...` / run-query.ts	100%	100%	100%	100%
🟡	`...` / stage-file.ts	72.73%	62.5%	83.33%	71.88%
🟢	`...` / watch-bulk-operation.ts	100%	100%	100%	100%

Show files with reduced coverage 🔻

St.^❔	File	Statements	Branches	Functions	Lines
🟡	`...` / specification.ts	68.52% (-0.57% 🔻)	75.61% (+2.44% 🔼)	76.47% (-1.31% 🔻)	68.09% (-0.66% 🔻)
🟢	`...` / developer-platform-client.ts	84.62% (-1.5% 🔻)	73.68% (+3.1% 🔼)	81.82% (+1.82% 🔼)	90.63% (-2.71% 🔻)
🟢	`...` / api.ts	87.07% (-0.43% 🔻)	76.71% (-0.1% 🔻)	100%	86.49% (-0.43% 🔻)
🟢	`...` / ConcurrentOutput.tsx	98.36% (-1.64% 🔻)	92% (-4% 🔻)	100%	98.33% (-1.67% 🔻)
🔴	`...` / ui.tsx	50.82% (-0.79% 🔻)	42.86% (-5.53% 🔻)	54.55% (+1.42% 🔼)	50% (-0.82% 🔻)
🟢	`...` / console.ts	81.82% (+15.15% 🔼)	75% (-25% 🔻)	100% (+33.33% 🔼)	81.82% (+15.15% 🔼)
🔴	`...` / dev.ts	12.77% (-0.57% 🔻)	2.78% (-0.16% 🔻)	57.14%	12.77% (-0.57% 🔻)
🟡	`...` / theme-environment.ts	69.57% (-1.86% 🔻)	50%	55.56% (-3.27% 🔻)	69.57% (-1.86% 🔻)

Test suite run success

3402 tests passing in 1384 suites.

Report generated by 🧪jest coverage report action from 4c19852

github-actions · 2025-11-11T00:45:12Z

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

packages/app/src/cli/flags.ts

packages/app/src/cli/services/watch-bulk-operation.ts

ericlee878 · 2025-11-22T00:04:44Z

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

+      } else {
+        renderSuccess({headline, customSections})
+      }
+      break


[nit] Would it be better to use renderWarning here for other cases? Not too sure so would like to hear your opinion.

Like

Suggested change

break

break

case 'CANCELED':

case 'CANCELING':

case 'EXPIRED':

renderWarning({headline, customSections})

break

Yeah, I considered this, no strong feelings either way. Happy to change it for now if you like. Let's check in with @nickwesselman about this once he's back from Thanksgiving.

IMO, those states should be shown as errors because the query didn't finish successfully, so I think it's ok as it is.

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

ericlee878 · 2025-11-22T06:21:49Z

Everything looks good to me! Great tophatting video btw 👍

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

gonzaloriestra · 2025-11-26T09:12:23Z

/snapit

github-actions · 2025-11-26T09:15:06Z

🫰✨ Thanks @gonzaloriestra! 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.

gonzaloriestra

LGTM! Tested that it works as expected.

I left a bunch of suggestions, mostly about UX.

gonzaloriestra · 2025-11-26T07:52:15Z

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

+  const createdOperation = bulkOperationResponse?.bulkOperation
+  if (createdOperation) {
+    if (watch) {
+      const finishedOperation = await watchBulkOperation(adminSession, createdOperation.id)
+      renderBulkOperationResult(finishedOperation)
+    } else {
+      renderBulkOperationResult(createdOperation)
+    }
+  }


What about simplifying this way? Improving the error message with something more useful if possible.

Suggested change

const createdOperation = bulkOperationResponse?.bulkOperation

if (createdOperation) {

if (watch) {

const finishedOperation = await watchBulkOperation(adminSession, createdOperation.id)

renderBulkOperationResult(finishedOperation)

} else {

renderBulkOperationResult(createdOperation)

}

}

let operation = bulkOperationResponse?.bulkOperation

if (!operation) throw new AbortError('Something went wrong when creating the bulk operation')

if (watch) operation = await watchBulkOperation(adminSession, createdOperation.id)

renderBulkOperationResult(operation)

Hmm. Fair suggestion, thanks for thinking it through!

I think I like the way it is currently more, even though it's more lines. The current structure has different names for the operation -- finishedOperation vs createdOperation -- which communicates explicitly the expected state of the operation in each case. That makes it easier to grok at a glance for me, but I dunno, maybe that's just a me thing?

I think I'm opting to leave it as is for now, but if you feel strongly let me know and I'm happy to adjust in a follow-up :)

No problem, I don't have a strong opinion.

What I don't like about the current approach is that it does nothing when createdOperation is undefined. But maybe that's not possible...

gonzaloriestra · 2025-11-26T07:59:47Z

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

+      } else {
+        renderSuccess({headline, customSections})
+      }
+      break


IMO, those states should be shown as errors because the query didn't finish successfully, so I think it's ok as it is.

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

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

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

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

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

packages/app/src/cli/flags.ts

…essages

…d print live progress updates

jordanverasamy mentioned this pull request Nov 11, 2025

Initial Setup: Bulk Operations Infrastructure for Shopify CLI #6588

Merged

jordanverasamy changed the title ~~introduce --watch flag~~ [Bulk Operations CLI] show live progress updates when --watch is provided Nov 11, 2025

jordanverasamy marked this pull request as ready for review November 11, 2025 00:45

jordanverasamy requested a review from a team as a code owner November 11, 2025 00:45

jordanverasamy force-pushed the jtv/watch-live-progress branch from 3d9e66e to 5d6b5d5 Compare November 11, 2025 00:48

jordanverasamy requested a review from a team as a code owner November 11, 2025 00:48

ericlee878 changed the base branch from 11-07-implement_simple_bulk_query to graphite-base/6595 November 11, 2025 00:49

jordanverasamy force-pushed the jtv/watch-live-progress branch from 5d6b5d5 to 153d57c Compare November 11, 2025 01:06

jordanverasamy changed the base branch from graphite-base/6595 to 11-07-implement_simple_bulk_query November 11, 2025 01:06

jordanverasamy self-assigned this Nov 11, 2025

jordanverasamy force-pushed the jtv/watch-live-progress branch from 153d57c to c324f49 Compare November 11, 2025 01:14

ericlee878 changed the base branch from 11-07-implement_simple_bulk_query to graphite-base/6595 November 11, 2025 01:20

ericlee878 mentioned this pull request Nov 11, 2025

Implement mutation support for BulkOps CLI command #6596

Merged

ericlee878 reviewed Nov 11, 2025

View reviewed changes

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

ericlee878 reviewed Nov 11, 2025

View reviewed changes

packages/app/src/cli/flags.ts Show resolved Hide resolved

packages/app/src/cli/services/watch-bulk-operation.ts Outdated Show resolved Hide resolved

jordanverasamy force-pushed the jtv/watch-live-progress branch from 2e960b1 to 594e201 Compare November 13, 2025 18:18

jordanverasamy force-pushed the graphite-base/6595 branch from 446c3cf to 2b6b260 Compare November 13, 2025 18:19

jordanverasamy force-pushed the jtv/watch-live-progress branch from 594e201 to 500737d Compare November 13, 2025 18:19

jordanverasamy changed the base branch from graphite-base/6595 to 11-07-implement_simple_bulk_query November 13, 2025 18:19

jordanverasamy force-pushed the jtv/watch-live-progress branch 5 times, most recently from 68dff49 to c4027ba Compare November 13, 2025 23:04

ericlee878 changed the base branch from 11-07-implement_simple_bulk_query to graphite-base/6595 November 14, 2025 00:26

jordanverasamy force-pushed the jtv/watch-live-progress branch from c4027ba to db8e837 Compare November 14, 2025 00:35

jordanverasamy changed the base branch from graphite-base/6595 to 11-07-implement_simple_bulk_query November 14, 2025 00:35

jordanverasamy requested a review from nickwesselman November 21, 2025 23:15

jordanverasamy force-pushed the jtv/watch-live-progress branch 3 times, most recently from 569eae4 to c9b42e0 Compare November 21, 2025 23:44

jordanverasamy mentioned this pull request Nov 21, 2025

Remove unused field selections from BulkOperation GraphQL documents #6655

Merged

ericlee878 reviewed Nov 22, 2025

View reviewed changes

jordanverasamy mentioned this pull request Nov 22, 2025

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

Merged

jordanverasamy force-pushed the jtv/watch-live-progress branch from c9b42e0 to 5270287 Compare November 22, 2025 00:51

ericlee878 reviewed Nov 22, 2025

View reviewed changes

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

jordanverasamy force-pushed the jtv/watch-live-progress branch from 5270287 to d3ffc48 Compare November 24, 2025 20:17

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

jordanverasamy force-pushed the jtv/watch-live-progress branch from d3ffc48 to 0804636 Compare November 25, 2025 22:07

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

gonzaloriestra approved these changes Nov 26, 2025

View reviewed changes

jordanverasamy added 4 commits November 26, 2025 10:27

add getBulkOperationById query

7e00334

introduce formatBulkOperationStatus helper to print nice progress m…

650aa9a

…essages

introduce watchBulkOperation function to poll the bulk operation an…

283cb69

…d print live progress updates

use our new watchBulkOperation rendering when --watch is provided

d270722

jordanverasamy force-pushed the jtv/watch-live-progress branch from 0804636 to c8e62d6 Compare November 26, 2025 18:35

[PR feedback] minor polish adjustments after Gonzalo's review

4c19852

jordanverasamy force-pushed the jtv/watch-live-progress branch from c8e62d6 to 4c19852 Compare November 26, 2025 18:51

jordanverasamy added this pull request to the merge queue Nov 26, 2025

Merged via the queue into main with commit 9dd0147 Nov 26, 2025
25 checks passed

jordanverasamy deleted the jtv/watch-live-progress branch November 26, 2025 19:33

-      break
+      break
+      case 'CANCELED':
+      case 'CANCELING':
+      case 'EXPIRED':
+            renderWarning({headline, customSections})
+            break

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

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

Uh oh!

Conversation

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

Uh oh!

WHY are these changes introduced?

WHAT is this pull request doing?

How to test your changes?

Bulk queries

Bulk mutations

Uh oh!

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

Uh oh!

Uh oh!

github-actions bot commented Nov 11, 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 11, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

gonzaloriestra commented Nov 26, 2025

Uh oh!

github-actions bot commented Nov 26, 2025

Uh oh!

gonzaloriestra left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

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

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

jordanverasamy commented Nov 11, 2025 •

edited

Loading

jordanverasamy commented Nov 11, 2025 •

edited

Loading

github-actions bot commented Nov 11, 2025 •

edited

Loading

ericlee878 commented Nov 22, 2025 •

edited

Loading