RUM-9899: fix tag extractor + tracer interceptor

satween · satween · commit 35ea66d22642 · 2025-06-16T19:39:23.000+01:00
diff --git a/dd-sdk-android-internal/src/main/java/com/datadog/android/internal/utils/CastExt.kt b/dd-sdk-android-internal/src/main/java/com/datadog/android/internal/utils/CastExt.kt
@@ -0,0 +1,28 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2016-Present Datadog, Inc.
+ */
+package com.datadog.android.internal.utils
+
+/**
+ * Handy function aimed to improve readability with casting logic
+ * E.g:
+ * ```kotlin
+ * val writer1 = (
+ *      featuredSdkCore.getFeature(Feature.TRACING_FEATURE_NAME)
+ *          ?.unwrap<Feature>() as? com.datadog.android.trace.InternalCoreWriterProvider
+ *      )
+ *     ?.getCoreTracerWriter()
+ * ```
+ * now could be written as:
+ * ```kotlin
+    val writer = featuredSdkCore.getFeature(Feature.TRACING_FEATURE_NAME)
+        ?.unwrap<Feature>()
+        ?.tryCastTo<com.datadog.android.trace.InternalCoreWriterProvider>()
+        ?.getCoreTracerWriter()
+ *  ```
+ */
+inline fun <reified R> Any.tryCastTo(): R? {
+    return this as R
+}
diff --git a/features/dd-sdk-android-trace-internal/src/main/java/com/datadog/trace/common/writer/NoOpWriter.java b/features/dd-sdk-android-trace-internal/src/main/java/com/datadog/trace/common/writer/NoOpWriter.java
@@ -10,16 +10,14 @@
 
 import java.util.List;
 
