review comments

Author: wind57

spring-cloud-kubernetes-commons/src/main/java/org/springframework/cloud/kubernetes/commons/config/Constants.java

@@ -63,6 +63,12 @@ public final class Constants {
 	 */
 	public static final String RELOAD_MODE = "spring.cloud.kubernetes.reload.mode";
 
+	/**
+	 * property set to true when there was an error reading config maps or secrets, when
+	 * generating a property source.
+	 */
+	public static final String ERROR_PROPERTY = "spring.cloud.k8s.error.reading.property.source";
+
 	private Constants() {
 	}
 

spring-cloud-kubernetes-commons/src/main/java/org/springframework/cloud/kubernetes/commons/config/LabeledSourceData.java

@@ -25,8 +25,8 @@
 import org.apache.commons.logging.LogFactory;
 
 import static org.springframework.cloud.kubernetes.commons.config.ConfigUtils.onException;
+import static org.springframework.cloud.kubernetes.commons.config.Constants.ERROR_PROPERTY;
 import static org.springframework.cloud.kubernetes.commons.config.Constants.PROPERTY_SOURCE_NAME_SEPARATOR;
-import static org.springframework.cloud.kubernetes.commons.config.SourceData.EMPTY_SOURCE_NAME_ON_ERROR;
 
 /**
  * @author wind57
@@ -41,7 +41,7 @@ public abstract class LabeledSourceData {
 	public final SourceData compute(Map<String, String> labels, ConfigUtils.Prefix prefix, String target,
 			boolean profileSources, boolean failFast, String namespace, String[] activeProfiles) {
 
-		MultipleSourcesContainer data;
+		MultipleSourcesContainer data = MultipleSourcesContainer.empty();
 
 		try {
 			Set<String> profiles = Set.of();
@@ -81,7 +81,7 @@ public final SourceData compute(Map<String, String> labels, ConfigUtils.Prefix p
 		catch (Exception e) {
 			LOG.warn("failure in reading labeled sources");
 			onException(failFast, e);
-			return SourceData.emptyRecord(EMPTY_SOURCE_NAME_ON_ERROR);
+			data = new MultipleSourcesContainer(data.names(), Map.of(ERROR_PROPERTY, "true"));
 		}
 
 		String names = data.names().stream().sorted().collect(Collectors.joining(PROPERTY_SOURCE_NAME_SEPARATOR));

spring-cloud-kubernetes-commons/src/main/java/org/springframework/cloud/kubernetes/commons/config/NamedSourceData.java

@@ -17,14 +17,15 @@
 package org.springframework.cloud.kubernetes.commons.config;
 
 import java.util.LinkedHashSet;
+import java.util.Map;
 import java.util.stream.Collectors;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
 import static org.springframework.cloud.kubernetes.commons.config.ConfigUtils.onException;
+import static org.springframework.cloud.kubernetes.commons.config.Constants.ERROR_PROPERTY;
 import static org.springframework.cloud.kubernetes.commons.config.Constants.PROPERTY_SOURCE_NAME_SEPARATOR;
-import static org.springframework.cloud.kubernetes.commons.config.SourceData.EMPTY_SOURCE_NAME_ON_ERROR;
 
 /**
  * @author wind57
@@ -43,7 +44,7 @@ public final SourceData compute(String sourceName, ConfigUtils.Prefix prefix, St
 		// first comes non-profile based source
 		sourceNames.add(sourceName);
 
-		MultipleSourcesContainer data;
+		MultipleSourcesContainer data = MultipleSourcesContainer.empty();
 
 		try {
 			if (profileSources) {
@@ -72,7 +73,7 @@ public final SourceData compute(String sourceName, ConfigUtils.Prefix prefix, St
 		catch (Exception e) {
 			LOG.warn("failure in reading named sources");
 			onException(failFast, e);
-			return SourceData.emptyRecord(EMPTY_SOURCE_NAME_ON_ERROR);
+			data = new MultipleSourcesContainer(data.names(), Map.of(ERROR_PROPERTY, "true"));
 		}
 
 		String names = data.names().stream().sorted().collect(Collectors.joining(PROPERTY_SOURCE_NAME_SEPARATOR));

spring-cloud-kubernetes-commons/src/main/java/org/springframework/cloud/kubernetes/commons/config/SourceData.java

@@ -26,12 +26,6 @@
  */
 public record SourceData(String sourceName, Map<String, Object> sourceData) {
 
-	/**
-	 * source name that is generated when there is an error reading the underlying
-	 * configmap(s) or secret(s).
-	 */
-	public static final String EMPTY_SOURCE_NAME_ON_ERROR = "source-generate-on-error";
-
 	public static SourceData emptyRecord(String sourceName) {
 		return new SourceData(sourceName, Map.of());
 	}

spring-cloud-kubernetes-commons/src/main/java/org/springframework/cloud/kubernetes/commons/config/reload/ConfigReloadUtil.java

@@ -27,13 +27,14 @@
 import org.springframework.cloud.bootstrap.config.BootstrapPropertySource;
 import org.springframework.cloud.bootstrap.config.PropertySourceLocator;
 import org.springframework.cloud.kubernetes.commons.config.MountConfigMapPropertySource;
-import org.springframework.cloud.kubernetes.commons.config.SourceData;
 import org.springframework.core.env.CompositePropertySource;
 import org.springframework.core.env.ConfigurableEnvironment;
 import org.springframework.core.env.MapPropertySource;
 import org.springframework.core.env.PropertySource;
 import org.springframework.core.log.LogAccessor;
 
+import static org.springframework.cloud.kubernetes.commons.config.Constants.ERROR_PROPERTY;
+
 /**
  * @author wind57
  */
@@ -164,7 +165,7 @@ else if (propertySource instanceof CompositePropertySource source) {
 
 	static boolean changed(List<? extends MapPropertySource> k8sSources, List<? extends MapPropertySource> appSources) {
 
-		if (k8sSources.stream().anyMatch(source -> source.getName().equals(SourceData.EMPTY_SOURCE_NAME_ON_ERROR))) {
+		if (k8sSources.stream().anyMatch(source -> "true".equals(source.getProperty(ERROR_PROPERTY)))) {
 			LOG.info(() -> "there was an error while reading config maps/secrets, no reload will happen");
 			return false;
 		}

spring-cloud-kubernetes-commons/src/test/java/org/springframework/cloud/kubernetes/commons/config/reload/ConfigReloadUtilTests.java

@@ -26,8 +26,8 @@
 import org.junit.jupiter.api.Test;
 
 import org.springframework.cloud.bootstrap.config.BootstrapPropertySource;
+import org.springframework.cloud.kubernetes.commons.config.Constants;
 import org.springframework.cloud.kubernetes.commons.config.MountConfigMapPropertySource;
-import org.springframework.cloud.kubernetes.commons.config.SourceData;
 import org.springframework.core.env.CompositePropertySource;
 import org.springframework.core.env.EnumerablePropertySource;
 import org.springframework.core.env.MapPropertySource;
@@ -154,9 +154,8 @@ public Object getProperty(String name) {
 	@Test
 	void testEmptySourceNameOnError() {
 		Object value = new Object();
-		Map<String, Object> rightMap = new HashMap<>();
-		rightMap.put("key", value);
-		MapPropertySource left = new MapPropertySource(SourceData.EMPTY_SOURCE_NAME_ON_ERROR, Map.of());
+		Map<String, Object> rightMap = Map.of("key", value);
+		MapPropertySource left = new MapPropertySource("on-error", Map.of(Constants.ERROR_PROPERTY, "true"));
 		MapPropertySource right = new MapPropertySource("right", rightMap);
 		boolean changed = ConfigReloadUtil.changed(List.of(left), List.of(right));
 		assertThat(changed).isFalse();