feat: new rule for excessive fields #383
Merged
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.
Description
This PR introduces a new GraphQL debug rule:
ExcessiveFields.The rule analyzes GraphQL queries to detect over-fetching, i.e., selecting an excessive number of fields for a single object type.
It uses the GraphQL schema to traverse queries and count fields per type. If any type exceeds the configurable threshold, the rule is triggered.
Key features:
graphql_debug_rule_excessive_fields_thresholdRelated Issue
Dependant PRs
Type of Change
How Has This Been Tested?
"triggered": false."triggered": true.Example filter usage:
Example Queries
Query that triggers the rule
Expected output:
{ "excessiveFieldsRule": { "triggered": true, "message": "Over-fetching detected: Type \"Post\" selects 16 fields, exceeding the threshold of 15." } }Query that does NOT trigger the rule
Expected output:
{ "excessiveFieldsRule": { "triggered": false, "message": "No excessive fields detected." } }