Support user language preference #306

strangelookingnerd · 2025-05-20T12:54:24Z

Picking up the work from #8 to solve https://issues.jenkins.io/browse/JENKINS-57456 and #234

I'll comment the code below to explain some of the details.

Testing done

Added unit tests and did some manual testing to verify the new user property works as expected.

Submitter checklist

Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
Ensure that the pull request title represents the desired changelog entry
Please describe what you did
Link to relevant issues in GitHub or Jira
Link to relevant pull requests, esp. upstream and downstream changes
Ensure you have provided tests that demonstrate the feature works or the issue is fixed

src/main/java/hudson/plugins/locale/user/UserLocaleProperty.java

README.md

strangelookingnerd · 2025-05-20T12:55:26Z

pom.xml

@@ -48,13 +49,14 @@
        <type>pom</type>
        <scope>import</scope>
      </dependency>
-      <dependency>


This is not needed from what I can tell.

strangelookingnerd · 2025-05-20T12:56:09Z

pom.xml

  <dependencies>
+    <dependency>


Can be removed once we migrate to Java 21 (see TODO in hudson.plugins.locale.PluginImpl#parse)

strangelookingnerd · 2025-05-20T12:56:46Z

src/main/java/hudson/plugins/locale/LocaleFilter.java

            PluginImpl plugin = PluginImpl.get();
-            if (plugin != null && plugin.isIgnoreAcceptLanguage()) {
-                request = new HttpServletRequestWrapper((HttpServletRequest) request) {
+            final Locale locale;


Took over the implementation from #8

strangelookingnerd · 2025-05-20T12:57:02Z

src/main/java/hudson/plugins/locale/LocaleFilter.java

@@ -68,4 +86,17 @@ public Locale nextElement() {
    public void destroy() {
        // nop
    }
+
+    @CheckForNull


Took over the implementation from #8

strangelookingnerd · 2025-05-20T12:57:35Z

src/main/java/hudson/plugins/locale/PluginImpl.java


    public static final String USE_BROWSER_LOCALE = "USE_BROWSER_LOCALE";

    // Set of allowed locales
-    private static final Set<String> ALLOWED_LOCALES = new HashSet<>(Arrays.asList(
+    public static final Set<String> ALLOWED_LOCALES = Set.of(


Changed visibility as it is reused in UserLocaleProperty.

strangelookingnerd · 2025-05-20T12:57:59Z

src/main/java/hudson/plugins/locale/PluginImpl.java

@@ -119,38 +133,34 @@ public void setSystemLocale(String systemLocale) {
        }
    }

-    public String getUseBrowserLocale() {


Unused, thus removed.

strangelookingnerd · 2025-05-20T12:58:38Z

src/main/java/hudson/plugins/locale/PluginImpl.java

-                throw new IllegalArgumentException(s + " is not a valid locale");
-        }
+        // TODO: Migrate to Locale.of() once we upgrade to Java 21
+        return LocaleUtils.toLocale(s.trim());


Simpler implementation using commons-lang3.

strangelookingnerd · 2025-05-20T12:59:00Z

src/main/java/hudson/plugins/locale/PluginImpl.java

-        String originalLocaleDisplay = String.format(
-                "Use Default Locale - %s (%s)", originalLocale.getDisplayName(), originalLocale.toString());
+        String originalLocaleDisplay =
+                String.format("Use Default Locale - %s (%s)", originalLocale.getDisplayName(), originalLocale);
        items.add(new ListBoxModel.Option(originalLocaleDisplay, USE_BROWSER_LOCALE));

        Locale[] availableLocales = Locale.getAvailableLocales();
        List<Locale> sortedLocales = Arrays.stream(availableLocales)
                .filter(locale -> ALLOWED_LOCALES.contains(locale.toString())) // Ensure no empty or null locale strings
-                .sorted((locale1, locale2) -> locale1.getDisplayName().compareTo(locale2.getDisplayName()))
-                .collect(Collectors.toList());
+                .sorted(Comparator.comparing(Locale::getDisplayName))
+                .toList();

        for (Locale locale : sortedLocales) {
-            String displayText = String.format("%s - %s", locale.getDisplayName(), locale.toString());
+            String displayText = String.format("%s - %s", locale.getDisplayName(), locale);


Some cleanup while at it.

jonesbusy · 2025-05-25T13:51:30Z

src/main/java/hudson/plugins/locale/LocaleFilter.java

@@ -59,6 +76,7 @@ public Locale nextElement() {
                        };
                    }
                };
+                ((HttpServletResponse) response).addHeader("X-Jenkins-Language", locale.toString());


If I understood correctly it's only used by test to know which language was set?

jonesbusy · 2025-05-25T13:54:39Z

Thanks. Looks good to me

This reverts commit 41dc8d4.

jonesbusy · 2025-05-26T06:18:41Z

Cause #307

Will probably revert on #308

This reverts commit 41dc8d4.

jonesbusy · 2025-05-26T06:27:06Z

I've tested locally this morning but not able (yet) to reproduce the index out of bound

However when trying to change my locale on my profile I cannot. I always get reverted to the default locale

When I check the XML I get an empty string after saving whatever locale on my user profile

    <hudson.plugins.locale.user.UserLocaleProperty plugin="locale@584.v41dc8d4f9377">
      <localeCode></localeCode>
    </hudson.plugins.locale.user.UserLocaleProperty>

strangelookingnerd · 2025-05-26T06:58:05Z

That's odd. I'll look into it.

Edit: https://github.com/jenkinsci/locale-plugin/pull/306/files#diff-7cc57c064ed9f1a223e0fbb172e68fbdf536de8208a59c5b99056201b72659ffR74

Should have been localeCode - I'll update the PR.

jonesbusy · 2025-05-27T07:24:19Z

Cause also #310

Support user language preference (JENKINS-57456)

2cc69f2

strangelookingnerd requested a review from a team as a code owner May 20, 2025 12:54

github-advanced-security bot found potential problems May 20, 2025

View reviewed changes

src/main/java/hudson/plugins/locale/user/UserLocaleProperty.java Fixed Show fixed Hide fixed

src/main/java/hudson/plugins/locale/user/UserLocaleProperty.java Show resolved Hide resolved

strangelookingnerd commented May 20, 2025

View reviewed changes

Add @RequirePOST where needed

e92403f

jonesbusy added the enhancement label May 25, 2025

jonesbusy reviewed May 25, 2025

View reviewed changes

jonesbusy approved these changes May 25, 2025

View reviewed changes

jonesbusy mentioned this pull request May 25, 2025

[JENKINS-57456] User language prefer setting support #8

Closed

jonesbusy merged commit 41dc8d4 into jenkinsci:main May 25, 2025
17 checks passed

strangelookingnerd deleted the JENKINS-57456 branch May 25, 2025 17:52

jonesbusy added a commit that referenced this pull request May 26, 2025

Revert "Support user language preference (#306)"

70d9914

This reverts commit 41dc8d4.

jonesbusy mentioned this pull request May 26, 2025

Revert "Support user language preference" #308

Merged

jonesbusy added a commit that referenced this pull request May 26, 2025

Revert "Support user language preference (#306)" (#308)

a126c41

This reverts commit 41dc8d4.

strangelookingnerd mentioned this pull request May 26, 2025

Support user language preference #309

Merged

6 tasks

Support user language preference #306

Support user language preference #306

Uh oh!

Conversation

strangelookingnerd commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Testing done

Submitter checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jonesbusy commented May 25, 2025

Uh oh!

Uh oh!

jonesbusy commented May 26, 2025

Uh oh!

jonesbusy commented May 26, 2025

Uh oh!

strangelookingnerd commented May 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jonesbusy commented May 27, 2025

Uh oh!

Uh oh!

strangelookingnerd commented May 20, 2025 •

edited

Loading

strangelookingnerd commented May 26, 2025 •

edited

Loading