Update to be compatible with Brave 5.18

Signed-off-by: Adrian Cole <adrian@tetrate.io>
spring-cloud · Jan 10, 2024 · 6ddb8dc · 6ddb8dc
1 parent 04dc4ee
commit 6ddb8dc
Show file tree

Hide file tree

Showing 16 changed files with 66 additions and 60 deletions.
diff --git a/pom.xml b/pom.xml
@@ -60,8 +60,6 @@
 		<spring-cloud-openfeign.version>3.1.10-SNAPSHOT</spring-cloud-openfeign.version>
 		<spring-cloud-task.version>2.4.6</spring-cloud-task.version>
 		<spring-cloud-deployer.version>2.5.1</spring-cloud-deployer.version>
-		<brave.version>5.13.9</brave.version>
-		<opentracing.version>0.32.0</opentracing.version>
 		<!-- Deprecated - reached EOL -->
 		<spring-security-boot-autoconfigure.version>2.3.4.RELEASE</spring-security-boot-autoconfigure.version>
 		<spring-security-oauth2.version>2.2.0.RELEASE</spring-security-oauth2.version>

diff --git a/spring-cloud-sleuth-autoconfigure/pom.xml b/spring-cloud-sleuth-autoconfigure/pom.xml
@@ -414,6 +414,7 @@
 			<artifactId>zipkin</artifactId>
 			<optional>true</optional>
 		</dependency>
+		<!-- Needed for ZipkinRestTemplateSenderConfiguration: BytesMessageEncoder  -->
 		<dependency>
 			<groupId>io.zipkin.reporter2</groupId>
 			<artifactId>zipkin-reporter</artifactId>

diff --git a/...ain/java/org/springframework/cloud/sleuth/autoconfig/brave/BraveBaggageConfiguration.java b/...ain/java/org/springframework/cloud/sleuth/autoconfig/brave/BraveBaggageConfiguration.java
@@ -334,12 +334,6 @@ public TraceContext decorate(TraceContext context) {
 			return delegate.decorate(context);
 		}
 
