Allow graphql schema export to use a canonical representation #439
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
|
@garyd203 Interested to update this pull request? |
|
Yes @firaskafri, hopefully in the next day or two |
garyd203
force-pushed
the
canonical-schema
branch
from
d3f02df to
3c3c637
Compare
|
I have rebased this now @firaskafri |
firaskafri
approved these changes
Mar 25, 2019
|
Thank you @garyd203! |
danpalmer
requested changes
Mar 25, 2019
|
Given that the current behaviour is essentially defined by dict ordering which until recently has been explicitly something that shouldn’t be depended on, I don’t think this is really breaking anything. I’m strongly in favour of remove this as it simplifies the code significantly. It may be worth keeping a brief note in the documentation to say that keys are sorted as it’s a nice thing to be able to rely on now! |
|
Completely agree with @danpalmer - this behaviour should be the default. |
garyd203
force-pushed
the
canonical-schema
branch
from
3c3c637 to
1ca44b5
Compare
danpalmer
approved these changes
Mar 26, 2019
jkimbo
approved these changes
Mar 31, 2019
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.
When we use the
graphql_schemamanagement command, the output can vary from run to run depending on arbitrary factors (because there is no guarantee made about the order used to output JSON dictionary keys). This makes it difficult to compare two schema's at different points in time.We address this by including a new
canonicalflag to the command, which uses standardjson.dumpfuncitonality to sort dictionary keys and force pretty-printed output.