Performance optimizations for RandomStringUtils #2
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
This commit improves the performance of RandomStringUtils: * Reduces the number of random bytes generated and the number of calls to the random number generator, by using a cache system `AmortizedRandomBits`. * Optimizes the case of alphanumerical strings, reducing the number of rejections in the rejection sampling. See comments in code for details.
Codecov ReportAttention: Patch coverage is
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## Secure_RandomStringUtils #2 +/- ##
===========================================================
Coverage ? 92.50%
Complexity ? 7773
===========================================================
Files ? 201
Lines ? 15940
Branches ? 2830
===========================================================
Hits ? 14746
Misses ? 652
Partials ? 542 ☔ View full report in Codecov by Sentry. |
garydgregory
requested changes
Jun 15, 2024
There was a problem hiding this comment.
Hello @fabrice102 !
Thank you for your contribution.
I'm OK with the PR, but, I'd like to resolve the discussion around the change in behavior this PR addresses first before making changes geared toward performance claims.
I've made some low-level comments.
Also, note the build failures due to checkstyle issues.
In the future, run mvn by itself to run all build checks before pushing.
TY! 😄
src/main/java/org/apache/commons/lang3/AmortizedRandomBits.java
Outdated
Show resolved
Hide resolved
src/main/java/org/apache/commons/lang3/AmortizedRandomBits.java
Outdated
Show resolved
Hide resolved
|
Hi @garydgregory! Thanks for the feedback! I'll submit a new version on Monday. |
* Fix 2 checkstyle errors. * Apply suggestions from review for garydgregory#2 * Improve comments in new (non-public) class `AmortizedRandomBits` to match comments in other classes.
garydgregory
added a commit
to apache/commons-lang
that referenced
this pull request
Jul 6, 2024
…g() (#1235) * Reimplement RandomStringUtils on top of SecureRandom#getInstanceStrong() The previous implementation used ThreadLocalRandom#current() * Performance optimizations for RandomStringUtils This commit improves the performance of RandomStringUtils: * Reduces the number of random bytes generated and the number of calls to the random number generator, by using a cache system `AmortizedRandomBits`. * Optimizes the case of alphanumerical strings, reducing the number of rejections in the rejection sampling. See comments in code for details. * Code style and comment improvements * Fix 2 checkstyle errors. * Apply suggestions from review for garydgregory#2 * Improve comments in new (non-public) class `AmortizedRandomBits` to match comments in other classes. * Make class final - Rename package-private class - Whitespace - Add null check - Add serialVersionUID - Remove redunant type cast - Throw IllegalStateException, not RuntimeException - nextBytes() should throw NullPointerException per contract - Javadoc: Use longer lines * Apply comments by aherbert in 55a70c8#r143834333 --------- Co-authored-by: Gary Gregory <gardgregory@gmail.com> Co-authored-by: Fabrice Benhamouda <yfabrice@amazon.com>
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.
This commit improves the performance of RandomStringUtils:
AmortizedRandomBits.See comments in code for details.