Avoid duplicate scope registration

Closes gh-14990

Author: wilkinsona

spring-boot/src/main/java/org/springframework/boot/context/embedded/EmbeddedWebApplicationContext.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2016 the original author or authors.
+ * Copyright 2012-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -51,6 +51,7 @@
 import org.springframework.web.context.support.GenericWebApplicationContext;
 import org.springframework.web.context.support.ServletContextAwareProcessor;
 import org.springframework.web.context.support.ServletContextResource;
+import org.springframework.web.context.support.ServletContextScope;
 import org.springframework.web.context.support.WebApplicationContextUtils;
 
 /**
@@ -114,7 +115,7 @@ protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactor
 		beanFactory.addBeanPostProcessor(
 				new WebApplicationContextServletContextAwareProcessor(this));
 		beanFactory.ignoreDependencyInterface(ServletContextAware.class);
-		registerWebApplicationScopes(null);
+		registerWebApplicationScopes();
 	}
 
 	@Override
@@ -218,19 +219,25 @@ public void onStartup(ServletContext servletContext) throws ServletException {
 
 	private void selfInitialize(ServletContext servletContext) throws ServletException {
 		prepareEmbeddedWebApplicationContext(servletContext);
-		registerWebApplicationScopes(servletContext);
+		registerApplicationScope(servletContext);
 		WebApplicationContextUtils.registerEnvironmentBeans(getBeanFactory(),
 				servletContext);
 		for (ServletContextInitializer beans : getServletContextInitializerBeans()) {
 			beans.onStartup(servletContext);
 		}
 	}
 
-	private void registerWebApplicationScopes(ServletContext servletContext) {
+	private void registerApplicationScope(ServletContext servletContext) {
+		ServletContextScope appScope = new ServletContextScope(servletContext);
+		getBeanFactory().registerScope(WebApplicationContext.SCOPE_APPLICATION, appScope);
+		// Register as ServletContext attribute, for ContextCleanupListener to detect it.
+		servletContext.setAttribute(ServletContextScope.class.getName(), appScope);
+	}
+
+	private void registerWebApplicationScopes() {
 		ExistingWebApplicationScopes existingScopes = new ExistingWebApplicationScopes(
 				getBeanFactory());
-		WebApplicationContextUtils.registerWebApplicationScopes(getBeanFactory(),
-				servletContext);
+		WebApplicationContextUtils.registerWebApplicationScopes(getBeanFactory());
 		existingScopes.restore();
 	}
 

spring-boot/src/test/java/org/springframework/boot/context/embedded/EmbeddedWebApplicationContextTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2016 the original author or authors.
+ * Copyright 2012-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -51,6 +51,7 @@
 import org.springframework.beans.factory.config.Scope;
 import org.springframework.beans.factory.support.AbstractBeanDefinition;
 import org.springframework.beans.factory.support.RootBeanDefinition;
+import org.springframework.boot.testutil.InternalOutputCapture;
 import org.springframework.boot.web.servlet.DelegatingFilterProxyRegistrationBean;
 import org.springframework.boot.web.servlet.FilterRegistrationBean;
 import org.springframework.boot.web.servlet.ServletContextInitializer;
@@ -96,6 +97,9 @@ public class EmbeddedWebApplicationContextTests {
 	@Rule
 	public ExpectedException thrown = ExpectedException.none();
 
+	@Rule
+	public InternalOutputCapture output = new InternalOutputCapture();
+
 	private EmbeddedWebApplicationContext context;
 
 	@Captor
@@ -489,6 +493,7 @@ public void doesNotReplaceExistingScopes() throws Exception {
 	@Test
 	public void servletRequestCanBeInjectedEarly() throws Exception {
 		// gh-14990
+		int initialOutputLength = this.output.toString().length();
 		addEmbeddedServletContainerFactoryBean();
 		RootBeanDefinition beanDefinition = new RootBeanDefinition(
 				WithAutowiredServletRequest.class);
@@ -507,6 +512,16 @@ public void postProcessBeanFactory(
 
 		});
 		this.context.refresh();
+		String output = this.output.toString().substring(initialOutputLength);
+		assertThat(output).doesNotContain("Replacing scope");
+	}
+
+	@Test
+	public void webApplicationScopeIsRegistered() throws Exception {
+		addEmbeddedServletContainerFactoryBean();
+		this.context.refresh();
+		assertThat(this.context.getBeanFactory()
+				.getRegisteredScope(WebApplicationContext.SCOPE_APPLICATION)).isNotNull();
 	}
 
 	private void addEmbeddedServletContainerFactoryBean() {
@@ -575,4 +590,18 @@ public ServletRequest getRequest() {
 
 	}
 
+	protected static class WithAutowiredServletContext {
+
+		private final ServletContext context;
+
+		public WithAutowiredServletContext(ServletContext context) {
+			this.context = context;
+		}
+
+		public ServletContext getContext() {
+			return this.context;
+		}
+
+	}
+
 }