Enable custom headers in CLI GraphiQL #6703
Open
+152
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Re-enables the header editor UI in GraphiQL and adds filtering to block problematic browser/hop-by-hop headers while allowing custom headers through. This allows users to pass headers like `Shopify-Search-Query-Debug=1` to the Admin API for debugging purposes. Changes: - Enable isHeadersEditorEnabled in GraphiQL component - Add BLOCKED_HEADERS set for hop-by-hop and proxy-controlled headers - Add filterCustomHeaders() to extract safe custom headers - Forward filtered custom headers to Admin API Fixes: shop/issues-develop#21688 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
amcaplan
force-pushed
the
allow-custom-headers-in-graphiql
branch
from
64f79b7 to
f793848
Compare
Contributor
Coverage report
Show new covered files 🐣
Show files with reduced coverage 🔻
Test suite run success3491 tests passing in 1408 suites. Report generated by 🧪jest coverage report action from 73a3833 |
ravangen
reviewed
Dec 10, 2025
ravangen
left a comment
ravangen
left a comment
There was a problem hiding this comment.
Should ideally also allow:
Shopify-GraphQL-Cost-Debug(https://shopify.dev/docs/api/usage/limits#graphql-response)Shopify-Debug-HeadersX-Shopify-Profile,X-Shopify-Profile-AuthShopify-Force-Canary,Shopify-Force-Alternate-Backend(docs)
There are other ones, but not sure if they are applicable here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Shopify-Search-Query-Debug=1to pass through to the Admin APIProblem
The CLI's built-in GraphiQL didn't allow passing custom headers. This feature was explicitly disabled because the proxy couldn't distinguish between user-set headers and browser defaults, causing conflicts.
Solution
isHeadersEditorEnabled: truein the GraphiQL componentTest plan
shopify app dev, open GraphiQL, add custom header, verify it reaches the APIFixes: https://github.com/shop/issues-develop/issues/21688
🤖 Generated with Claude Code