Merge pull request #50829 from mkouba/issue-47585

Qute i18n: attempt to resolve ambiguity for multiple localized files

Author: ia3andy

docs/src/main/asciidoc/qute-reference.adoc

@@ -3042,7 +3042,14 @@ Message bundle files must be encoded in _UTF-8_.
 The file name consists of the relevant bundle name (e.g. `msg`) and underscore followed by a language tag (IETF; e.g. `en-US`).
 The language tag may be omitted, in which case the language tag of the default bundle locale is used.
 For example, if bundle `msg` has default locale `en`, then `msg.properties` is going to be treated as `msg_en.properties`.
-If both `msg.properties` and `msg_en.properties` are detected, an exception is thrown and build fails.
+
+If there are multiple files for a specific locale then Qute attempts to resolve the ambiguity.
+Localized files from the application root have higher priority and take precedence over localized files from dependencies.
+If multiple files of the same priority exist, then the build fails.
+For example, if the default bundle locale is `en` and the files `msg.properties` and `msg_en.properties` are found in the application root, then an exception is thrown and the build fails. 
+Or another example - if there are two dependencies and both contain the `msg_en.properties` file, then the build fails again.
+On the other hand, if there is the `msg_en.properties` file in the application root and also the `msg_en.properties` file in a dependency, then messages from the application root take precedence and override the values from the dependency.
+
 The file format is very simple: each line represents either a key/value pair with the equals sign used as a separator or a comment (line starts with `#`).
 Blank lines are ignored.
 Keys are _mapped to method names_ from the corresponding message bundle interface.

extensions/qute/deployment/src/main/java/io/quarkus/qute/deployment/MessageBundleBuildItem.java

@@ -1,24 +1,25 @@
 package io.quarkus.qute.deployment;
 
-import java.nio.file.Path;
+import java.util.List;
 import java.util.Map;
 
 import org.jboss.jandex.ClassInfo;
 
 import io.quarkus.builder.item.MultiBuildItem;
+import io.quarkus.qute.deployment.MessageBundleProcessor.MessageFile;
 
 public final class MessageBundleBuildItem extends MultiBuildItem {
 
     private final String name;
     private final ClassInfo defaultBundleInterface;
     private final Map<String, ClassInfo> localizedInterfaces;
-    private final Map<String, Path> localizedFiles;
-    private final Map<String, Path> mergeCandidates;
+    private final Map<String, List<MessageFile>> localizedFiles;
+    private final Map<String, List<MessageFile>> mergeCandidates;
     private final String defaultLocale;
 
     public MessageBundleBuildItem(String name, ClassInfo defaultBundleInterface,
-            Map<String, ClassInfo> localizedInterfaces, Map<String, Path> localizedFiles,
-            Map<String, Path> mergeCandidates, String defaultLocale) {
+            Map<String, ClassInfo> localizedInterfaces, Map<String, List<MessageFile>> localizedFiles,
+            Map<String, List<MessageFile>> mergeCandidates, String defaultLocale) {
         this.name = name;
         this.defaultBundleInterface = defaultBundleInterface;
         this.localizedInterfaces = localizedInterfaces;
@@ -39,17 +40,15 @@ public Map<String, ClassInfo> getLocalizedInterfaces() {
         return localizedInterfaces;
     }
 
-    public Map<String, Path> getLocalizedFiles() {
+    public Map<String, List<MessageFile>> getLocalizedFiles() {
         return localizedFiles;
     }
 
     /**
      * Merge candidates are localized files used as a supplementary source of message templates
      * not specified by localized interfaces.
-     *
-     * @return locale -> localized file {@link Path}
      */
-    public Map<String, Path> getMergeCandidates() {
+    public Map<String, List<MessageFile>> getMergeCandidates() {
         return mergeCandidates;
     }