Make deprecated introspection optional for legacy servers - #1849
Open
johnxy84 wants to merge 7 commits into
Open
Make deprecated introspection optional for legacy servers#1849johnxy84 wants to merge 7 commits into
johnxy84 wants to merge 7 commits into
Conversation
3 tasks
spawnia
reviewed
Feb 6, 2026
| * - typeIsOneOf | ||
| * Include field `isOneOf` for types? | ||
| * Default: false | ||
| * |
Collaborator
There was a problem hiding this comment.
Let's keep this blank line
| self::assertCount(0, $matches[0]); | ||
| } | ||
|
|
||
| /** @see it('excludes deprecated fields and indicators when disabled') */ |
Collaborator
There was a problem hiding this comment.
Are there tests in graphql-js called exactly like this? If so, please provide links to them. If not, we can omit this comment.
Author
There was a problem hiding this comment.
Ohh, did not know that's how it worked, but no, this is not covered there. I'll take out the comment.
|
|
||
| ### Changed | ||
|
|
||
| - Allow omitting deprecated introspection arguments/fields for legacy servers |
Collaborator
There was a problem hiding this comment.
Suggested change
| - Allow omitting deprecated introspection arguments/fields for legacy servers | |
| - Allow omitting deprecated introspection arguments/fields for legacy servers https://github.com/webonyx/graphql-php/pull/1849 |
20 tasks
# Conflicts: # CHANGELOG.md # src/Type/Introspection.php # tests/Type/IntrospectionTest.php
# Conflicts: # CHANGELOG.md
Contributor
There was a problem hiding this comment.
Pull request overview
This PR makes deprecation metadata in introspection optional to improve compatibility with legacy GraphQL servers and to support generating introspection results that omit deprecated schema members.
Changes:
- Add
includeDeprecatedoption toIntrospection::getIntrospectionQuery()(and thereforeIntrospection::fromSchema()) to omitincludeDeprecatedarguments andisDeprecated/deprecationReasonselections when disabled. - Harden
BuildClientSchemato treat a missingdeprecationReasonkey in introspection results asnull. - Add regression tests verifying query generation and schema building behavior when deprecated entries are excluded.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/Utils/BuildClientSchemaTest.php | Adds a regression test that BuildClientSchema can build from introspection with deprecated fields/enum values excluded. |
| tests/Type/IntrospectionTest.php | Adds coverage ensuring the generated introspection query omits deprecated indicators and includeDeprecated arguments when disabled. |
| src/Utils/BuildClientSchema.php | Makes enum/field deprecation reason parsing tolerant of missing keys in introspection results. |
| src/Type/Introspection.php | Introduces includeDeprecated option to control whether deprecated-related selections/arguments are included in the query string. |
| CHANGELOG.md | Documents the behavioral change under Unreleased. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
# Conflicts: # CHANGELOG.md
# Conflicts: # CHANGELOG.md
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
includeDeprecatedoption toIntrospection::getIntrospectionQuery()to omit deprecated args/fields for older spec compatibility.isDeprecated/deprecationReasonandincludeDeprecatedarguments when disabled.BuildClientSchemato treat missingdeprecationReasonas null.