From 1def245a2cb7f5aa520531059956c3c3794625d7 Mon Sep 17 00:00:00 2001
From: Phillip Webb <pwebb@vmware.com>
Date: Mon, 25 Jan 2021 23:06:39 -0800
Subject: [PATCH] Support DeferredLogFactory injection

Update `ConfigDataLoader` and `ConfigDataLocationResolver` to support
`DeferredLogFactory` injection.

Closes gh-24988
---
 .../boot/context/config/ConfigDataLoader.java |  6 ++--
 .../context/config/ConfigDataLoaders.java     |  3 +-
 .../config/ConfigDataLocationResolver.java    |  6 ++--
 .../config/ConfigDataLocationResolvers.java   |  1 +
 .../config/ConfigDataLoadersTests.java        | 36 ++++++++++++++++++-
 .../ConfigDataLocationResolversTests.java     | 35 +++++++++++++++++-
 6 files changed, 80 insertions(+), 7 deletions(-)

diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataLoader.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataLoader.java
index 22e5d3a7549..eaea00ca3a2 100644
--- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataLoader.java
+++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataLoader.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-2021 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.
@@ -23,6 +23,7 @@ import org.apache.commons.logging.Log;
 import org.springframework.boot.BootstrapContext;
 import org.springframework.boot.BootstrapRegistry;
 import org.springframework.boot.ConfigurableBootstrapContext;
