14017 - fix - do not use bean replacement for jspViewResolver & ensure all view resolvers are lazy init

Author: jdaugherty

grails-gsp/grails-layout/build.gradle

@@ -44,7 +44,7 @@ dependencies {
     implementation platform(project(':grails-bom'))
     implementation project(':grails-web-common') // GrailsViewResolver
     implementation project(':grails-core') // for plugin & groovy
-    implementation project(':grails-gsp-core') // for grails layout preprocessor
+    implementation project(':grails-gsp') // for grails layout preprocessor & gsp configuration classes
 
     runtimeOnly project(':grails-web-jsp')
 

grails-gsp/grails-layout/src/main/groovy/org/apache/grails/web/layout/GrailsLayoutViewResolverPostProcessor.groovy

@@ -19,10 +19,11 @@
 
 package org.apache.grails.web.layout
 
+import org.grails.plugins.web.GroovyPagesPostProcessor
+import org.grails.web.servlet.view.GroovyPageViewResolver
 import org.springframework.beans.BeansException
 import org.springframework.beans.MutablePropertyValues
 import org.springframework.beans.factory.config.BeanDefinition
-import org.springframework.beans.factory.config.ConfigurableListableBeanFactory
 import org.springframework.beans.factory.config.RuntimeBeanReference
 import org.springframework.beans.factory.support.BeanDefinitionRegistry
 import org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor
@@ -46,34 +47,39 @@ class GrailsLayoutViewResolverPostProcessor implements BeanDefinitionRegistryPos
 
     private static final String GRAILS_VIEW_RESOLVER_BEAN_NAME = 'jspViewResolver'
     private static final String GROOVY_PAGE_LAYOUT_FINDER_BEAN_NAME = 'groovyPageLayoutFinder'
-    int order = 0
+    int order = GroovyPagesPostProcessor.ORDER - 1
     Class<?> layoutViewResolverClass = GrailsLayoutViewResolver
     String layoutViewResolverBeanParentName = null
     boolean markBeanPrimary = true
-
     boolean enabled = true
 
-    @Override
-    void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
-    }
-
     @Override
     void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
-        if (enabled && registry.containsBeanDefinition(GRAILS_VIEW_RESOLVER_BEAN_NAME)) {
-            BeanDefinition previousViewResolver = registry.getBeanDefinition(GRAILS_VIEW_RESOLVER_BEAN_NAME)
-            registry.removeBeanDefinition(GRAILS_VIEW_RESOLVER_BEAN_NAME)
+        if (enabled) {
+            BeanDefinition innerViewDefinition
+            if (registry.containsBeanDefinition(GRAILS_VIEW_RESOLVER_BEAN_NAME)) {
+                innerViewDefinition = registry.getBeanDefinition(GRAILS_VIEW_RESOLVER_BEAN_NAME)
+                registry.removeBeanDefinition(GRAILS_VIEW_RESOLVER_BEAN_NAME)
+            } else {
+                // default to what GroovyPagesPostProcessor would
+                innerViewDefinition = new GenericBeanDefinition()
+                innerViewDefinition.beanClass = GroovyPageViewResolver
+                innerViewDefinition.parentName = 'abstractViewResolver'
+                innerViewDefinition.lazyInit = true
+            }
 
             GenericBeanDefinition beanDefinition = new GenericBeanDefinition()
             beanDefinition.beanClass = layoutViewResolverClass
+            beanDefinition.lazyInit = true
             if (layoutViewResolverBeanParentName) {
                 beanDefinition.parentName = layoutViewResolverBeanParentName
             }
             if (markBeanPrimary) {
                 beanDefinition.primary = true
             }
             final MutablePropertyValues propertyValues = beanDefinition.getPropertyValues()
-            propertyValues.addPropertyValue('innerViewResolver', previousViewResolver)
-            propertyValues.addPropertyValue('groovyPageLayoutFinder', new RuntimeBeanReference((String) GROOVY_PAGE_LAYOUT_FINDER_BEAN_NAME, false))
+            propertyValues.addPropertyValue('innerViewResolver', innerViewDefinition)
+            propertyValues.addPropertyValue('groovyPageLayoutFinder', new RuntimeBeanReference(GROOVY_PAGE_LAYOUT_FINDER_BEAN_NAME, false))
             registry.registerBeanDefinition(GRAILS_VIEW_RESOLVER_BEAN_NAME, beanDefinition)
         }
     }

