WebApplicationInitializer with AnnotationConfigWebApplicationContext parent gets reset to null by ContextLoaderListener [SPR-9591]

[spring-projects-issues]

Kirk Rasmussen opened SPR-9591 and commented

org.springframework.web.context.ContextLoader.configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext, ServletContext)

The following code ignores that the parent was already set previously and ends up setting the parent to null.

		// Determine parent for root web application context, if any.
		ApplicationContext parent = loadParentContext(sc);

		wac.setParent(parent);

The documentation for org.springframework.web.context.ContextLoaderListener.ContextLoaderListener(WebApplicationContext) doesn't match the implementation for condition (b)

The context may or may not yet be refreshed. If it (a) is an implementation of ConfigurableWebApplicationContext and (b) has not already been refreshed (the recommended approach), then the following will occur:

It appears that refresh is ALWAYS called:

org.springframework.web.context.ContextLoader.initWebApplicationContext(ServletContext)

			if (this.context instanceof ConfigurableWebApplicationContext) {
				configureAndRefreshWebApplicationContext((ConfigurableWebApplicationContext)this.context, servletContext);

---

Issue Links:

• ContextLoader incorrectly refreshes already refreshed context [SPR-9996] #14630 ContextLoader incorrectly refreshes already refreshed context

Backported to: 3.1.4

[spring-projects-issues]

Kirk Rasmussen commented

I tried to trick it using my own overloaded ContextLoaderListener but it fails later

class SmartContextLoaderListener extends ContextLoaderListener {
	
	private WebApplicationContext parentContext
	
	SmartContextLoaderListener(WebApplicationContext context) {
		super(context)
		parentContext = context
	}
	
	@Override
	protected ApplicationContext loadParentContext(ServletContext servletContext) {
		return parentContext ?: super.loadParentContext(servletContext) 
	}
}

10:14:31,666 ERROR [org.springframework.web.context.ContextLoader] (MSC service thread 1-6) Context initialization failed: java.lang.IllegalStateException: BeanFactory not initialized or already closed - call 'refresh' before accessing beans via the ApplicationContext
        at org.springframework.context.support.AbstractRefreshableApplicationContext.getBeanFactory(AbstractRefreshableApplicationContext.java:172) [org.springframework.context-3.1.2.RELEASE.jar:3.1.2.RELEASE]
        at org.springframework.context.support.AbstractApplicationContext.getInternalParentBeanFactory(AbstractApplicationContext.java:1202) [org.springframework.context-3.1.2.RELEASE.jar:3.1.2.RELEASE]
        at org.springframework.context.support.AbstractRefreshableApplicationContext.createBeanFactory(AbstractRefreshableApplicationContext.java:195) [org.springframework.context-3.1.2.RELEASE.jar:3.1.2.RELEASE]
        at org.springframework.context.support.AbstractRefreshableApplicationContext.refreshBeanFactory(AbstractRefreshableApplicationContext.java:128) [org.springframework.context-3.1.2.RELEASE.jar:3.1.2.RELEASE]
        at org.springframework.context.support.AbstractApplicationContext.obtainFreshBeanFactory(AbstractApplicationContext.java:527) [org.springframework.context-3.1.2.RELEASE.jar:3.1.2.RELEASE]
        at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:441) [org.springframework.context-3.1.2.RELEASE.jar:3.1.2.RELEASE]
        at org.springframework.web.context.ContextLoader.configureAndRefreshWebApplicationContext(ContextLoader.java:383) [org.springframework.web-3.1.2.RELEASE.jar:3.1.2.RELEASE]
        at org.springframework.web.context.ContextLoader.initWebApplicationContext(ContextLoader.java:283) [org.springframework.web-3.1.2.RELEASE.jar:3.1.2.RELEASE]

[spring-projects-issues]

Kirk Rasmussen commented

What's strange is that it works just fine from the WebApplicationInitializer

	@Override
	void onStartup(ServletContext servletContext) throws ServletException {

		// Create the 'root' Spring application context
		AnnotationConfigWebApplicationContext rootContext = new AnnotationConfigWebApplicationContext()
		rootContext.setParent(ServiceProviderContextFactory.serviceProviderContext.applicationContext)
		rootContext.scan('com.textura.demo.config')
		rootContext.refresh()
				
		// Manage the lifecycle of the root application context
		servletContext.addListener(new SmartContextLoaderListener(rootContext))
		
		Environment environment = rootContext.getEnvironment()
		servletContext.setInitParameter('productionMode', environment.acceptsProfiles('production') as String)

		logger.info('DemoInitializer I18nService = {}', rootContext.getBean(I18nService))
		logger.info('DemoInitializer DemoApplication = {}', rootContext.getBean(DemoApplication))
		
	}
}

10:13:41,690 INFO  [com.textura.vaadin.builder.demo.DemoInitializer] (MSC service thread 1-6) DemoInitializer I18nService = com.textura.service.internal.ResourceBundleI18nServiceProvider@4a4f4daf
10:13:41,797 INFO  [com.textura.demo.DemoInitializer] (MSC service thread 1-6) DemoInitializer DemoApplication = com.textura.demo.app.DemoApplication@31ae517f

class ServiceProviderContextFactory {
	
	private static class ServiceProviderHolder {
		static ServiceProviderContext serviceProviderContext = new ServiceProviderContextImpl() 
	}
		
	static ServiceProviderContext getServiceProviderContext() {
		return ServiceProviderHolder.serviceProviderContext
	} 
	
}

class ServiceProviderContextImpl implements ServiceProviderContext {
	
	private static Logger logger = LoggerFactory.getLogger(ServiceProviderContextImpl)
	
	private ApplicationContext applicationContext
		
	ServiceProviderContextImpl() {
		AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext()
		ConfigurableEnvironment environment = context.getEnvironment()
		
		// TODO read environment from cpmsconfig.xml
		environment.setActiveProfiles('integration')
		context.scan('com.textura.config')
		context.refresh()
		
		logger.info('environment = {}', environment)
		
		logger.info('I18nService = {}', context.getBean(I18nService))
		
		this.applicationContext = context
	}

	@Override
	ApplicationContext getApplicationContext() {
		return applicationContext
	}
}

[spring-projects-issues]

Kirk Rasmussen commented

BTW I should point out what I'm trying to accomplish. We have a shared Spring context that is used by multiple WAR files and also for standlone batch processing. I also created a WAR specific Spring context used for view management of Vaadin based applications. I'm trying to set the shared context as a parent and it works great inside of the WebApplicationInitializer but fails when I try add the ContextLoaderListener :(

[spring-projects-issues]

Kirk Rasmussen commented

Ooops I made a mistake above. I was able to make the following work

// Create the 'root' Spring application context
AnnotationConfigWebApplicationContext rootContext = new AnnotationConfigWebApplicationContext()
rootContext.scan('com.textura.demo.config')
				
// Manage the lifecycle of the root application context
servletContext.addListener(new SmartContextLoaderListener(rootContext))


class SmartContextLoaderListener extends ContextLoaderListener {
	
	SmartContextLoaderListener(WebApplicationContext context) {
		super(context)
	}
	
	@Override
	protected ApplicationContext loadParentContext(ServletContext servletContext) {
		return ServiceProviderContextFactory.serviceProviderContext.applicationContext
	}
}

I still think the Spring API could be improved to avoid needing to subclass like this. Or at least better document this use case of 100% code driven configuration with a parent context.

[spring-projects-issues]

Juergen Hoeller commented

This has been fixed along with #14630.

Juergen