Skip to content

Fix confusing error message when query is empty #6787

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
ericlee878 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix confusing error message when query is empty #6787

ericlee878 wants to merge 1 commit into from
+41 −1

Conversation

@ericlee878
Copy link
Contributor

@ericlee878 ericlee878 commented Jan 21, 2026 •
edited
Loading

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

Problem

The code would reach this BugError, which it should never reach. This was because when a query or query file was blank, it was considered "provided" by oclif (satisfying the exactlyOne constraint) but empty by the code.

Solution

Added validation that checks if the query or query file content is blank, and throws a user-friendly error message instead of falling through to the BugError.

Test plan

  • Added unit test for empty --query flag
  • Added unit test for --query flag with only whitespace
  • Added unit test for empty query file
  • Added unit test for query file containing only whitespace
  • All existing tests pass (15 total)

Before and After

Before:

  • For empty --query or empty --query-file:
    Screenshot 2026-01-21 at 3.21.48 PM.png

After:

  • For empty --query:
    Screenshot 2026-01-21 at 3.07.24 PM.png

  • For empty --query-file:
    Screenshot 2026-01-21 at 3.06.55 PM.png

@ericlee878 Graphite App
Copy link
Contributor Author

ericlee878 commented Jan 21, 2026

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

@ericlee878 ericlee878 changed the title fix-error-message-with-empty-query Fix confusing error message when --query-file points to an empty file Jan 21, 2026
@ericlee878 ericlee878 changed the title Fix confusing error message when --query-file points to an empty file Fix confusing error message when query points to an empty file Jan 21, 2026
@ericlee878 ericlee878 changed the title Fix confusing error message when query points to an empty file Fix confusing error message when query is empty Jan 21, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 21, 2026 •
edited
Loading

Coverage report

St.❔
 Category Percentage Covered / Total
🟡 Statements
79.54% (+0.31% 🔼)
 14377/18076
🟡 Branches
73.84% (+0.73% 🔼)
 7114/9634
🟡 Functions
79.66% (+0.29% 🔼)
 3674/4612
🟡 Lines
79.9% (+0.31% 🔼)
 13592/17012
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%
🟢
... / organization_exp_flags.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
 86.76% 83.67% 100% 88.06%
🟢
... / 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%
🟢
... / utilities.ts
 100% 100% 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%
🟢
... / file-formatter.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%
🟢
... / loader.ts
94.06% (+0.2% 🔼)
86.41% (-0.42% 🔻)
97.17% (+0.11% 🔼)
94.85% (+0.18% 🔼)
🟢
... / extension-instance.ts
84.8% (+0.23% 🔼)
77.6% (-0.91% 🔻)
92.06% (+0.13% 🔼)
85.11% (+0.24% 🔼)
🟡
... / specification.ts
69.64% (+0.55% 🔼)
75.61% (+2.44% 🔼)
76.47% (-1.31% 🔻)
69.39% (+0.64% 🔼)
🟢
... / ui_extension.ts
88.61% (-6.22% 🔻)
78.57% (-2.68% 🔻)
85.19% (-14.81% 🔻)
90.79% (-5.67% 🔻)
🟢
... / 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% 🔻)
🟡
... / middlewares.ts
77.33% (-0.87% 🔻)
 75%
68.42% (-1.58% 🔻)
76.39% (-0.94% 🔻)
🔴
... / server.ts
1.23% (-0.02% 🔻)
 0% 0%
1.3% (-0.02% 🔻)
🟢
... / 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% 🔻)
🟢
... / api.ts
87.07% (-0.43% 🔻)
76.71% (-0.1% 🔻)
 100%
86.49% (-0.43% 🔻)
🟢
... / device-authorization.ts
88.24% (-0.83% 🔻)
76.47% (-2.94% 🔻)
 100%
88.24% (-0.83% 🔻)
🟢
... / 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% 🔻)
🟡
... / local.ts
68.63% (-1.37% 🔻)
56.25% (-1.2% 🔻)
54.55% (-2.6% 🔻)
68.63% (-1.37% 🔻)
🟢
... / 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

3688 tests passing in 1431 suites.

Report generated by 🧪jest coverage report action from 52e54ff

@ericlee878 ericlee878 marked this pull request as ready for review January 21, 2026 23:07
@ericlee878 ericlee878 requested a review from a team as a code owner January 21, 2026 23:07
@github-actions
Copy link
Contributor

github-actions bot commented Jan 21, 2026

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 marked this pull request as draft January 21, 2026 23:07
@ericlee878 ericlee878 force-pushed the more-accurate-error-messaging-for-empty-query branch from f6cb114 to 52e54ff Compare January 21, 2026 23:10
@ericlee878 ericlee878 marked this pull request as ready for review January 22, 2026 00:15
jordanverasamy
jordanverasamy approved these changes Jan 22, 2026
View reviewed changes
Copy link
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.

nicee

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dmerand dmerand dmerand approved these changes

@jordanverasamy jordanverasamy jordanverasamy 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.

3 participants

@ericlee878 @dmerand @jordanverasamy