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

jordanverasamy · 2025-11-22T00:27:40Z

WHY are these changes introduced?

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

WHAT is this pull request doing?

Adds behaviour to shopify app execute to match the designs:

if --watch and --output-file are both provided, write results to that file after completion
if --watch is provided but --output-file is not, write results to STDOUT after completion
if --watch is not provided, no change to behaviour

How to test your changes?

Try running shopify app execute with --watch and --output-file and verify it writes to the correct file:

pnpm shopify app execute --path=<PATH_TO_YOUR_APP> --query="{ products { edges { node { id } } } }" --watch --output-file=my-results.jsonl

Then try doing the same thing without --output-file, and verify it prints to STDOUT:

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

jordanverasamy · 2025-11-22T00:28:03Z

Introduce --output-file flag, write bulk operation results to STDOUT or a file #6656 👈 (View in Graphite)
[Bulk Operations CLI] show live progress updates when --watch is provided #6595 : 1 other dependent PR (#6655 )
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-22T00:33:23Z

Coverage report

St.^❔	Category	Percentage	Covered / Total
🟡	Statements	79.27% (-0.01% 🔻)	13723/17311
🟡	Branches	73.18% (-0.02% 🔻)	6698/9153
🟡	Functions	79.42% (+0% 🔼)	3530/4445
🟡	Lines	79.64% (-0.01% 🔻)	12968/16284

Show new covered files 🐣

St.^❔	File	Statements	Branches	Functions	Lines
🟢	`...` / download-bulk-operation-results.ts	100%	100%	100%	100%

Show files with reduced coverage 🔻

St.^❔	File	Statements	Branches	Functions	Lines
🟢	`...` / execute-bulk-operation.ts	92.31% (-5.61% 🔻)	82.35% (-8.27% 🔻)	100%	92% (-5.83% 🔻)

Test suite run success

3406 tests passing in 1386 suites.

Report generated by 🧪jest coverage report action from 4b2da57

packages/app/src/cli/services/bulk-operations/download-bulk-operation-results.test.ts

isaacroldan · 2025-11-25T09:55:05Z

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

+export async function downloadBulkOperationResults(url: string): Promise<string> {
+  const response = await fetch(url)
+
+  if (!response.ok) {
+    throw new AbortError(`Failed to download bulk operation results: ${response.statusText}`)
+  }
+
+  return response.text()
+}


Why have this function in a different file? is just wrapping a call to fetch and a error? And is only used in a single place... best to put the call to fetch directly where it is needed. I'd say the tests don't add much value either (you are just testing an if)

Yeah good question! It's really small and like you said, doesnt have any complexity to test. I waffled on whether it should be in its own file, and ultimately decided to, because we're going to want the same behaviour in the bulk status command (more info here) so may as well have it available to reuse.

I'm happy to just duplicate the function in both execute and status if you would prefer, since it's so simple, just a couple lines.

gonzaloriestra · 2025-11-26T09:41:58Z

/snapit

github-actions · 2025-11-26T09:44:35Z

🫰✨ 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 · 2025-11-26T10:28:28Z

packages/app/src/cli/flags.ts

  }),
