Correctly handle includes within 404 forward requests. Fixes #10149

Author: graemerocher

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

@@ -131,7 +131,7 @@ class UrlMappingsHandlerMapping extends AbstractHandlerMapping {
         String version = findRequestedVersion(webRequest)
 
 
-        if(errorStatus) {
+        if(errorStatus && !WebUtils.isInclude(request)) {
             def exception = request.getAttribute(WebUtils.ERROR_EXCEPTION_ATTRIBUTE)
             UrlMappingInfo info
             if(exception instanceof Throwable) {

grails-web-url-mappings/src/test/groovy/org/codehaus/groovy/grails/web/servlet/mvc/UrlMappingsHandlerMappingSpec.groovy

@@ -10,14 +10,84 @@ import org.grails.web.mapping.DefaultUrlMappingInfo
 import org.grails.web.mapping.mvc.GrailsControllerUrlMappings
 import org.grails.web.mapping.mvc.UrlMappingsHandlerMapping
 import org.grails.web.mapping.mvc.UrlMappingsInfoHandlerAdapter
+import org.grails.web.util.WebUtils
 import org.springframework.web.context.request.RequestContextHolder
 import org.springframework.web.servlet.view.InternalResourceView
+import spock.lang.Issue
 
 /**
  * Created by graemerocher on 26/05/14.
  */
 class UrlMappingsHandlerMappingSpec extends AbstractUrlMappingsSpec {
 
+    void "Test that when a request coming from a 404 forward is matched the correct action is executed"() {
+        given:"A URL mapping definition that has a 404 mapping"
+        def grailsApplication = new DefaultGrailsApplication(FooController)
+        grailsApplication.initialise()
+        def holder = getUrlMappingsHolder {
+            "/foo/bar"(controller:"foo", action:"bar")
+            "/foo/error"(controller:"foo", action:"error")
+            "404"(controller: "foo", action:"notFound")
+        }
+
+        holder = new GrailsControllerUrlMappings(grailsApplication, holder)
+        def handler = new UrlMappingsHandlerMapping(holder)
+
+        when:"A request that contains a 404 error status code is handled"
+        def webRequest = GrailsWebMockUtil.bindMockWebRequest()
+        webRequest.renderView = true
+        def request = webRequest.request
+        request.setRequestURI("/foo/notThere")
+        request.setAttribute(WebUtils.ERROR_STATUS_CODE_ATTRIBUTE, "404")
+        def handlerChain = handler.getHandler(request)
+
+        then:"The handler chain is not null"
+        handlerChain != null
+
+        when:"A HandlerAdapter is used"
+        def handlerAdapter = new UrlMappingsInfoHandlerAdapter()
+        def result = handlerAdapter.handle(request, webRequest.response, handlerChain.handler)
+
+        then:"The controller action that is mapped to the 404 handler is executed"
+        webRequest.response.contentAsString == 'Not Found'
+    }
+
+    @Issue('https://github.com/grails/grails-core/issues/10149')
+    void "Test that when an include request from within a 404 forward is matched"() {
+        given:"A URL mapping definition that has a 404 mapping"
+        def grailsApplication = new DefaultGrailsApplication(FooController)
+        grailsApplication.initialise()
+        def holder = getUrlMappingsHolder {
+            "/foo/bar"(controller:"foo", action:"bar")
+            "/foo/error"(controller:"foo", action:"error")
+            "404"(controller: "foo", action:"notFound")
+        }
+
+        holder = new GrailsControllerUrlMappings(grailsApplication, holder)
+        def handler = new UrlMappingsHandlerMapping(holder)
+
+        when:"A request arrives that is an include within a 404 forward request"
+        def webRequest = GrailsWebMockUtil.bindMockWebRequest()
+        webRequest.renderView = true
+        def request = webRequest.request
+        request.setRequestURI("/foo/notThere")
+        request.setAttribute(WebUtils.ERROR_STATUS_CODE_ATTRIBUTE, "404")
+        request.setAttribute(WebUtils.INCLUDE_REQUEST_URI_ATTRIBUTE, "/foo/bar")
+        def handlerChain = handler.getHandler(request)
+
+        then:"The handler chain is not null"
+        handlerChain != null
+
+        when:"A HandlerAdapter is used"
+        def handlerAdapter = new UrlMappingsInfoHandlerAdapter()
+        def result = handlerAdapter.handle(request, webRequest.response, handlerChain.handler)
+
+        then:"The correct action was executed to handle the include"
+        result.viewName == 'bar'
+        result.model == [foo:'bar']
+
+    }
+
     void "Test that a matched URL returns a URLMappingInfo"() {
 
         given:
@@ -93,4 +163,9 @@ class FooController  {
     def error() {
         RequestContextHolder.currentRequestAttributes().response.sendError(405)
     }
+
+    @Action
+    def notFound() {
+        RequestContextHolder.currentRequestAttributes().response.writer << "Not Found"
+    }
 }