Merge pull request #10631 from grails/3.2.x-issue-10623

Params not being passed to UrlMappings capturing errors

Author: graemerocher

grails-web-mvc/src/main/groovy/org/grails/web/errors/GrailsExceptionResolver.java

@@ -20,10 +20,7 @@
 import grails.util.Environment;
 
 import java.io.IOException;
-import java.util.Collections;
-import java.util.Enumeration;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 
 import javax.servlet.ServletContext;
 import javax.servlet.ServletException;
@@ -34,13 +31,13 @@
 import org.apache.commons.logging.LogFactory;
 import org.codehaus.groovy.control.CompilationFailedException;
 import grails.core.GrailsApplication;
-import grails.util.GrailsClassUtils;
 import org.grails.exceptions.reporting.DefaultStackTraceFilterer;
 import org.grails.core.exceptions.GrailsRuntimeException;
 import org.grails.exceptions.reporting.StackTraceFilterer;
 import grails.core.support.GrailsApplicationAware;
 import grails.web.mapping.UrlMappingInfo;
 import org.grails.exceptions.ExceptionUtils;
+import org.grails.web.mapping.DefaultUrlMappingInfo;
 import org.grails.web.mapping.UrlMappingUtils;
 import grails.web.mapping.UrlMappingsHolder;
 import org.grails.web.util.GrailsApplicationAttributes;
