Repository navigation
Print descriptions as quoted strings when a block string cannot hold them - #156
Open
swalkinshaw wants to merge 1 commit into
Open
swalkinshaw wants to merge 1 commit into
swalkinshaw wants to merge 1 commit into
Conversation
…them Block string parsing removes common indentation and leading and trailing blank lines, and treats \r as a line terminator. So descriptions such as "\nfoo", "foo\n" and " foo" changed after a print and parse. Fall back to a quoted string for these values, and escape control characters in quoted strings. Found by fuzzing with apollo-smith.
swalkinshaw
marked this pull request as ready for review
October 22, 2026 20:22
szluzero
approved these changes
Oct 27, 2026
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.
BlockStringValuePrinterwrites every description as a block string, so some descriptions change after a print and parse. Block string parsing removes common indentation and leading and trailing blank lines, and treats\ras a line terminator (spec)."\nfoo""foo""foo\n""foo"" foo""foo""a\r\nb""a\nb"The printer now writes these values as quoted strings. The check is based on graphql-js
isPrintableAsBlockString, adapted to the multi-line format that Bluejay prints. All other descriptions print as before, so no snapshots change.Quoted strings now also escape control characters as
\uXXXX, like graphql-js. Bluejay parses raw control characters, but parsers that follow the June 2018 spec reject them.