TRUNK-6341: Intelligent Locale Matching using RFC 4647 #5524
+251
−6
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
ibacher
reviewed
Nov 24, 2025
web/src/main/java/org/openmrs/web/filter/initialization/InitializationFilter.java
Show resolved
Hide resolved
jwnasambu
reviewed
Dec 10, 2025
| availableLocales.add(new Locale("es")); // Spanish | ||
| availableLocales.add(new Locale("pt", "BR")); // Portuguese (Brazil) | ||
|
|
||
| // Use the protected constructor to inject test locales |
Contributor
There was a problem hiding this comment.
Kindly as a best practice let’s remove comments that restate what the code already conveys. Clean code is easy to read and maintain.
ibacher
reviewed
Dec 12, 2025
| * | ||
| * @param availableLocales the set of locales to be used as available locales | ||
| */ | ||
| protected CustomResourceLoader(Set<Locale> availableLocales) { |
Member
There was a problem hiding this comment.
Default visibility is probably the right thing here.
Suggested change
| protected CustomResourceLoader(Set<Locale> availableLocales) { | |
| CustomResourceLoader(Set<Locale> availableLocales) { |
| * @param availableLocales the set of locales to be used as available locales | ||
| */ | ||
| protected CustomResourceLoader(Set<Locale> availableLocales) { | ||
| this.resources = new HashMap<>(); |
Member
There was a problem hiding this comment.
Since there's no sensible way to set this, just returning the empty map is probably best.
Suggested change
| this.resources = new HashMap<>(); | |
| this.resources = Collections.emptyMap(); |
| public Locale findBestMatchLocale(String acceptLanguageHeader) { | ||
| // Return default locale if header is null or empty | ||
| if (acceptLanguageHeader == null || acceptLanguageHeader.trim().isEmpty()) { | ||
| return Locale.ENGLISH; |
Member
There was a problem hiding this comment.
Suggested change
| return Locale.ENGLISH; | |
| return LocaleUtility.getDefaultLocale(); |
Member
There was a problem hiding this comment.
This may slightly disrupt the tests, but comparing assertEquals(Locale.ENGLISH.getLanguage(), findBestMatchLocale(null).getLanguage()); as suggested by the docs should work.
| Locale matchedLocale = Locale.lookup(languageRanges, availableLocalesList); | ||
|
|
||
| // Return matched locale or default to English if no match found | ||
| return matchedLocale != null ? matchedLocale : Locale.ENGLISH; |
Member
There was a problem hiding this comment.
Suggested change
| return matchedLocale != null ? matchedLocale : Locale.ENGLISH; | |
| return matchedLocale != null ? matchedLocale : LocaleUtility.getDefaultLocale(); |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
TRUNK-6341: Intelligent Locale Matching using RFC 4647
Description of what I changed
I implemented intelligent locale matching to replace the simple, exact-match-only logic in
InitializationFilter.Previously, if a user requested
fr-BE(Belgian French) but OpenMRS only hadfr(French), the system would default to English. This change uses RFC 4647 (java.util.Locale.lookup) to properly handle:fr-BEnow correctly falls back tofr.fr;q=0.9, en;q=0.8are respected.Specific Changes:
CustomResourceLoader.java:findBestMatchLocale(String header)to handle the parsing logic.protectedconstructor to allow injectingavailableLocales. This ensures the logic is testable without needing complex file system mocks (addressing previous review feedback).InitializationFilter.java:Accept-Languageheader and call the new loader method.CustomResourceLoaderTest.java:Issue I worked on
see https://issues.openmrs.org/browse/TRUNK-6341
Checklist: I completed these to help reviewers :)
mvn clean packageright before creating this pull request and added all formatting changes to my commit.