Reorder formatString expression check for JacksonEvent #3533
Conversation
This file contains 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
graytaylor0
requested review from
chenqi0805,
engechas,
dinujoh,
kkondaka,
asifsmohammed,
dlvenable and
oeyh
as code owners
Signed-off-by: Taylor Gray <tylgry@amazon.com>
graytaylor0
force-pushed
the
ExpressionFix
branch
from
e2c2bdd
to
b08e9d4
Compare
engechas
previously approved these changes
Oct 20, 2023
oeyh
previously approved these changes
Oct 20, 2023
kkondaka
previously approved these changes
Oct 20, 2023
dlvenable
requested changes
Oct 20, 2023
graytaylor0
dismissed stale reviews from kkondaka, oeyh, and engechas
via
d9119c2
Signed-off-by: Taylor Gray <tylgry@amazon.com>
graytaylor0
force-pushed
the
ExpressionFix
branch
from
d9119c2
to
8053d9e
Compare
engechas
approved these changes
Oct 20, 2023
dlvenable
approved these changes
Oct 20, 2023
| @@ -567,8 +602,9 @@ public void testBuild_withFormatStringWithExpressionEvaluator() { | |||
|
|
|||
| final ExpressionEvaluator expressionEvaluator = mock(ExpressionEvaluator.class); | |||
|
|
|||
| when(expressionEvaluator.isValidExpressionStatement("foo")).thenReturn(false); | |||
| verify(expressionEvaluator, times(0)).isValidExpressionStatement(eventKey); | |||
There was a problem hiding this comment.
There is also a never() you can use instead of times(0). It's a bit more readable, but should have the same result. Also, I'd probably put an anyString() in there instead of eventKey. When verifying that something is not called, I prefer to be as loose as possible.
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Oct 20, 2023
Reorder formatString expression check for JacksonEvent Signed-off-by: Taylor Gray <tylgry@amazon.com> (cherry picked from commit 53a06bd)
dlvenable
pushed a commit
that referenced
this pull request
Oct 20, 2023
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.
Description
Any call to JacksonEvent
formatStringmethod with an expression evaluator would callisValidExpressionStatement. A call toisValidExpressionStatementthat was false, such as the configurations for normal keys (such as${some_key}) resulted in the ANTLR parser logging something likeevery time this occurs, which is very often when the format is a dynamic index that is evaluated for every Event. This causes cpu spikes and a thread freeze from timeouts for the logger writing to console.
This mitigation includes swapping the order of the evaluation of the format expressions (
${}), so that it is first evaluated whether or not the key is in the Event, and only if it is not do we evaluate whether the statement is a valid expression. The behavior should not change with this swap, but it will very heavily reduce the amount of logging that is seen from the ANTLR parser for this error. Eventually, we should try to keep this log from showing up completely when evaluating if an expression is valid.Issues Resolved
Resolves #3357
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.