-public class NoOpWriter implements Writer{
+public class NoOpWriter implements Writer {
 
     @Override
     public void write(List<DDSpan> trace) {
-
     }
 
     @Override
     public void start() {
-
     }
 
     @Override
@@ -29,11 +27,9 @@ public boolean flush() {
 
     @Override
     public void close() {
-
     }
 
     @Override
     public void incrementDropCounts(int spanCount) {
-
     }
 }
diff --git a/features/dd-sdk-android-trace-internal/src/main/java/com/datadog/trace/core/propagation/HttpCodec.java b/features/dd-sdk-android-trace-internal/src/main/java/com/datadog/trace/core/propagation/HttpCodec.java
@@ -2,6 +2,9 @@
 
 import static com.datadog.trace.api.TracePropagationStyle.TRACECONTEXT;
 
+import androidx.annotation.Nullable;
+
+import com.datadog.android.trace.internal.compat.function.Supplier;
 import com.datadog.trace.api.Config;
 import com.datadog.trace.api.DD128bTraceId;
 import com.datadog.trace.api.DD64bTraceId;
@@ -24,7 +27,6 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
-import com.datadog.android.trace.internal.compat.function.Supplier;
 
 public class HttpCodec {
 
@@ -66,6 +68,7 @@ public interface Extractor {
      * @return {@code null} for failed context extraction, a {@link TagContext} instance for partial
      *     context extraction or an {@link ExtractedContext} for complete context extraction.
      */
+    @Nullable
     <C> TagContext extract(final C carrier, final AgentPropagation.ContextVisitor<C> getter);
 
     /**
diff --git a/features/dd-sdk-android-trace-internal/src/main/java/com/datadog/trace/core/propagation/TagContextExtractor.java b/features/dd-sdk-android-trace-internal/src/main/java/com/datadog/trace/core/propagation/TagContextExtractor.java
@@ -1,32 +1,47 @@
 package com.datadog.trace.core.propagation;
 
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+import com.datadog.android.trace.internal.compat.function.Supplier;
 import com.datadog.trace.api.TraceConfig;
 import com.datadog.trace.bootstrap.instrumentation.api.AgentPropagation;
 import com.datadog.trace.bootstrap.instrumentation.api.TagContext;
 
-import com.datadog.android.trace.internal.compat.function.Supplier;
-
 public class TagContextExtractor implements HttpCodec.Extractor {
 
   private final Supplier<TraceConfig> traceConfigSupplier;
   private final ThreadLocal<ContextInterpreter> ctxInterpreter;
+  private final ContextInterpreter.Factory factory;
 
   public TagContextExtractor(
       final Supplier<TraceConfig> traceConfigSupplier, final ContextInterpreter.Factory factory) {
+    this.factory = factory;
     this.traceConfigSupplier = traceConfigSupplier;
     this.ctxInterpreter = new ThreadLocal<>();
-    this.ctxInterpreter.set(factory.create());
   }
 
   @Override
+  public void cleanup() {
+    ctxInterpreter.remove();
+  }
+
+  @Override
+  @Nullable
   public <C> TagContext extract(final C carrier, final AgentPropagation.ContextVisitor<C> getter) {
-    ContextInterpreter interpreter = this.ctxInterpreter.get().reset(traceConfigSupplier.get());
+    ContextInterpreter interpreter = resolveContextInterpreter().reset(traceConfigSupplier.get());
     getter.forEachKey(carrier, interpreter);
     return interpreter.build();
   }
 
-  @Override
-  public void cleanup() {
-    ctxInterpreter.remove();
+  @NonNull
+  private ContextInterpreter resolveContextInterpreter() {
+    ContextInterpreter contextInterpreter = ctxInterpreter.get();
+    if (contextInterpreter == null) {
+      contextInterpreter = factory.create();
+      ctxInterpreter.set(contextInterpreter);
+    }
+
+    return contextInterpreter;
   }
 }
diff --git a/features/dd-sdk-android-trace-otel/src/main/kotlin/com/datadog/android/trace/opentelemetry/internal/NoOpCoreTracerWriter.kt b/features/dd-sdk-android-trace-otel/src/main/kotlin/com/datadog/android/trace/opentelemetry/internal/NoOpCoreTracerWriter.kt
diff --git a/features/dd-sdk-android-trace-otel/src/test/kotlin/com/datadog/android/trace/opentelemetry/OtelTracerBuilderProviderTest.kt b/features/dd-sdk-android-trace-otel/src/test/kotlin/com/datadog/android/trace/opentelemetry/OtelTracerBuilderProviderTest.kt
@@ -14,7 +14,6 @@ import com.datadog.android.api.feature.FeatureSdkCore
 import com.datadog.android.log.LogAttributes
 import com.datadog.android.trace.InternalCoreWriterProvider
 import com.datadog.android.trace.TracingHeaderType
-import com.datadog.android.trace.opentelemetry.internal.NoOpCoreTracerWriter
 import com.datadog.android.trace.opentelemetry.utils.verifyLog
 import com.datadog.android.utils.forge.Configurator
 import com.datadog.opentelemetry.trace.OtelSpan
@@ -28,6 +27,7 @@ import com.datadog.trace.api.sampling.PrioritySampling
 import com.datadog.trace.bootstrap.instrumentation.api.AgentScopeManager
 import com.datadog.trace.bootstrap.instrumentation.api.AgentTracer
 import com.datadog.trace.bootstrap.instrumentation.api.ScopeSource
+import com.datadog.trace.common.writer.NoOpWriter
 import com.datadog.trace.common.writer.Writer
 import com.datadog.trace.core.CoreTracer
 import com.datadog.trace.core.DDSpan
@@ -181,7 +181,7 @@ internal class OtelTracerBuilderProviderTest {
         assertThat(tracer).isNotNull
         val coreTracer: CoreTracer = tracer.getFieldValue("coreTracer")
         val writer: Writer = coreTracer.getFieldValue("writer")
-        assertThat(writer).isInstanceOf(NoOpCoreTracerWriter::class.java)
+        assertThat(writer).isInstanceOf(NoOpWriter::class.java)
     }
 
     @Test
diff --git a/integrations/dd-sdk-android-okhttp/src/main/kotlin/com/datadog/android/okhttp/trace/TracingInterceptor.kt b/integrations/dd-sdk-android-okhttp/src/main/kotlin/com/datadog/android/okhttp/trace/TracingInterceptor.kt
@@ -19,6 +19,7 @@ import com.datadog.android.core.internal.net.DefaultFirstPartyHostHeaderTypeReso
 import com.datadog.android.core.sampling.Sampler
 import com.datadog.android.internal.telemetry.TracingHeaderTypesSet
 import com.datadog.android.internal.utils.loggableStackTrace
+import com.datadog.android.internal.utils.tryCastTo
 import com.datadog.android.okhttp.TraceContext
 import com.datadog.android.okhttp.TraceContextInjection
 import com.datadog.android.okhttp.internal.otel.toAgentSpanContext
@@ -33,6 +34,7 @@ import com.datadog.trace.api.sampling.SamplingMechanism
 import com.datadog.trace.bootstrap.instrumentation.api.AgentSpan
 import com.datadog.trace.bootstrap.instrumentation.api.Tags
 import com.datadog.trace.common.sampling.AllSampler
+import com.datadog.trace.common.writer.NoOpWriter
 import com.datadog.trace.core.CoreTracer
 import com.datadog.trace.core.DDSpan
 import com.datadog.trace.core.propagation.ExtractedContext
@@ -385,7 +387,7 @@ internal constructor(
         val tagContext = request.tag(Span::class.java)?.context()
             ?: request.tag(TraceContext::class.java)?.toAgentSpanContext()
 
-        val headerContext: AgentSpan.Context.Extracted = tracer.propagate().extract(request) { carrier, classifier ->
+        val headerContext: AgentSpan.Context.Extracted? = tracer.propagate().extract(request) { carrier, classifier ->
             val headers = carrier.headers.toMultimap()
                 .map { it.key to it.value.joinToString(";") }
                 .toMap()
@@ -847,17 +849,35 @@ internal constructor(
         internal const val OKHTTP_INTERCEPTOR_HEADER_TYPES = "okhttp_interceptor_header_types"
 
         private const val AGENT_PSR_ATTRIBUTE = "_dd.agent_psr"
+        private const val WRITER_PROVIDER_INTERFACE_NOT_IMPLEMENTED_ERROR_MESSAGE =
+            "The Tracing feature is not implementing the InternalCoreWriterProvider interface." +
+                    " No tracing data will be sent."
 
         private val DEFAULT_LOCAL_TRACER_FACTORY: (SdkCore, Set<TracingHeaderType>) -> Tracer =
             { sdkCore, tracingHeaderTypes: Set<TracingHeaderType> ->
-                val propagationStyles = tracingHeaderTypes.joinToString(",")
-                CoreTracer.CoreTracerBuilder((sdkCore as FeatureSdkCore).internalLogger)
+                val featuredSdkCore = sdkCore as FeatureSdkCore
+                val writer = featuredSdkCore.getFeature(Feature.TRACING_FEATURE_NAME)
+                    ?.unwrap<Feature>()
+                    ?.tryCastTo<com.datadog.android.trace.InternalCoreWriterProvider>()
+                    ?.getCoreTracerWriter()
+                    ?: run {
+                        sdkCore.internalLogger.log(
+                            InternalLogger.Level.ERROR,
+                            InternalLogger.Target.MAINTAINER,
+                            { WRITER_PROVIDER_INTERFACE_NOT_IMPLEMENTED_ERROR_MESSAGE }
+                        )
+                        NoOpWriter()
+                    }
+
+                CoreTracer.CoreTracerBuilder(featuredSdkCore.internalLogger)
                     .withProperties(
                         Properties().apply {
+                            val propagationStyles = tracingHeaderTypes.joinToString(",")
                             setProperty(TracerConfig.PROPAGATION_STYLE_EXTRACT, propagationStyles)
                             setProperty(TracerConfig.PROPAGATION_STYLE_INJECT, propagationStyles)
                         }
                     )
+                    .writer(writer)
                     .sampler(AllSampler())
                     .build()
             }

Original file line number	Diff line number	Diff line change
`@@ -10,16 +10,14 @@`
`10`	`10`
`11`	`11`	`import java.util.List;`
`12`	`12`
`13`		`-public class NoOpWriter implements Writer{`
	`13`	`+public class NoOpWriter implements Writer {`
`14`	`14`
`15`	`15`	`@Override`
`16`	`16`	`public void write(List<DDSpan> trace) {`
`17`		`-`
`18`	`17`	`}`
`19`	`18`
`20`	`19`	`@Override`
`21`	`20`	`public void start() {`
`22`		`-`
`23`	`21`	`}`
`24`	`22`
`25`	`23`	`@Override`
`@@ -29,11 +27,9 @@ public boolean flush() {`
`29`	`27`
`30`	`28`	`@Override`
`31`	`29`	`public void close() {`
`32`		`-`
`33`	`30`	`}`
`34`	`31`
`35`	`32`	`@Override`
`36`	`33`	`public void incrementDropCounts(int spanCount) {`
`37`		`-`
`38`	`34`	`}`
`39`	`35`	`}`