LUCENE-10369: Move DelegatingCacheHelper to FilterDirectoryReader #596
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
To support building long-lived readers without IndexReader to delegate caching to, it would be beneficial to refactor SoftDeletesDirectoryReaderWrapper, such that its caching behaviour (DelegatingCacheHelper) is moved into the superclass FilterDirectoryReader.
With this change, external implementations of such readers, e.g. LazySoftDeletesDirectoryReaderWrapper in Elasticsearch could properly modularize their codebase and remove split packages.
Solution
The solution proposed here moves the delegating CacheHelper implementation from SoftDeletesDirectoryReaderWrapper to the superclass, so that it can be used by other subclasses.
An alternative approach could possibly be a new public class specialization of the FilterDirectoryReader class, which brings in the DelegatingCacheHelper and enforces the caching behaviour.
Tests
I added the following unit tests for the moved DelegatingCacheHelper class:
Checklist
Please review the following and check all that apply:
main
branch../gradlew check
.