feat: output GRAPHQL_DEBUG message if requested amount is larger than connection limit #3013
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
|
Code Climate has analyzed commit 471ca6a and detected 0 issues on this pull request. View more on Code Climate. |
3 tasks
justlevine
changed the title
Collaborator
Author
|
(relabeled the PR as a |
justlevine
added
type: enhancement
jasonbahl
approved these changes
Jan 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
What does this implement/fix? Explain your changes.
This PR adds a debug message to the GraphQL response when the requested amount (
first,last) is greater than thegraphql_connection_max_query_amountfilter value set on the server.Why
This addition provides developers with an important indication that they're not actually getting the full results requested, which is particularly important to new users coming from traditional WP-PHP for whom setting
WP_Query( [ 'posts_per_page' => -1 ] )is discouraged, but commonplace.A debug message was chosen over throwing a
GraphQLError, both to preserve back-compat, and because IMO this is the ideal GraphQL pattern: a too-largefirstisnt a schema error, it's something that gets filtered on the backend (ostensibly even based on user role).More importantly, it keeps the frontend code reusable and server-agnostic. E.g. a pagination pattern uses the last returned item to fetch the next page of results no matter what the server-limit is, whereas if a
GraphQLErrorwas thrown, users would need to manually update their frontend code and eschew component libraries / framework starters).Does this close any currently open issues?
Closes #3012
Any relevant logs, error output, GraphiQL screenshots, etc?
Any other comments?
…
Where has this been tested?
Operating System: Ubuntu 20.04 (wsl2 + devilbox + php 8.1.15)
WordPress Version: 6.4.2