Skip to content

Add support for executing GraphQL queries on non-dev stores#6738

Merged
ericlee878 merged 5 commits intomainfrom
eric-lee-allow_graphql_queries_on_prod_stores
Jan 13, 2026
Merged

Add support for executing GraphQL queries on non-dev stores#6738
ericlee878 merged 5 commits intomainfrom
eric-lee-allow_graphql_queries_on_prod_stores

Conversation

@ericlee878
Copy link
Copy Markdown
Contributor

@ericlee878 ericlee878 commented Dec 23, 2025 •
edited
Loading

Add support for executing GraphQL queries on non-dev stores

Came from: https://app.graphite.com/github/pr/Shopify/cli/6689/Add-support-for-executing-GraphQL-queries-on-non-dev-stores

Made a new PR because this task was handed off to me and the rebasing caused major changes.

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

What

  • Added a new GraphQL query to fetch stores by domain without filtering by store type
  • Updates the executeBulkOperation and executeOperation services to accept a store object instead of just the FQDN. This is so that we can determine the storeType of the store. The storeType is either dev or non-dev.
  • Modifies the store context to optionally include all store types, not just development stores
  • Using the storeType, we only let dev stores use bulkOperation mutations. BulkOperation queries are allowed for all stores.
  • The already existing mutation validation was integrated with the part where only let dev stores do bulkOperation mutations.
  • Added tests to verify mutation validation works correctly.
  • Added helper functions to check if a GraphQL operation is a mutation

How to test your changes?

  1. Try executing a query on a production store:

    shopify app execute --store=your-production-store.myshopify.com --query "{ shop { name } }"

    This should succeed.

  2. Try executing a mutation on a production store:

    shopify app execute --store=your-production-store.myshopify.com --query "mutation { productUpdate(input: {}) { product { id } } }"

    This should fail with an error message indicating mutations can only be executed on Dev Stores.

  3. Try executing a mutation on a development store:

    shopify app execute --store=your-dev-store.myshopify.com --query  "mutation { productUpdate(input: {}) { product { id } } }"

    This should succeed.

@ericlee878 Graphite App
Copy link
Copy Markdown
Contributor Author

ericlee878 commented Dec 23, 2025

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

@ericlee878 ericlee878 marked this pull request as ready for review December 23, 2025 19:27
@ericlee878 ericlee878 requested a review from a team as a code owner December 23, 2025 19:27
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Dec 23, 2025

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.

@ericlee878 ericlee878 force-pushed the eric-lee-allow_graphql_queries_on_prod_stores branch 2 times, most recently from 924deb3 to aecb581 Compare December 23, 2025 20:52
@ericlee878 ericlee878 changed the title better testing of resolveApiVersion use Add support for executing GraphQL queries on non-dev stores Dec 23, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Dec 23, 2025 •
edited
Loading

Coverage report

St.❔
 Category Percentage Covered / Total
🟡 Statements
79.43% (+0.21% 🔼)
 14233/17918
🟡 Branches
73.64% (+0.53% 🔼)
 6995/9499
🟡 Functions
79.55% (+0.18% 🔼)
 3646/4583
🟡 Lines
79.8% (+0.22% 🔼)
 13459/16866
Show new covered files 🐣
St.❔
 File Statements Branches Functions Lines
🟢
... / admin-as-app.ts
 100% 100% 100% 100%
🟢
... / metafield_definitions.ts
 100% 100% 100% 100%
🟢
... / metaobject_definitions.ts
 100% 100% 100% 100%
🟢
... / bulk-operation-cancel.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%
🟢
... / list-bulk-operations.ts
 100% 100% 100% 100%
🟢
... / staged-uploads-create.ts
 100% 100% 100% 100%
🟢
... / fetch_store_by_domain.ts
 100% 100% 100% 100%
🔴
... / import-custom-data-definitions.ts
 0% 100% 0% 0%
🔴
... / cancel.ts
 0% 100% 0% 0%
🔴
... / execute.ts
 0% 0% 0% 0%
🔴
... / status.ts
 0% 0% 0% 0%
🔴
... / pull.ts
 0% 100% 0% 0%
🟡
... / execute-operation.ts
 75% 50% 100% 75%
🔴
... / pull.ts
 0% 0% 0% 0%