-		@Override
-		public <K> Propagation<K> create(Propagation.KeyFactory<K> keyFactory) {
-			Propagation<K> propagation = delegate.create(keyFactory);
-			return delegateWithoutB3Baggage(factoryFromSupplier, propagation);
-		}
-
 		private <K> Propagation<K> delegateWithoutB3Baggage(Propagation.Factory factoryFromSupplier,
 				Propagation<K> propagation) {
 			return new Propagation<K>() {

diff --git a/.../springframework/cloud/sleuth/autoconfig/brave/instrument/web/BraveHttpConfiguration.java b/.../springframework/cloud/sleuth/autoconfig/brave/instrument/web/BraveHttpConfiguration.java
@@ -77,9 +77,8 @@ public class BraveHttpConfiguration {
 	@Bean
 	@ConditionalOnMissingBean
 	// NOTE: stable bean name as might be used outside sleuth
-	HttpTracing httpTracing(Tracing tracing, @Nullable SkipPatternProvider provider,
-			@Nullable brave.http.HttpClientParser clientParser, @Nullable brave.http.HttpServerParser serverParser,
-			BeanFactory beanFactory, @Nullable List<HttpTracingCustomizer> httpTracingCustomizers) {
+	HttpTracing httpTracing(Tracing tracing, @Nullable SkipPatternProvider provider, BeanFactory beanFactory,
+			@Nullable List<HttpTracingCustomizer> httpTracingCustomizers) {
 		HttpTracing.Builder builder = httpTracingBuilder(tracing, provider, beanFactory);
 		brave.http.HttpRequestParser httpClientRequestParser = httpRequestParser(beanFactory,
 				HttpClientRequestParser.NAME);
@@ -98,9 +97,6 @@ HttpTracing httpTracing(Tracing tracing, @Nullable SkipPatternProvider provider,
 				builder.clientResponseParser(httpClientResponseParser);
 			}
 		}
-		else if (clientParser != null) { // consider deprecated last
-			builder.clientParser(clientParser);
-		}
 
 		if (httpServerRequestParser != null || httpServerResponseParser != null) {
 			if (httpServerRequestParser != null) {
@@ -110,9 +106,6 @@ else if (clientParser != null) { // consider deprecated last
 				builder.serverResponseParser(httpServerResponseParser);
 			}
 		}
-		else if (serverParser != null) { // consider deprecated last
-			builder.serverParser(serverParser);
-		}
 
 		if (httpTracingCustomizers != null) {
 			for (HttpTracingCustomizer customizer : httpTracingCustomizers) {

diff --git a/...t/java/org/springframework/cloud/sleuth/autoconfig/brave/BraveAutoConfigurationTests.java b/...t/java/org/springframework/cloud/sleuth/autoconfig/brave/BraveAutoConfigurationTests.java
@@ -16,7 +16,7 @@
 
 package org.springframework.cloud.sleuth.autoconfig.brave;
 
-import java.util.List;
+import java.util.Map;
 
 import brave.Tracing;
 import brave.baggage.BaggageField;
@@ -95,8 +95,7 @@ void should_use_B3Propagation_factory_by_default() {
 	void should_use_baggageBean() {
 		this.contextRunner.withUserConfiguration(WithBaggageBeans.class, Baggage.class).run((context -> {
 			final Baggage bean = context.getBean(Baggage.class);
-			BDDAssertions.then(bean.fields).containsOnly(BaggageField.create("country-code"),
-					BaggageField.create("x-vcap-request-id"));
+			BDDAssertions.then(bean.fields).containsEntry("country-code", "x-vcap-request-id");
 		}));
 	}
 
@@ -105,7 +104,7 @@ void should_use_local_keys_from_properties() {
 		this.contextRunner.withPropertyValues("spring.sleuth.baggage.local-fields=bp")
 				.withUserConfiguration(Baggage.class).run((context -> {
 					final Baggage bean = context.getBean(Baggage.class);
-					BDDAssertions.then(bean.fields).containsExactly(BaggageField.create("bp"));
+					BDDAssertions.then(bean.fields).containsKey("bp");
 				}));
 	}
 
@@ -114,8 +113,7 @@ void should_combine_baggage_beans_and_properties() {
 		this.contextRunner.withPropertyValues("spring.sleuth.baggage.local-fields=bp")
 				.withUserConfiguration(WithBaggageBeans.class, Baggage.class).run((context -> {
 					final Baggage bean = context.getBean(Baggage.class);
-					BDDAssertions.then(bean.fields).containsOnly(BaggageField.create("country-code"),
-							BaggageField.create("x-vcap-request-id"), BaggageField.create("bp"));
+					BDDAssertions.then(bean.fields).containsOnlyKeys("country-code", "x-vcap-request-id", "bp");
 				}));
 	}
 
@@ -131,15 +129,15 @@ void should_use_baggagePropagationFactoryBuilder_bean() {
 	@Configuration(proxyBeanMethods = false)
 	static class Baggage {
 
-		List<BaggageField> fields;
+		Map<String, String> fields;
 
 		@Autowired
 		Baggage(Tracing tracing) {
 			// When predefined baggage fields exist, the result !=
 			// TraceContextOrSamplingFlags.EMPTY
 			TraceContextOrSamplingFlags emptyExtraction = tracing.propagation().extractor((c, k) -> null)
 					.extract(Boolean.TRUE);
-			fields = BaggageField.getAll(emptyExtraction);
+			fields = BaggageField.getAllValues(emptyExtraction);
 		}
 
 	}

diff --git a/...rc/test/java/org/springframework/cloud/sleuth/autoconfig/brave/BravePropagationTests.java b/...rc/test/java/org/springframework/cloud/sleuth/autoconfig/brave/BravePropagationTests.java
@@ -22,7 +22,6 @@
 import java.util.Map;
 
 import brave.internal.codec.HexCodec;
-import brave.internal.propagation.StringPropagationAdapter;
 import brave.propagation.Propagation;
 import brave.propagation.TraceContext;
 import brave.propagation.TraceContextOrSamplingFlags;
@@ -159,8 +158,8 @@ public <R> TraceContext.Extractor<R> extractor(Getter<R, String> getter) {
 	}
 
 	@Override
-	public <K> Propagation<K> create(KeyFactory<K> keyFactory) {
-		return StringPropagationAdapter.create(this, keyFactory);
+	public Propagation<String> get() {
+		return this;
 	}
 
 }

diff --git a/.../springframework/cloud/sleuth/autoconfig/brave/baggage/CustomPropagationFactoryTests.java b/.../springframework/cloud/sleuth/autoconfig/brave/baggage/CustomPropagationFactoryTests.java
@@ -19,7 +19,6 @@
 import java.util.Collections;
 import java.util.List;
 
-import brave.internal.propagation.StringPropagationAdapter;
 import brave.propagation.Propagation;
 import brave.propagation.TraceContext;
 import brave.propagation.TraceContextOrSamplingFlags;
@@ -94,8 +93,8 @@ public <R> TraceContext.Extractor<R> extractor(Getter<R, String> getter) {
 			}
 
 			@Override
-			public <K> Propagation<K> create(KeyFactory<K> keyFactory) {
-				return StringPropagationAdapter.create(this, keyFactory);
+			public Propagation<String> get() {
+				return this;
 			}
 
 		}

diff --git a/...va/org/springframework/cloud/sleuth/brave/bridge/CompositePropagationFactorySupplier.java b/...va/org/springframework/cloud/sleuth/brave/bridge/CompositePropagationFactorySupplier.java
@@ -23,7 +23,6 @@
 import java.util.Map;
 import java.util.stream.Collectors;
 
-import brave.internal.propagation.StringPropagationAdapter;
 import brave.propagation.B3Propagation;
 import brave.propagation.Propagation;
 import brave.propagation.TraceContext;
@@ -129,8 +128,8 @@ public <R> TraceContext.Extractor<R> extractor(Getter<R, String> getter) {
 	}
 
 	@Override
-	public <K> Propagation<K> create(KeyFactory<K> keyFactory) {
-		return StringPropagationAdapter.create(this, keyFactory);
+	public Propagation<String> get() {
+		return this;
 	}
 
 	@Override
@@ -177,8 +176,8 @@ private Propagation.Factory propagationFactory() {
 		}
 
 		@Override
-		public <K> Propagation<K> create(KeyFactory<K> keyFactory) {
-			return propagationFactory().create(keyFactory);
+		public Propagation<String> get() {
+			return new LazyPropagation(this);
 		}
 
 		@Override
@@ -191,11 +190,6 @@ public boolean requires128BitTraceId() {
 			return propagationFactory().requires128BitTraceId();
 		}
 
-		@Override
-		public Propagation<String> get() {
-			return new LazyPropagation(this);
-		}
-
 		@Override
 		public TraceContext decorate(TraceContext context) {
 			return propagationFactory().decorate(context);
@@ -260,8 +254,8 @@ public <R> TraceContext.Extractor<R> extractor(Getter<R, String> getter) {
 		}
 
 		@Override
-		public <K> Propagation<K> create(KeyFactory<K> keyFactory) {
-			return StringPropagationAdapter.create(this, keyFactory);
+		public Propagation<String> get() {
+			return this;
 		}
 
 	}

diff --git a/...uth-brave/src/main/java/org/springframework/cloud/sleuth/brave/bridge/W3CPropagation.java b/...uth-brave/src/main/java/org/springframework/cloud/sleuth/brave/bridge/W3CPropagation.java
@@ -31,7 +31,6 @@
 import brave.baggage.BaggagePropagation;
 import brave.baggage.BaggagePropagationConfig;
 import brave.internal.baggage.BaggageFields;
-import brave.internal.propagation.StringPropagationAdapter;
 import brave.propagation.Propagation;
 import brave.propagation.TraceContext;
 import brave.propagation.TraceContextOrSamplingFlags;
@@ -129,8 +128,8 @@ class W3CPropagation extends Propagation.Factory implements Propagation<String>
 	}
 
 	@Override
-	public <K> Propagation<K> create(KeyFactory<K> keyFactory) {
-		return StringPropagationAdapter.create(this, keyFactory);
+	public Propagation<String> get() {
+		return this;
 	}
 
 	@Override
@@ -321,7 +320,7 @@ class W3CBaggagePropagator {
 	private BaggagePropagation.FactoryBuilder factory() {
 		return BaggagePropagation.newFactoryBuilder(new Propagation.Factory() {
 			@Override
-			public <K> Propagation<K> create(Propagation.KeyFactory<K> keyFactory) {
+			public Propagation<String> get() {
 				return null;
 			}
 		});

diff --git a/spring-cloud-sleuth-dependencies/.flattened-pom.xml b/spring-cloud-sleuth-dependencies/.flattened-pom.xml
@@ -100,9 +100,10 @@
     <downloadUrl>https://github.com/spring-cloud</downloadUrl>
   </distributionManagement>
   <properties>
-    <brave.opentracing.version>0.37.4</brave.opentracing.version>
+    <brave.opentracing.version>1.0.1</brave.opentracing.version>
     <grpc.spring.boot.version>4.2.2</grpc.spring.boot.version>
-    <brave.version>5.13.9</brave.version>
+	<zipkin-reporter.version>2.17.2</zipkin-reporter.version>
+	<brave.version>5.18.0</brave.version>
   </properties>
   <dependencyManagement>
     <dependencies>
@@ -141,6 +142,13 @@
         <artifactId>spring-cloud-sleuth-tests-common</artifactId>
         <version>${project.version}</version>
       </dependency>
+      <dependency>
+        <groupId>io.zipkin.reporter2</groupId>
+        <artifactId>zipkin-reporter-bom</artifactId>
+        <version>${zipkin-reporter.version}</version>
+        <type>pom</type>
+        <scope>import</scope>
+      </dependency>
       <dependency>
         <groupId>io.zipkin.brave</groupId>
         <artifactId>brave-bom</artifactId>

diff --git a/spring-cloud-sleuth-dependencies/pom.xml b/spring-cloud-sleuth-dependencies/pom.xml
@@ -42,8 +42,9 @@
 	</scm>
 
 	<properties>
-		<brave.version>5.13.11</brave.version>
-		<brave.opentracing.version>0.37.5</brave.opentracing.version>
+		<brave.version>5.18.1</brave.version>
+		<zipkin-reporter.version>2.17.2</zipkin-reporter.version>
+		<brave.opentracing.version>1.0.1</brave.opentracing.version>
 		<grpc.spring.boot.version>4.2.3</grpc.spring.boot.version>
 	</properties>
 	<dependencyManagement>
@@ -85,13 +86,32 @@
 				<version>${project.version}</version>
 			</dependency>
 			<!-- BRAVE -->
+			<dependency>
+				<groupId>io.zipkin.reporter2</groupId>
+				<artifactId>zipkin-reporter-bom</artifactId>
+				<version>${zipkin-reporter.version}</version>
+				<type>pom</type>
+				<scope>import</scope>
+			</dependency>
 			<dependency>
 				<groupId>io.zipkin.brave</groupId>
 				<artifactId>brave-bom</artifactId>
 				<version>${brave.version}</version>
 				<type>pom</type>
 				<scope>import</scope>
 			</dependency>
+			<!-- Brave prior to v6 had a reporter dependency. Remove that to avoid conflicts. -->
+			<dependency>
+				<groupId>io.zipkin.brave</groupId>
+				<artifactId>brave</artifactId>
+				<version>${brave.version}</version>
+				<exclusions>
+					<exclusion>
+						<groupId>*</groupId>
+						<artifactId>*</artifactId>
+					</exclusion>
+				</exclusions>
+			</dependency>
 			<dependency>
 				<groupId>io.opentracing.brave</groupId>
 				<artifactId>brave-opentracing</artifactId>

diff --git a/spring-cloud-sleuth-zipkin/pom.xml b/spring-cloud-sleuth-zipkin/pom.xml
@@ -96,6 +96,7 @@
 			<groupId>io.zipkin.zipkin2</groupId>
 			<artifactId>zipkin</artifactId>
 		</dependency>
+		<!-- Needed for ZipkinRestTemplateSenderConfiguration: BytesMessageEncoder  -->
 		<dependency>
 			<groupId>io.zipkin.reporter2</groupId>
 			<artifactId>zipkin-reporter</artifactId>

diff --git a/...a/org/springframework/cloud/sleuth/brave/instrument/async/TraceAsyncIntegrationTests.java b/...a/org/springframework/cloud/sleuth/brave/instrument/async/TraceAsyncIntegrationTests.java
@@ -24,8 +24,8 @@
 import brave.propagation.CurrentTraceContext;
 import brave.propagation.TraceContext;
 import brave.test.IntegrationTestSpanHandler;
-import org.junit.ClassRule;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -48,7 +48,7 @@ public class TraceAsyncIntegrationTests {
 
 	private static final Logger log = LoggerFactory.getLogger(TraceAsyncIntegrationTests.class);
 
-	@ClassRule
+	@RegisterExtension
 	public static IntegrationTestSpanHandler spans = new IntegrationTestSpanHandler();
 
 	TraceContext context = TraceContext.newBuilder().traceId(1).spanId(2).sampled(true).build();

diff --git a/...test/java/org/springframework/cloud/sleuth/brave/instrument/web/client/MergedFactory.java b/...test/java/org/springframework/cloud/sleuth/brave/instrument/web/client/MergedFactory.java
@@ -20,7 +20,6 @@
 
 import brave.Span;
 import brave.internal.collect.Lists;
-import brave.internal.propagation.StringPropagationAdapter;
 import brave.propagation.B3Propagation;
 import brave.propagation.Propagation;
 import brave.propagation.TraceContext;
@@ -52,8 +51,8 @@ public <R> TraceContext.Extractor<R> extractor(Getter<R, String> getter) {
 	}
 
 	@Override
-	public <K> Propagation<K> create(KeyFactory<K> keyFactory) {
-		return StringPropagationAdapter.create(this, keyFactory);
+	public Propagation<String> get() {
+		return this;
 	}
 
 }
diff --git a/tests/brave/spring-cloud-sleuth-zipkin-tests/pom.xml b/tests/brave/spring-cloud-sleuth-zipkin-tests/pom.xml
@@ -82,11 +82,13 @@
 		</dependency>
 		<dependency>
 			<groupId>io.zipkin.reporter2</groupId>
-			<artifactId>zipkin-reporter</artifactId>
+			<artifactId>zipkin-reporter-brave</artifactId>
 		</dependency>
+		<!-- Needed for ZipkinRestTemplateSenderConfiguration: BytesMessageEncoder  -->
 		<dependency>
 			<groupId>io.zipkin.reporter2</groupId>
-			<artifactId>zipkin-reporter-brave</artifactId>
+			<artifactId>zipkin-reporter</artifactId>
+			<optional>true</optional>
 		</dependency>
 		<dependency>
 			<groupId>io.zipkin.reporter2</groupId>

diff --git a/tests/common/pom.xml b/tests/common/pom.xml
@@ -241,12 +241,13 @@
 		</dependency>
 		<dependency>
 			<groupId>io.zipkin.reporter2</groupId>
-			<artifactId>zipkin-reporter</artifactId>
+			<artifactId>zipkin-reporter-brave</artifactId>
 			<optional>true</optional>
 		</dependency>
+		<!-- Needed for ZipkinRestTemplateSenderConfiguration: BytesMessageEncoder  -->
 		<dependency>
 			<groupId>io.zipkin.reporter2</groupId>
-			<artifactId>zipkin-reporter-brave</artifactId>
+			<artifactId>zipkin-reporter</artifactId>
 			<optional>true</optional>
 		</dependency>
 		<dependency>