@@ -162,6 +159,18 @@ protected ModelAndView resolveViewOrForward(Exception ex, UrlMappingsHolder urlM
             HttpServletResponse response, ModelAndView mv) {
 
         UrlMappingInfo info = matchStatusCode(ex, urlMappings);
+
+        if ( info != null ) {
+            UrlMappingInfo requestInfo = urlMappings.match(request.getRequestURI());
+
+            if ( requestInfo != null ) {
+                Map params = new HashMap();
+                params.putAll(UrlMappingUtils.findAllParamsNotInUrlMappingKeywords(requestInfo.getParameters()));
+                params.putAll(info.getParameters());
+                info = new DefaultUrlMappingInfo(info, params, grailsApplication);
+            }
+        }
+
         try {
             if (info != null && info.getViewName() != null) {
                 resolveView(request, info, mv);
@@ -190,7 +199,7 @@ protected void forwardRequest(UrlMappingInfo info, HttpServletRequest request, H
             ModelAndView mv, String uri) throws ServletException, IOException {
         info.configure(WebUtils.retrieveGrailsWebRequest());
         String forwardUrl = UrlMappingUtils.forwardRequestForUrlMappingInfo(
-                request, response, info, mv.getModel());
+                request, response, info, mv.getModel(), true);
         if (LOG.isDebugEnabled()) {
             LOG.debug("Matched URI [" + uri + "] to URL mapping [" + info +
                     "], forwarding to [" + forwardUrl + "] with response [" + response.getClass() + "]");

grails-web-url-mappings/src/main/groovy/grails/web/mapping/UrlMapping.java

@@ -17,6 +17,8 @@
 
 import grails.validation.ConstrainedProperty;
 
+import java.util.Arrays;
+import java.util.List;
 import java.util.Map;
 
 /**
@@ -89,6 +91,33 @@ public interface UrlMapping extends Comparable, UrlCreator {
      */
     String NAMESPACE = "namespace";
 
+
+    String VIEW = "view";
+
+    String RESOURCES = "resources";
+
+    String EXCLUDES = "excludes";
+
+    String INCLUDES = "includes";
+
+    String PERMANENT = "permanent";
+
+    String EXCEPTION = "exception";
+
+    List<String> KEYWORDS = Arrays.asList(CONTROLLER,
+            ACTION,
+            HTTP_METHOD,
+            REDIRECT_INFO,
+            VERSION,
+            URI,
+            PLUGIN,
+            NAMESPACE,
+            VIEW,
+            RESOURCES,
+            INCLUDES,
+            PERMANENT,
+            EXCEPTION);
+
     /**
      * Matches the given URI and returns an instance of the UrlMappingInfo interface or null
      * if a match couldn't be established

grails-web-url-mappings/src/main/groovy/grails/web/mapping/UrlMappingInfo.java

@@ -121,4 +121,11 @@ public interface UrlMappingInfo {
      * @return redirect information for this url mapping, null if no redirect is specified
      */
     Object getRedirectInfo();
+
+    /**
+     * Retrieves the UrlMappingData (information about a parsed URL) if any
+     *
+     * @return The UrlMappingData instance
+     */
+    UrlMappingData getUrlData();
 }

grails-web-url-mappings/src/main/groovy/org/grails/web/mapping/DefaultUrlMappingInfo.java

@@ -30,6 +30,7 @@
 import grails.web.mapping.UrlMapping;
 import grails.web.mapping.UrlMappingData;
 import grails.core.GrailsApplication;
+import grails.web.mapping.UrlMappingInfo;
 import grails.web.mapping.exceptions.UrlMappingException;
 import org.grails.web.servlet.mvc.GrailsWebRequest;
 import org.grails.web.util.WebUtils;
@@ -124,7 +125,6 @@ public DefaultUrlMappingInfo(Object viewName, Map params, UrlMappingData urlData
         this(params, urlData, grailsApplication);
         this.viewName = viewName;
         Assert.notNull(viewName, "Argument [viewName] cannot be null or blank");
-
     }
 
     public DefaultUrlMappingInfo(Object uri, UrlMappingData data, GrailsApplication grailsApplication) {
@@ -140,6 +140,17 @@ public DefaultUrlMappingInfo(Object uri,String httpMethod, UrlMappingData data,
         Assert.notNull(uri, "Argument [uri] cannot be null or blank");
     }
 
+    public DefaultUrlMappingInfo(UrlMappingInfo info, Map params, GrailsApplication grailsApplication) {
+        this(params, info.getUrlData(), grailsApplication);
+        this.redirectInfo = info.getRedirectInfo();
+        this.controllerName = info.getControllerName();
+        this.actionName = info.getActionName();
+        this.namespace = info.getNamespace();
+        this.pluginName = info.getPluginName();
+        this.viewName = info.getViewName();
+    }
+
+
     @Override
     public String getHttpMethod() {
         return httpMethod;
@@ -268,6 +279,11 @@ public Object getRedirectInfo() {
         return redirectInfo;
     }
 
+    @Override
+    public UrlMappingData getUrlData() {
+        return null;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;

grails-web-url-mappings/src/main/groovy/org/grails/web/mapping/ForwardUrlMappingInfo.groovy

@@ -15,6 +15,7 @@
  */
 package org.grails.web.mapping
 
+import grails.web.mapping.UrlMappingData
 import groovy.transform.CompileStatic
 
 /**
@@ -64,4 +65,9 @@ class ForwardUrlMappingInfo extends AbstractUrlMappingInfo {
     boolean isParsingRequest() {
         return false
     }
+
+    @Override
+    UrlMappingData getUrlData() {
+        null
+    }
 }

grails-web-url-mappings/src/main/groovy/org/grails/web/mapping/UrlMappingUtils.java

@@ -18,6 +18,7 @@
 import grails.util.GrailsStringUtils;
 import grails.web.CamelCaseUrlConverter;
 import grails.web.UrlConverter;
+import grails.web.mapping.UrlMapping;
 import grails.web.mapping.UrlMappingInfo;
 import grails.web.mapping.UrlMappingsHolder;
 import groovy.lang.Binding;
@@ -59,6 +60,22 @@ public class UrlMappingUtils {
     private UrlMappingUtils() {
     }
 
+    /**
+     *
+     * @return a Map without entries whose key belongs to UrlMapping#KEYWORDS
+     */
+    public static  Map<String, Object> findAllParamsNotInUrlMappingKeywords(Map<String, Object> params) {
+        Map<String, Object> urlParams = new HashMap<>();
+        if ( params != null ) {
+            for (String key : params.keySet()) {
+                if (!UrlMapping.KEYWORDS.contains(key)) {
+                    urlParams.put(key, params.get(key));
+                }
+            }
+        }
+        return urlParams;
+    }
+
     /**
      * Looks up the UrlMappingsHolder instance
      *
@@ -120,7 +137,7 @@ private static String buildDispatchUrlForMapping(UrlMappingInfo info, boolean in
             }
         }
 
-        final Map parameters = info.getParameters();
+        final Map parameters = findAllParamsNotInUrlMappingKeywords(info.getParameters());
         if (parameters != null && !parameters.isEmpty() && includeParams) {
             try {
                 forwardUrl.append(WebUtils.toQueryString(parameters));

grails-web-url-mappings/src/test/groovy/org/grails/web/mapping/UrlMappingUtilsSpec.groovy

@@ -0,0 +1,18 @@
+package org.grails.web.mapping
+
+import spock.lang.Specification
+import spock.lang.Unroll
+
+class UrlMappingUtilsSpec extends Specification {
+
+    @Unroll
+    def "test buildDispatchUrlForMapping"() {
+        expect:
+        expected == UrlMappingUtils.findAllParamsNotInUrlMappingKeywords(params)
+
+        where:
+        params                      | expected
+        [id: 1, controller: 'home'] | [id: 1]
+        [id: 1, format: 'json']     | [id: 1, format: 'json']
+    }
+}