feat: add metadata transfer for http header via spring.cloud.tencent.…

…metadata.headers (#1137)

CHANGELOG.md

@@ -8,6 +8,7 @@
 - [feat: support log path configuration parameters.](https://github.com/Tencent/spring-cloud-tencent/pull/1128)
 - [refactor:optimize the order and condition matching of service registration automatic configuration.](https://github.com/Tencent/spring-cloud-tencent/pull/1129)
 - [feat: add circuit breaker actuator.](https://github.com/Tencent/spring-cloud-tencent/pull/1136)
+- [feat: add metadata transfer for http header via spring.cloud.tencent.metadata.headers.](https://github.com/Tencent/spring-cloud-tencent/pull/1137)
 - [feat:support service contract reporting.](https://github.com/Tencent/spring-cloud-tencent/pull/1139)
 - [feat:add swagger exposure filters.](https://github.com/Tencent/spring-cloud-tencent/pull/1146)
 - [feat:add swagger report switch.](https://github.com/Tencent/spring-cloud-tencent/pull/1148)

spring-cloud-tencent-commons/src/main/java/com/tencent/cloud/common/metadata/MetadataContextHolder.java

@@ -68,8 +68,8 @@ public static MetadataContext get() {
 		metadataContext.setTransitiveMetadata(staticMetadataManager.getMergedStaticTransitiveMetadata());
 		metadataContext.setDisposableMetadata(staticMetadataManager.getMergedStaticDisposableMetadata());
 
-		if (StringUtils.hasText(staticMetadataManager.getTransHeaderFromEnv())) {
-			metadataContext.setTransHeaders(staticMetadataManager.getTransHeaderFromEnv(), "");
+		if (StringUtils.hasText(staticMetadataManager.getTransHeader())) {
+			metadataContext.setTransHeaders(staticMetadataManager.getTransHeader(), "");
 		}
 
 		METADATA_CONTEXT.set(metadataContext);

spring-cloud-tencent-commons/src/main/java/com/tencent/cloud/common/metadata/StaticMetadataManager.java

@@ -17,8 +17,11 @@
 
 package com.tencent.cloud.common.metadata;
 
+import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
@@ -71,6 +74,7 @@ public class StaticMetadataManager {
 	private Map<String, String> configMetadata;
 	private Map<String, String> configTransitiveMetadata;
 	private Map<String, String> configDisposableMetadata;
+	private String configTransHeaders;
 	private Map<String, String> customSPIMetadata;
 	private Map<String, String> customSPITransitiveMetadata;
 	private Map<String, String> customSPIDisposableMetadata;
@@ -162,6 +166,7 @@ private void parseConfigMetadata(MetadataLocalProperties metadataLocalProperties
 		Map<String, String> allMetadata = metadataLocalProperties.getContent();
 		List<String> transitiveKeys = metadataLocalProperties.getTransitive();
 		List<String> disposableKeys = metadataLocalProperties.getDisposable();
+		List<String> headers = metadataLocalProperties.getHeaders();
 
 		Map<String, String> transitiveResult = new HashMap<>();
 		for (String key : transitiveKeys) {
@@ -179,6 +184,7 @@ private void parseConfigMetadata(MetadataLocalProperties metadataLocalProperties
 
 		configTransitiveMetadata = Collections.unmodifiableMap(transitiveResult);
 		configDisposableMetadata = Collections.unmodifiableMap(disposableResult);
+		configTransHeaders = CollectionUtils.isEmpty(headers) ? null : String.join(",", headers);
 		configMetadata = Collections.unmodifiableMap(allMetadata);
 	}
 
@@ -313,6 +319,29 @@ public String getTransHeaderFromEnv() {
 		return envNotReportMetadata.get(ENV_TRAFFIC_CONTENT_RAW_TRANSHEADERS);
 	}
 
+	public String getTransHeaderFromConfig() {
+		return configTransHeaders;
+	}
+
+	public String getTransHeader() {
+		Set<String> transHeaderSet = new HashSet<>();
+
+		String transHeaderFromEnv = getTransHeaderFromEnv();
+		String transHeaderFromConfig = getTransHeaderFromConfig();
+
+		Set<String> transHeaderFromEnvSet = StringUtils.isNotBlank(transHeaderFromEnv)
+				? Arrays.stream(transHeaderFromEnv.split(",")).collect(Collectors.toSet())
+				: Collections.emptySet();
+		Set<String> transHeaderFromConfigSet = StringUtils.isNotBlank(transHeaderFromConfig)
+				? Arrays.stream(transHeaderFromConfig.split(",")).collect(Collectors.toSet())
+				: Collections.emptySet();
+
+		transHeaderSet.addAll(transHeaderFromEnvSet);
+		transHeaderSet.addAll(transHeaderFromConfigSet);
+
+		return new ArrayList<>(transHeaderSet).stream().sorted().collect(Collectors.joining(","));
+	}
+
 	public Map<String, String> getEnvTransitiveMetadata() {
 		return envTransitiveMetadata;
 	}
@@ -390,6 +419,7 @@ public String toString() {
 				", envTransitiveMetadata=" + envTransitiveMetadata +
 				", configMetadata=" + configMetadata +
 				", configTransitiveMetadata=" + configTransitiveMetadata +
+				", configTransHeaders='" + configTransHeaders + '\'' +
 				", customSPIMetadata=" + customSPIMetadata +
 				", customSPITransitiveMetadata=" + customSPITransitiveMetadata +
 				", mergedStaticMetadata=" + mergedStaticMetadata +

spring-cloud-tencent-commons/src/main/java/com/tencent/cloud/common/metadata/config/MetadataLocalProperties.java

@@ -48,6 +48,11 @@ public class MetadataLocalProperties {
 	 */
 	private List<String> disposable;
 
+	/**
+	 * A transitive http header key list.
+	 */
+	private List<String> headers;
+
 	public Map<String, String> getContent() {
 		if (CollectionUtils.isEmpty(content)) {
 			content = new HashMap<>();
@@ -80,4 +85,15 @@ public List<String> getDisposable() {
 	public void setDisposable(List<String> disposable) {
 		this.disposable = disposable;
 	}
+
+	public List<String> getHeaders() {
+		if (CollectionUtils.isEmpty(headers)) {
+			headers = new ArrayList<>();
+		}
+		return headers;
+	}
+
+	public void setHeaders(List<String> headers) {
+		this.headers = headers;
+	}
 }

spring-cloud-tencent-commons/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@@ -14,6 +14,11 @@
       "name": "spring.cloud.tencent.metadata.disposable",
       "type": "java.util.List",
       "description": "Custom disposable metadata key list."
+    },
+    {
+      "name": "spring.cloud.tencent.metadata.headers",
+      "type": "java.util.List",
+      "description": "Custom transitive http header key list."
     }
   ]
 }

spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/metadata/MetadataContextHolderTest.java

@@ -52,6 +52,10 @@ public void test1() {
 		Assertions.assertThat(customMetadata.get("a")).isEqualTo("1");
 		Assertions.assertThat(customMetadata.get("b")).isEqualTo("2");
 
+		Map<String, String> transHeaders = MetadataContextHolder.get().getTransHeaders();
+		Assertions.assertThat(transHeaders.size()).isEqualTo(1);
+		Assertions.assertThat(transHeaders.keySet().iterator().next()).isEqualTo("c,d");
+
 		MetadataContextHolder.remove();
 
 		customMetadata = new HashMap<>();
@@ -65,6 +69,10 @@ public void test1() {
 		Assertions.assertThat(customMetadata.get("b")).isEqualTo("22");
 		Assertions.assertThat(customMetadata.get("c")).isEqualTo("3");
 		Assertions.assertThat(MetadataContext.LOCAL_NAMESPACE).isEqualTo("default");
+
+		transHeaders = MetadataContextHolder.get().getTransHeaders();
+		Assertions.assertThat(transHeaders.size()).isEqualTo(1);
+		Assertions.assertThat(transHeaders.keySet().iterator().next()).isEqualTo("c,d");
 	}
 
 	@Test

spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/metadata/StaticMetadataManagerTest.java

@@ -97,6 +97,7 @@ public void testParseConfigMetadata() {
 		when(metadataLocalProperties.getContent()).thenReturn(content);
 		when(metadataLocalProperties.getTransitive()).thenReturn(Collections.singletonList("k1"));
 		when(metadataLocalProperties.getDisposable()).thenReturn(Collections.singletonList("k1"));
+		when(metadataLocalProperties.getHeaders()).thenReturn(Arrays.asList("a", "d"));
 
 		StaticMetadataManager metadataManager = new StaticMetadataManager(metadataLocalProperties, null);
 
@@ -119,6 +120,9 @@ public void testParseConfigMetadata() {
 		Map<String, String> locationInfo = metadataManager.getLocationMetadata();
 		assertThat(locationInfo.get("zone")).isEqualTo("zone1");
 		assertThat(locationInfo.get("region")).isEqualTo("region1");
+
+		String transHeaderFromConfig = metadataManager.getTransHeaderFromConfig();
+		assertThat(transHeaderFromConfig).isEqualTo("a,d");
 	}
 
 	@Test
@@ -161,6 +165,9 @@ public void testCustomSPIMetadata() {
 
 	@Test
 	public void testMergedMetadata() {
+		// set environment variables
+		environmentVariables.set("SCT_TRAFFIC_CONTENT_RAW_TRANSHEADERS", "a,b,c,e");
+
 		Map<String, String> content = new HashMap<>();
 		content.put("k1", "v1");
 		content.put("k2", "v2");
@@ -170,6 +177,7 @@ public void testMergedMetadata() {
 
 		when(metadataLocalProperties.getContent()).thenReturn(content);
 		when(metadataLocalProperties.getTransitive()).thenReturn(Collections.singletonList("k1"));
+		when(metadataLocalProperties.getHeaders()).thenReturn(Arrays.asList("b", "d"));
 
 		StaticMetadataManager metadataManager = new StaticMetadataManager(metadataLocalProperties,
 				Arrays.asList(new MockedMetadataProvider(), new DefaultInstanceMetadataProvider(null)));
@@ -204,6 +212,9 @@ public void testMergedMetadata() {
 		assertThat(locationInfo.get("zone")).isEqualTo("zone2");
 		assertThat(locationInfo.get("region")).isEqualTo("region1");
 		assertThat(locationInfo.get("campus")).isEqualTo("campus2");
+
+		String transHeader = metadataManager.getTransHeader();
+		assertThat(transHeader).isEqualTo("a,b,c,d,e");
 	}
 
 	@Test

spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/metadata/config/MetadataLocalPropertiesTest.java

@@ -52,6 +52,12 @@ public void test2() {
 		Assertions.assertThat(metadataLocalProperties.getTransitive().contains("b")).isTrue();
 	}
 
+	@Test
+	public void test3() {
+		Assertions.assertThat(metadataLocalProperties.getHeaders().contains("c")).isTrue();
+		Assertions.assertThat(metadataLocalProperties.getHeaders().contains("d")).isTrue();
+	}
+
 	@SpringBootApplication
 	protected static class TestApplication {
 

spring-cloud-tencent-commons/src/test/resources/application-test.yml

@@ -14,3 +14,6 @@ spring:
           b: 2
         transitive:
           - b
+        headers:
+          - c
+          - d