Composite component does not reflect locale changes

[cristof]

Bug

According to VDL documentation (2.3, 3.0, and 4.0), "[t]he normal localization rules for ResourceBundle would apply" for composite components localized with <composite_component_name>.properties files that uses #{cc.resourceBundleMap}. As such, when using a composite component named custom_button.xhtml and its associated custom_button.properties and custom_button_fr.properties, the change in locale definition should change the displayed messages.

In mojarra and myfaces (2.3, 2.3-next (myfaces), 3.0 and 4.0), the expected behaviour does not occur (as recognized by BalusC in 2013.) His proposed hack still works for MyFaces, but I couldn't use it in recent versions of mojarra.

To reproduce

Example project localized-components and localized-web are available to show the issue. Please install the first one into your local maven and then compile the second.
You may deploy localized-web into a tomee-plume versions 8.0.13 (profile jakarta8) and 9.0.0-MX (profile jakarta9) and check the behavior. Go to localhost:8080/localized-web and change the language.

Expected behavior

The button label should change reflecting the desired language, but it doesn't.

Solution

I'm opening three pull requests that fixes the issue for branches 2.3.18, 3.0.2 and 4.0

[BalusC]

Quick review: I noticed that the getLocalizedProperties() method was copypasted into both ClasspathResourceHelper and WebappResourceHelper, which both extend from ResourceHelper. Can you please avoid code duplication and move up the method into ResourceHelper as a protected method? See also https://en.wikipedia.org/wiki/Don%27t_repeat_yourself

[cristof]

Moved the method as requested in all branches, changing the name to getLocalizedPaths because it will return a list of a single path even if the target path is not a properties resource - so it will be the one and only localized path.

[cristof]

Changed localized-web project so it is easier to test the issue and the fix. Added readme with instructions there. As this is my first contribution to mojarra, I'm struggling on how I could add a test into the project.

[BalusC]

Tests should be added in one of the faces* subfolders here https://github.com/jakartaee/faces/tree/master/tck

E.g.:
If you've fixed it in 2.3 (and inherently also 3.0/4.0), then add to faces23, it'll also be tested against 3.0 and 4.0.
If you've fixed it in 4.0 only, then add to faces40, it won't be tested against 2.3 and 3.0.

In this specific case, add to faces23.

[cristof]

Do I have to open another issue there, or I can use this one as reference for pull requests?

[melloware]

@cristof i think you are safe to refernence this issue and also the MyFaces issue you opened in the TCK test. It would be a great addition since then MyFaces and Mojarra would have to pass the test!

[cristof]

Created the TCK test and made the pull request, as previously asked.

[melloware]

Nice work!