feat(core): Rename AgentScope.noop() into AgentScope.noopScope()

PerfectSlayer · PerfectSlayer · commit d7acd784e54d · 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,5 +1,6 @@
 package datadog.trace.instrumentation.opentelemetry;
 
+import static datadog.trace.bootstrap.instrumentation.api.AgentScope.noopScope;
 import static datadog.trace.bootstrap.instrumentation.api.AgentSpan.noopSpan;
 import static datadog.trace.bootstrap.instrumentation.api.AgentSpanContext.noopSpanContext;
 
@@ -20,7 +21,7 @@ public class TypeConverter {
   public TypeConverter() {
     noopSpanWrapper = new OtelSpan(noopSpan(), this);
     noopContextWrapper = new OtelSpanContext(noopSpanContext());
-    noopScopeWrapper = new OtelScope(AgentScope.noop());
+    noopScopeWrapper = new OtelScope(noopScope());
   }
 
   public AgentSpan toAgentSpan(final Span span) {
@@ -64,7 +65,7 @@ public Scope toScope(final AgentScope scope) {
       attachableScopeWrapper.attachWrapper(otScope);
       return otScope;
     }
-    if (scope == AgentScope.noop()) {
+    if (scope == noopScope()) {
       return noopScopeWrapper;
     }
     return new OtelScope(scope);
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
@@ -2,7 +2,6 @@ import datadog.trace.agent.test.AgentTestRunner
 import datadog.trace.api.DDSpanId
 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.AgentTracer.NoopPathwayContext
 import datadog.trace.bootstrap.instrumentation.api.ScopeSource
@@ -13,6 +12,7 @@ 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.AgentScope.noopScope
 import static datadog.trace.bootstrap.instrumentation.api.AgentSpanContext.noopSpanContext
 
 class TypeConverterTest extends AgentTestRunner {
@@ -42,7 +42,7 @@ class TypeConverterTest extends AgentTestRunner {
   }
 
   def "should avoid the noop scope wrapper allocation"() {
-    def noopScope = AgentScope.noop()
+    def noopScope = noopScope()
     expect:
     typeConverter.toScope(noopScope) is typeConverter.toScope(noopScope)
   }
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,5 +1,6 @@
 package datadog.trace.instrumentation.opentracing31;
 
+import static datadog.trace.bootstrap.instrumentation.api.AgentScope.noopScope;
 import static datadog.trace.bootstrap.instrumentation.api.AgentSpan.noopSpan;
 import static datadog.trace.bootstrap.instrumentation.api.AgentSpanContext.noopSpanContext;
 
@@ -23,7 +24,7 @@ public TypeConverter(final LogHandler logHandler) {
     this.logHandler = logHandler;
     noopSpanWrapper = new OTSpan(noopSpan(), this, logHandler);
     noopContextWrapper = new OTSpanContext(noopSpanContext());
-    noopScopeWrapper = new OTScopeManager.OTScope(AgentScope.noop(), false, this);
+    noopScopeWrapper = new OTScopeManager.OTScope(noopScope(), false, this);
   }
 
   public AgentSpan toAgentSpan(final Span span) {
@@ -70,7 +71,7 @@ public Scope toScope(final AgentScope scope, final boolean finishSpanOnClose) {
       attachableScopeWrapper.attachWrapper(otScope);
       return otScope;
     }
-    if (scope == AgentScope.noop()) {
+    if (scope == noopScope()) {
       return noopScopeWrapper;
     }
     return new OTScopeManager.OTScope(scope, finishSpanOnClose, this);
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
@@ -2,7 +2,6 @@ import datadog.trace.agent.test.AgentTestRunner
 import datadog.trace.api.DDSpanId
 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.AgentTracer.NoopPathwayContext
 import datadog.trace.bootstrap.instrumentation.api.ScopeSource
@@ -14,6 +13,7 @@ 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.AgentScope.noopScope
 import static datadog.trace.bootstrap.instrumentation.api.AgentSpanContext.noopSpanContext
 
 class TypeConverterTest extends AgentTestRunner {
@@ -43,7 +43,7 @@ class TypeConverterTest extends AgentTestRunner {
   }
 
   def "should avoid the noop scope wrapper allocation"() {
-    def noopScope = AgentScope.noop()
+    def noopScope = noopScope()
     expect:
     typeConverter.toScope(noopScope, true) is typeConverter.toScope(noopScope, true)
     typeConverter.toScope(noopScope, false) is typeConverter.toScope(noopScope, false)
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,5 +1,6 @@
 package datadog.trace.instrumentation.opentracing32;
 
+import static datadog.trace.bootstrap.instrumentation.api.AgentScope.noopScope;
 import static datadog.trace.bootstrap.instrumentation.api.AgentSpan.noopSpan;
 import static datadog.trace.bootstrap.instrumentation.api.AgentSpanContext.noopSpanContext;
 
@@ -23,7 +24,7 @@ public TypeConverter(final LogHandler logHandler) {
     this.logHandler = logHandler;
     noopSpanWrapper = new OTSpan(noopSpan(), this, logHandler);
     noopContextWrapper = new OTSpanContext(noopSpanContext());
-    noopScopeWrapper = new OTScopeManager.OTScope(AgentScope.noop(), false, this);
+    noopScopeWrapper = new OTScopeManager.OTScope(noopScope(), false, this);
   }
 
   public AgentSpan toAgentSpan(final Span span) {
@@ -70,7 +71,7 @@ public Scope toScope(final AgentScope scope, final boolean finishSpanOnClose) {
       attachableScopeWrapper.attachWrapper(otScope);
       return otScope;
     }
-    if (scope == AgentScope.noop()) {
+    if (scope == noopScope()) {
       return noopScopeWrapper;
     }
     return new OTScopeManager.OTScope(scope, finishSpanOnClose, this);
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
@@ -2,7 +2,6 @@ import datadog.trace.agent.test.AgentTestRunner
 import datadog.trace.api.DDSpanId
 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.AgentTracer.NoopPathwayContext
 import datadog.trace.bootstrap.instrumentation.api.ScopeSource
@@ -14,6 +13,7 @@ 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.AgentScope.noopScope
 import static datadog.trace.bootstrap.instrumentation.api.AgentSpanContext.noopSpanContext
 
 class TypeConverterTest extends AgentTestRunner {
@@ -43,7 +43,7 @@ class TypeConverterTest extends AgentTestRunner {
   }
 
   def "should avoid the noop scope wrapper allocation"() {
-    def noopScope = AgentScope.noop()
+    def noopScope = noopScope()
     expect:
     typeConverter.toScope(noopScope, true) is typeConverter.toScope(noopScope, true)
     typeConverter.toScope(noopScope, false) is typeConverter.toScope(noopScope, false)
diff --git a/dd-java-agent/instrumentation/vertx-web-3.4/src/main/java/datadog/trace/instrumentation/vertx_3_4/server/RouteHandlerWrapper.java b/dd-java-agent/instrumentation/vertx-web-3.4/src/main/java/datadog/trace/instrumentation/vertx_3_4/server/RouteHandlerWrapper.java
@@ -1,5 +1,6 @@
 package datadog.trace.instrumentation.vertx_3_4.server;
 
+import static datadog.trace.bootstrap.instrumentation.api.AgentScope.noopScope;
 import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activateSpan;
 import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activeSpan;
 import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.startSpan;
@@ -54,7 +55,7 @@ public void handle(final RoutingContext routingContext) {
 
       updateRoutingContextWithRoute(routingContext);
     }
-    try (final AgentScope scope = span != null ? activateSpan(span, true) : AgentScope.noop()) {
+    try (final AgentScope scope = span != null ? activateSpan(span, true) : noopScope()) {
       try {
         actual.handle(routingContext);
       } catch (final Throwable t) {
diff --git a/dd-java-agent/instrumentation/vertx-web-4.0/src/main/java/datadog/trace/instrumentation/vertx_4_0/server/RouteHandlerWrapper.java b/dd-java-agent/instrumentation/vertx-web-4.0/src/main/java/datadog/trace/instrumentation/vertx_4_0/server/RouteHandlerWrapper.java
@@ -1,5 +1,6 @@
 package datadog.trace.instrumentation.vertx_4_0.server;
 
+import static datadog.trace.bootstrap.instrumentation.api.AgentScope.noopScope;
 import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activateSpan;
 import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activeSpan;
 import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.startSpan;
@@ -48,7 +49,7 @@ public void handle(final RoutingContext routingContext) {
       updateRoutingContextWithRoute(routingContext);
     }
 
-    try (final AgentScope scope = span != null ? activateSpan(span, true) : AgentScope.noop()) {
+    try (final AgentScope scope = span != null ? activateSpan(span, true) : noopScope()) {
       try {
         actual.handle(routingContext);
       } catch (final Throwable t) {
diff --git a/dd-trace-core/src/main/java/datadog/trace/core/scopemanager/ContinuableScopeManager.java b/dd-trace-core/src/main/java/datadog/trace/core/scopemanager/ContinuableScopeManager.java
@@ -1,6 +1,7 @@
 package datadog.trace.core.scopemanager;
 
 import static datadog.trace.api.ConfigDefaults.DEFAULT_ASYNC_PROPAGATING;
+import static datadog.trace.bootstrap.instrumentation.api.AgentScope.noopScope;
 import static datadog.trace.bootstrap.instrumentation.api.AgentSpan.noopSpan;
 import static java.util.concurrent.TimeUnit.MINUTES;
 import static java.util.concurrent.TimeUnit.NANOSECONDS;
@@ -115,7 +116,7 @@ private AgentScope activate(
     if (depthLimit <= currentDepth) {
       healthMetrics.onScopeStackOverflow();
       log.debug("Scope depth limit exceeded ({}).  Returning NoopScope.", currentDepth);
-      return AgentScope.noop();
+      return noopScope();
     }
 
     assert span != null;
@@ -191,7 +192,7 @@ public AgentScope activateNext(final AgentSpan span) {
     if (depthLimit <= currentDepth) {
       healthMetrics.onScopeStackOverflow();
       log.debug("Scope depth limit exceeded ({}).  Returning NoopScope.", currentDepth);
-      return AgentScope.noop();
+      return noopScope();
     }
 
     assert span != null;
diff --git a/dd-trace-core/src/main/java/datadog/trace/core/scopemanager/ScopeContinuation.java b/dd-trace-core/src/main/java/datadog/trace/core/scopemanager/ScopeContinuation.java
@@ -1,5 +1,7 @@
 package datadog.trace.core.scopemanager;
 
+import static datadog.trace.bootstrap.instrumentation.api.AgentScope.noopScope;
+
 import datadog.trace.bootstrap.instrumentation.api.AgentScope;
 import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
 import datadog.trace.bootstrap.instrumentation.api.AgentTraceCollector;
@@ -78,7 +80,7 @@ public AgentScope activate() {
     } else {
       // continuation cancelled or too many activations; rollback count
       COUNT.decrementAndGet(this);
-      return AgentScope.noop();
+      return noopScope();
     }
   }
 
diff --git a/dd-trace-core/src/test/groovy/datadog/trace/core/scopemanager/ScopeManagerDepthTest.groovy b/dd-trace-core/src/test/groovy/datadog/trace/core/scopemanager/ScopeManagerDepthTest.groovy
@@ -7,6 +7,7 @@ import datadog.trace.bootstrap.instrumentation.api.ScopeSource
 import datadog.trace.common.writer.ListWriter
 import datadog.trace.core.test.DDCoreSpecification
 
+import static datadog.trace.bootstrap.instrumentation.api.AgentScope.noopScope
 import static datadog.trace.bootstrap.instrumentation.api.AgentSpan.noopSpan
 
 class ScopeManagerDepthTest extends DDCoreSpecification {
@@ -31,13 +32,13 @@ class ScopeManagerDepthTest extends DDCoreSpecification {
     scope = tracer.activateSpan(span)
 
     then: "a noop instance is returned"
-    scope == AgentScope.noop()
+    scope == noopScope()
 
     when: "activate a noop scope over the limit"
     scope = scopeManager.activate(noopSpan(), ScopeSource.MANUAL)
 
     then: "still have a noop instance"
-    scope == AgentScope.noop()
+    scope == noopScope()
 
     and: "scope stack not effected."
     scopeManager.scopeStack().depth() == depth
@@ -72,14 +73,14 @@ class ScopeManagerDepthTest extends DDCoreSpecification {
     scope = tracer.activateSpan(span)
 
     then: "a real scope is returned"
-    scope != AgentScope.noop()
+    scope != noopScope()
     scopeManager.scopeStack().depth() == defaultLimit + 1
 
     when: "activate a noop span"
     scope = scopeManager.activate(noopSpan(), ScopeSource.MANUAL)
 
     then: "a real instance is still returned"
-    scope != AgentScope.noop()
+    scope != noopScope()
 
     and: "scope stack not effected."
     scopeManager.scopeStack().depth() == defaultLimit + 2
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,5 +1,6 @@
 package datadog.opentracing;
 
+import static datadog.trace.bootstrap.instrumentation.api.AgentScope.noopScope;
 import static datadog.trace.bootstrap.instrumentation.api.AgentSpan.noopSpan;
 import static datadog.trace.bootstrap.instrumentation.api.AgentSpanContext.noopSpanContext;
 
@@ -22,7 +23,7 @@ public TypeConverter(final LogHandler logHandler) {
     this.logHandler = logHandler;
     noopSpanWrapper = new OTSpan(noopSpan(), this, logHandler);
     noopContextWrapper = new OTSpanContext(noopSpanContext());
-    noopScopeWrapper = new OTScopeManager.OTScope(AgentScope.noop(), false, this);
+    noopScopeWrapper = new OTScopeManager.OTScope(noopScope(), false, this);
   }
 
   public AgentSpan toAgentSpan(final Span span) {
@@ -73,7 +74,7 @@ public Scope toScope(final AgentScope scope, final boolean finishSpanOnClose) {
       attachableScopeWrapper.attachWrapper(otScope);
       return otScope;
     }
-    if (scope == AgentScope.noop()) {
+    if (scope == noopScope()) {
       return noopScopeWrapper;
     }
     return new OTScopeManager.OTScope(scope, finishSpanOnClose, this);
diff --git a/dd-trace-ot/src/test/groovy/datadog/opentracing/TypeConverterTest.groovy b/dd-trace-ot/src/test/groovy/datadog/opentracing/TypeConverterTest.groovy
@@ -3,7 +3,6 @@ package datadog.opentracing
 import datadog.trace.api.DDSpanId
 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.ScopeSource
 import datadog.trace.core.CoreTracer
@@ -14,6 +13,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.AgentScope.noopScope
 import static datadog.trace.bootstrap.instrumentation.api.AgentSpanContext.noopSpanContext
 import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.NoopPathwayContext
 
@@ -44,7 +44,7 @@ class TypeConverterTest extends DDSpecification {
   }
 
   def "should avoid the noop scope wrapper allocation"() {
-    def noopScope = AgentScope.noop()
+    def noopScope = noopScope()
     expect:
     typeConverter.toScope(noopScope, true) is typeConverter.toScope(noopScope, true)
     typeConverter.toScope(noopScope, false) is typeConverter.toScope(noopScope, false)
diff --git a/internal-api/src/main/java/datadog/trace/bootstrap/instrumentation/api/AgentScope.java b/internal-api/src/main/java/datadog/trace/bootstrap/instrumentation/api/AgentScope.java
@@ -12,7 +12,7 @@ public interface AgentScope extends TraceScope, Closeable {
    *
    * @return the noop scope instance.
    */
-  static AgentScope noop() {
+  static AgentScope noopScope() {
     return NoopScope.INSTANCE;
   }
 

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,7 @@`
`1`	`1`	`package datadog.trace.core.scopemanager;`
`2`	`2`
	`3`	`+import static datadog.trace.bootstrap.instrumentation.api.AgentScope.noopScope;`
	`4`	`+`
`3`	`5`	`import datadog.trace.bootstrap.instrumentation.api.AgentScope;`
`4`	`6`	`import datadog.trace.bootstrap.instrumentation.api.AgentSpan;`
`5`	`7`	`import datadog.trace.bootstrap.instrumentation.api.AgentTraceCollector;`
`@@ -78,7 +80,7 @@ public AgentScope activate() {`
`78`	`80`	`} else {`
`79`	`81`	`// continuation cancelled or too many activations; rollback count`
`80`	`82`	`COUNT.decrementAndGet(this);`
`81`		`- return AgentScope.noop();`
	`83`	`+ return noopScope();`
`82`	`84`	`}`
`83`	`85`	`}`
`84`	`86`