🟢
... / bulk-operation-status.ts
 96.55% 92.11% 100% 100%
🟢
... / cancel-bulk-operation.ts
 100% 100% 100% 100%
🟢
... / constants.ts
 100% 100% 100% 100%
🟢
... / download-bulk-operation-results.ts
 100% 100% 100% 100%
🟢
... / execute-bulk-operation.ts
 92.06% 86.05% 100% 93.55%
🟢
... / 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
 73.53% 62.5% 85.71% 72.73%
🟢
... / watch-bulk-operation.ts
 100% 94.74% 100% 100%
🟢
... / declarative-definitions.ts
 98.54% 93.18% 100% 98.51%
🟢
... / common.ts
 97.62% 95% 100% 97.06%
🟢
... / execute-command-helpers.ts
 100% 100% 100% 100%
🔴
... / promiseWithResolvers.ts
 33.33% 50% 50% 33.33%
Show files with reduced coverage 🔻
St.❔
 File Statements Branches Functions Lines
🔴
... / execute.ts
 0%
0% (-100% 🔻)
 0% 0%
🟢
... / extension-instance.ts
84.8% (+0.23% 🔼)
77.6% (-0.91% 🔻)
92.06% (+0.13% 🔼)
85.11% (+0.24% 🔼)
🟡
... / specification.ts
 69.09%
75.61% (+2.44% 🔼)
76.47% (-1.31% 🔻)
 68.75%
🟢
... / ui_extension.ts
85.38% (-9.44% 🔻)
72.34% (-8.91% 🔻)
84% (-16% 🔻)
88% (-8.46% 🔻)
🟢
... / store-context.ts
 100%
82.35% (-0.98% 🔻)
 100% 100%
🟢
... / Logs.tsx
 90%
90.91% (-5.97% 🔻)
 100% 90%
🟢
... / fetch.ts
84.21% (+0.88% 🔼)
82.35% (-0.98% 🔻)
 75%
85.29% (+1.42% 🔼)
🟢
... / app-event-watcher-handler.ts
86.36% (-4.11% 🔻)
 75% 86.67%
85.71% (-5.19% 🔻)
🟢
... / bundle.ts
 93.22%
63.33% (-3.33% 🔻)
94.12% (+5.88% 🔼)
 96.3%
🟢
... / developer-platform-client.ts
84.62% (-1.5% 🔻)
71.43% (+0.84% 🔼)
81.82% (+1.82% 🔼)
93.75% (+0.42% 🔼)
🔴
... / http-reverse-proxy.ts
58.97% (-4.91% 🔻)
37.04% (-2.96% 🔻)
58.33% (-5.3% 🔻)
59.46% (-5.25% 🔻)
🔴
... / app-management-client.ts
53.69% (-0.16% 🔻)
 47.47%
50% (-0.45% 🔻)
52.53% (-0.17% 🔻)
🟢
... / api.ts
87.07% (-0.43% 🔻)
76.71% (-0.1% 🔻)
 100%
86.49% (-0.43% 🔻)
🟢
... / SingleTask.tsx
84.21% (-15.79% 🔻)
50% (-50% 🔻)
80% (-20% 🔻)
84.21% (-15.79% 🔻)
🔴
... / environment.ts
35% (-5% 🔻)
 41.18%
40% (-10% 🔻)
36.84% (-5.26% 🔻)
🔴
... / 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% 🔼)
🟢
... / init.ts
88% (-0.89% 🔻)
71.43% (+4.76% 🔼)
86.67% (+4.85% 🔼)
88% (-0.89% 🔻)
🟢
... / storefront-renderer.ts
90.2% (-0.54% 🔻)
 78.95%
81.82% (-1.52% 🔻)
90.2% (-0.54% 🔻)
🟡
... / theme-polling.ts
67.12% (-0.93% 🔻)
 68.75% 78.57%
66.67% (-0.98% 🔻)

Test suite run success

3597 tests passing in 1422 suites.

Report generated by 🧪jest coverage report action from c9b495e

@ericlee878 ericlee878 force-pushed the eric-lee-allow_graphql_queries_on_prod_stores branch from aecb581 to 1a8018f Compare December 23, 2025 21:40
jordanverasamy
jordanverasamy reviewed Jan 2, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@jordanverasamy jordanverasamy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems generally reasonable :) tophatting now!

