Feat/hunspell ref path - #20792
Closed
shayush622 wants to merge 11 commits into
Closed
Conversation
- Add INDEX_REF_PATH_SETTING for package-based hunspell dictionaries - Add RestHunspellCacheInvalidateAction for cache invalidation endpoint - Update HunspellService with cache management methods - Add ref_path validation in MetadataCreateIndexService Signed-off-by: shayush622 <ayush5267@gmail.com>
- Add ref_path parameter to hunspell token filter for package-based dictionaries
- Load dictionaries from config/packages/{packageId}/hunspell/{locale}/
- Add cache invalidation REST API endpoints:
- GET /_hunspell/cache (view cached dictionaries)
- POST /_hunspell/cache/_invalidate (invalidate by package_id, locale, or cache_key)
- POST /_hunspell/cache/_invalidate_all (clear all cached dictionaries)
- Add TransportAction with cluster:admin/hunspell/cache/clear permission
- Add path traversal security validation for packageId and locale
- Add updateable flag support for hot-reload via _reload_search_analyzers
- Add comprehensive test coverage for HunspellTokenFilterFactory and REST endpoint
- Remove unused index-level ref_path setting
Addresses PR feedback:
- Removed mise.toml from commit (local dev config)
- Added TransportAction authorization pattern
- Added 21 unit tests for REST endpoint
- Fixed security validation for path traversal attacks
- Documented race condition in invalidateAllDictionaries
Signed-off-by: shayush622 <ayush5267@gmail.com>
- Add ref_path parameter for package-based dictionary loading
- Load from config/packages/{packageId}/hunspell/{locale}/
- Add cache invalidation REST API (GET/POST /_hunspell/cache/_invalidate)
- Add TransportAction with cluster:admin permission
- Add comprehensive security validation (path traversal, separators, cache-key injection)
- Add updateable flag for hot-reload via _reload_search_analyzers
- Add comprehensive test coverage
PR feedback addressed:
- Stricter validate() to reject conflicting params
- Path traversal checks now use config/packages/ as base
- ref_path/locale validation rejects ., .., /, \, : characters
Signed-off-by: shayush622 <ayush5267@gmail.com>
Signed-off-by: shayush622 <ayush5267@gmail.com>
- Add ref_path parameter for package-based dictionary loading
- Load from config/packages/{packageId}/hunspell/{locale}/
- Add cache info API: GET /_hunspell/cache (cluster:monitor/hunspell/cache)
- Add cache invalidation API: POST /_hunspell/cache/_invalidate (cluster:admin/hunspell/cache/invalidate)
- Support invalidation by package_id, locale, cache_key, or invalidate_all
- Add security validation (path traversal, separator injection, null bytes)
- Add updateable flag for hot-reload via _reload_search_analyzers
- Use Strings.hasText() and Strings.isNullOrEmpty() for validation consistency
- Consistent response schema with all fields always present
- Add unit tests, REST handler tests, and integration tests
Signed-off-by: shayush622 <ayush5267@gmail.com>
shayush622
requested review from
a team,
Bukhtawar,
CEHENKLE,
Rishikesh1159,
anasalkouz,
andrross,
ashking94,
cwperks,
dbwiddis,
gbbafna,
jed326,
kotwanikunal,
mch2,
msfroh,
owaiskazi19,
reta,
sachinpkale,
saratvemulapalli,
shwetathareja and
sohami
as code owners
March 6, 2026 18:24
Contributor
PR Code Analyzer ❗AI-powered 'Code-Diff-Analyzer' found issues on commit 3917262. 'Diff too large, requires skip by maintainers after manual review' Pull Requests Author(s): Please update your Pull Request according to the report above. Repository Maintainer(s): You can Thanks. |
Contributor
|
Persistent review updated to latest commit 33f4a54 |
Contributor
|
❌ Gradle check result for 33f4a54: FAILURE Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change? |
shayush622
force-pushed
the
feat/hunspell-ref-path
branch
from
March 9, 2026 08:29
33f4a54 to
dbc150a
Compare
Contributor
|
Persistent review updated to latest commit dbc150a |
Contributor
|
❌ Gradle check result for dbc150a: FAILURE Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change? |
Member
|
Not sure if its related to the changes in this PR, but this is showing backwards compatibility failures: |
Contributor
|
❌ Gradle check result for dbc150a: FAILURE Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change? |
3 tasks
- Add ref_path parameter for package-based dictionary loading
- Load from config/packages/{packageId}/hunspell/{locale}/
- Add cache info API: GET /_hunspell/cache (cluster:monitor/hunspell/cache)
- Add cache invalidation API: POST /_hunspell/cache/_invalidate (cluster:admin/hunspell/cache/invalidate)
- Support invalidation by package_id, locale, cache_key, or invalidate_all
- Add security validation (path traversal, separator injection, null bytes)
- Add updateable flag for hot-reload via _reload_search_analyzers
- Use Strings.hasText() and Strings.isNullOrEmpty() for validation consistency
- Consistent response schema with all fields always present
- Add unit tests, REST handler tests, and integration tests
Signed-off-by: shayush622 <ayush5267@gmail.com>
shayush622
force-pushed
the
feat/hunspell-ref-path
branch
from
March 11, 2026 04:47
dbc150a to
190bfd1
Compare
Contributor
|
Persistent review updated to latest commit 190bfd1 |
Contributor
|
❌ Gradle check result for 190bfd1: FAILURE Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change? |
- Add ref_path parameter for package-based dictionary loading
- Load from config/packages/{packageId}/hunspell/{locale}/
- Add cache info API: GET /_hunspell/cache (cluster:monitor/hunspell/cache)
- Add cache invalidation API: POST /_hunspell/cache/_invalidate (cluster:admin/hunspell/cache/invalidate)
- Support invalidation by package_id, locale, cache_key, or invalidate_all
- Add security validation (path traversal, separator injection, null bytes)
- Add updateable flag for hot-reload via _reload_search_analyzers
- Use Strings.hasText() and Strings.isNullOrEmpty() for validation consistency
- Consistent response schema with all fields always present
- Add unit tests, REST handler tests, and integration tests
Signed-off-by: shayush622 <ayush5267@gmail.com>
shayush622
force-pushed
the
feat/hunspell-ref-path
branch
from
March 11, 2026 11:48
190bfd1 to
385793b
Compare
Contributor
|
Persistent review updated to latest commit 385793b |
Contributor
|
❌ Gradle check result for 385793b: FAILURE Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change? |
3 tasks
Contributor
Author
Contributor
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #20792 +/- ##
============================================
- Coverage 73.31% 73.27% -0.05%
- Complexity 72248 72308 +60
============================================
Files 5795 5804 +9
Lines 330044 330395 +351
Branches 47641 47696 +55
============================================
+ Hits 241975 242092 +117
- Misses 68609 68853 +244
+ Partials 19460 19450 -10 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This was referenced Apr 27, 2026
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
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.
Description
This PR adds support for loading Hunspell dictionaries from package-based directories using a new ref_path parameter, enabling multi-tenant dictionary isolation and hot-reload capabilities.
Related Issues
Resolves #[20712]
Link to #20712 (comment).
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.