feat:upgrade nearby router and add namespace nearby router. (#1374)

Co-authored-by: Haotian Zhang <skyebefreeman@qq.com>

CHANGELOG.md

@@ -25,4 +25,5 @@
 - [fix: memory cost too many when using wildcard feign calls](https://github.com/Tencent/spring-cloud-tencent/pull/1359)
 - [feat:support consul config data. ](https://github.com/Tencent/spring-cloud-tencent/pull/1365)
 - [feat: support otel trace](https://github.com/Tencent/spring-cloud-tencent/pull/1366)
-- [feat:support TSF router.](https://github.com/Tencent/spring-cloud-tencent/pull/1372)
+- [feat:support TSF router.](https://github.com/Tencent/spring-cloud-tencent/pull/1372)
+- [feat:upgrade nearby router and add namespace nearby router.](https://github.com/Tencent/spring-cloud-tencent/pull/1374)

spring-cloud-starter-tencent-polaris-circuitbreaker/pom.xml

@@ -57,6 +57,10 @@
 					<groupId>com.tencent.polaris</groupId>
 					<artifactId>router-nearby</artifactId>
 				</exclusion>
+				<exclusion>
+					<groupId>com.tencent.polaris</groupId>
+					<artifactId>router-namespace</artifactId>
+				</exclusion>
 				<exclusion>
 					<groupId>com.tencent.polaris</groupId>
 					<artifactId>router-metadata</artifactId>

spring-cloud-starter-tencent-polaris-config/pom.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-		 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		 xmlns="http://maven.apache.org/POM/4.0.0"
 		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<parent>
 		<artifactId>spring-cloud-tencent</artifactId>
@@ -34,6 +34,10 @@
 					<groupId>com.tencent.polaris</groupId>
 					<artifactId>router-nearby</artifactId>
 				</exclusion>
+				<exclusion>
+					<groupId>com.tencent.polaris</groupId>
+					<artifactId>router-namespace</artifactId>
+				</exclusion>
 				<exclusion>
 					<groupId>com.tencent.polaris</groupId>
 					<artifactId>router-metadata</artifactId>

spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/registry/PolarisServiceRegistry.java

@@ -146,8 +146,9 @@ public void register(PolarisRegistration registration) {
 				heartbeat(heartbeatRequest);
 			}
 			registration.setInstanceId(instanceRegisterResponse.getInstanceId());
-			LOGGER.info("polaris registry, {} {} {} {}:{} {} register finished", polarisDiscoveryProperties.getNamespace(),
+			LOGGER.info("polaris registry, {} {} {} {}:{} {} {} {} {} register finished", polarisDiscoveryProperties.getNamespace(),
 					registration.getServiceId(), registration.getInstanceId(), registration.getHost(), registration.getPort(),
+					staticMetadataManager.getRegion(), staticMetadataManager.getZone(), staticMetadataManager.getCampus(),
 					staticMetadataManager.getMergedStaticMetadata());
 			if (Objects.nonNull(polarisStatProperties) && polarisStatProperties.isEnabled()) {
 				try {

spring-cloud-starter-tencent-polaris-ratelimit/pom.xml

@@ -39,6 +39,10 @@
 					<groupId>com.tencent.polaris</groupId>
 					<artifactId>router-nearby</artifactId>
 				</exclusion>
+				<exclusion>
+					<groupId>com.tencent.polaris</groupId>
+					<artifactId>router-namespace</artifactId>
+				</exclusion>
 				<exclusion>
 					<groupId>com.tencent.polaris</groupId>
 					<artifactId>router-canary</artifactId>

spring-cloud-starter-tencent-polaris-router/pom.xml

@@ -44,6 +44,10 @@
 			<groupId>com.tencent.polaris</groupId>
 			<artifactId>router-nearby</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>com.tencent.polaris</groupId>
+			<artifactId>router-namespace</artifactId>
+		</dependency>
 		<!-- Polaris dependencies end -->
 
 		<dependency>

spring-cloud-starter-tencent-polaris-router/src/main/java/com/tencent/cloud/polaris/router/RouterConfigModifier.java

@@ -22,10 +22,10 @@
 import com.tencent.cloud.polaris.context.PolarisConfigModifier;
 import com.tencent.cloud.polaris.router.config.properties.PolarisNearByRouterProperties;
 import com.tencent.polaris.api.config.consumer.ServiceRouterConfig;
-import com.tencent.polaris.api.plugin.route.LocationLevel;
 import com.tencent.polaris.factory.config.ConfigurationImpl;
 import com.tencent.polaris.plugins.router.healthy.RecoverRouterConfig;
 import com.tencent.polaris.plugins.router.nearby.NearbyRouterConfig;
+import com.tencent.polaris.specification.api.v1.traffic.manage.RoutingProto;
 import org.apache.commons.lang.StringUtils;
 
 /**
@@ -53,7 +53,8 @@ public void modify(ConfigurationImpl configuration) {
 				.setPluginConfig(ServiceRouterConfig.DEFAULT_ROUTER_RECOVER, recoverRouterConfig);
 
 		if (StringUtils.isNotBlank(polarisNearByRouterProperties.getMatchLevel())) {
-			LocationLevel locationLevel = LocationLevel.valueOf(polarisNearByRouterProperties.getMatchLevel());
+			RoutingProto.NearbyRoutingConfig.LocationLevel locationLevel =
+					RoutingProto.NearbyRoutingConfig.LocationLevel.valueOf(StringUtils.upperCase(polarisNearByRouterProperties.getMatchLevel()));
 			NearbyRouterConfig nearbyRouterConfig = configuration.getConsumer().getServiceRouter().getPluginConfig(
 					ServiceRouterConfig.DEFAULT_ROUTER_NEARBY, NearbyRouterConfig.class);
 			nearbyRouterConfig.setMatchLevel(locationLevel);

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

@@ -23,9 +23,11 @@
 import java.util.List;
 
 import com.tencent.cloud.polaris.router.config.properties.PolarisMetadataRouterProperties;
+import com.tencent.cloud.polaris.router.config.properties.PolarisNamespaceRouterProperties;
 import com.tencent.cloud.polaris.router.config.properties.PolarisNearByRouterProperties;
 import com.tencent.cloud.polaris.router.config.properties.PolarisRuleBasedRouterProperties;
 import com.tencent.cloud.polaris.router.interceptor.MetadataRouterRequestInterceptor;
+import com.tencent.cloud.polaris.router.interceptor.NamespaceRouterRequestInterceptor;
 import com.tencent.cloud.polaris.router.interceptor.NearbyRouterRequestInterceptor;
 import com.tencent.cloud.polaris.router.interceptor.RuleBasedRouterRequestInterceptor;
 import com.tencent.cloud.polaris.router.resttemplate.RouterLabelRestTemplateInterceptor;
@@ -70,6 +72,11 @@ public RuleBasedRouterRequestInterceptor ruleBasedRouterRequestInterceptor(Polar
 		return new RuleBasedRouterRequestInterceptor(polarisRuleBasedRouterProperties);
 	}
 
+	@Bean
+	@ConditionalOnProperty(value = "spring.cloud.polaris.router.namespace-router.enabled", matchIfMissing = true)
+	public NamespaceRouterRequestInterceptor namespaceRouterRequestInterceptor(PolarisNamespaceRouterProperties polarisNamespaceRouterProperties) {
+		return new NamespaceRouterRequestInterceptor(polarisNamespaceRouterProperties);
+	}
 
 	/**
 	 * Create when gateway application is SCG.

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

@@ -20,6 +20,7 @@
 
 import com.tencent.cloud.polaris.router.RouterConfigModifier;
 import com.tencent.cloud.polaris.router.config.properties.PolarisMetadataRouterProperties;
+import com.tencent.cloud.polaris.router.config.properties.PolarisNamespaceRouterProperties;
 import com.tencent.cloud.polaris.router.config.properties.PolarisNearByRouterProperties;
 import com.tencent.cloud.polaris.router.config.properties.PolarisRuleBasedRouterProperties;
 
@@ -35,7 +36,8 @@
  */
 @Configuration(proxyBeanMethods = false)
 @ConditionalOnPolarisRouterEnabled
-@Import({PolarisNearByRouterProperties.class, PolarisMetadataRouterProperties.class, PolarisRuleBasedRouterProperties.class})
+@Import({PolarisNearByRouterProperties.class, PolarisMetadataRouterProperties.class, PolarisRuleBasedRouterProperties.class,
+		PolarisNamespaceRouterProperties.class})
 public class RouterConfigModifierAutoConfiguration {
 
 	@Bean

spring-cloud-starter-tencent-polaris-router/src/main/java/com/tencent/cloud/polaris/router/config/properties/PolarisNamespaceRouterProperties.java

@@ -0,0 +1,59 @@
+/*
+ * Tencent is pleased to support the open source community by making Spring Cloud Tencent available.
+ *
+ * Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved.
+ *
+ * Licensed under the BSD 3-Clause License (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://opensource.org/licenses/BSD-3-Clause
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed
+ * 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.router.config.properties;
+
+import com.tencent.polaris.api.rpc.NamespaceRouterFailoverType;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+/**
+ * the configuration for namespace router.
+ *
+ * @author lepdou 2022-05-23
+ */
+@ConfigurationProperties(prefix = "spring.cloud.polaris.router.namespace-router")
+public class PolarisNamespaceRouterProperties {
+
+	private boolean enabled = false;
+
+	private NamespaceRouterFailoverType failOver = NamespaceRouterFailoverType.all;
+
+	public boolean isEnabled() {
+		return enabled;
+	}
+
+	public void setEnabled(boolean enabled) {
+		this.enabled = enabled;
+	}
+
+	public NamespaceRouterFailoverType getFailOver() {
+		return failOver;
+	}
+
+	public void setFailOver(NamespaceRouterFailoverType failOver) {
+		this.failOver = failOver;
+	}
+
+	@Override
+	public String toString() {
+		return "PolarisNamespaceRouterProperties{" +
+				"enabled=" + enabled +
+				", failOver=" + failOver +
+				'}';
+	}
+}

spring-cloud-starter-tencent-polaris-router/src/main/java/com/tencent/cloud/polaris/router/config/properties/PolarisNearByRouterProperties.java

@@ -27,7 +27,7 @@
 @ConfigurationProperties(prefix = "spring.cloud.polaris.router.nearby-router")
 public class PolarisNearByRouterProperties {
 
-	private boolean enabled = true;
+	private boolean enabled = false;
 
 	private String matchLevel;
 

spring-cloud-starter-tencent-polaris-router/src/main/java/com/tencent/cloud/polaris/router/interceptor/NamespaceRouterRequestInterceptor.java

@@ -0,0 +1,55 @@
+/*
+ * Tencent is pleased to support the open source community by making Spring Cloud Tencent available.
+ *
+ * Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved.
+ *
+ * Licensed under the BSD 3-Clause License (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://opensource.org/licenses/BSD-3-Clause
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed
+ * 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.router.interceptor;
+
+import com.tencent.cloud.common.metadata.MetadataContextHolder;
+import com.tencent.cloud.polaris.router.PolarisRouterContext;
+import com.tencent.cloud.polaris.router.config.properties.PolarisNamespaceRouterProperties;
+import com.tencent.cloud.polaris.router.spi.RouterRequestInterceptor;
+import com.tencent.polaris.metadata.core.MetadataContainer;
+import com.tencent.polaris.metadata.core.MetadataType;
+import com.tencent.polaris.metadata.core.TransitiveType;
+import com.tencent.polaris.plugins.router.namespace.NamespaceRouter;
+import com.tencent.polaris.router.api.rpc.ProcessRoutersRequest;
+
+/**
+ * Router request interceptor for namespace router.
+ *
+ * @author Hoatian Zhang
+ */
+public class NamespaceRouterRequestInterceptor implements RouterRequestInterceptor {
+
+	private final PolarisNamespaceRouterProperties polarisNamespaceRouterProperties;
+
+	public NamespaceRouterRequestInterceptor(PolarisNamespaceRouterProperties polarisNamespaceRouterProperties) {
+		this.polarisNamespaceRouterProperties = polarisNamespaceRouterProperties;
+	}
+
+	@Override
+	public void apply(ProcessRoutersRequest request, PolarisRouterContext routerContext) {
+		// set namespace router enable
+		MetadataContainer metadataContainer = MetadataContextHolder.get()
+				.getMetadataContainer(MetadataType.CUSTOM, false);
+		metadataContainer.putMetadataMapValue(NamespaceRouter.ROUTER_TYPE_NAMESPACE, NamespaceRouter.ROUTER_ENABLED,
+				String.valueOf(polarisNamespaceRouterProperties.isEnabled()), TransitiveType.NONE);
+
+		// set namespace router fail over type.
+		request.setNamespaceRouterFailoverType(polarisNamespaceRouterProperties.getFailOver());
+	}
+}

spring-cloud-starter-tencent-polaris-router/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@@ -9,14 +9,14 @@
     {
       "name": "spring.cloud.polaris.router.nearby-router.enabled",
       "type": "java.lang.Boolean",
-      "defaultValue": true,
+      "defaultValue": false,
       "description": "the switch for nearby router."
     },
     {
       "name": "spring.cloud.polaris.router.nearby-router.matchLevel",
       "type": "java.lang.String",
-      "defaultValue": "zone",
-      "description": "the match level for nearby router, options can be region/zone/campus."
+      "defaultValue": "ZONE",
+      "description": "the match level for nearby router, options can be REGION/ZONE/CAMPUS."
     },
     {
       "name": "spring.cloud.polaris.router.rule-router.enabled",
@@ -30,11 +30,42 @@
       "defaultValue": "all",
       "description": "the fail over type for rule based router."
     },
+    {
+      "name": "spring.cloud.polaris.router.namespace-router.enabled",
+      "type": "java.lang.Boolean",
+      "defaultValue": false,
+      "description": "the switch for namespace router."
+    },
+    {
+      "name": "spring.cloud.polaris.router.namespace-router.failOver",
+      "type": "java.lang.String",
+      "defaultValue": "all",
+      "description": "the fail over type for namespace router."
+    },
     {
       "name": "spring.cloud.polaris.router.enabled",
       "type": "java.lang.Boolean",
       "defaultValue": true,
       "description": "the switch for router module."
     }
+  ],
+  "hints": [
+    {
+      "name": "spring.cloud.polaris.router.nearby-router.matchLevel",
+      "values": [
+        {
+          "value": "CAMPUS"
+        },
+        {
+          "value": "ZONE"
+        },
+        {
+          "value": "REGION"
+        },
+        {
+          "value": "ALL"
+        }
+      ]
+    }
   ]
 }

spring-cloud-starter-tencent-polaris-router/src/test/java/com/tencent/cloud/polaris/router/config/RouterBootstrapAutoConfigurationTest.java

@@ -49,7 +49,7 @@ public class RouterBootstrapAutoConfigurationTest {
 					RpcEnhancementAutoConfiguration.class,
 					RouterBootstrapAutoConfiguration.class))
 			.withPropertyValues("spring.cloud.polaris.enabled=true")
-			.withPropertyValues("spring.cloud.polaris.router.nearby-router.matchLevel=campus")
+			.withPropertyValues("spring.cloud.polaris.router.nearby-router.matchLevel=CAMPUS")
 			.withPropertyValues("spring.cloud.polaris.circuitbreaker.enabled=true");
 
 	@Test
@@ -61,7 +61,7 @@ public void testDefaultInitialization() {
 			routerConfigModifier.modify((ConfigurationImpl) configuration);
 			NearbyRouterConfig nearbyRouterConfig = configuration.getConsumer().getServiceRouter().getPluginConfig(
 					ServiceRouterConfig.DEFAULT_ROUTER_NEARBY, NearbyRouterConfig.class);
-			Assertions.assertEquals("campus", nearbyRouterConfig.getMatchLevel().name());
+			Assertions.assertEquals("CAMPUS", nearbyRouterConfig.getMatchLevel().name());
 		});
 	}
 }

spring-cloud-starter-tencent-polaris-router/src/test/java/com/tencent/cloud/polaris/router/config/properties/PolarisNearByRouterPropertiesTest.java

@@ -37,7 +37,7 @@ void setUp() {
 
 	@Test
 	public void isEnabled() {
-		assertThat(properties.isEnabled()).isEqualTo(true);
+		assertThat(properties.isEnabled()).isEqualTo(false);
 	}
 
 	@Test
@@ -49,6 +49,6 @@ public void setEnabled() {
 	@Test
 	public void testToString() {
 		assertThat(properties.toString())
-				.isEqualTo("PolarisNearByRouterProperties{enabled=true, matchLevel='null'}");
+				.isEqualTo("PolarisNearByRouterProperties{enabled=false, matchLevel='null'}");
 	}
 }

spring-cloud-tencent-examples/quickstart-example/quickstart-callee-service-a/src/main/java/com/tencent/cloud/quickstart/callee/CustomMetadata.java

@@ -39,8 +39,8 @@ public Map<String, String> getMetadata() {
 		return metadata;
 	}
 
-	@Override
-	public String getZone() {
-		return "shenzhen-zone-1";
-	}
+//	@Override
+//	public String getZone() {
+//		return "shenzhen-zone-1";
+//	}
 }

spring-cloud-tencent-examples/quickstart-example/quickstart-callee-service-a/src/main/resources/application.yml

@@ -37,7 +37,7 @@ spring:
       metadata:
         content:
           label1: value1
-          region: huanan
+#          region: huanan
 management:
   endpoints:
     web:

spring-cloud-tencent-examples/quickstart-example/quickstart-callee-service-b/src/main/java/com/tencent/cloud/quickstart/callee/CustomMetadata.java

@@ -39,8 +39,8 @@ public Map<String, String> getMetadata() {
 		return metadata;
 	}
 
-	@Override
-	public String getZone() {
-		return "shenzhen-zone-2";
-	}
+//	@Override
+//	public String getZone() {
+//		return "shenzhen-zone-2";
+//	}
 }