Merge pull request #31305 from mkouba/qute-message-annotation-optional

Qute type-safe messages - make the Message annotation optional

Author: mkouba

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

@@ -699,6 +699,10 @@ private Map<String, String> getLocalizedFileKeyToTemplate(MessageBundleBuildItem
                             } else {
                                 messageAnnotation = method.annotation(Names.MESSAGE);
                             }
+                            if (messageAnnotation == null) {
+                                messageAnnotation = AnnotationInstance.builder(Names.MESSAGE).value(Message.DEFAULT_VALUE)
+                                        .add("name", Message.DEFAULT_NAME).build();
+                            }
                             return getMessageAnnotationValue(messageAnnotation) != null;
                         })
                         .map(MethodInfo::name)
@@ -760,7 +764,7 @@ private String adaptLine(String line) {
 
     private boolean hasMessageBundleMethod(ClassInfo bundleInterface, String name) {
         for (MethodInfo method : bundleInterface.methods()) {
-            if (method.name().equals(name) && method.hasAnnotation(Names.MESSAGE)) {
+            if (method.name().equals(name)) {
                 return true;
             }
         }
@@ -813,8 +817,8 @@ private String generateImplementation(MessageBundleBuildItem bundle, ClassInfo d
         for (MethodInfo method : methods) {
             if (!method.returnType().name().equals(DotNames.STRING)) {
                 throw new MessageBundleException(
-                        String.format("A message bundle interface method must return java.lang.String on %s: %s",
-                                bundleInterface, method));
+                        String.format("A message bundle method must return java.lang.String: %s#%s",
+                                bundleInterface, method.name()));
             }
             LOGGER.debugf("Found message bundle method %s on %s", method, bundleInterface);
 
@@ -834,9 +838,9 @@ private String generateImplementation(MessageBundleBuildItem bundle, ClassInfo d
             }
 
             if (messageAnnotation == null) {
-                throw new MessageBundleException(
-                        "A message bundle interface method must be annotated with @Message: " +
-                                bundleInterface.name() + "#" + method.name());
+                LOGGER.debugf("@Message not declared on %s#%s - using the default key/value", bundleInterface, method);
+                messageAnnotation = AnnotationInstance.builder(Names.MESSAGE).value(Message.DEFAULT_VALUE)
+                        .add("name", Message.DEFAULT_NAME).build();
             }
 
             String key = getKey(method, messageAnnotation, defaultKeyValue);

extensions/qute/deployment/src/test/java/io/quarkus/qute/deployment/i18n/LocalizedFileBundleLocaleMergeTest.java

@@ -68,7 +68,6 @@ public interface Messages {
         @Message("Nazdar!")
         String hello();
 
-        @Message
         String goodbye();
 
         @Message("Greetings!")

extensions/qute/deployment/src/test/java/io/quarkus/qute/deployment/i18n/MessageBundleMethodMissingAnnotationTest.java

@@ -29,6 +29,7 @@ public interface MyBundle {
         @Message("Hello {name}")
         String hello(String name);
 
+        // this fails because there is no value specified in a localized file
         String notAllowed();
 
     }

extensions/qute/runtime/src/main/java/io/quarkus/qute/i18n/Message.java

@@ -7,9 +7,20 @@
 import java.lang.annotation.Target;
 
 /**
- * Identifies a message bundle method.
+ * Identifies a message bundle method that represents a single message of the enclosing bundle.
  * <p>
- * Each method of a message bundle interface annotated with {@link MessageBundle} must be annotated with this annotation.
+ * The value of the {@link #key()} can be used to reference a message in a template. It is possible to specify an explicit key
+ * or a strategy to extract the default key. The default strategy is defined by the enclosing
+ * {@link MessageBundle#defaultKey()}.
+ * <p>
+ * The {@link #value()} defines the template of a message. The method parameters can be used in this template. All the message
+ * templates are validated at build time.
+ * <p>
+ * Note that any method declared on a message bundle interface is consireded a message bundle method. If not annotated with this
+ * annotation then the defaulted values are used for the key and template.
+ * <p>
+ * All message bundle methods must return {@link String}. If a message bundle method does not return string then the build
+ * fails.
  *
  * @see MessageBundle
  */
@@ -47,8 +58,9 @@
     String UNDERSCORED_ELEMENT_NAME = "<<underscored element name>>";
 
     /**
+     * The key of a message.
      *
-     * @return the key
+     * @return the message key
      */
     String key() default DEFAULT_NAME;