+import org.springframework.boot.logging.DeferredLogFactory;
 
 /**
  * Strategy class that can be used used to load {@link ConfigData} for a given
@@ -30,7 +31,8 @@ import org.springframework.boot.ConfigurableBootstrapContext;
  * {@code spring.factories} entries. The following constructor parameter types are
  * supported:
  * <ul>
- * <li>{@link Log} - if the resolver needs deferred logging</li>
+ * <li>{@link Log} or {@link DeferredLogFactory} - if the loader needs deferred
+ * logging</li>
  * <li>{@link ConfigurableBootstrapContext} - A bootstrap context that can be used to
  * store objects that may be expensive to create, or need to be shared
  * ({@link BootstrapContext} or {@link BootstrapRegistry} may also be used).</li>
diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataLoaders.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataLoaders.java
index d2c1c681e20..86ef04d5f23 100644
--- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataLoaders.java
+++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataLoaders.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-2021 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.
@@ -68,6 +68,7 @@ class ConfigDataLoaders {
 		Instantiator<ConfigDataLoader<?>> instantiator = new Instantiator<>(ConfigDataLoader.class,
 				(availableParameters) -> {
 					availableParameters.add(Log.class, logFactory::getLog);
+					availableParameters.add(DeferredLogFactory.class, logFactory);
 					availableParameters.add(ConfigurableBootstrapContext.class, bootstrapContext);
 					availableParameters.add(BootstrapContext.class, bootstrapContext);
 					availableParameters.add(BootstrapRegistry.class, bootstrapContext);
diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataLocationResolver.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataLocationResolver.java
index f51ae7c50cd..08bfa76821b 100644
--- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataLocationResolver.java
+++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataLocationResolver.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-2021 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.
@@ -25,6 +25,7 @@ import org.springframework.boot.BootstrapContext;
 import org.springframework.boot.BootstrapRegistry;
 import org.springframework.boot.ConfigurableBootstrapContext;
 import org.springframework.boot.context.properties.bind.Binder;
+import org.springframework.boot.logging.DeferredLogFactory;
 import org.springframework.core.Ordered;
 import org.springframework.core.annotation.Order;
 import org.springframework.core.env.Environment;
@@ -36,7 +37,8 @@ import org.springframework.core.io.ResourceLoader;
  * {@code spring.factories} entries. The following constructor parameter types are
  * supported:
  * <ul>
- * <li>{@link Log} - if the resolver needs deferred logging</li>
+ * <li>{@link Log} or {@link DeferredLogFactory} - if the resolver needs deferred
+ * logging</li>
  * <li>{@link Binder} - if the resolver needs to obtain values from the initial
  * {@link Environment}</li>
  * <li>{@link ResourceLoader} - if the resolver needs a resource loader</li>
diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataLocationResolvers.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataLocationResolvers.java
index 3951c07c756..60f5ce9269a 100644
--- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataLocationResolvers.java
+++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigDataLocationResolvers.java
@@ -70,6 +70,7 @@ class ConfigDataLocationResolvers {
 		Instantiator<ConfigDataLocationResolver<?>> instantiator = new Instantiator<>(ConfigDataLocationResolver.class,
 				(availableParameters) -> {
 					availableParameters.add(Log.class, logFactory::getLog);
+					availableParameters.add(DeferredLogFactory.class, logFactory);
 					availableParameters.add(Binder.class, binder);
 					availableParameters.add(ResourceLoader.class, resourceLoader);
 					availableParameters.add(ConfigurableBootstrapContext.class, bootstrapContext);
diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigDataLoadersTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigDataLoadersTests.java
index ca0aa74b381..df7b9655bae 100644
--- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigDataLoadersTests.java
+++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigDataLoadersTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-2021 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.
@@ -57,6 +57,20 @@ class ConfigDataLoadersTests {
 				Arrays.asList(LoggingConfigDataLoader.class.getName()));
 	}
 
+	@Test
+	void createWhenLoaderHasDeferredLogFactoryParameterInjectsDeferredLogFactory() {
+		ConfigDataLoaders loaders = new ConfigDataLoaders(this.logFactory, this.bootstrapContext,
+				Arrays.asList(DeferredLogFactoryConfigDataLoader.class.getName()));
+		assertThat(loaders).extracting("loaders").asList()
+				.satisfies(this::containsValidDeferredLogFactoryConfigDataLoader);
+	}
+
+	private void containsValidDeferredLogFactoryConfigDataLoader(List<?> list) {
+		assertThat(list).hasSize(1);
+		DeferredLogFactoryConfigDataLoader loader = (DeferredLogFactoryConfigDataLoader) list.get(0);
+		assertThat(loader.getLogFactory()).isSameAs(this.logFactory);
+	}
+
 	@Test
 	void createWhenLoaderHasBootstrapParametersInjectsBootstrapContext() {
 		new ConfigDataLoaders(this.logFactory, this.bootstrapContext,
@@ -144,6 +158,26 @@ class ConfigDataLoadersTests {
 
 	}
 
+	static class DeferredLogFactoryConfigDataLoader implements ConfigDataLoader<ConfigDataResource> {
+
+		private final DeferredLogFactory logFactory;
+
+		DeferredLogFactoryConfigDataLoader(DeferredLogFactory logFactory) {
+			assertThat(logFactory).isNotNull();
+			this.logFactory = logFactory;
+		}
+
+		@Override
+		public ConfigData load(ConfigDataLoaderContext context, ConfigDataResource resource) throws IOException {
+			throw new AssertionError("Unexpected call");
+		}
+
+		DeferredLogFactory getLogFactory() {
+			return this.logFactory;
+		}
+
+	}
+
 	static class BootstrappingConfigDataLoader implements ConfigDataLoader<ConfigDataResource> {
 
 		BootstrappingConfigDataLoader(ConfigurableBootstrapContext configurableBootstrapContext,
diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigDataLocationResolversTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigDataLocationResolversTests.java
index 784e723c159..abc12408f4f 100644
--- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigDataLocationResolversTests.java
+++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigDataLocationResolversTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-2021 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.
@@ -23,6 +23,7 @@ import java.util.Collections;
 import java.util.List;
 import java.util.function.Supplier;
 
+import org.apache.commons.logging.Log;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.Mock;
@@ -68,6 +69,17 @@ class ConfigDataLocationResolversTests {
 
 	private ResourceLoader resourceLoader = new DefaultResourceLoader();
 
+	@Test
+	void createWhenInjectingLogAndDeferredLogFactoryCreatesResolver() {
+		ConfigDataLocationResolvers resolvers = new ConfigDataLocationResolvers(this.logFactory, this.bootstrapContext,
+				this.binder, this.resourceLoader, Collections.singletonList(TestLogResolver.class.getName()));
+		assertThat(resolvers.getResolvers()).hasSize(1);
+		assertThat(resolvers.getResolvers().get(0)).isExactlyInstanceOf(TestLogResolver.class);
+		TestLogResolver resolver = (TestLogResolver) resolvers.getResolvers().get(0);
+		assertThat(resolver.getDeferredLogFactory()).isSameAs(this.logFactory);
+		assertThat(resolver.getLog()).isNotNull();
+	}
+
 	@Test
 	void createWhenInjectingBinderCreatesResolver() {
 		ConfigDataLocationResolvers resolvers = new ConfigDataLocationResolvers(this.logFactory, this.bootstrapContext,
@@ -180,6 +192,27 @@ class ConfigDataLocationResolversTests {
 
 	}
 
+	static class TestLogResolver extends TestResolver {
+
+		private final DeferredLogFactory deferredLogFactory;
+
+		private final Log log;
+
+		TestLogResolver(DeferredLogFactory deferredLogFactory, Log log) {
+			this.deferredLogFactory = deferredLogFactory;
+			this.log = log;
+		}
+
+		DeferredLogFactory getDeferredLogFactory() {
+			return this.deferredLogFactory;
+		}
+
+		Log getLog() {
+			return this.log;
+		}
+
+	}
+
 	static class TestBoundResolver extends TestResolver {
 
 		private final Binder binder;