Add overwrite prompt for store export if file exists #6114

skelley-ton · 2025-07-15T18:43:36Z

WHY are these changes introduced?

Fixes https://github.com/Shopify/workflows-operations/issues/3364

WHAT is this pull request doing?

Adds a confirmation prompt when attempting to export store data to a file that already exists. This prevents accidental overwriting of existing files by:

Update confirmExportPrompt function so that it asks users if they want to overwrite an existing file if the file exists
Showing the appropriate confirmation prompt based on whether the file exists or not

How to test your changes?

run this command twice, the first time you will see the normal flow, the second time you will see the overwrite flow

pnpm shopify store copy --from-store=source --to-file=file --mock

Measuring impact

How do we know this change was effective? Please choose one:

n/a - this doesn't need measurement, e.g. a linting rule or a bug-fix
Existing analytics will cater for this addition
PR includes analytics changes to measure impact

Checklist

I've considered possible cross-platform impacts (Mac, Linux, Windows)
I've considered possible documentation changes

skelley-ton · 2025-07-15T18:43:55Z

Add overwrite prompt for store export if file exists #6114 👈 (View in Graphite)
main

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

github-actions · 2025-07-15T18:48:24Z

Coverage report

St.^❔	Category	Percentage	Covered / Total
🟡	Statements	78.06%	13004/16658
🟡	Branches	72.29%	6343/8774
🟡	Functions	78.18%	3371/4312
🟡	Lines	78.47%	12313/15691

Test suite run success

3031 tests passing in 1314 suites.

Report generated by 🧪jest coverage report action from 3d61b1b

github-actions · 2025-07-15T19:06:56Z

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.

rzaharenkov · 2025-07-15T19:16:18Z

packages/store/src/services/store/operations/store-export.ts

