refactor:let the configuration SDK context stand alone. (Tencent#1383)

Co-authored-by: Haotian Zhang <[email protected]>

.github/PULL_REQUEST_TEMPLATE.md

@@ -28,6 +28,6 @@ closes #
 
 - [ ] Will pull request to branch of 2023.
 - [ ] Will pull request to branch of 2022.
-- [ ] Will pull request to branch of 2020.
 - [ ] Will pull request to branch of 2021.
+- [ ] Will pull request to branch of 2020.
 - [ ] Will pull request to branch of hoxton.

CHANGELOG.md

@@ -11,3 +11,4 @@
 - [fix: fix the lossless provider override in multiple registries scenario](https://github.com/Tencent/spring-cloud-tencent/pull/1380)
 - [fix:fix nearby router properties loading bug.](https://github.com/Tencent/spring-cloud-tencent/pull/1381)
 - [fix: fix grammar issues for lane router example & optimize the gateway dependency](https://github.com/Tencent/spring-cloud-tencent/pull/1382)
+- [refactor:let the configuration SDK context stand alone.](https://github.com/Tencent/spring-cloud-tencent/pull/1383)

spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/ConfigurationModifier.java

@@ -13,7 +13,6 @@
  * 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 com.tencent.cloud.polaris.config;
@@ -26,7 +25,7 @@
 import com.tencent.cloud.common.util.AddressUtils;
 import com.tencent.cloud.polaris.config.config.PolarisConfigProperties;
 import com.tencent.cloud.polaris.config.config.PolarisCryptoConfigProperties;
-import com.tencent.cloud.polaris.context.PolarisConfigModifier;
+import com.tencent.cloud.polaris.context.PolarisConfigurationConfigModifier;
 import com.tencent.cloud.polaris.context.config.PolarisContextProperties;
 import com.tencent.polaris.factory.config.ConfigurationImpl;
 import com.tencent.polaris.factory.config.configuration.ConfigFilterConfigImpl;
@@ -42,7 +41,7 @@
  *
  * @author lepdou 2022-03-10
  */
-public class ConfigurationModifier implements PolarisConfigModifier {
+public class ConfigurationModifier implements PolarisConfigurationConfigModifier {
 	private static final Logger LOGGER = LoggerFactory.getLogger(ConfigurationModifier.class);
 
 	private static final String DATA_SOURCE_POLARIS = "polaris";

spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/PolarisConfigAutoConfiguration.java

@@ -21,7 +21,6 @@
 import com.tencent.cloud.polaris.config.adapter.AffectedConfigurationPropertiesRebinder;
 import com.tencent.cloud.polaris.config.adapter.PolarisConfigPropertyRefresher;
 import com.tencent.cloud.polaris.config.adapter.PolarisConfigRefreshScopeAnnotationDetector;
-import com.tencent.cloud.polaris.config.adapter.PolarisPropertySourceManager;
 import com.tencent.cloud.polaris.config.adapter.PolarisRefreshAffectedContextRefresher;
 import com.tencent.cloud.polaris.config.adapter.PolarisRefreshEntireContextRefresher;
 import com.tencent.cloud.polaris.config.annotation.PolarisConfigAnnotationProcessor;
@@ -78,9 +77,9 @@ public ConfigurationPropertiesRebinder affectedConfigurationPropertiesRebinder(
 
 	@Bean
 	@ConditionalOnMissingBean(search = SearchStrategy.CURRENT)
-	public PolarisConfigPropertyRefresher polarisRefreshContextPropertySourceAutoRefresher(PolarisConfigProperties polarisConfigProperties,
-			PolarisPropertySourceManager polarisPropertySourceManager, ContextRefresher contextRefresher) {
-		return new PolarisRefreshEntireContextRefresher(polarisConfigProperties, polarisPropertySourceManager, contextRefresher);
+	public PolarisConfigPropertyRefresher polarisRefreshContextPropertySourceAutoRefresher(
+			PolarisConfigProperties polarisConfigProperties, ContextRefresher contextRefresher) {
+		return new PolarisRefreshEntireContextRefresher(polarisConfigProperties, contextRefresher);
 	}
 
 	@Configuration(proxyBeanMethods = false)
@@ -104,10 +103,10 @@ public SpringValueProcessor springValueProcessor(PlaceholderHelper placeholderHe
 		}
 
 		@Bean
-		public PolarisConfigPropertyRefresher polarisReflectPropertySourceAutoRefresher(PolarisConfigProperties polarisConfigProperties,
-				PolarisPropertySourceManager polarisPropertySourceManager, SpringValueRegistry springValueRegistry,
+		public PolarisConfigPropertyRefresher polarisReflectPropertySourceAutoRefresher(
+				PolarisConfigProperties polarisConfigProperties, SpringValueRegistry springValueRegistry,
 				PlaceholderHelper placeholderHelper) {
-			return new PolarisRefreshAffectedContextRefresher(polarisConfigProperties, polarisPropertySourceManager,
+			return new PolarisRefreshAffectedContextRefresher(polarisConfigProperties,
 					springValueRegistry, placeholderHelper);
 		}
 

spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/PolarisConfigBootstrapAutoConfiguration.java

@@ -20,7 +20,6 @@
 
 import com.tencent.cloud.polaris.config.adapter.AffectedConfigurationPropertiesRebinder;
 import com.tencent.cloud.polaris.config.adapter.PolarisConfigFileLocator;
-import com.tencent.cloud.polaris.config.adapter.PolarisPropertySourceManager;
 import com.tencent.cloud.polaris.config.condition.ConditionalOnReflectRefreshType;
 import com.tencent.cloud.polaris.config.config.PolarisConfigProperties;
 import com.tencent.cloud.polaris.config.config.PolarisCryptoConfigProperties;
@@ -59,16 +58,10 @@ public PolarisCryptoConfigProperties polarisCryptoConfigProperties() {
 		return new PolarisCryptoConfigProperties();
 	}
 
-	@Bean
-	@ConditionalOnMissingBean
-	public PolarisPropertySourceManager polarisPropertySourceManager() {
-		return new PolarisPropertySourceManager();
-	}
-
 	@Bean
 	@ConditionalOnConnectRemoteServerEnabled
 	public ConfigFileService configFileService(PolarisSDKContextManager polarisSDKContextManager) {
-		return ConfigFileServiceFactory.createConfigFileService(polarisSDKContextManager.getSDKContext());
+		return ConfigFileServiceFactory.createConfigFileService(polarisSDKContextManager.getConfigSDKContext());
 	}
 
 	@Bean
@@ -77,11 +70,9 @@ public PolarisConfigFileLocator polarisConfigFileLocator(
 			PolarisConfigProperties polarisConfigProperties,
 			PolarisContextProperties polarisContextProperties,
 			ConfigFileService configFileService,
-			PolarisPropertySourceManager polarisPropertySourceManager,
 			Environment environment) {
 		return new PolarisConfigFileLocator(polarisConfigProperties,
-				polarisContextProperties, configFileService,
-				polarisPropertySourceManager, environment);
+				polarisContextProperties, configFileService, environment);
 	}
 
 	@Bean

spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigCustomExtensionLayer.java

@@ -31,8 +31,9 @@
 public interface PolarisConfigCustomExtensionLayer {
 	void initRegisterConfig(PolarisConfigPropertyAutoRefresher polarisConfigPropertyAutoRefresher);
 
-	void initConfigFiles(Environment environment, CompositePropertySource compositePropertySource, PolarisPropertySourceManager polarisPropertySourceManager, ConfigFileService configFileService);
+	void initConfigFiles(Environment environment, CompositePropertySource compositePropertySource, ConfigFileService configFileService);
 
 	void executeAfterLocateConfigReturning(CompositePropertySource compositePropertySource);
+
 	boolean executeRegisterPublishChangeListener(PolarisPropertySource polarisPropertySource);
 }

spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigFileLocator.java

@@ -64,17 +64,15 @@ public class PolarisConfigFileLocator implements PropertySourceLocator {
 
 	private final ConfigFileService configFileService;
 
-	private final PolarisPropertySourceManager polarisPropertySourceManager;
-
 	private final Environment environment;
 	// this class provides customized logic for some customers to configure special business group files
 	private final PolarisConfigCustomExtensionLayer polarisConfigCustomExtensionLayer = PolarisServiceLoaderUtil.getPolarisConfigCustomExtensionLayer();
 
-	public PolarisConfigFileLocator(PolarisConfigProperties polarisConfigProperties, PolarisContextProperties polarisContextProperties, ConfigFileService configFileService, PolarisPropertySourceManager polarisPropertySourceManager, Environment environment) {
+	public PolarisConfigFileLocator(PolarisConfigProperties polarisConfigProperties,
+			PolarisContextProperties polarisContextProperties, ConfigFileService configFileService, Environment environment) {
 		this.polarisConfigProperties = polarisConfigProperties;
 		this.polarisContextProperties = polarisContextProperties;
 		this.configFileService = configFileService;
-		this.polarisPropertySourceManager = polarisPropertySourceManager;
 		this.environment = environment;
 	}
 
@@ -104,7 +102,7 @@ private void initCustomPolarisConfigExtensionFiles(CompositePropertySource compo
 			LOGGER.debug("[SCT Config] PolarisConfigCustomExtensionLayer is not init, ignore the following execution steps");
 			return;
 		}
-		polarisConfigCustomExtensionLayer.initConfigFiles(environment, compositePropertySource, polarisPropertySourceManager, configFileService);
+		polarisConfigCustomExtensionLayer.initConfigFiles(environment, compositePropertySource, configFileService);
 	}
 
 	private void afterLocatePolarisConfigExtension(CompositePropertySource compositePropertySource) {
@@ -123,7 +121,7 @@ private void initInternalConfigFiles(CompositePropertySource compositePropertySo
 
 			compositePropertySource.addPropertySource(polarisPropertySource);
 
-			polarisPropertySourceManager.addPropertySource(polarisPropertySource);
+			PolarisPropertySourceManager.addPropertySource(polarisPropertySource);
 
 			LOGGER.info("[SCT Config] Load and inject polaris config file. file = {}", configFile);
 		}
@@ -206,7 +204,7 @@ private void initCustomPolarisConfigFiles(CompositePropertySource compositePrope
 
 				compositePropertySource.addPropertySource(polarisPropertySource);
 
-				polarisPropertySourceManager.addPropertySource(polarisPropertySource);
+				PolarisPropertySourceManager.addPropertySource(polarisPropertySource);
 
 				LOGGER.info("[SCT Config] Load and inject polaris config file success. namespace = {}, group = {}, fileName = {}", namespace, group, fileName);
 			}

spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigPropertyAutoRefresher.java

@@ -46,16 +46,13 @@ public abstract class PolarisConfigPropertyAutoRefresher implements ApplicationL
 
 	private final PolarisConfigProperties polarisConfigProperties;
 
-	private final PolarisPropertySourceManager polarisPropertySourceManager;
-
 	private final AtomicBoolean registered = new AtomicBoolean(false);
 
 	// this class provides customized logic for some customers to configure special business group files
 	private final PolarisConfigCustomExtensionLayer polarisConfigCustomExtensionLayer = PolarisServiceLoaderUtil.getPolarisConfigCustomExtensionLayer();
 
-	public PolarisConfigPropertyAutoRefresher(PolarisConfigProperties polarisConfigProperties, PolarisPropertySourceManager polarisPropertySourceManager) {
+	public PolarisConfigPropertyAutoRefresher(PolarisConfigProperties polarisConfigProperties) {
 		this.polarisConfigProperties = polarisConfigProperties;
-		this.polarisPropertySourceManager = polarisPropertySourceManager;
 	}
 
 	@Override
@@ -68,7 +65,7 @@ private void registerPolarisConfigPublishEvent() {
 			return;
 		}
 
-		List<PolarisPropertySource> polarisPropertySources = polarisPropertySourceManager.getAllPropertySources();
+		List<PolarisPropertySource> polarisPropertySources = PolarisPropertySourceManager.getAllPropertySources();
 		if (CollectionUtils.isEmpty(polarisPropertySources)) {
 			return;
 		}
@@ -144,4 +141,11 @@ private void customRegisterPolarisConfigPublishChangeListener(PolarisPropertySou
 		}
 		polarisConfigCustomExtensionLayer.executeRegisterPublishChangeListener(polarisPropertySource);
 	}
+
+	/**
+	 * Just for junit test.
+	 */
+	public void setRegistered(boolean registered) {
+		this.registered.set(registered);
+	}
 }

spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisPropertySourceManager.java

@@ -28,15 +28,25 @@
  *
  * @author lepdou 2022-03-28
  */
-public class PolarisPropertySourceManager {
+public final class PolarisPropertySourceManager {
 
-	private final Map<String, PolarisPropertySource> polarisPropertySources = new ConcurrentHashMap<>();
+	private static final Map<String, PolarisPropertySource> polarisPropertySources = new ConcurrentHashMap<>();
 
-	public void addPropertySource(PolarisPropertySource polarisPropertySource) {
-		polarisPropertySources.putIfAbsent(polarisPropertySource.getPropertySourceName(), polarisPropertySource);
+	private PolarisPropertySourceManager() {
 	}
 
-	public List<PolarisPropertySource> getAllPropertySources() {
+	public static void addPropertySource(PolarisPropertySource polarisPropertySource) {
+		polarisPropertySources.put(polarisPropertySource.getPropertySourceName(), polarisPropertySource);
+	}
+
+	public static List<PolarisPropertySource> getAllPropertySources() {
 		return new ArrayList<>(polarisPropertySources.values());
 	}
+
+	/**
+	 * Just for test.
+	 */
+	public static void clearPropertySources() {
+		polarisPropertySources.clear();
+	}
 }

spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisRefreshAffectedContextRefresher.java

@@ -59,9 +59,8 @@ public class PolarisRefreshAffectedContextRefresher extends PolarisConfigPropert
 	private TypeConverter typeConverter;
 
 	public PolarisRefreshAffectedContextRefresher(PolarisConfigProperties polarisConfigProperties,
-			PolarisPropertySourceManager polarisPropertySourceManager, SpringValueRegistry springValueRegistry,
-			PlaceholderHelper placeholderHelper) {
-		super(polarisConfigProperties, polarisPropertySourceManager);
+			SpringValueRegistry springValueRegistry, PlaceholderHelper placeholderHelper) {
+		super(polarisConfigProperties);
 		this.springValueRegistry = springValueRegistry;
 		this.placeholderHelper = placeholderHelper;
 	}

spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisRefreshEntireContextRefresher.java

@@ -35,9 +35,8 @@ public class PolarisRefreshEntireContextRefresher extends PolarisConfigPropertyA
 	private final ContextRefresher contextRefresher;
 
 	public PolarisRefreshEntireContextRefresher(PolarisConfigProperties polarisConfigProperties,
-			PolarisPropertySourceManager polarisPropertySourceManager,
 			ContextRefresher contextRefresher) {
-		super(polarisConfigProperties, polarisPropertySourceManager);
+		super(polarisConfigProperties);
 		this.contextRefresher = contextRefresher;
 	}
 

spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/endpoint/PolarisConfigEndpoint.java

@@ -37,20 +37,17 @@
 public class PolarisConfigEndpoint {
 
 	private final PolarisConfigProperties polarisConfigProperties;
-	private final PolarisPropertySourceManager polarisPropertySourceManager;
 
-	public PolarisConfigEndpoint(PolarisConfigProperties polarisConfigProperties,
-			PolarisPropertySourceManager polarisPropertySourceManager) {
+	public PolarisConfigEndpoint(PolarisConfigProperties polarisConfigProperties) {
 		this.polarisConfigProperties = polarisConfigProperties;
-		this.polarisPropertySourceManager = polarisPropertySourceManager;
 	}
 
 	@ReadOperation
 	public Map<String, Object> polarisConfig() {
 		Map<String, Object> configInfo = new HashMap<>();
 		configInfo.put("PolarisConfigProperties", polarisConfigProperties);
 
-		List<PolarisPropertySource> propertySourceList = polarisPropertySourceManager.getAllPropertySources();
+		List<PolarisPropertySource> propertySourceList = PolarisPropertySourceManager.getAllPropertySources();
 		configInfo.put("PolarisPropertySource", propertySourceList);
 
 		return configInfo;

spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/endpoint/PolarisConfigEndpointAutoConfiguration.java

@@ -18,7 +18,6 @@
 package com.tencent.cloud.polaris.config.endpoint;
 
 import com.tencent.cloud.polaris.config.ConditionalOnPolarisConfigEnabled;
-import com.tencent.cloud.polaris.config.adapter.PolarisPropertySourceManager;
 import com.tencent.cloud.polaris.config.config.PolarisConfigProperties;
 
 import org.springframework.boot.actuate.autoconfigure.endpoint.condition.ConditionalOnAvailableEndpoint;
@@ -41,8 +40,7 @@ public class PolarisConfigEndpointAutoConfiguration {
 	@Bean
 	@ConditionalOnAvailableEndpoint
 	@ConditionalOnMissingBean
-	public PolarisConfigEndpoint polarisConfigEndpoint(PolarisConfigProperties polarisConfigProperties,
-			PolarisPropertySourceManager polarisPropertySourceManager) {
-		return new PolarisConfigEndpoint(polarisConfigProperties, polarisPropertySourceManager);
+	public PolarisConfigEndpoint polarisConfigEndpoint(PolarisConfigProperties polarisConfigProperties) {
+		return new PolarisConfigEndpoint(polarisConfigProperties);
 	}
 }

spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/listener/PolarisConfigRefreshOptimizationListener.java

@@ -21,7 +21,6 @@
 import java.util.Collections;
 
 import com.tencent.cloud.polaris.config.adapter.PolarisConfigRefreshScopeAnnotationDetector;
-import com.tencent.cloud.polaris.config.adapter.PolarisPropertySourceManager;
 import com.tencent.cloud.polaris.config.adapter.PolarisRefreshEntireContextRefresher;
 import com.tencent.cloud.polaris.config.config.PolarisConfigProperties;
 import com.tencent.cloud.polaris.config.enums.RefreshType;
@@ -112,7 +111,7 @@ private void removeRelatedBeansOfReflect(ConfigurableApplicationContext applicat
 			beanFactory.removeBeanDefinition(REFLECT_REBINDER_BEAN_NAME);
 		}
 		catch (BeansException e) {
-		    // If there is a removeBean exception in this code, do not affect the main process startup. Some user usage may cause the polarisReflectPropertySourceAutoRefresher to not load, and the removeBeanDefinition will report an error
+			// If there is a removeBean exception in this code, do not affect the main process startup. Some user usage may cause the polarisReflectPropertySourceAutoRefresher to not load, and the removeBeanDefinition will report an error
 			LOGGER.debug("removeRelatedBeansOfReflect occur error:", e);
 		}
 	}
@@ -122,12 +121,10 @@ private void registerRefresherBeanOfRefreshContext(ConfigurableApplicationContex
 		AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.genericBeanDefinition().getBeanDefinition();
 		beanDefinition.setBeanClass(PolarisRefreshEntireContextRefresher.class);
 		PolarisConfigProperties polarisConfigProperties = beanFactory.getBean(PolarisConfigProperties.class);
-		PolarisPropertySourceManager polarisPropertySourceManager = beanFactory.getBean(PolarisPropertySourceManager.class);
 		ContextRefresher contextRefresher = beanFactory.getBean(ContextRefresher.class);
 		ConstructorArgumentValues constructorArgumentValues = beanDefinition.getConstructorArgumentValues();
 		constructorArgumentValues.addIndexedArgumentValue(0, polarisConfigProperties);
-		constructorArgumentValues.addIndexedArgumentValue(1, polarisPropertySourceManager);
-		constructorArgumentValues.addIndexedArgumentValue(2, contextRefresher);
+		constructorArgumentValues.addIndexedArgumentValue(1, contextRefresher);
 		beanFactory.registerBeanDefinition(REFRESH_CONTEXT_REFRESHER_BEAN_NAME, beanDefinition);
 	}
 

spring-cloud-starter-tencent-polaris-config/src/test/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigFileLocatorTest.java

@@ -29,6 +29,7 @@
 import com.tencent.cloud.polaris.context.config.PolarisContextProperties;
 import com.tencent.polaris.configuration.api.core.ConfigFileService;
 import com.tencent.polaris.configuration.api.core.ConfigKVFile;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.Mock;
@@ -57,14 +58,17 @@ public class PolarisConfigFileLocatorTest {
 	@Mock
 	private ConfigFileService configFileService;
 	@Mock
-	private PolarisPropertySourceManager polarisPropertySourceManager;
-	@Mock
 	private Environment environment;
 
+	@BeforeEach
+	public void setUp() {
+		PolarisPropertySourceManager.clearPropertySources();
+	}
+
 	@Test
 	public void testLoadApplicationPropertiesFile() {
 		PolarisConfigFileLocator locator = new PolarisConfigFileLocator(polarisConfigProperties, polarisContextProperties,
-				configFileService, polarisPropertySourceManager, environment);
+				configFileService, environment);
 
 		when(polarisContextProperties.getNamespace()).thenReturn(testNamespace);
 		when(polarisContextProperties.getService()).thenReturn(testServiceName);
@@ -99,7 +103,7 @@ public void testLoadApplicationPropertiesFile() {
 	@Test
 	public void testActiveProfileFilesPriorityBiggerThanDefault() {
 		PolarisConfigFileLocator locator = new PolarisConfigFileLocator(polarisConfigProperties, polarisContextProperties,
-				configFileService, polarisPropertySourceManager, environment);
+				configFileService, environment);
 
 		when(polarisContextProperties.getNamespace()).thenReturn(testNamespace);
 		when(polarisContextProperties.getService()).thenReturn(testServiceName);
@@ -146,7 +150,7 @@ public void testActiveProfileFilesPriorityBiggerThanDefault() {
 	@Test
 	public void testGetCustomFiles() {
 		PolarisConfigFileLocator locator = new PolarisConfigFileLocator(polarisConfigProperties, polarisContextProperties,
-				configFileService, polarisPropertySourceManager, environment);
+				configFileService, environment);
 
 		when(polarisContextProperties.getNamespace()).thenReturn(testNamespace);
 		when(polarisContextProperties.getService()).thenReturn(testServiceName);