Repository navigation
split # comment descriptions on carriage returns in SchemaPrinter - #4511
Merged
bbakerman merged 1 commit intoOct 26, 2026
Merged
Conversation
Contributor
Test ReportTest Results
Code Coverage (Java 25)
Changed Class Coverage (1 class)
|
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.
Spock, SchemaPrinter with descriptionsAsHashComments(true) on a type whose description is "x\rtype Injected { a: String }", then re-parsing the printed sdl:
printComments splits the description on
\nonly before writing each line as a#comment, but the lexer's Comment token also stops at\r(SourceCharacterWithoutLineFeed in GraphqlCommon.g4), so everything after a carriage return is parsed as sdl. The description can come from a\rescape in sdl or from a remote introspection result fed through IntrospectionResultToSchema and SchemaGenerator, so whoever controls a description can add definitions to the printed schema.The hash comment branch now splits on
\r\n,\rand\n. Block string and single line descriptions are unaffected: there the CR stays inside the block string or is escaped by escapeJsonString. The regression test in SchemaPrinterTest fails before the patch.