feat(core): Rename AgentSpanContext.noop() into AgentSpanContext.noopSpanContext()

PerfectSlayer · PerfectSlayer · commit a8ce0d6001e6 · 2025-02-06T15:15:35.000+01:00
The goal is to normalize the API
diff --git a/dd-java-agent/instrumentation/opentelemetry/opentelemetry-0.3/src/main/java/datadog/trace/instrumentation/opentelemetry/TypeConverter.java b/dd-java-agent/instrumentation/opentelemetry/opentelemetry-0.3/src/main/java/datadog/trace/instrumentation/opentelemetry/TypeConverter.java
@@ -1,6 +1,7 @@
 package datadog.trace.instrumentation.opentelemetry;
 
 import static datadog.trace.bootstrap.instrumentation.api.AgentSpan.noopSpan;
+import static datadog.trace.bootstrap.instrumentation.api.AgentSpanContext.noopSpanContext;
 
 import datadog.trace.bootstrap.instrumentation.api.AgentScope;
 import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
@@ -18,7 +19,7 @@ public class TypeConverter {
 
   public TypeConverter() {
     noopSpanWrapper = new OtelSpan(noopSpan(), this);
-    noopContextWrapper = new OtelSpanContext(AgentSpanContext.noop());
+    noopContextWrapper = new OtelSpanContext(noopSpanContext());
     noopScopeWrapper = new OtelScope(AgentScope.noop());
   }
 
@@ -74,7 +75,7 @@ public SpanContext toSpanContext(final AgentSpanContext context) {
       return null;
     }
     // avoid a new SpanContext wrapper allocation for the noop context
-    if (context == AgentSpanContext.noop()) {
+    if (context == noopSpanContext()) {
       return noopContextWrapper;
     }
     return new OtelSpanContext(context);
@@ -84,6 +85,6 @@ public AgentSpanContext toContext(final SpanContext spanContext) {
     if (spanContext instanceof OtelSpanContext) {
       return ((OtelSpanContext) spanContext).getDelegate();
     }
-    return null == spanContext ? null : AgentSpanContext.noop();
+    return null == spanContext ? null : noopSpanContext();
   }
 }
diff --git a/dd-java-agent/instrumentation/opentelemetry/opentelemetry-0.3/src/test/groovy/TypeConverterTest.groovy b/dd-java-agent/instrumentation/opentelemetry/opentelemetry-0.3/src/test/groovy/TypeConverterTest.groovy
@@ -4,7 +4,6 @@ import datadog.trace.api.DDTraceId
 import datadog.trace.api.sampling.PrioritySampling
 import datadog.trace.bootstrap.instrumentation.api.AgentScope
 import datadog.trace.bootstrap.instrumentation.api.AgentSpan
-import datadog.trace.bootstrap.instrumentation.api.AgentSpanContext
 import datadog.trace.bootstrap.instrumentation.api.AgentTracer.NoopPathwayContext
 import datadog.trace.bootstrap.instrumentation.api.ScopeSource
 import datadog.trace.core.DDSpan
@@ -14,6 +13,8 @@ import datadog.trace.core.propagation.PropagationTags
 import datadog.trace.core.scopemanager.ContinuableScopeManager
 import datadog.trace.instrumentation.opentelemetry.TypeConverter
 
+import static datadog.trace.bootstrap.instrumentation.api.AgentSpanContext.noopSpanContext
+
 class TypeConverterTest extends AgentTestRunner {
   TypeConverter typeConverter = new TypeConverter()
 
@@ -35,7 +36,7 @@ class TypeConverterTest extends AgentTestRunner {
   }
 
   def "should avoid the noop context wrapper allocation"() {
-    def noopContext = AgentSpanContext.noop()
+    def noopContext = noopSpanContext()
     expect:
     typeConverter.toSpanContext(noopContext) is typeConverter.toSpanContext(noopContext)
   }
diff --git a/dd-java-agent/instrumentation/opentracing/api-0.31/src/main/java/datadog/trace/instrumentation/opentracing31/TypeConverter.java b/dd-java-agent/instrumentation/opentracing/api-0.31/src/main/java/datadog/trace/instrumentation/opentracing31/TypeConverter.java
@@ -1,6 +1,7 @@
 package datadog.trace.instrumentation.opentracing31;
 
 import static datadog.trace.bootstrap.instrumentation.api.AgentSpan.noopSpan;
+import static datadog.trace.bootstrap.instrumentation.api.AgentSpanContext.noopSpanContext;
 
 import datadog.trace.bootstrap.instrumentation.api.AgentScope;
 import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
@@ -21,7 +22,7 @@ public class TypeConverter {
   public TypeConverter(final LogHandler logHandler) {
     this.logHandler = logHandler;
     noopSpanWrapper = new OTSpan(noopSpan(), this, logHandler);
-    noopContextWrapper = new OTSpanContext(AgentSpanContext.noop());
+    noopContextWrapper = new OTSpanContext(noopSpanContext());
     noopScopeWrapper = new OTScopeManager.OTScope(AgentScope.noop(), false, this);
   }
 
@@ -80,7 +81,7 @@ public SpanContext toSpanContext(final AgentSpanContext context) {
       return null;
     }
     // avoid a new SpanContext wrapper allocation for the noop context
-    if (context == AgentSpanContext.noop()) {
+    if (context == noopSpanContext()) {
       return noopContextWrapper;
     }
     return new OTSpanContext(context);
@@ -90,6 +91,6 @@ public AgentSpanContext toContext(final SpanContext spanContext) {
     if (spanContext instanceof OTSpanContext) {
       return ((OTSpanContext) spanContext).getDelegate();
     }
-    return null == spanContext ? null : AgentSpanContext.noop();
+    return null == spanContext ? null : noopSpanContext();
   }
 }
diff --git a/dd-java-agent/instrumentation/opentracing/api-0.31/src/test/groovy/TypeConverterTest.groovy b/dd-java-agent/instrumentation/opentracing/api-0.31/src/test/groovy/TypeConverterTest.groovy
@@ -4,7 +4,6 @@ import datadog.trace.api.DDTraceId
 import datadog.trace.api.sampling.PrioritySampling
 import datadog.trace.bootstrap.instrumentation.api.AgentScope
 import datadog.trace.bootstrap.instrumentation.api.AgentSpan
-import datadog.trace.bootstrap.instrumentation.api.AgentSpanContext
 import datadog.trace.bootstrap.instrumentation.api.AgentTracer.NoopPathwayContext
 import datadog.trace.bootstrap.instrumentation.api.ScopeSource
 import datadog.trace.core.DDSpan
@@ -15,6 +14,8 @@ import datadog.trace.core.scopemanager.ContinuableScopeManager
 import datadog.trace.instrumentation.opentracing.DefaultLogHandler
 import datadog.trace.instrumentation.opentracing31.TypeConverter
 
+import static datadog.trace.bootstrap.instrumentation.api.AgentSpanContext.noopSpanContext
+
 class TypeConverterTest extends AgentTestRunner {
   TypeConverter typeConverter = new TypeConverter(new DefaultLogHandler())
 
@@ -36,7 +37,7 @@ class TypeConverterTest extends AgentTestRunner {
   }
 
   def "should avoid the noop context wrapper allocation"() {
-    def noopContext = AgentSpanContext.noop()
+    def noopContext = noopSpanContext()
     expect:
     typeConverter.toSpanContext(noopContext) is typeConverter.toSpanContext(noopContext)
   }
diff --git a/dd-java-agent/instrumentation/opentracing/api-0.32/src/main/java/datadog/trace/instrumentation/opentracing32/TypeConverter.java b/dd-java-agent/instrumentation/opentracing/api-0.32/src/main/java/datadog/trace/instrumentation/opentracing32/TypeConverter.java
@@ -1,6 +1,7 @@
 package datadog.trace.instrumentation.opentracing32;
 
 import static datadog.trace.bootstrap.instrumentation.api.AgentSpan.noopSpan;
+import static datadog.trace.bootstrap.instrumentation.api.AgentSpanContext.noopSpanContext;
 
 import datadog.trace.bootstrap.instrumentation.api.AgentScope;
 import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
@@ -21,7 +22,7 @@ public class TypeConverter {
   public TypeConverter(final LogHandler logHandler) {
     this.logHandler = logHandler;
     noopSpanWrapper = new OTSpan(noopSpan(), this, logHandler);
-    noopContextWrapper = new OTSpanContext(AgentSpanContext.noop());
+    noopContextWrapper = new OTSpanContext(noopSpanContext());
     noopScopeWrapper = new OTScopeManager.OTScope(AgentScope.noop(), false, this);
   }
 
@@ -80,7 +81,7 @@ public SpanContext toSpanContext(final AgentSpanContext context) {
       return null;
     }
     // avoid a new SpanContext wrapper allocation for the noop context
-    if (context == AgentSpanContext.noop()) {
+    if (context == noopSpanContext()) {
       return noopContextWrapper;
     }
     return new OTSpanContext(context);
@@ -90,6 +91,6 @@ public AgentSpanContext toContext(final SpanContext spanContext) {
     if (spanContext instanceof OTSpanContext) {
       return ((OTSpanContext) spanContext).getDelegate();
     }
-    return null == spanContext ? null : AgentSpanContext.noop();
+    return null == spanContext ? null : noopSpanContext();
   }
 }
diff --git a/dd-java-agent/instrumentation/opentracing/api-0.32/src/test/groovy/TypeConverterTest.groovy b/dd-java-agent/instrumentation/opentracing/api-0.32/src/test/groovy/TypeConverterTest.groovy
@@ -4,7 +4,6 @@ import datadog.trace.api.DDTraceId
 import datadog.trace.api.sampling.PrioritySampling
 import datadog.trace.bootstrap.instrumentation.api.AgentScope
 import datadog.trace.bootstrap.instrumentation.api.AgentSpan
-import datadog.trace.bootstrap.instrumentation.api.AgentSpanContext
 import datadog.trace.bootstrap.instrumentation.api.AgentTracer.NoopPathwayContext
 import datadog.trace.bootstrap.instrumentation.api.ScopeSource
 import datadog.trace.core.DDSpan
@@ -15,6 +14,8 @@ import datadog.trace.core.scopemanager.ContinuableScopeManager
 import datadog.trace.instrumentation.opentracing.DefaultLogHandler
 import datadog.trace.instrumentation.opentracing32.TypeConverter
 
+import static datadog.trace.bootstrap.instrumentation.api.AgentSpanContext.noopSpanContext
+
 class TypeConverterTest extends AgentTestRunner {
   TypeConverter typeConverter = new TypeConverter(new DefaultLogHandler())
 
@@ -36,7 +37,7 @@ class TypeConverterTest extends AgentTestRunner {
   }
 
   def "should avoid the noop context wrapper allocation"() {
-    def noopContext = AgentSpanContext.noop()
+    def noopContext = noopSpanContext()
     expect:
     typeConverter.toSpanContext(noopContext) is typeConverter.toSpanContext(noopContext)
   }
diff --git a/dd-trace-core/src/main/java/datadog/trace/core/tagprocessor/SpanPointersProcessor.java b/dd-trace-core/src/main/java/datadog/trace/core/tagprocessor/SpanPointersProcessor.java
@@ -1,10 +1,11 @@
 package datadog.trace.core.tagprocessor;
 
+import static datadog.trace.bootstrap.instrumentation.api.AgentSpanContext.noopSpanContext;
+import static datadog.trace.bootstrap.instrumentation.api.AgentSpanLink.DEFAULT_FLAGS;
 import static datadog.trace.bootstrap.instrumentation.api.InstrumentationTags.AWS_BUCKET_NAME;
 import static datadog.trace.bootstrap.instrumentation.api.InstrumentationTags.AWS_OBJECT_KEY;
 import static datadog.trace.bootstrap.instrumentation.api.InstrumentationTags.S3_ETAG;
 
-import datadog.trace.bootstrap.instrumentation.api.AgentSpanContext;
 import datadog.trace.bootstrap.instrumentation.api.AgentSpanLink;
 import datadog.trace.bootstrap.instrumentation.api.SpanAttributes;
 import datadog.trace.bootstrap.instrumentation.api.SpanLink;
@@ -57,8 +58,7 @@ public Map<String, Object> processTags(
               .put("link.kind", LINK_KIND)
               .build();
 
-      AgentSpanContext zeroContext = AgentSpanContext.noop();
-      AgentSpanLink link = SpanLink.from(zeroContext, AgentSpanLink.DEFAULT_FLAGS, "", attributes);
+      AgentSpanLink link = SpanLink.from(noopSpanContext(), DEFAULT_FLAGS, "", attributes);
       spanLinks.add(link);
     } catch (Exception e) {
       LOG.debug("Failed to add span pointer: {}", e.getMessage());
diff --git a/dd-trace-ot/src/main/java/datadog/opentracing/TypeConverter.java b/dd-trace-ot/src/main/java/datadog/opentracing/TypeConverter.java
@@ -1,6 +1,7 @@
 package datadog.opentracing;
 
 import static datadog.trace.bootstrap.instrumentation.api.AgentSpan.noopSpan;
+import static datadog.trace.bootstrap.instrumentation.api.AgentSpanContext.noopSpanContext;
 
 import datadog.trace.bootstrap.instrumentation.api.AgentScope;
 import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
@@ -20,7 +21,7 @@ class TypeConverter {
   public TypeConverter(final LogHandler logHandler) {
     this.logHandler = logHandler;
     noopSpanWrapper = new OTSpan(noopSpan(), this, logHandler);
-    noopContextWrapper = new OTSpanContext(AgentSpanContext.noop());
+    noopContextWrapper = new OTSpanContext(noopSpanContext());
     noopScopeWrapper = new OTScopeManager.OTScope(AgentScope.noop(), false, this);
   }
 
@@ -83,7 +84,7 @@ public SpanContext toSpanContext(final AgentSpanContext context) {
       return null;
     }
     // avoid a new SpanContext wrapper allocation for the noop context
-    if (context == AgentSpanContext.noop()) {
+    if (context == noopSpanContext()) {
       return noopContextWrapper;
     }
     return new OTSpanContext(context);
@@ -95,7 +96,7 @@ public AgentSpanContext toContext(final SpanContext spanContext) {
     } else if (spanContext instanceof OTSpanContext) {
       return ((OTSpanContext) spanContext).getDelegate();
     } else {
-      return AgentSpanContext.noop();
+      return noopSpanContext();
     }
   }
 }
diff --git a/dd-trace-ot/src/test/groovy/datadog/opentracing/TypeConverterTest.groovy b/dd-trace-ot/src/test/groovy/datadog/opentracing/TypeConverterTest.groovy
@@ -5,7 +5,6 @@ import datadog.trace.api.DDTraceId
 import datadog.trace.api.sampling.PrioritySampling
 import datadog.trace.bootstrap.instrumentation.api.AgentScope
 import datadog.trace.bootstrap.instrumentation.api.AgentSpan
-import datadog.trace.bootstrap.instrumentation.api.AgentSpanContext
 import datadog.trace.bootstrap.instrumentation.api.ScopeSource
 import datadog.trace.core.CoreTracer
 import datadog.trace.core.DDSpan
@@ -15,6 +14,7 @@ import datadog.trace.core.propagation.PropagationTags
 import datadog.trace.core.scopemanager.ContinuableScopeManager
 import datadog.trace.test.util.DDSpecification
 
+import static datadog.trace.bootstrap.instrumentation.api.AgentSpanContext.noopSpanContext
 import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.NoopPathwayContext
 
 class TypeConverterTest extends DDSpecification {
@@ -38,7 +38,7 @@ class TypeConverterTest extends DDSpecification {
   }
 
   def "should avoid the noop context wrapper allocation"() {
-    def noopContext = AgentSpanContext.noop()
+    def noopContext = noopSpanContext()
     expect:
     typeConverter.toSpanContext(noopContext) is typeConverter.toSpanContext(noopContext)
   }
diff --git a/internal-api/src/main/java/datadog/trace/bootstrap/instrumentation/api/AgentSpanContext.java b/internal-api/src/main/java/datadog/trace/bootstrap/instrumentation/api/AgentSpanContext.java
@@ -21,7 +21,7 @@ public interface AgentSpanContext {
    *
    * @return the noop scope instance.
    */
-  static AgentSpanContext noop() {
+  static AgentSpanContext noopSpanContext() {
     return NoopSpanContext.INSTANCE;
   }
 

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package datadog.trace.instrumentation.opentelemetry;`
`2`	`2`
`3`	`3`	`import static datadog.trace.bootstrap.instrumentation.api.AgentSpan.noopSpan;`
	`4`	`+import static datadog.trace.bootstrap.instrumentation.api.AgentSpanContext.noopSpanContext;`
`4`	`5`
`5`	`6`	`import datadog.trace.bootstrap.instrumentation.api.AgentScope;`
`6`	`7`	`import datadog.trace.bootstrap.instrumentation.api.AgentSpan;`
`@@ -18,7 +19,7 @@ public class TypeConverter {`
`18`	`19`
`19`	`20`	`public TypeConverter() {`
`20`	`21`	`noopSpanWrapper = new OtelSpan(noopSpan(), this);`
`21`		`- noopContextWrapper = new OtelSpanContext(AgentSpanContext.noop());`
	`22`	`+ noopContextWrapper = new OtelSpanContext(noopSpanContext());`
`22`	`23`	`noopScopeWrapper = new OtelScope(AgentScope.noop());`
`23`	`24`	`}`
`24`	`25`
`@@ -74,7 +75,7 @@ public SpanContext toSpanContext(final AgentSpanContext context) {`
`74`	`75`	`return null;`
`75`	`76`	`}`
`76`	`77`	`// avoid a new SpanContext wrapper allocation for the noop context`
`77`		`- if (context == AgentSpanContext.noop()) {`
	`78`	`+ if (context == noopSpanContext()) {`
`78`	`79`	`return noopContextWrapper;`
`79`	`80`	`}`
`80`	`81`	`return new OtelSpanContext(context);`
`@@ -84,6 +85,6 @@ public AgentSpanContext toContext(final SpanContext spanContext) {`
`84`	`85`	`if (spanContext instanceof OtelSpanContext) {`
`85`	`86`	`return ((OtelSpanContext) spanContext).getDelegate();`
`86`	`87`	`}`
`87`		`- return null == spanContext ? null : AgentSpanContext.noop();`
	`88`	`+ return null == spanContext ? null : noopSpanContext();`
`88`	`89`	`}`
`89`	`90`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package datadog.opentracing;`
`2`	`2`
`3`	`3`	`import static datadog.trace.bootstrap.instrumentation.api.AgentSpan.noopSpan;`
	`4`	`+import static datadog.trace.bootstrap.instrumentation.api.AgentSpanContext.noopSpanContext;`
`4`	`5`
`5`	`6`	`import datadog.trace.bootstrap.instrumentation.api.AgentScope;`
`6`	`7`	`import datadog.trace.bootstrap.instrumentation.api.AgentSpan;`
`@@ -20,7 +21,7 @@ class TypeConverter {`
`20`	`21`	`public TypeConverter(final LogHandler logHandler) {`
`21`	`22`	`this.logHandler = logHandler;`
`22`	`23`	`noopSpanWrapper = new OTSpan(noopSpan(), this, logHandler);`
`23`		`- noopContextWrapper = new OTSpanContext(AgentSpanContext.noop());`
	`24`	`+ noopContextWrapper = new OTSpanContext(noopSpanContext());`
`24`	`25`	`noopScopeWrapper = new OTScopeManager.OTScope(AgentScope.noop(), false, this);`
`25`	`26`	`}`
`26`	`27`
`@@ -83,7 +84,7 @@ public SpanContext toSpanContext(final AgentSpanContext context) {`
`83`	`84`	`return null;`
`84`	`85`	`}`
`85`	`86`	`// avoid a new SpanContext wrapper allocation for the noop context`
`86`		`- if (context == AgentSpanContext.noop()) {`
	`87`	`+ if (context == noopSpanContext()) {`
`87`	`88`	`return noopContextWrapper;`
`88`	`89`	`}`
`89`	`90`	`return new OTSpanContext(context);`
`@@ -95,7 +96,7 @@ public AgentSpanContext toContext(final SpanContext spanContext) {`
`95`	`96`	`} else if (spanContext instanceof OTSpanContext) {`
`96`	`97`	`return ((OTSpanContext) spanContext).getDelegate();`
`97`	`98`	`} else {`
`98`		`- return AgentSpanContext.noop();`
	`99`	`+ return noopSpanContext();`
`99`	`100`	`}`
`100`	`101`	`}`
`101`	`102`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ public interface AgentSpanContext {`
`21`	`21`	`*`
`22`	`22`	`* @return the noop scope instance.`
`23`	`23`	`*/`
`24`		`- static AgentSpanContext noop() {`
	`24`	`+ static AgentSpanContext noopSpanContext() {`
`25`	`25`	`return NoopSpanContext.INSTANCE;`
`26`	`26`	`}`
`27`	`27`