@jordanverasamy
Copy link
Copy Markdown
Contributor

jordanverasamy commented Jan 2, 2026 •
edited
Loading

🎩 on a production store successfully:

Queries work:

image

Mutations don't:

image

jordanverasamy
jordanverasamy approved these changes Jan 2, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@jordanverasamy jordanverasamy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎩 , works!

@jordanverasamy
Copy link
Copy Markdown
Contributor

jordanverasamy commented Jan 2, 2026

My one question is whether it would've been possible to accomplish the same stuff with slightly fewer code changes, but I'm sure a reviewer who's more deeply knowledgeable about the CLI will be able to weigh in on that :) from a Bulk Ops perspective this change def works!

@ericlee878 ericlee878 force-pushed the eric-lee-allow_graphql_queries_on_prod_stores branch from 1a8018f to 4cf88af Compare January 8, 2026 20:59
ryancbahan
ryancbahan reviewed Jan 9, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@ryancbahan ryancbahan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like we're coercing down the store type field into a boolean -- I'm curious of the reason for this? Would it be more type-safe and also stable in the long run to have something like storeType: []and pass all allowed store types instead of includeAllStores boolean?

@ericlee878 ericlee878 force-pushed the eric-lee-allow_graphql_queries_on_prod_stores branch from 4cf88af to a2be03d Compare January 10, 2026 00:33
@ericlee878 Graphite App
Copy link
Copy Markdown
Contributor Author

ericlee878 commented Jan 10, 2026

I think the boolean was added as a quick toggle between two hardcoded queries: one filtered to APP_DEVELOPMENT stores, one unfiltered. I can see how using storeTypes: Store[] would be better. Refactored this way!

@ericlee878 ericlee878 requested a review from ryancbahan January 10, 2026 00:33
@ericlee878 ericlee878 force-pushed the eric-lee-allow_graphql_queries_on_prod_stores branch from a2be03d to c02e5d0 Compare January 10, 2026 00:44
@ericlee878 ericlee878 requested a review from a team as a code owner January 10, 2026 00:44
@ericlee878 ericlee878 force-pushed the eric-lee-allow_graphql_queries_on_prod_stores branch 2 times, most recently from f861620 to 6da08fe Compare January 10, 2026 02:29
ryancbahan
ryancbahan reviewed Jan 12, 2026
View reviewed changes
ryancbahan
ryancbahan reviewed Jan 12, 2026
View reviewed changes
@ericlee878 ericlee878 force-pushed the eric-lee-allow_graphql_queries_on_prod_stores branch from 6da08fe to e99a896 Compare January 12, 2026 20:48
@ericlee878 ericlee878 force-pushed the eric-lee-allow_graphql_queries_on_prod_stores branch from e99a896 to e197fba Compare January 12, 2026 20:55
@ericlee878 ericlee878 requested a review from ryancbahan January 12, 2026 21:13
@ericlee878 ericlee878 force-pushed the eric-lee-allow_graphql_queries_on_prod_stores branch 2 times, most recently from 48795cc to a3b29e2 Compare January 12, 2026 21:56
ryancbahan
ryancbahan approved these changes Jan 12, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@ryancbahan ryancbahan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code lgtm. I didn't tophat, but as an external stakeholder it all makes sense. I still have the question of whether the cli itself should do mutation validation, but I recognize that's plausibly a longer conversation.

@ericlee878 ericlee878 force-pushed the eric-lee-allow_graphql_queries_on_prod_stores branch from a3b29e2 to c9b495e Compare January 12, 2026 22:51
@ericlee878 ericlee878 added this pull request to the merge queue Jan 13, 2026
Merged via the queue into main with commit 1ccfc0d Jan 13, 2026
25 checks passed
@ericlee878 ericlee878 deleted the eric-lee-allow_graphql_queries_on_prod_stores branch January 13, 2026 18:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jordanverasamy jordanverasamy jordanverasamy approved these changes

@nickwesselman nickwesselman nickwesselman left review comments

@ryancbahan ryancbahan ryancbahan approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@ericlee878 @jordanverasamy @nickwesselman @ryancbahan