Add option to redact token details from parser error messages #3618
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
dondonz
commented
Jun 5, 2024
| @@ -1188,4 +1188,70 @@ triple3 : """edge cases \\""" "" " \\"" \\" edge cases""" | |||
| "\"\t\" scalar A" | _ | |||
| } | |||
|
|
|||
| def "can redact tokens in InvalidSyntax parser error message"() { | |||
There was a problem hiding this comment.
Finding the right offending cases was the hard bit!
These tests cover the 3 message strings to be redacted
InvalidSyntax.fullInvalidSyntaxBail.fullInvalidSyntaxMoreTokens.full
dondonz
commented
Jun 5, 2024
|
|
||
| defaultOperationOptions.getMaxTokens() == 15_000 | ||
| defaultOperationOptions.getMaxWhitespaceTokens() == 200_000 | ||
| defaultOperationOptions.isCaptureSourceLocation() | ||
| !defaultOperationOptions.isCaptureLineComments() | ||
| !defaultOperationOptions.isCaptureIgnoredChars() | ||
| defaultOptions.isReaderTrackData() |
dondonz
commented
Jun 5, 2024
|
|
||
| defaultSdlOptions.getMaxCharacters() == Integer.MAX_VALUE | ||
| defaultSdlOptions.getMaxTokens() == Integer.MAX_VALUE | ||
| defaultSdlOptions.getMaxWhitespaceTokens() == Integer.MAX_VALUE | ||
| defaultSdlOptions.isCaptureSourceLocation() | ||
| defaultSdlOptions.isCaptureLineComments() | ||
| !defaultSdlOptions.isCaptureIgnoredChars() | ||
| defaultOptions.isReaderTrackData() |
|
This looks good to me! |
bbakerman
reviewed
Jun 7, 2024
| @@ -189,6 +192,7 @@ public static void setDefaultSdlParserOptions(ParserOptions options) { | |||
| private final int maxTokens; | |||
| private final int maxWhitespaceTokens; | |||
| private final int maxRuleDepth; | |||
| private final boolean redactTokenParserErrorMessages; | |||
bbakerman
reviewed
Jun 7, 2024
| @@ -319,6 +332,7 @@ public static class Builder { | |||
| private int maxTokens = MAX_QUERY_TOKENS; | |||
| private int maxWhitespaceTokens = MAX_WHITESPACE_TOKENS; | |||
| private int maxRuleDepth = MAX_RULE_DEPTH; | |||
| private boolean redactTokenParserErrorMessages = false; | |||
|
@ee-usgs FYI I merged this PR into master. This will kick off a master build deployment, in case you want to test (of course, no obligation to do anything, you've given me very detailed info already!) Our master build versions contain the date in UTC and the git short hash in the name. Look for it in your favourite Maven website, this one is most up to date: https://repo1.maven.org/maven2/com/graphql-java/graphql-java/. It takes a short while to land in Maven, it'll land soon. Thanks again for the suggestion! |
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.
Addresses #3617
Adds an option to redact the token from parser error messages. Note that the default behaviour will be the same as before, by default error messages provide token information if available, to assist with debugging.
There are three parsing messages to be redacted:
InvalidSyntax.fullInvalidSyntaxBail.fullInvalidSyntaxMoreTokens.full