* solve the chaos code problem on rejectTips

* Update CHANGELOG.md

* fix:UnknownHostException: RateLimitCalleeService

* Update CHANGELOG.md

doc:update PULL_REQUEST_TEMPLATE.md. (#282)

* refactor to use text/html resolve chaos problem on rejectTips

* Update QuotaCheckServletFilterTest.java

* Update QuotaCheckReactiveFilter.java

* Update CHANGELOG.md

UT add metadata-transfer unit test

.github/PULL_REQUEST_TEMPLATE.md

@@ -10,17 +10,19 @@ Other... Please describe:
 
 ## Describe what this PR does for and how you did.
 
+## Adding the issue link (#xxx) if possible.
 
-## Does this PR be associated with issue? If so, please adding the issue link below.
+## Note
 
+## Checklist
 
-## Note
+- [ ] Add copyright holder at the beginning of .class file if it is new.
+- [ ] Add information of this PR to CHANGELOG.md in root of project.
+- [ ] All junit tests passing.
+- [ ] Coverage from `Codecov Report` should not decrease.
 
+## Checklist (Optional)
 
-### Checklist
+- [ ] Will Pull Request to branch of 2020.0 and 2021.0.
-- [ ] Code compiles correctly
+- [ ] Add documentation in javadoc in code or comment below the PR if necessary.
-- [ ] Pull Request has submit to 2020.0 and Greenwich
+- [ ] Add your name as @author to the beginning of .class file.
-- [ ] Create at least one junit test if possible
-- [ ] All tests passing
-- [ ] Extend documentation if necessary
-- [ ] Add myself / the copyright holder to the AUTHORS file

CHANGELOG.md

@@ -12,3 +12,7 @@
 - [fix:fix ClassNotFoundException while not importing openfeign when using circuit-breaker module.](https://github.com/Tencent/spring-cloud-tencent/pull/269)
 - [Update GitHub Actions workflow](https://github.com/Tencent/spring-cloud-tencent/pull/273)
 - [fix:fix TypeNotPresentException in @ConditionalOnClass of router.](https://github.com/Tencent/spring-cloud-tencent/pull/276)
+- [fix:solve the chaos code problem on rejectTips.](https://github.com/Tencent/spring-cloud-tencent/pull/279)
+- [fix:solve ratelimit-callee-service UnknownHostException.](https://github.com/Tencent/spring-cloud-tencent/pull/281)
+- [fix:refactor to use text/html resolve chaos problem on rejectTips](https://github.com/Tencent/spring-cloud-tencent/pull/285)
+- [UT: add metadata-transfer unit test](https://github.com/Tencent/spring-cloud-tencent/pull/290)

spring-cloud-starter-tencent-metadata-transfer/src/test/java/com/tencent/cloud/metadata/CustomTransitiveMetadataResolverTest.java

@@ -0,0 +1,54 @@
+/*
+ * 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.metadata;
+
+import java.util.Map;
+
+import com.tencent.cloud.metadata.core.CustomTransitiveMetadataResolver;
+import org.assertj.core.api.Assertions;
+import org.junit.Test;
+
+import org.springframework.mock.http.server.reactive.MockServerHttpRequest;
+import org.springframework.mock.web.MockHttpServletRequest;
+import org.springframework.mock.web.server.MockServerWebExchange;
+
+/**
+ * @author quan
+ */
+public class CustomTransitiveMetadataResolverTest {
+
+	@Test
+	public void test() {
+		MockServerHttpRequest.BaseBuilder<?> builder = MockServerHttpRequest.get("");
+		builder.header("X-SCT-Metadata-Transitive-a", "test");
+		MockServerWebExchange exchange = MockServerWebExchange.from(builder);
+		Map<String, String> resolve = CustomTransitiveMetadataResolver.resolve(exchange);
+		Assertions.assertThat(resolve.size()).isEqualTo(1);
+		Assertions.assertThat(resolve.get("a")).isEqualTo("test");
+	}
+
+	@Test
+	public void testServlet() {
+		MockHttpServletRequest request = new MockHttpServletRequest();
+		request.addHeader("X-SCT-Metadata-Transitive-a", "test");
+		Map<String, String> resolve = CustomTransitiveMetadataResolver.resolve(request);
+		Assertions.assertThat(resolve.size()).isEqualTo(1);
+		Assertions.assertThat(resolve.get("a")).isEqualTo("test");
+	}
+}

spring-cloud-starter-tencent-metadata-transfer/src/test/java/com/tencent/cloud/metadata/core/filter/EncodeTransferMedataScgFilterTest.java

@@ -0,0 +1,77 @@
+/*
+ * 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.metadata.core.filter;
+
+import java.io.UnsupportedEncodingException;
+import java.net.URLDecoder;
+import java.util.Map;
+
+import com.tencent.cloud.common.constant.MetadataConstant;
+import com.tencent.cloud.common.util.JacksonUtils;
+import com.tencent.cloud.metadata.core.EncodeTransferMedataScgFilter;
+import org.assertj.core.api.Assertions;
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.cloud.gateway.filter.GatewayFilterChain;
+import org.springframework.context.ApplicationContext;
+import org.springframework.mock.http.server.reactive.MockServerHttpRequest;
+import org.springframework.mock.web.server.MockServerWebExchange;
+import org.springframework.test.context.junit4.SpringRunner;
+
+import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT;
+
+/**
+ * @author quan
+ */
+@RunWith(SpringRunner.class)
+@SpringBootTest(webEnvironment = RANDOM_PORT,
+		classes = EncodeTransferMedataScgFilterTest.TestApplication.class,
+		properties = { "spring.config.location = classpath:application-test.yml", "spring.main.web-application-type = reactive" })
+public class EncodeTransferMedataScgFilterTest {
+
+	@Autowired
+	private ApplicationContext applicationContext;
+
+	@Mock
+	private GatewayFilterChain chain;
+
+	@Test
+	public void testTransitiveMetadataFromApplicationConfig() throws UnsupportedEncodingException {
+		EncodeTransferMedataScgFilter filter = applicationContext.getBean(EncodeTransferMedataScgFilter.class);
+		MockServerHttpRequest.BaseBuilder<?> builder = MockServerHttpRequest.get("");
+		MockServerWebExchange exchange = MockServerWebExchange.from(builder);
+		filter.filter(exchange, chain);
+		String metadataStr = exchange.getRequest().getHeaders().getFirst(MetadataConstant.HeaderName.CUSTOM_METADATA);
+		String decode = URLDecoder.decode(metadataStr, "UTF-8");
+		Map<String, String> transitiveMap = JacksonUtils.deserialize2Map(decode);
+		Assertions.assertThat(transitiveMap.size()).isEqualTo(1);
+		Assert.assertEquals(transitiveMap.get("b"), "2");
+	}
+
+	@SpringBootApplication
+	protected static class TestApplication {
+
+	}
+}

spring-cloud-starter-tencent-metadata-transfer/src/test/java/com/tencent/cloud/metadata/core/filter/EncodeTransferMetadataZuulFilterTest.java

@@ -0,0 +1,83 @@
+/*
+ * 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.metadata.core.filter;
+
+import java.io.UnsupportedEncodingException;
+import java.net.URLDecoder;
+import java.util.Map;
+
+import com.netflix.zuul.context.RequestContext;
+import com.tencent.cloud.common.constant.MetadataConstant;
+import com.tencent.cloud.common.util.JacksonUtils;
+import com.tencent.cloud.metadata.core.EncodeTransferMetadataZuulFilter;
+import org.assertj.core.api.Assertions;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.context.ApplicationContext;
+import org.springframework.mock.web.MockMultipartHttpServletRequest;
+import org.springframework.test.context.junit4.SpringRunner;
+
+import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT;
+
+/**
+ * @author quan
+ */
+@RunWith(SpringRunner.class)
+@SpringBootTest(webEnvironment = RANDOM_PORT,
+		classes = EncodeTransferMetadataZuulFilterTest.TestApplication.class,
+		properties = { "spring.config.location = classpath:application-test.yml", "spring.main.web-application-type = reactive" })
+
+public class EncodeTransferMetadataZuulFilterTest {
+
+	@Autowired
+	private ApplicationContext applicationContext;
+
+	private MockMultipartHttpServletRequest request = new MockMultipartHttpServletRequest();
+
+	@Before
+	public void init() {
+		RequestContext ctx = RequestContext.getCurrentContext();
+		ctx.clear();
+		ctx.setRequest(this.request);
+	}
+
+	@Test
+	public void multiplePartNamesWithMultipleParts() throws UnsupportedEncodingException {
+		EncodeTransferMetadataZuulFilter filter = applicationContext.getBean(EncodeTransferMetadataZuulFilter.class);
+		filter.run();
+		final RequestContext ctx = RequestContext.getCurrentContext();
+		Map<String, String> zuulRequestHeaders = ctx.getZuulRequestHeaders();
+		String metaData = zuulRequestHeaders.get(MetadataConstant.HeaderName.CUSTOM_METADATA.toLowerCase());
+		String decode = URLDecoder.decode(metaData, "UTF-8");
+		Map<String, String> transitiveMap = JacksonUtils.deserialize2Map(decode);
+		Assertions.assertThat(transitiveMap.size()).isEqualTo(1);
+		Assert.assertEquals(transitiveMap.get("b"), "2");
+	}
+
+	@SpringBootApplication
+	protected static class TestApplication {
+
+	}
+}

spring-cloud-starter-tencent-polaris-ratelimit/src/main/java/com/tencent/cloud/polaris/ratelimit/filter/QuotaCheckReactiveFilter.java

@@ -55,7 +55,7 @@ import static com.tencent.cloud.polaris.ratelimit.constant.RateLimitConstant.LAB
 /**
  * Reactive filter to check quota.
  *
- * @author Haotian Zhang, lepdou
+ * @author Haotian Zhang, lepdou, cheese8
  */
 public class QuotaCheckReactiveFilter implements WebFilter, Ordered {
 
@@ -106,7 +106,7 @@ public class QuotaCheckReactiveFilter implements WebFilter, Ordered {
 			if (quotaResponse.getCode() == QuotaResultCode.QuotaResultLimited) {
 				ServerHttpResponse response = exchange.getResponse();
 				response.setRawStatusCode(polarisRateLimitProperties.getRejectHttpCode());
-				response.getHeaders().setContentType(MediaType.APPLICATION_JSON);
+				response.getHeaders().setContentType(MediaType.TEXT_HTML);
 				DataBuffer dataBuffer = response.bufferFactory().allocateBuffer()
 						.write(rejectTips.getBytes(StandardCharsets.UTF_8));
 				return response.writeWith(Mono.just(dataBuffer));

spring-cloud-starter-tencent-polaris-ratelimit/src/main/java/com/tencent/cloud/polaris/ratelimit/filter/QuotaCheckServletFilter.java

@@ -53,7 +53,7 @@ import static com.tencent.cloud.polaris.ratelimit.constant.RateLimitConstant.LAB
 /**
  * Servlet filter to check quota.
  *
- * @author Haotian Zhang, lepdou
+ * @author Haotian Zhang, lepdou, cheese8
  */
 @Order(RateLimitConstant.FILTER_ORDER)
 public class QuotaCheckServletFilter extends OncePerRequestFilter {
@@ -99,6 +99,7 @@ public class QuotaCheckServletFilter extends OncePerRequestFilter {
 
 			if (quotaResponse.getCode() == QuotaResultCode.QuotaResultLimited) {
 				response.setStatus(polarisRateLimitProperties.getRejectHttpCode());
+				response.setContentType("text/html;charset=UTF-8");
 				response.getWriter().write(rejectTips);
 				return;
 			}

spring-cloud-starter-tencent-polaris-ratelimit/src/test/java/com/tencent/cloud/polaris/ratelimit/filter/QuotaCheckReactiveFilterTest.java

@@ -65,7 +65,7 @@ import static org.mockito.Mockito.when;
 /**
  * Test for {@link QuotaCheckReactiveFilter}.
  *
- * @author Haotian Zhang
+ * @author Haotian Zhang, cheese8
  */
 @RunWith(MockitoJUnitRunner.class)
 @SpringBootTest(classes = QuotaCheckReactiveFilterTest.TestApplication.class, properties = {
@@ -118,7 +118,7 @@ public class QuotaCheckReactiveFilterTest {
 		});
 
 		PolarisRateLimitProperties polarisRateLimitProperties = new PolarisRateLimitProperties();
-		polarisRateLimitProperties.setRejectRequestTips("RejectRequestTips");
+		polarisRateLimitProperties.setRejectRequestTips("RejectRequestTips提示消息");
 		polarisRateLimitProperties.setRejectHttpCode(419);
 
 		RateLimitRuleLabelResolver rateLimitRuleLabelResolver = mock(RateLimitRuleLabelResolver.class);
@@ -138,7 +138,7 @@ public class QuotaCheckReactiveFilterTest {
 		try {
 			Field rejectTips = QuotaCheckReactiveFilter.class.getDeclaredField("rejectTips");
 			rejectTips.setAccessible(true);
-			assertThat(rejectTips.get(quotaCheckReactiveFilter)).isEqualTo("RejectRequestTips");
+			assertThat(rejectTips.get(quotaCheckReactiveFilter)).isEqualTo("RejectRequestTips提示消息");
 		}
 		catch (NoSuchFieldException | IllegalAccessException e) {
 			fail("Exception encountered.", e);

spring-cloud-starter-tencent-polaris-ratelimit/src/test/java/com/tencent/cloud/polaris/ratelimit/filter/QuotaCheckServletFilterTest.java

@@ -65,7 +65,7 @@ import static org.mockito.Mockito.when;
 /**
  * Test for {@link QuotaCheckServletFilter}.
  *
- * @author Haotian Zhang
+ * @author Haotian Zhang, cheese8
  */
 @RunWith(MockitoJUnitRunner.class)
 @SpringBootTest(classes = QuotaCheckServletFilterTest.TestApplication.class, properties = {
@@ -77,6 +77,8 @@ public class QuotaCheckServletFilterTest {
 
 	private QuotaCheckServletFilter quotaCheckServletFilter;
 
+	private QuotaCheckServletFilter quotaCheckWithHtmlRejectTipsServletFilter;
+
 	private static MockedStatic<ApplicationContextAwareUtils> mockedApplicationContextAwareUtils;
 	private static MockedStatic<ExpressionLabelUtils> expressionLabelUtilsMockedStatic;
 	@BeforeClass
@@ -118,13 +120,18 @@ public class QuotaCheckServletFilterTest {
 		});
 
 		PolarisRateLimitProperties polarisRateLimitProperties = new PolarisRateLimitProperties();
-		polarisRateLimitProperties.setRejectRequestTips("RejectRequestTips");
+		polarisRateLimitProperties.setRejectRequestTips("RejectRequestTips提示消息");
 		polarisRateLimitProperties.setRejectHttpCode(419);
 
+		PolarisRateLimitProperties polarisRateLimitWithHtmlRejectTipsProperties = new PolarisRateLimitProperties();
+		polarisRateLimitWithHtmlRejectTipsProperties.setRejectRequestTips("<h1>RejectRequestTips提示消息</h1>");
+		polarisRateLimitWithHtmlRejectTipsProperties.setRejectHttpCode(419);
+
 		RateLimitRuleLabelResolver rateLimitRuleLabelResolver = mock(RateLimitRuleLabelResolver.class);
 		when(rateLimitRuleLabelResolver.getExpressionLabelKeys(anyString(), anyString())).thenReturn(Collections.EMPTY_SET);
 
 		this.quotaCheckServletFilter = new QuotaCheckServletFilter(limitAPI, labelResolver, polarisRateLimitProperties, rateLimitRuleLabelResolver);
+		this.quotaCheckWithHtmlRejectTipsServletFilter = new QuotaCheckServletFilter(limitAPI, labelResolver, polarisRateLimitWithHtmlRejectTipsProperties, rateLimitRuleLabelResolver);
 	}
 
 	@Test
@@ -133,7 +140,16 @@ public class QuotaCheckServletFilterTest {
 		try {
 			Field rejectTips = QuotaCheckServletFilter.class.getDeclaredField("rejectTips");
 			rejectTips.setAccessible(true);
-			assertThat(rejectTips.get(quotaCheckServletFilter)).isEqualTo("RejectRequestTips");
+			assertThat(rejectTips.get(quotaCheckServletFilter)).isEqualTo("RejectRequestTips提示消息");
+		}
+		catch (NoSuchFieldException | IllegalAccessException e) {
+			fail("Exception encountered.", e);
+		}
+		quotaCheckWithHtmlRejectTipsServletFilter.init();
+		try {
+			Field rejectTips = QuotaCheckServletFilter.class.getDeclaredField("rejectTips");
+			rejectTips.setAccessible(true);
+			assertThat(rejectTips.get(quotaCheckWithHtmlRejectTipsServletFilter)).isEqualTo("<h1>RejectRequestTips提示消息</h1>");
 		}
 		catch (NoSuchFieldException | IllegalAccessException e) {
 			fail("Exception encountered.", e);
@@ -201,7 +217,11 @@ public class QuotaCheckServletFilterTest {
 			MetadataContext.LOCAL_SERVICE = "TestApp3";
 			quotaCheckServletFilter.doFilterInternal(request, response, filterChain);
 			assertThat(response.getStatus()).isEqualTo(419);
-			assertThat(response.getContentAsString()).isEqualTo("RejectRequestTips");
+			assertThat(response.getContentAsString()).isEqualTo("RejectRequestTips提示消息");
+
+			quotaCheckWithHtmlRejectTipsServletFilter.doFilterInternal(request, response, filterChain);
+			assertThat(response.getStatus()).isEqualTo(419);
+			assertThat(response.getContentAsString()).isEqualTo("RejectRequestTips提示消息");
 
 
 			// Exception

spring-cloud-tencent-examples/polaris-ratelimit-example/ratelimit-callee-service/pom.xml

@@ -18,6 +18,11 @@
 			<artifactId>spring-boot-starter-web</artifactId>
 		</dependency>
 
+		<dependency>
+			<groupId>com.tencent.cloud</groupId>
+			<artifactId>spring-cloud-starter-tencent-polaris-discovery</artifactId>
+		</dependency>
+
 		<dependency>
 			<groupId>com.tencent.cloud</groupId>
 			<artifactId>spring-cloud-starter-tencent-polaris-ratelimit</artifactId>