Removed @PluginAttribute 'patternFlags' argument from @PluginFactory for RegexFilter. (#3086) #3512
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
+ made AbstractFiltter.AbstractFilterBuilder onMatch/onMismatch fields protected + added AbstractFilter(AbstractFilterBuilder) constructor + added RegexFilter.Builder implementation + added RegexFilter(Builder) constructor + moved RegexFilter Pattern compile into constructor + added fields to persist configuration propertties + getters (regexExpression, patternFlags) + changed private constructor to accept builder as argument + renamed private method 'targetMessageTest' to more approprriate 'getMessageTextByType' + added Javadoc + grouped deprecations
+ added validation checks to RegexFilter + added JVerify nullability annotations to RegexFilter + updated javadoc + replaced deprecated usages of CompositeFilter#getFilters with CompositeFilter#getFiltersArray in AbstractFilterableTest
|
New branch based on 2.x branch - replacing PR #3463 |
JWT007
added
bug
Generated by gradle/develocity-actions |
vy
requested changes
Mar 14, 2025
| @Override | ||
| public Result filter(final LogEvent event) { | ||
| final String text = targetMessageTest(event.getMessage()); | ||
| return filter(text); | ||
| Objects.requireNonNull(event, "The 'event' argument must not be null."); |
There was a problem hiding this comment.
Suggested change
| Objects.requireNonNull(event, "The 'event' argument must not be null."); | |
| Objects.requireNonNull(event, "event"); |
| * The regular expression to match. | ||
| */ | ||
| @PluginBuilderAttribute | ||
| @Required(message = "No 'regex' provided for RegexFilter") |
There was a problem hiding this comment.
Please don't provide a failure message for cases where the failure system should be providing the necessary context.
Suggested change
| @Required(message = "No 'regex' provided for RegexFilter") | |
| @Required |
| /** {@inheritDoc} */ | ||
| @Override | ||
| public boolean isValid() { | ||
| return (Strings.isNotEmpty(this.regex)); |
There was a problem hiding this comment.
Suggested change
| return (Strings.isNotEmpty(this.regex)); | |
| return Strings.isNotEmpty(this.regex); |
Comment on lines
+323
to
338
| public @Nullable RegexFilter build() { | ||
|
|
||
| // validate the "regex" attribute | ||
| if (Strings.isEmpty(this.regex)) { | ||
| LOGGER.error("Unable to create RegexFilter: The 'regex' attribute be set to a non-empty String."); | ||
| return null; | ||
| } | ||
|
|
||
| // build with *safety* to not throw exceptions | ||
| try { | ||
| return new RegexFilter(this); | ||
| } catch (final Exception ex) { | ||
| LOGGER.error("Unable to create RegexFilter. {}", ex.getMessage(), ex); | ||
| return null; | ||
| } | ||
| } |
There was a problem hiding this comment.
We had a dev@ discussion about this, and the conclusion is to throw exception on failures while building components. Would you mind updating this build() logic accordingly, please?
| * @deprecated pattern flags have been deprecated - they can just be included in the regex-expression. | ||
| */ | ||
| @Deprecated | ||
| private static final int DEFAULT_PATTERN_FLAGS = 0; |
There was a problem hiding this comment.
AFAIU, this constant is only used in toPatternFlags(), could you move it into that method, please?
Comment on lines
+389
to
392
| @Deprecated | ||
| public String[] getPatternFlags() { | ||
| return this.patternFlags.clone(); | ||
| } |
There was a problem hiding this comment.
We're adding a new deprecated method? Why don't we simply not add it?
| Boolean.TRUE.equals(useRawMsg), Pattern.compile(regex, toPatternFlags(patternFlags)), match, mismatch); | ||
|
|
||
| // LOG4J-3086 - pattern-flags can be embedded in RegEx expression | ||
| Objects.requireNonNull(regex, "The 'regex' argument must not be null."); |
There was a problem hiding this comment.
Suggested change
| Objects.requireNonNull(regex, "The 'regex' argument must not be null."); | |
| Objects.requireNonNull(regex, "regex"); |
ppkarwasz
requested changes
May 16, 2025
| @PluginBuilderAttribute(ATTR_ON_MATCH) | ||
| private Result onMatch = Result.NEUTRAL; | ||
| protected Result onMatch = Result.NEUTRAL; |
There was a problem hiding this comment.
There is already a getOnMatch(), no need to expose the field too.
| @PluginBuilderAttribute(ATTR_ON_MISMATCH) | ||
| private Result onMismatch = Result.DENY; | ||
| protected Result onMismatch = Result.DENY; |
There was a problem hiding this comment.
There is already a getOnMismatch(), no need to expose the field too.
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
(#3086)
Removed @PluginAttribute 'patternFlags' argument from https://github.com/pluginfactory for RegexFilter.
Actually created new https://github.com/pluginfactory without the argument and deprecated old 'createFilter' method.
See ticket for discussion of the reasoning - short version - pattern flags can be passed as part of RegEx expression.
Also guarded the "PatternCompile" method against excepttions - logging and returning null if the pattern fails to compile.
Recreated from 2.x and superceding PR #3463