Fix introspection false mismatch: defaultValue list of objects #6075
Conversation
This file contains 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
In GraphQL introspection response, the `defaultValue` of an anrgument or input object field is represented as a JSON string that contains GraphQL syntax. If that value contains a GraphQL object value, graphql-js seems to sort its contents by input object field name whereas apollo-compiler preserves the source ordering. This causes introspection JSON responses to be different in a way that we consider not to be meaningful: object values are semantically unordered maps. Introspection "both" mode already had code to sort object values in order to ignore these differences, but was missing the case where `defaultValue` is not directly an object value but a list value of object values.
|
@SimonSapin, please consider creating a changeset entry in |
goto-bus-stop
approved these changes
Sep 27, 2024
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.
In GraphQL introspection response, the
defaultValueof an anrgument or input object field is represented as a JSON string that contains GraphQL syntax. If that value contains a GraphQL object value, graphql-js seems to sort its contents by input object field name whereas apollo-compiler preserves the source ordering.This causes introspection JSON responses to be different in a way that we consider not to be meaningful: object values are semantically unordered maps. Introspection "both" mode already had code to sort object values in order to ignore these differences, but was missing the case where
defaultValueis not directly an object value but a list value of object values.Checklist
Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.
Exceptions
Note any exceptions here
Notes
Footnotes
It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this. ↩
Configuration is an important part of many changes. Where applicable please try to document configuration examples. ↩
Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions. ↩