Federation: multi-line description bug #3828
Closed
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
abernix
requested changes
Feb 25, 2020
Comment on lines
+351
to
+355
| // If a description uses the double quote character, it absolutely must use | ||
| // a multi-line comment. | ||
| const requireMultiline = lines.some(line => line.includes('"')); | ||
|
|
||
| if (lines.length === 1 && !requireMultiline) { |
There was a problem hiding this comment.
Escaped quotes (i.e. \") are valid in non-block'd def.description.values in a schema's AST, so the comment here is not quite correct. Further, I believe by using this implementation we'd be applying/requiring this transformation unnecessarily.
Perhaps we might consider downstreaming some of the changes in graphql's printSchema which seems to have a more current version of the printDescription method which I believe we cargo cult-ed at one point.
Generally, except for where we leverage specific overrides, I'd have a preference for a more exact copy of that implementation.
|
Fixed in #4405 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
printFederatedSchemahas a bug where descriptions that use double quotes as part of the description itself (note, this REQUIRES a multi-line description - triple double-quotes - to work) can be transformed into a single-line description with double-quotes which is unparseable!The additional test case demonstrates the bug well, and the fix is straightforward. If a description contains a double quote, force a multi-line description to be printed regardless of the length.
Fixes #3864.