Cleanup request attributes after a forward. Fixes #10443

Author: graemerocher

grails-plugin-controllers/src/main/groovy/grails/artefact/controller/support/RequestForwarder.groovy

@@ -28,6 +28,9 @@ import org.springframework.web.context.request.WebRequest
 import org.springframework.web.filter.OncePerRequestFilter
 
 import javax.servlet.RequestDispatcher
+import javax.servlet.http.HttpServletRequest
+import javax.servlet.http.HttpServletResponse
+
 /**
  * A Trait for classes that forward the request
  *
@@ -88,28 +91,37 @@ trait RequestForwarder implements WebAttributes {
             }
         }
 
-        def model = params.model instanceof Map ? params.model : Collections.EMPTY_MAP
+        Map model = params.model instanceof Map ? (Map)params.model : Collections.EMPTY_MAP
 
-        def request = webRequest.currentRequest
-        def response = webRequest.currentResponse
+        HttpServletRequest request = webRequest.currentRequest
+        HttpServletResponse response = webRequest.currentResponse
 
         WebUtils.exposeRequestAttributes(request, (Map)model);
 
         request.setAttribute(GrailsApplicationAttributes.FORWARD_IN_PROGRESS, true)
         params.includeContext = false
-        def fowardURI = lookupLinkGenerator().link(params)
+        String fowardURI = lookupLinkGenerator().link(params)
 
 
         RequestDispatcher dispatcher = request.getRequestDispatcher(fowardURI)
 
-        def requestScope = WebRequest.SCOPE_REQUEST
+        int requestScope = WebRequest.SCOPE_REQUEST
         webRequest.removeAttribute(GrailsApplicationAttributes.MODEL_AND_VIEW, requestScope)
         webRequest.removeAttribute(GrailsApplicationAttributes.GRAILS_CONTROLLER_CLASS_AVAILABLE, requestScope)
         webRequest.removeAttribute(UrlMappingsHandlerMapping.MATCHED_REQUEST, requestScope)
         webRequest.removeAttribute(WebUtils.ERROR_STATUS_CODE_ATTRIBUTE, requestScope)
         webRequest.removeAttribute("grailsWebRequestFilter" + OncePerRequestFilter.ALREADY_FILTERED_SUFFIX, requestScope)
-        dispatcher.forward(request, response);
-        request.setAttribute(GrailsApplicationAttributes.FORWARD_ISSUED, true)
+        try {
+            dispatcher.forward(request, response)
+            request.setAttribute(GrailsApplicationAttributes.FORWARD_ISSUED, true)
+        } finally {
+            // cleanup after forward
+            webRequest.removeAttribute(GrailsApplicationAttributes.MODEL_AND_VIEW, requestScope)
+            webRequest.removeAttribute(GrailsApplicationAttributes.GRAILS_CONTROLLER_CLASS_AVAILABLE, requestScope)
+            webRequest.removeAttribute(UrlMappingsHandlerMapping.MATCHED_REQUEST, requestScope)
+            webRequest.removeAttribute(WebUtils.ERROR_STATUS_CODE_ATTRIBUTE, requestScope)
+            webRequest.removeAttribute("grailsWebRequestFilter" + OncePerRequestFilter.ALREADY_FILTERED_SUFFIX, requestScope)
+        }
         return fowardURI
     }
 

grails-plugin-controllers/src/test/groovy/grails/artefact/controller/support/RequestForwarderSpec.groovy

@@ -0,0 +1,67 @@
+package grails.artefact.controller.support
+
+import grails.util.GrailsWebMockUtil
+import grails.web.mapping.LinkGenerator
+import org.grails.web.servlet.mvc.GrailsWebRequest
+import org.grails.web.servlet.mvc.ParameterCreationListener
+import org.grails.web.util.GrailsApplicationAttributes
+import org.springframework.mock.web.MockHttpServletRequest
+import org.springframework.mock.web.MockHttpServletResponse
+import org.springframework.mock.web.MockRequestDispatcher
+import org.springframework.web.context.WebApplicationContext
+import org.springframework.web.context.request.RequestContextHolder
+import org.springframework.web.servlet.ModelAndView
+import spock.lang.Specification
+
+import javax.servlet.RequestDispatcher
+import javax.servlet.ServletRequest
+import javax.servlet.ServletResponse
+
+/**
+ * Created by graemerocher on 21/02/2017.
+ */
+class RequestForwarderSpec extends Specification {
+
+    void "test request forward cleans up request attributes after forward"() {
+
+        setup:
+        def applicationContext = Mock(WebApplicationContext)
+        def linkGenerator = Mock(LinkGenerator)
+        linkGenerator.link(_) >> "/test"
+        applicationContext.getBean(LinkGenerator) >> linkGenerator
+        applicationContext.getBeansOfType(ParameterCreationListener) >> [:]
+        MockRequestDispatcher mockRequestDispatcher = new MockRequestDispatcher("test") {
+            @Override
+            void forward(ServletRequest request, ServletResponse response) {
+                request.setAttribute(GrailsApplicationAttributes.MODEL_AND_VIEW, new ModelAndView())
+                super.forward(request, response)
+            }
+        };
+
+        GrailsWebRequest webRequest = GrailsWebMockUtil.bindMockWebRequest(applicationContext, new MockHttpServletRequest() {
+            @Override
+            RequestDispatcher getRequestDispatcher(String path) {
+                return mockRequestDispatcher
+            }
+        }, new MockHttpServletResponse())
+
+        when:"A forward is issued that populates the model"
+        TestForwarder forwarder = new TestForwarder()
+
+        forwarder.doForward()
+
+        then:"The model and view attribute is cleared"
+        webRequest.request.getAttribute(GrailsApplicationAttributes.MODEL_AND_VIEW) == null
+
+
+
+        cleanup:
+        RequestContextHolder.setRequestAttributes(null)
+    }
+}
+
+class TestForwarder implements RequestForwarder {
+    void doForward() {
+        forward(controller:"blah")
+    }
+}