Skip to content

Refactor GrailsExceptionResolver #1254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rainboyan merged 3 commits into from
Dec 19, 2025
Merged

Refactor GrailsExceptionResolver #1254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
835e087
Introduce GrailsUrlMappingsExceptionResolver to make grace-web-mvc de…
rainboyan Dec 18, 2025
e663697
GrailsExceptionResolver should not reuse cached controller attribute …
rainboyan Dec 18, 2025
09ae9a3
Cleanup GrailsWrappedRuntimeException
rainboyan Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions grace-plugin-controllers/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ dependencies {
api project(":grace-plugin-validation")
api project(":grace-web-gsp")
api project(":grace-web-mvc")
api project(":grace-web-url-mappings")
api project(":grace-util")

compileOnly libs.jakarta.servlet
Expand Down
3 changes: 2 additions & 1 deletion ...rs/src/main/groovy/org/grails/plugins/web/controllers/ControllersPluginConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
import org.grails.web.errors.GrailsExceptionResolver;
import org.grails.web.filters.HiddenHttpMethodFilter;
import org.grails.web.filters.OrderedHiddenHttpMethodFilter;
import org.grails.web.mapping.mvc.GrailsUrlMappingsExceptionResolver;
import org.grails.web.servlet.mvc.GrailsDispatcherServlet;
import org.grails.web.servlet.mvc.GrailsWebRequestFilter;
import org.grails.web.servlet.mvc.ParameterCreationListener;
Expand Down Expand Up @@ -101,7 +102,7 @@ public StackTraceFilterer stackTraceFilterer(ObjectProvider<GrailsApplication> g
@Bean
public GrailsExceptionResolver exceptionHandler(ObjectProvider<GrailsApplication> grailsApplicationProvider,
ObjectProvider<StackTraceFilterer> stackTraceFiltererObjectProvider) {
GrailsExceptionResolver exceptionResolver = new GrailsExceptionResolver();
GrailsUrlMappingsExceptionResolver exceptionResolver = new GrailsUrlMappingsExceptionResolver();
exceptionResolver.setGrailsApplication(grailsApplicationProvider.getIfAvailable());
exceptionResolver.setStackTraceFilterer(stackTraceFiltererObjectProvider.getIfAvailable());

Expand Down
160 changes: 30 additions & 130 deletions ...test-suite-uber/src/test/groovy/org/grails/web/errors/GrailsExceptionResolverTests.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,43 +1,34 @@
package org.grails.web.errors

import grails.core.DefaultGrailsApplication
import grails.core.GrailsApplication
import grails.util.Environment
import grails.util.GrailsWebMockUtil
import grails.web.CamelCaseUrlConverter
import grails.web.UrlConverter
import grails.web.mapping.UrlMappingsHolder
import org.grails.config.PropertySourcesConfig
import org.grails.exceptions.reporting.DefaultStackTraceFilterer
import org.grails.plugins.testing.GrailsMockHttpServletRequest
import org.grails.plugins.testing.GrailsMockHttpServletResponse
import org.grails.support.MockApplicationContext
import org.grails.web.mapping.DefaultUrlMappingEvaluator
import org.grails.web.mapping.DefaultUrlMappingsHolder
import org.grails.web.servlet.view.CompositeViewResolver
import org.junit.jupiter.api.AfterEach
import org.junit.jupiter.api.BeforeEach
import org.junit.jupiter.api.Test
import org.springframework.mock.web.MockHttpServletRequest
import org.springframework.mock.web.MockHttpServletResponse
import org.springframework.mock.web.MockServletContext
import org.springframework.web.context.WebApplicationContext
import org.springframework.web.context.request.RequestContextHolder
import org.springframework.web.multipart.support.StandardServletMultipartResolver
import org.springframework.web.servlet.View
import org.springframework.web.servlet.ViewResolver
import org.springframework.web.servlet.view.InternalResourceView

import static org.junit.jupiter.api.Assertions.*
import grails.core.DefaultGrailsApplication
import grails.core.GrailsApplication
import grails.util.Environment
import grails.web.CamelCaseUrlConverter
import grails.web.UrlConverter

import org.grails.config.PropertySourcesConfig
import org.grails.exceptions.reporting.DefaultStackTraceFilterer
import org.grails.support.MockApplicationContext

import static org.junit.jupiter.api.Assertions.assertEquals
import static org.junit.jupiter.api.Assertions.assertThrows

/**
* Test case for {@link org.grails.web.errors.GrailsExceptionResolver}.
*/
class GrailsExceptionResolverTests {

private application = new DefaultGrailsApplication()
private resolver = new GrailsExceptionResolver()
private mockContext = new MockServletContext()
private mockCtx = new MockApplicationContext()

@AfterEach
Expand All @@ -49,8 +40,8 @@ class GrailsExceptionResolverTests {
void setUp() throws Exception {
mockCtx.registerMockBean(GrailsApplication.APPLICATION_ID, new DefaultGrailsApplication())
def mainContext = new MockApplicationContext();
mainContext.registerMockBean(UrlConverter.BEAN_NAME, new CamelCaseUrlConverter());
application.mainContext = mainContext
mainContext.registerMockBean(UrlConverter.BEAN_NAME, new CamelCaseUrlConverter())
application.mainContext = mainContext
}

@Test
Expand All @@ -70,101 +61,6 @@ class GrailsExceptionResolverTests {
}
}

@Test
void testResolveExceptionToView() {
def mappings = new DefaultUrlMappingEvaluator(mockCtx).evaluateMappings {
"500"(view:"myView")
}

def urlMappingsHolder = new DefaultUrlMappingsHolder(mappings)
def webRequest = GrailsWebMockUtil.bindMockWebRequest(mockCtx,
new GrailsMockHttpServletRequest(), new GrailsMockHttpServletResponse())

mockCtx.registerMockBean UrlMappingsHolder.BEAN_ID, urlMappingsHolder
ViewResolver viewResolver = new DummyViewResolver()
mockCtx.registerMockBean "viewResolver", viewResolver
mockCtx.registerMockBean 'grailsApplication', application
mockCtx.registerMockBean CompositeViewResolver.BEAN_NAME, new CompositeViewResolver(viewResolvers: [viewResolver])
mockContext.setAttribute WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, mockCtx

resolver.servletContext = mockContext
resolver.exceptionMappings = ['java.lang.Exception': '/error'] as Properties
resolver.grailsApplication = application
resolver.stackFilterer = new DefaultStackTraceFilterer()

def ex = new Exception()
def request = webRequest.currentRequest
def response = webRequest.currentResponse
def handler = new Object()
def modelAndView = resolver.resolveException(request, response, handler, ex)

assertNotNull modelAndView, "should have returned a ModelAndView"
assertEquals "/myView", modelAndView.view.url
}

@Test
void testResolveExceptionToController() {
def mappings = new DefaultUrlMappingEvaluator(mockCtx).evaluateMappings {
"500"(controller:"foo", action:"bar")
}

def urlMappingsHolder = new DefaultUrlMappingsHolder(mappings)
def webRequest = GrailsWebMockUtil.bindMockWebRequest()

mockCtx.registerMockBean UrlMappingsHolder.BEAN_ID, urlMappingsHolder
mockCtx.registerMockBean "viewResolver", new DummyViewResolver()
mockCtx.registerMockBean GrailsApplication.APPLICATION_ID, application
mockCtx.registerMockBean "multipartResolver", new StandardServletMultipartResolver()
mockContext.setAttribute WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, mockCtx

resolver.servletContext = mockContext
resolver.exceptionMappings = ['java.lang.Exception': '/error'] as Properties
resolver.grailsApplication = application
resolver.stackFilterer = new DefaultStackTraceFilterer()

def ex = new Exception()
def request = webRequest.currentRequest
MockHttpServletResponse response = webRequest.currentResponse
def handler = new Object()
def modelAndView = resolver.resolveException(request, response, handler, ex)

assertNotNull modelAndView, "should have returned a ModelAndView"
assertTrue modelAndView.empty

assertEquals "/foo/bar",response.getForwardedUrl()
}

@Test
void testResolveExceptionToControllerWhenResponseCommitted() {
def mappings = new DefaultUrlMappingEvaluator(mockCtx).evaluateMappings {
"500"(controller:"foo", action:"bar")
}

def urlMappingsHolder = new DefaultUrlMappingsHolder(mappings)
def webRequest = GrailsWebMockUtil.bindMockWebRequest()

mockCtx.registerMockBean UrlMappingsHolder.BEAN_ID, urlMappingsHolder
mockCtx.registerMockBean "viewResolver", new DummyViewResolver()
mockCtx.registerMockBean GrailsApplication.APPLICATION_ID, application
mockCtx.registerMockBean "multipartResolver", new StandardServletMultipartResolver()
mockContext.setAttribute WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, mockCtx

resolver.servletContext = mockContext
resolver.exceptionMappings = ['java.lang.Exception': '/error'] as Properties
resolver.grailsApplication = application
resolver.stackFilterer = new DefaultStackTraceFilterer()

def ex = new Exception()
def request = webRequest.currentRequest
MockHttpServletResponse response = webRequest.currentResponse
def handler = new Object()
response.setCommitted(true)
def modelAndView = resolver.resolveException(request, response, handler, ex)

assertNotNull modelAndView, "should have returned a ModelAndView"
assertFalse modelAndView.empty
}

@Test
void testLogRequestWithException() {
def config = new ConfigSlurper().parse('''
Expand All @@ -179,7 +75,7 @@ grails.exceptionresolver.params.exclude = ['jennysPhoneNumber']
request.addParameter "jennysPhoneNumber", "8675309"

System.setProperty(Environment.KEY, Environment.DEVELOPMENT.name)
def resolver = new GrailsExceptionResolver(grailsApplication:new DefaultGrailsApplication(config:new PropertySourcesConfig().merge(config)))
def resolver = new GrailsExceptionResolver(grailsApplication: new DefaultGrailsApplication(config: new PropertySourcesConfig().merge(config)))
resolver.stackFilterer = new DefaultStackTraceFilterer()
def msg = resolver.getRequestLogMessage(new RuntimeException("bad things happened"), request)

Expand Down Expand Up @@ -210,7 +106,7 @@ grails.exceptionresolver.params.exclude = ['jennysPhoneNumber']
request.addParameter "jennysPhoneNumber", "8675309"

System.setProperty(Environment.KEY, Environment.DEVELOPMENT.name)
def resolver = new GrailsExceptionResolver(grailsApplication:new DefaultGrailsApplication(config:new PropertySourcesConfig().merge(config)))
def resolver = new GrailsExceptionResolver(grailsApplication: new DefaultGrailsApplication(config: new PropertySourcesConfig().merge(config)))
resolver.stackFilterer = new DefaultStackTraceFilterer()
def msg = resolver.getRequestLogMessage(request)

Expand Down Expand Up @@ -251,19 +147,19 @@ Method: GET
Filtered stacktrace:'''.replaceAll('[\n\r]', '')

System.setProperty(Environment.KEY, Environment.DEVELOPMENT.name)
def resolver = new GrailsExceptionResolver(grailsApplication:application)
def resolver = new GrailsExceptionResolver(grailsApplication: application)
resolver.stackFilterer = new DefaultStackTraceFilterer()
def msg = resolver.getRequestLogMessage(request)
assertEquals msgWithParameters, msg.replaceAll('[\n\r]', '')

System.setProperty(Environment.KEY, Environment.PRODUCTION.name)
resolver = new GrailsExceptionResolver(grailsApplication:application)
resolver = new GrailsExceptionResolver(grailsApplication: application)
resolver.stackFilterer = new DefaultStackTraceFilterer()
msg = resolver.getRequestLogMessage(request)
assertEquals msgWithoutParameters, msg.replaceAll('[\n\r]', '')

System.setProperty(Environment.KEY, Environment.TEST.name)
resolver = new GrailsExceptionResolver(grailsApplication:application)
resolver = new GrailsExceptionResolver(grailsApplication: application)
resolver.stackFilterer = new DefaultStackTraceFilterer()
msg = resolver.getRequestLogMessage(request)
assertEquals msgWithoutParameters, msg.replaceAll('[\n\r]', '')
Expand All @@ -273,19 +169,19 @@ grails.exceptionresolver.logRequestParameters = false
''')

System.setProperty(Environment.KEY, Environment.DEVELOPMENT.name)
resolver = new GrailsExceptionResolver(grailsApplication:new DefaultGrailsApplication(config:new PropertySourcesConfig().merge(config)))
resolver = new GrailsExceptionResolver(grailsApplication: new DefaultGrailsApplication(config: new PropertySourcesConfig().merge(config)))
resolver.stackFilterer = new DefaultStackTraceFilterer()
msg = resolver.getRequestLogMessage(request)
assertEquals msgWithoutParameters, msg.replaceAll('[\n\r]', '')

System.setProperty(Environment.KEY, Environment.PRODUCTION.name)
resolver = new GrailsExceptionResolver(grailsApplication:new DefaultGrailsApplication(config:new PropertySourcesConfig().merge(config)))
resolver = new GrailsExceptionResolver(grailsApplication: new DefaultGrailsApplication(config: new PropertySourcesConfig().merge(config)))
resolver.stackFilterer = new DefaultStackTraceFilterer()
msg = resolver.getRequestLogMessage(request)
assertEquals msgWithoutParameters, msg.replaceAll('[\n\r]', '')

System.setProperty(Environment.KEY, Environment.TEST.name)
resolver = new GrailsExceptionResolver(grailsApplication:new DefaultGrailsApplication(config:new PropertySourcesConfig().merge(config)))
resolver = new GrailsExceptionResolver(grailsApplication: new DefaultGrailsApplication(config: new PropertySourcesConfig().merge(config)))
resolver.stackFilterer = new DefaultStackTraceFilterer()
msg = resolver.getRequestLogMessage(request)
assertEquals msgWithoutParameters, msg.replaceAll('[\n\r]', '')
Expand All @@ -295,30 +191,34 @@ grails.exceptionresolver.logRequestParameters = true
''')

System.setProperty(Environment.KEY, Environment.DEVELOPMENT.name)
resolver = new GrailsExceptionResolver(grailsApplication:new DefaultGrailsApplication(config:new PropertySourcesConfig().merge(config)))
resolver = new GrailsExceptionResolver(grailsApplication: new DefaultGrailsApplication(config: new PropertySourcesConfig().merge(config)))
resolver.stackFilterer = new DefaultStackTraceFilterer()
msg = resolver.getRequestLogMessage(request)
assertEquals msgWithParameters, msg.replaceAll('[\n\r]', '')

System.setProperty(Environment.KEY, Environment.PRODUCTION.name)
resolver = new GrailsExceptionResolver(grailsApplication:new DefaultGrailsApplication(config:new PropertySourcesConfig().merge(config)))
resolver = new GrailsExceptionResolver(grailsApplication: new DefaultGrailsApplication(config: new PropertySourcesConfig().merge(config)))
resolver.stackFilterer = new DefaultStackTraceFilterer()
msg = resolver.getRequestLogMessage(request)
assertEquals msgWithParameters, msg.replaceAll('[\n\r]', '')

System.setProperty(Environment.KEY, Environment.TEST.name)
resolver = new GrailsExceptionResolver(grailsApplication:new DefaultGrailsApplication(config:new PropertySourcesConfig().merge(config)))
resolver = new GrailsExceptionResolver(grailsApplication: new DefaultGrailsApplication(config: new PropertySourcesConfig().merge(config)))
resolver.stackFilterer = new DefaultStackTraceFilterer()
msg = resolver.getRequestLogMessage(request)
assertEquals msgWithParameters, msg.replaceAll('[\n\r]', '')
} finally {
}
finally {
System.setProperty(Environment.KEY, oldEnvName)
}
}
}

class DummyViewResolver implements ViewResolver {

@Override
View resolveViewName(String viewName, Locale locale) {
new InternalResourceView(viewName)
}

}
1 change: 0 additions & 1 deletion grace-web-mvc/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
dependencies {
api project(":grace-gsp")
api project(":grace-web")
api project(":grace-web-url-mappings")

compileOnlyApi libs.jakarta.servlet

Expand Down
Loading