+  'output-file': Flags.string({
+    description: 'The file path where results should be written. If not specified, results will be written to STDOUT.',
+    env: 'SHOPIFY_FLAG_OUTPUT_FILE',


In theory, if you add this it will throw an error when used without watch

Suggested change

env: 'SHOPIFY_FLAG_OUTPUT_FILE',

env: 'SHOPIFY_FLAG_OUTPUT_FILE',

compatible: ['watch'],

Interesting. I tried this and it didn't work for me:

pnpm shopify app execute --path="../my-second-test-app" --query="{ products { edges { node { id variants { edges { node { id } } } } } } }" --output-file='hello.jsonl'

but maybe I'm missing something?

Let me know and I'm happy to add this in a followup though :)

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

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

github-actions · 2025-11-26T18:54: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.

jordanverasamy mentioned this pull request Nov 22, 2025

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

Merged

jordanverasamy mentioned this pull request Nov 22, 2025

Remove unused field selections from BulkOperation GraphQL documents #6655

Merged

jordanverasamy changed the title ~~introduce --output-file flag~~ Write bulk operation results to STDOUT or a file, determined by new --output-file flag Nov 22, 2025

jordanverasamy changed the title ~~Write bulk operation results to STDOUT or a file, determined by new --output-file flag~~ Introduce --output-file flag, write bulk operation results to STDOUT or a file Nov 22, 2025

jordanverasamy force-pushed the jtv/add-output-file-support branch 2 times, most recently from cb7b47a to 91d94fd Compare November 22, 2025 00:40

jordanverasamy requested review from ericlee878 and isaacroldan November 22, 2025 00:41

jordanverasamy self-assigned this Nov 22, 2025

jordanverasamy force-pushed the jtv/add-output-file-support branch from 91d94fd to 9ae6397 Compare November 22, 2025 00:44

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

jordanverasamy force-pushed the jtv/add-output-file-support branch from 9ae6397 to 535eb18 Compare November 22, 2025 00:51

ericlee878 approved these changes Nov 22, 2025

View reviewed changes

packages/app/src/cli/services/bulk-operations/download-bulk-operation-results.test.ts Show resolved Hide resolved

jordanverasamy changed the base branch from jtv/watch-live-progress to graphite-base/6656 November 24, 2025 20:17

jordanverasamy force-pushed the graphite-base/6656 branch from 5270287 to d3ffc48 Compare November 24, 2025 20:17

jordanverasamy force-pushed the jtv/add-output-file-support branch from 535eb18 to de334e2 Compare November 24, 2025 20:17

jordanverasamy changed the base branch from graphite-base/6656 to jtv/watch-live-progress November 24, 2025 20:17

isaacroldan reviewed Nov 25, 2025

View reviewed changes

jordanverasamy requested a review from isaacroldan November 25, 2025 19:54

jordanverasamy changed the base branch from jtv/watch-live-progress to graphite-base/6656 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 force-pushed the graphite-base/6656 branch from d3ffc48 to c8e62d6 Compare November 26, 2025 18:35

jordanverasamy force-pushed the jtv/add-output-file-support branch from de334e2 to 57c73ad Compare November 26, 2025 18:35

jordanverasamy changed the base branch from graphite-base/6656 to jtv/watch-live-progress November 26, 2025 18:36

jordanverasamy force-pushed the jtv/add-output-file-support branch from 57c73ad to 989db7c Compare November 26, 2025 18:51

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

jordanverasamy marked this pull request as ready for review November 26, 2025 18:53

jordanverasamy requested review from a team as code owners November 26, 2025 18:53

introduce --output-file flag

4b2da57

jordanverasamy force-pushed the jtv/add-output-file-support branch from 989db7c to 4b2da57 Compare November 26, 2025 19:16

Base automatically changed from jtv/watch-live-progress to main November 26, 2025 19:33

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

Merged via the queue into main with commit f00e623 Nov 26, 2025
23 checks passed

jordanverasamy deleted the jtv/add-output-file-support branch November 26, 2025 21:14

	env: 'SHOPIFY_FLAG_OUTPUT_FILE',
	env: 'SHOPIFY_FLAG_OUTPUT_FILE',
	compatible: ['watch'],

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

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

Uh oh!

Conversation

jordanverasamy commented Nov 22, 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?

Uh oh!

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

Uh oh!

Uh oh!

github-actions bot commented Nov 22, 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!

Uh oh!

isaacroldan Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

jordanverasamy Nov 25, 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!

gonzaloriestra commented Nov 26, 2025

Uh oh!

github-actions bot commented Nov 26, 2025

Uh oh!

gonzaloriestra Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

jordanverasamy Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

jordanverasamy Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Nov 26, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

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

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

jordanverasamy commented Nov 22, 2025 •

edited

Loading

jordanverasamy commented Nov 22, 2025 •

edited

Loading

github-actions bot commented Nov 22, 2025 •

edited

Loading

jordanverasamy Nov 25, 2025 •

edited

Loading