test backfill

Signed-off-by: Adrian Cole <[email protected]>

Author: codefromthecrypt

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/zipkin/ZipkinAutoConfiguration.java

@@ -18,8 +18,6 @@
 
 import zipkin2.reporter.BytesMessageSender;
 import zipkin2.reporter.Encoding;
-import zipkin2.reporter.HttpEndpointSupplier;
-import zipkin2.reporter.HttpEndpointSuppliers;
 
 import org.springframework.boot.actuate.autoconfigure.tracing.zipkin.ZipkinConfigurations.BraveConfiguration;
 import org.springframework.boot.actuate.autoconfigure.tracing.zipkin.ZipkinConfigurations.OpenTelemetryConfiguration;
@@ -48,12 +46,6 @@
 @EnableConfigurationProperties(ZipkinProperties.class)
 public class ZipkinAutoConfiguration {
 
-	@Bean
-	@ConditionalOnMissingBean(HttpEndpointSupplier.Factory.class)
-	HttpEndpointSupplier.Factory endpointSupplierFactory() {
-		return HttpEndpointSuppliers.constantFactory();
-	}
-
 	@Bean
 	@ConditionalOnMissingBean(ZipkinConnectionDetails.class)
 	PropertiesZipkinConnectionDetails zipkinConnectionDetails(ZipkinProperties properties) {

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/tracing/zipkin/ZipkinConfigurations.java

@@ -150,15 +150,10 @@ static class BraveConfiguration {
 		@Bean
 		@ConditionalOnMissingBean(value = MutableSpan.class, parameterizedContainer = BytesEncoder.class)
 		@ConditionalOnEnabledTracing
-		Tag<Throwable> errorTag() {
-			return Tags.ERROR;
-		}
-
-		@Bean
-		@ConditionalOnMissingBean(value = MutableSpan.class, parameterizedContainer = BytesEncoder.class)
-		@ConditionalOnEnabledTracing
-		BytesEncoder<MutableSpan> braveSpanEncoder(Encoding encoding, Tag<Throwable> errorTag) {
-			return MutableSpanBytesEncoder.create(encoding, errorTag);
+		BytesEncoder<MutableSpan> braveSpanEncoder(Encoding encoding,
+				ObjectProvider<Tag<Throwable>> throwableTagProvider) {
+			Tag<Throwable> throwableTag = throwableTagProvider.getIfAvailable(() -> Tags.ERROR);
+			return MutableSpanBytesEncoder.create(encoding, throwableTag);
 		}
 
 		@Bean

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/tracing/zipkin/ZipkinConfigurationsBraveConfigurationTests.java

@@ -16,6 +16,8 @@
 
 package org.springframework.boot.actuate.autoconfigure.tracing.zipkin;
 
+import java.nio.charset.StandardCharsets;
+
 import brave.Tag;
 import brave.handler.MutableSpan;
 import brave.handler.SpanHandler;
@@ -121,6 +123,43 @@ void shouldUseCustomEncodingBean() {
 			});
 	}
 
+	@Test
+	void shouldUseDefaultThrowableTagBean() {
+		this.contextRunner.withUserConfiguration(SenderConfiguration.class).run((context) -> {
+			@SuppressWarnings("unchecked")
+			BytesEncoder<MutableSpan> encoder = context.getBean(BytesEncoder.class);
+
+			MutableSpan span = new MutableSpan();
+			span.traceId("1");
+			span.id("1");
+			span.tag("error", "true");
+			span.error(new RuntimeException("ice cream"));
+
+			// default tag key name is "error", and doesn't overwrite
+			assertThat(new String(encoder.encode(span), StandardCharsets.UTF_8)).isEqualTo(
+					"{\"traceId\":\"0000000000000001\",\"id\":\"0000000000000001\",\"tags\":{\"error\":\"true\"}}");
+		});
+	}
+
+	@Test
+	void shouldUseCustomThrowableTagBean() {
+		this.contextRunner.withUserConfiguration(SenderConfiguration.class, CustomThrowableTagConfiguration.class)
+			.run((context) -> {
+				@SuppressWarnings("unchecked")
+				BytesEncoder<MutableSpan> encoder = context.getBean(BytesEncoder.class);
+
+				MutableSpan span = new MutableSpan();
+				span.traceId("1");
+				span.id("1");
+				span.tag("error", "true");
+				span.error(new RuntimeException("ice cream"));
+
+				// The custom throwable parser doesn't use the key "error" we can see both
+				assertThat(new String(encoder.encode(span), StandardCharsets.UTF_8)).isEqualTo(
+						"{\"traceId\":\"0000000000000001\",\"id\":\"0000000000000001\",\"tags\":{\"error\":\"true\",\"exception\":\"ice cream\"}}");
+			});
+	}
+
 	@Configuration(proxyBeanMethods = false)
 	private static final class SenderConfiguration {
 
@@ -142,10 +181,10 @@ AsyncZipkinSpanHandler customAsyncZipkinSpanHandler() {
 	}
 
 	@Configuration(proxyBeanMethods = false)
-	private static final class CustomErrorTagConfiguration {
+	private static final class CustomThrowableTagConfiguration {
 
 		@Bean
-		Tag<Throwable> errorTag() {
+		Tag<Throwable> throwableTag() {
 			return new Tag<Throwable>("exception") {
 				@Override
 				protected String parseValue(Throwable throwable, TraceContext traceContext) {

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/tracing/zipkin/ZipkinConfigurationsOpenTelemetryConfigurationTests.java

@@ -144,18 +144,7 @@ BytesEncoder<Span> encoder(Encoding encoding) {
 
 	}
 
-	private static final class CustomSpanEncoder implements BytesEncoder<Span> {
-
-		private final Encoding encoding;
-
-		private CustomSpanEncoder(Encoding encoding) {
-			this.encoding = encoding;
-		}
-
-		@Override
-		public Encoding encoding() {
-			return this.encoding;
-		}
+	record CustomSpanEncoder(Encoding encoding) implements BytesEncoder<Span> {
 
 		@Override
 		public int sizeInBytes(Span span) {

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/tracing/zipkin/ZipkinConfigurationsSenderConfigurationTests.java

@@ -27,6 +27,7 @@
 import org.junit.jupiter.api.Test;
 import org.mockito.ArgumentMatchers;
 import zipkin2.reporter.BytesMessageSender;
+import zipkin2.reporter.HttpEndpointSupplier;
 import zipkin2.reporter.urlconnection.URLConnectionSender;
 
 import org.springframework.boot.actuate.autoconfigure.tracing.zipkin.ZipkinConfigurations.SenderConfiguration;
@@ -173,6 +174,32 @@ void shouldApplyZipkinRestTemplateBuilderCustomizers() throws IOException {
 		}
 	}
 
+	@Test
+	void shouldUseCustomHttpEndpointSupplierFactory() {
+		this.contextRunner.withUserConfiguration(CustomHttpEndpointSupplierFactoryConfiguration.class)
+			.run((context) -> assertThat(context.getBean(URLConnectionSender.class))
+				.extracting("delegate.endpointSupplier")
+				.isInstanceOf(CustomHttpEndpointSupplier.class));
+	}
+
+	@Test
+	void shouldUseCustomHttpEndpointSupplierFactoryWhenReactive() {
+		this.reactiveContextRunner.withUserConfiguration(WebClientConfiguration.class)
+			.withClassLoader(new FilteredClassLoader(URLConnectionSender.class))
+			.withUserConfiguration(CustomHttpEndpointSupplierFactoryConfiguration.class)
+			.run((context) -> assertThat(context.getBean(ZipkinWebClientSender.class)).extracting("endpointSupplier")
+				.isInstanceOf(CustomHttpEndpointSupplier.class));
+	}
+
+	@Test
+	void shouldUseCustomHttpEndpointSupplierFactoryWhenRestTemplate() {
+		this.contextRunner.withUserConfiguration(RestTemplateConfiguration.class)
+			.withClassLoader(new FilteredClassLoader(URLConnectionSender.class, WebClient.class))
+			.withUserConfiguration(CustomHttpEndpointSupplierFactoryConfiguration.class)
+			.run((context) -> assertThat(context.getBean(ZipkinRestTemplateSender.class)).extracting("endpointSupplier")
+				.isInstanceOf(CustomHttpEndpointSupplier.class));
+	}
+
 	@Configuration(proxyBeanMethods = false)
 	private static final class RestTemplateConfiguration {
 
@@ -212,4 +239,35 @@ public RestTemplateBuilder customize(RestTemplateBuilder restTemplateBuilder) {
 
 	}
 
+	@Configuration(proxyBeanMethods = false)
+	private static final class CustomHttpEndpointSupplierFactoryConfiguration {
+
+		@Bean
+		HttpEndpointSupplier.Factory httpEndpointSupplier() {
+			return new CustomHttpEndpointSupplierFactory();
+		}
+
+	}
+
+	private static final class CustomHttpEndpointSupplierFactory implements HttpEndpointSupplier.Factory {
+
+		@Override
+		public HttpEndpointSupplier create(String endpoint) {
+			return new CustomHttpEndpointSupplier(endpoint);
+		}
+
+	}
+
+	private record CustomHttpEndpointSupplier(String endpoint) implements HttpEndpointSupplier {
+
+		@Override
+		public String get() {
+			return this.endpoint;
+		}
+
+		@Override
+		public void close() {
+		}
+	}
+
 }