Merge pull request #61 from prime-framework/wied03/alternate_messages_path

Allow adding a fallback message action

Author: wied03

build.savant

@@ -29,7 +29,7 @@ logbackVersion = "1.4.14"
 slf4jVersion = "2.0.13"
 testngVersion = "7.8.0"
 
-project(group: "org.primeframework", name: "prime-mvc", version: "4.25.1", licenses: ["ApacheV2_0"]) {
+project(group: "org.primeframework", name: "prime-mvc", version: "4.26.0", licenses: ["ApacheV2_0"]) {
   workflow {
     fetch {
       // Dependency resolution order:

pom.xml

@@ -5,7 +5,7 @@
 
   <groupId>org.primeframework</groupId>
   <artifactId>prime-mvc</artifactId>
-  <version>4.25.1</version>
+  <version>4.26.0</version>
   <packaging>jar</packaging>
 
   <name>FusionAuth App</name>

src/main/java/org/primeframework/mvc/action/annotation/AlternateMessageResources.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2024, Inversoft Inc., All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
+ */
+package org.primeframework.mvc.action.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Customize message resource behavior for an action class
+ *
+ * @author Brady Wied
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+public @interface AlternateMessageResources {
+  /**
+   * @return By default, will look for messages, via the {@link org.primeframework.mvc.message.l10n.MessageProvider}
+   *     interface, in an implementation specific search path (see {@link org.primeframework.mvc.message.l10n.ResourceBundleMessageProvider} for an
+   *     example).
+   *     If you want an additional action's messages in the search path, use this attribute.
+   */
+  Class<?>[] actions();
+}

src/main/java/org/primeframework/mvc/action/config/ActionConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2001-2023, Inversoft Inc., All Rights Reserved
+ * Copyright (c) 2001-2024, Inversoft Inc., All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -50,6 +50,8 @@ public class ActionConfiguration {
 
   public final boolean allowUnknownParameters;
 
+  public final List<String> alternateMessageURIs;
+
   public final Action annotation;
 
   public final Map<Class<? extends Annotation>, Annotation> annotations = new HashMap<>();
@@ -122,15 +124,16 @@ public ActionConfiguration(Class<?> actionClass,
                              String uri,
                              List<Method> preValidationMethods,
                              Field unknownParametersField,
-                             Set<String> validContentTypes) {
-
+                             Set<String> validContentTypes,
+                             List<String> alternateMessageURIs) {
     Objects.requireNonNull(actionClass);
 
     this.actionClass = actionClass;
     this.allowUnknownParameters = allowUnknownParameters;
     this.constraintValidationMethods = constraintValidationMethods;
     this.formPrepareMethods = formPrepareMethods;
     this.authorizationMethods = authorizationMethods;
+    this.alternateMessageURIs = alternateMessageURIs;
     this.jwtAuthorizationMethods = jwtAuthorizationMethods;
     this.preValidationMethods = preValidationMethods;
     this.postValidationMethods = postValidationMethods;

src/main/java/org/primeframework/mvc/action/config/DefaultActionConfigurationBuilder.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012-2023, Inversoft Inc., All Rights Reserved
+ * Copyright (c) 2012-2024, Inversoft Inc., All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,6 +27,7 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.Set;
 import java.util.function.BiFunction;
 import java.util.function.Function;
@@ -44,6 +45,7 @@
 import org.primeframework.mvc.action.ValidationMethodConfiguration;
 import org.primeframework.mvc.action.annotation.Action;
 import org.primeframework.mvc.action.annotation.AllowUnknownParameters;
+import org.primeframework.mvc.action.annotation.AlternateMessageResources;
 import org.primeframework.mvc.action.result.annotation.ResultAnnotation;
 import org.primeframework.mvc.action.result.annotation.ResultContainerAnnotation;
 import org.primeframework.mvc.content.ValidContentTypes;
@@ -136,7 +138,13 @@ public ActionConfiguration build(Class<?> actionClass) {
     Field unknownParametersField = findUnknownParametersField(actionClass);
     Set<String> validContentTypes = findAllowedContentTypes(actionClass);
 
-    return new ActionConfiguration(actionClass, allowKnownParameters, constraintValidationMethods, executeMethods, validationMethods, formPrepareMethods, authorizationMethods, jwtAuthorizationMethods, postValidationMethods, preParameterMethods, postParameterMethods, resultAnnotations, preParameterMembers, preRenderMethodsMap, fileUploadMembers, memberNames, securitySchemes, scopeFields, additionalConfiguration, uri, preValidationMethods, unknownParametersField, validContentTypes);
+    List<String> alternateMessageURIs = Optional.ofNullable(actionClass.getAnnotation(AlternateMessageResources.class))
+                                                .map(alternate -> Arrays.stream(alternate.actions())
+                                                                        .map(uriBuilder::build)
+                                                                        .toList())
+                                                .orElse(List.of());
+
+    return new ActionConfiguration(actionClass, allowKnownParameters, constraintValidationMethods, executeMethods, validationMethods, formPrepareMethods, authorizationMethods, jwtAuthorizationMethods, postValidationMethods, preParameterMethods, postParameterMethods, resultAnnotations, preParameterMembers, preRenderMethodsMap, fileUploadMembers, memberNames, securitySchemes, scopeFields, additionalConfiguration, uri, preValidationMethods, unknownParametersField, validContentTypes, alternateMessageURIs);
   }
 
   /**

src/main/java/org/primeframework/mvc/message/l10n/ResourceBundleMessageProvider.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2001-2019, Inversoft Inc., All Rights Reserved
+ * Copyright (c) 2001-2024, Inversoft Inc., All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,13 +18,16 @@
 import java.util.Formatter;
 import java.util.LinkedList;
 import java.util.MissingResourceException;
+import java.util.Objects;
 import java.util.Queue;
 import java.util.ResourceBundle;
 import java.util.ResourceBundle.Control;
 
 import com.google.inject.Inject;
 import org.primeframework.mvc.action.ActionInvocation;
 import org.primeframework.mvc.action.ActionInvocationStore;
+import org.primeframework.mvc.action.annotation.AlternateMessageResources;
+import org.primeframework.mvc.action.config.ActionConfiguration;
 import org.primeframework.mvc.locale.LocaleProvider;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -120,24 +123,25 @@ protected Queue<String> determineBundles(String bundle) {
 
   /**
    * Finds the message in a resource bundle using the search method described in the class comment.
+   * If the action was annotated with a {@link AlternateMessageResources} annotation
+   * and the message was not found with the request's action, that action will be searched as well.
    *
    * @param actionInvocation The action invocation.
    * @param key              The key of the message.
    * @return The message or null if it doesn't exist.
    */
   protected String findMessage(ActionInvocation actionInvocation, String key) {
-    String uri = actionInvocation.actionURI;
-    Queue<String> names = determineBundles(uri);
-    for (String name : names) {
-      try {
-        ResourceBundle rb = ResourceBundle.getBundle(name, localeProvider.get(), control);
-        return rb.getString(key);
-      } catch (MissingResourceException ignore) {
-        // Ignore and check the next bundle
-      }
+    String message = findMessage(actionInvocation.actionURI, key);
+    if (message != null) {
+      return message;
     }
 
-    return null;
+    ActionConfiguration config = actionInvocation.configuration;
+    return config.alternateMessageURIs.stream()
+                                      .map(uri -> findMessage(uri, key))
+                                      .filter(Objects::nonNull)
+                                      .findFirst()
+                                      .orElse(null);
   }
 
   /**
@@ -157,4 +161,25 @@ private String findDefaultMessage(ActionInvocation actionInvocation, String key)
 
     return null;
   }
-}
+
+  /**
+   * Finds the message in a resource bundle using the search method described in the class comment.
+   *
+   * @param uri The action URI to use for searching.
+   * @param key The key of the message.
+   * @return The message or null if it doesn't exist.
+   */
+  private String findMessage(String uri, String key) {
+    Queue<String> names = determineBundles(uri);
+    for (String name : names) {
+      try {
+        ResourceBundle rb = ResourceBundle.getBundle(name, localeProvider.get(), control);
+        return rb.getString(key);
+      } catch (MissingResourceException ignore) {
+        // Ignore and check the next bundle
+      }
+    }
+
+    return null;
+  }
+}

src/test/java/org/example/action/AlternateMessageResourcesAnnotatedAction.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2024, Inversoft Inc., All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
+ */
+package org.example.action;
+
+import com.google.inject.Inject;
+import org.example.action.nested.NestedMessageAction;
+import org.primeframework.mvc.action.annotation.Action;
+import org.primeframework.mvc.action.annotation.AlternateMessageResources;
+import org.primeframework.mvc.action.result.annotation.Status;
+import org.primeframework.mvc.message.MessageStore;
+import org.primeframework.mvc.message.MessageType;
+import org.primeframework.mvc.message.SimpleMessage;
+import org.primeframework.mvc.message.l10n.MessageProvider;
+
+@Action
+@Status
+@AlternateMessageResources(actions = NestedMessageAction.class)
+public class AlternateMessageResourcesAnnotatedAction {
+  private final MessageProvider messageProvider;
+
+  private final MessageStore messageStore;
+
+  public String messageKey;
+
+  @Inject
+  public AlternateMessageResourcesAnnotatedAction(MessageProvider messageProvider, MessageStore messageStore) {
+    this.messageProvider = messageProvider;
+    this.messageStore = messageStore;
+  }
+
+  public String get() {
+    try {
+      messageStore.add(new SimpleMessage(MessageType.INFO, messageKey, messageProvider.getMessage(messageKey)));
+    } catch (Exception e) {
+      messageStore.add(new SimpleMessage(MessageType.ERROR, messageKey, "not found"));
+    }
+    return "success";
+  }
+}

src/test/java/org/example/action/CallbackAction.java

@@ -53,7 +53,8 @@ public String get() {
     messageStore.add(new SimpleMessage(MessageType.INFO, "[INFO]", messageProvider.getMessage("[INFO]")));
     messageStore.add(new SimpleMessage(MessageType.WARNING, "[WARNING]", messageProvider.getMessage("[WARNING]")));
 
-    // Call another endpoint that adds messages to the message store
+    // Call another endpoint that adds messages to the message store - we want to ensure those messages are scoped
+    // with the request we make here using HttpClient, NOT with the request we are handling
     URI url = URI.create(request.getBaseURL() + "/message-store");
     var request = HttpRequest.newBuilder(url)
                              .GET()

src/test/java/org/example/action/MessageStoreAction.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022, Inversoft Inc., All Rights Reserved
+ * Copyright (c) 2022-2024, Inversoft Inc., All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -40,9 +40,9 @@ public MessageStoreAction(MessageProvider messageProvider, MessageStore messageS
   }
 
   public String get() {
-    messageStore.add(new SimpleMessage(MessageType.ERROR, "[ERROR]", messageProvider.getMessage("[ERROR]")));
-    messageStore.add(new SimpleMessage(MessageType.INFO, "[INFO]", messageProvider.getMessage("[INFO]")));
-    messageStore.add(new SimpleMessage(MessageType.WARNING, "[WARNING]", messageProvider.getMessage("[WARNING]")));
+    messageStore.add(new SimpleMessage(MessageType.ERROR, "[STORE_ERROR]", messageProvider.getMessage("[STORE_ERROR]")));
+    messageStore.add(new SimpleMessage(MessageType.INFO, "[STORE_INFO]", messageProvider.getMessage("[STORE_INFO]")));
+    messageStore.add(new SimpleMessage(MessageType.WARNING, "[STORE_WARNING]", messageProvider.getMessage("[STORE_WARNING]")));
     return "success";
   }
 }

src/test/java/org/example/action/nested/NestedMessageAction.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2024, Inversoft Inc., All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
+ */
+package org.example.action.nested;
+
+import org.primeframework.mvc.action.annotation.Action;
+
+@Action
+public class NestedMessageAction {
+  public String execute() {
+    return "success";
+  }
+}