+          outputInfo('Exiting.')
+          process.exit(0)
+        }
+      } else if (!(await confirmExportPrompt(sourceShopDomain, toFile))) {


I am slightly concerned that with file conflict we are getting less informative confirmation that is only asking to override the file and export prompt is not being shown.

I would make it so export confirmation prompt is displayed first and then when user confirmed the intent to export from a store to a file we show the next prompt to confirm file overwrite.

nit, I would extract the confirmation logic into separate function since it becomes really bulky.

Other issue I can see with it is that no-prompt mode will automatically overwrite the file. I would expect it to actually fail with the error stating that the file already exists. I think no-prompt should be still safe. E.g. when I use it in automation I would love it to not silently overwrite the file if I messed up with the logic. I don't have strong opinions on that so I would love to hear what other people think about.

I paired on this with @Rusty-UX, so will let him chime in!

👋 @rzaharenkov We discussed having the overwrite then the export prompt. IMO the proposed option in the PR is the strongest, because it clarifies the export operation will proceed, while also communicating the overwrite. IMO it's less verbose, but the information communicated is essentially the same.

On the comment of no-prompt I have less of an opinion on this, but I agree with you that it should fail instead of silently overwriting. LMK if that means we need to rethink the prompt content displayed for the export+overwrite.

OK, I am good to have a single confirmation, I think it's more user friendly.

nit, I would love to see some kind of extracting this logic. Maybe it could be arguments passed to the same function confirmExportPrompt, or it could be another function. But not a blocker for this PR.

Also would love a change to avoid silent overwrite for no-prompt mode. But it could definitely be a follow up since this behavior is not changing in this PR and it's positive incremental change.

rzaharenkov · 2025-07-15T21:47:04Z

packages/store/src/services/store/operations/store-export.ts

+          outputInfo('Exiting.')
+          process.exit(0)
+        }
+      } else if (!(await confirmExportPrompt(sourceShopDomain, toFile))) {


OK, I am good to have a single confirmation, I think it's more user friendly.

nit, I would love to see some kind of extracting this logic. Maybe it could be arguments passed to the same function confirmExportPrompt, or it could be another function. But not a blocker for this PR.

Also would love a change to avoid silent overwrite for no-prompt mode. But it could definitely be a follow up since this behavior is not changing in this PR and it's positive incremental change.

odacrem · 2025-07-16T15:26:36Z

packages/store/src/services/store/operations/store-export.ts

@@ -36,7 +38,12 @@ export class StoreExportOperation implements StoreOperation {
    const apiShopId = await this.validateShop(sourceShopDomain)

    if (!flags['no-prompt']) {


I agree that this section is a little unwieldy; I would prefer to have this operation just call confirmExportPrompt(sourceShopDomain, toFile)

and then have the prompt sort out whether it needs confirm about the overwrite or not.

the unit test for the operation can just test that it calls the confirmExport prompt with the right parameters;

and the confirmExportPrompt tests can confirm that asks the right questions based on no-prompt flags, file existence etc

skelley-ton mentioned this pull request Jul 15, 2025

EA Release Stub #6109

Open

skelley-ton force-pushed the cli-prompts-store-export-overwrite branch from 0044cb0 to 0dc8cdd Compare July 15, 2025 19:05

odacrem changed the base branch from ea-release to graphite-base/6114 July 15, 2025 19:06

skelley-ton marked this pull request as ready for review July 15, 2025 19:06

skelley-ton requested review from a team as code owners July 15, 2025 19:06

skelley-ton requested review from alexcwatt and jordanverasamy July 15, 2025 19:06

rzaharenkov reviewed Jul 15, 2025

View reviewed changes

rzaharenkov approved these changes Jul 15, 2025

View reviewed changes

szluzero approved these changes Jul 16, 2025

View reviewed changes

odacrem requested changes Jul 16, 2025

View reviewed changes

skelley-ton force-pushed the cli-prompts-store-export-overwrite branch from 0dc8cdd to e246a3c Compare July 16, 2025 15:54

skelley-ton force-pushed the graphite-base/6114 branch from 547dbbb to b438c68 Compare July 16, 2025 15:54

skelley-ton changed the base branch from graphite-base/6114 to ea-release July 16, 2025 15:54

skelley-ton requested a review from odacrem July 16, 2025 15:56

odacrem approved these changes Jul 16, 2025

View reviewed changes

odacrem force-pushed the cli-prompts-store-export-overwrite branch from e246a3c to 5095851 Compare July 16, 2025 18:17

odacrem force-pushed the ea-release branch from b438c68 to 904f6c8 Compare July 16, 2025 18:17

rzaharenkov changed the base branch from ea-release to graphite-base/6114 July 16, 2025 20:12

rzaharenkov mentioned this pull request Jul 16, 2025

Use apropriate shop domain name in different environment #6123

Merged

3 tasks

Confirm export prompt now shows overwrite prompt if file exists

3d61b1b

odacrem force-pushed the graphite-base/6114 branch from 904f6c8 to e81e08a Compare July 17, 2025 13:23

odacrem force-pushed the cli-prompts-store-export-overwrite branch from 5095851 to 3d61b1b Compare July 17, 2025 13:23

odacrem changed the base branch from graphite-base/6114 to main July 17, 2025 13:24

odacrem added this pull request to the merge queue Jul 17, 2025

Merged via the queue into main with commit 9907280 Jul 17, 2025
56 of 97 checks passed

odacrem deleted the cli-prompts-store-export-overwrite branch July 17, 2025 13:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add overwrite prompt for store export if file exists #6114

Add overwrite prompt for store export if file exists #6114

Uh oh!

skelley-ton commented Jul 15, 2025 •

edited

Loading

Uh oh!

skelley-ton commented Jul 15, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 15, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 15, 2025

Uh oh!

rzaharenkov Jul 15, 2025

Uh oh!

rzaharenkov Jul 15, 2025

Uh oh!

skelley-ton Jul 15, 2025

Uh oh!

Rusty-UX Jul 15, 2025

Uh oh!

rzaharenkov Jul 15, 2025

Uh oh!

rzaharenkov Jul 15, 2025

Uh oh!

odacrem Jul 16, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

		@@ -36,7 +38,12 @@ export class StoreExportOperation implements StoreOperation {
		const apiShopId = await this.validateShop(sourceShopDomain)

		if (!flags['no-prompt']) {

Add overwrite prompt for store export if file exists #6114

Add overwrite prompt for store export if file exists #6114

Uh oh!

Conversation

skelley-ton commented Jul 15, 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?

Measuring impact

Checklist

Uh oh!

skelley-ton commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jul 15, 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 Jul 15, 2025

Uh oh!

rzaharenkov Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

rzaharenkov Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

skelley-ton Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

Rusty-UX Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

rzaharenkov Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

rzaharenkov Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

odacrem Jul 16, 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!

Uh oh!

Uh oh!

skelley-ton commented Jul 15, 2025 •

edited

Loading

skelley-ton commented Jul 15, 2025 •

edited

Loading

github-actions bot commented Jul 15, 2025 •

edited

Loading

odacrem Jul 16, 2025 •

edited

Loading