grails-gsp/plugin/src/main/groovy/org/grails/plugins/web/GroovyPagesGrailsPlugin.groovy

@@ -247,11 +247,8 @@ class GroovyPagesGrailsPlugin extends Plugin {
                     cacheTimeout = gspCacheTimeout
                 }
             }
-            // Configure a Spring MVC view resolver
-            jspViewResolver(GroovyPageViewResolver) { bean ->
-                bean.lazyInit = true
-                bean.parent = 'abstractViewResolver'
-            }
+            // Configure a Spring MVC view resolver if none is defined
+            groovyPagesPostProcessor(GroovyPagesPostProcessor)
 
             // Now go through tag libraries and configure them in Spring too. With AOP proxies and so on
             for (taglib in application.tagLibClasses) {

grails-gsp/plugin/src/main/groovy/org/grails/plugins/web/GroovyPagesPostProcessor.groovy

@@ -0,0 +1,49 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you 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
+ *
+ *    https://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.grails.plugins.web
+
+import org.grails.web.servlet.view.GroovyPageViewResolver
+import org.springframework.beans.BeansException
+import org.springframework.beans.factory.support.BeanDefinitionRegistry
+import org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor
+import org.springframework.beans.factory.support.GenericBeanDefinition
+import org.springframework.core.Ordered
+
+/**
+ * Registers a jspViewResolver bean definition if one does not already exist.
+ */
+class GroovyPagesPostProcessor implements BeanDefinitionRegistryPostProcessor, Ordered {
+
+    private static final String JSP_VIEW_RESOLVER_BEAN_NAME = 'jspViewResolver'
+    public static final int ORDER = 0
+
+    int order = ORDER
+
+    @Override
+    void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
+        if (!registry.containsBeanDefinition(JSP_VIEW_RESOLVER_BEAN_NAME)) {
+            GenericBeanDefinition beanDefinition = new GenericBeanDefinition()
+            beanDefinition.beanClass = GroovyPageViewResolver
+            beanDefinition.parentName = 'abstractViewResolver'
+            beanDefinition.lazyInit = true
+            registry.registerBeanDefinition(JSP_VIEW_RESOLVER_BEAN_NAME, beanDefinition)
+        }
+    }
+}

grails-test-examples/gsp-sitemesh3/src/integration-test/groovy/EndToEndSpec.groovy

@@ -24,7 +24,6 @@ import spock.lang.PendingFeature
 @Integration
 class EndToEndSpec extends ContainerGebSpec {
 
-    @PendingFeature
     def 'simple layout'() {
         when:
         go('endToEnd/simpleLayout')
@@ -35,7 +34,6 @@ class EndToEndSpec extends ContainerGebSpec {
 </body></html>"""
     }
 
-    @PendingFeature
     def 'title in subtemplate'() {
         when:
         go('endToEnd/titleInSubtemplate')
@@ -58,7 +56,6 @@ class EndToEndSpec extends ContainerGebSpec {
 </body></html>"""
     }
 
-    @PendingFeature
     def 'parameters'() {
         when:
         go('endToEnd/parameters')
@@ -67,7 +64,6 @@ class EndToEndSpec extends ContainerGebSpec {
         pageSource == """<html><head></head><body><h1>pageProperty: here!</h1></body></html>"""
     }
 
-    @PendingFeature
     def 'parameters with logic'() {
         when:
         go('endToEnd/parametersWithLogic')
@@ -76,7 +72,6 @@ class EndToEndSpec extends ContainerGebSpec {
         pageSource == "<html><head></head><body>good</body></html>"
     }
 
-    @PendingFeature
     def 'multiline title'() {
         when:
         go('endToEnd/multilineTitle')