Fix ReflectionUtils#getDeclaredMethods to provide consistent result #34110
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.
Hi. This PR is inspired by gh-34082.
As @welovelain pointed in it, the test below sometimes passes but sometimes doesn't.
I've tested with IntelliJ IDEA 2024.3 and on several JDKs such as Temurin 17.0.13, Temurin 21.0.3, Corretto 21.0.5, etc., but the problem occurred upon all these JDKs.
You can check it out with this reproducer.
sample.zip
The problem is, how Class#getDeclaredMethods() returns a Method[] in a different order on each run. However
ReflectionUtils#getDeclaredMethods()
just iterates through this array and returns the first matched method.Even
ReflectionUtilsTests#findMethod()
sometimes fails if you remove the sorting line introduced in this changes.FWIW ReflectionUtils in junit5 (heavily contributed by @sbrannen) also sorts methods of
Class#getDeclaredMethods()
and I believe this is worth it.My sorter would not be optimized but I intended that the methods declared in actual source come first.