[LANG-1753] StringUtils.replaceEachRepeatedly regression in 3.11+ #1297
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
palacsint
reviewed
Oct 15, 2024
| @@ -6611,7 +6608,8 @@ private static String replaceEach( | |||
| * @since 2.4 | |||
| */ | |||
| public static String replaceEachRepeatedly(final String text, final String[] searchList, final String[] replacementList) { | |||
| return replaceEach(text, searchList, replacementList, true, ArrayUtils.getLength(searchList)); | |||
| int timeToLive = Math.max(ArrayUtils.getLength(searchList), DEFAULT_TTL); | |||
There was a problem hiding this comment.
The Javadoc only mentions endless loops ("if the search is repeating and there is an endless loop"). It would be clearer if it also included a mention of the TTL to avoid confusion.
palacsint
reviewed
Oct 15, 2024
Comment on lines
+1999
to
+2000
| assertEquals("a", StringUtils.replaceEachRepeatedly("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", | ||
| new String[]{"aa"}, new String[]{"a"})); |
There was a problem hiding this comment.
I would suggest adding an example of IllegalStateException with a shorter input, like:
assertThrows(
IllegalStateException.class,
() -> StringUtils.replaceEachRepeatedly("aaaaaab", new String[] {"ab"}, new String[] {"b"}),
"Should be a circular reference");
It might surprise newcomers that even far fewer than 32 repetitions can trigger an IllegalStateException.
|
Thanks for the fix! Seems perfect for us. |
garydgregory
added a commit
that referenced
this pull request
Oct 15, 2024
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.
https://issues.apache.org/jira/browse/LANG-1753
The method
replaceEachRepeatedlycallsreplaceEachrepeatedly until no more replacements are possible ortimeToLive < 0. ThetimeToLivestarts with the value ofsearchList.length. The current implementation can't distinguish between infinite loops and deeply nested string patterns. In both cases, it continues replacements until it hits the time-to-live limit and throwsIllegalStateExceptionif replacements are still possible.The problem with LANG-1528 fix is that in some cases, it allows partially replaced strings after TTL is exceeded. This fix reverts
replaceEachlogic back to version 3.10 (see PR #505), but allows deeper dives due to an increased initial TTL value. The initial TTL value is now set to the greater ofsearchList.lengthor up to 5 levels deep. This default value was chosen based on rational considerations.