Deprecate ScopeManager.active()

README.md

@@ -35,9 +35,9 @@ Access to the active span is straightforward:
 ```java
 io.opentracing.Tracer tracer = ...;
 ...
-Scope scope = tracer.scopeManager().active();
-if (scope != null) {
-    scope.span().log("...");
+Span span = tracer.scopeManager().activeSpan();
+if (span != null) {
+    span.log("...");
 }
 ```
 

opentracing-api/src/main/java/io/opentracing/ScopeManager.java

@@ -17,8 +17,8 @@
 
 /**
  * The {@link ScopeManager} interface abstracts both the activation of {@link Span} instances via
- * {@link ScopeManager#activate(Span, boolean)} and access to an active {@link Span}/{@link Scope}
- * via {@link ScopeManager#active()}.
+ * {@link ScopeManager#activate(Span)} and access to an active {@link Span}
+ * via {@link ScopeManager#activeSpan()}.
  *
  * @see Scope
  * @see Tracer#scopeManager()
@@ -37,10 +37,7 @@ public interface ScopeManager {
      * is called.
      *
      * <p>
-     * This {@link Scope} instance can be accessed at any time through {@link #active()},
-     * in case it is not possible for the user to store it (when used through middleware
-     * or start/finish event hooks, for example). The corresponding {@link Span} can be
-     * accessed through {@link #activeSpan()} likewise.
+     * The corresponding {@link Span} can be accessed at any time through {@link #activeSpan()}.
      *
      * <p>
      * Usage:
@@ -65,6 +62,7 @@ public interface ScopeManager {
     Scope activate(Span span);
 
     /**
+     * @deprecated use {@link #activeSpan()} instead.
      * Return the currently active {@link Scope} which can be used to deactivate the currently active
      * {@link Span}.
      *
@@ -78,6 +76,7 @@ public interface ScopeManager {
      *
      * @return the {@link Scope active scope}, or null if none could be found.
      */
+    @Deprecated
     Scope active();
 
     /**

opentracing-api/src/main/java/io/opentracing/Tracer.java

@@ -143,12 +143,12 @@ interface SpanBuilder {
          * <p>
          * If
          * <ul>
-         * <li>the {@link Tracer}'s {@link ScopeManager#active()} is not null, and
+         * <li>the {@link Tracer}'s {@link ScopeManager#activeSpan()} is not null, and
          * <li>no <b>explicit</b> references are added via {@link SpanBuilder#addReference}, and
          * <li>{@link SpanBuilder#ignoreActiveSpan()} is not invoked,
          * </ul>
          * ... then an inferred {@link References#CHILD_OF} reference is created to the
-         * {@link ScopeManager#active()} {@link SpanContext} when either {@link SpanBuilder#startActive(boolean)} or
+         * {@link ScopeManager#activeSpan()} {@link SpanContext} when either {@link SpanBuilder#startActive(boolean)} or
          * {@link SpanBuilder#start} is invoked.
          *
          * @param referenceType the reference type, typically one of the constants defined in References
@@ -161,7 +161,7 @@ interface SpanBuilder {
         SpanBuilder addReference(String referenceType, SpanContext referencedContext);
 
         /**
-         * Do not create an implicit {@link References#CHILD_OF} reference to the {@link ScopeManager#active()}).
+         * Do not create an implicit {@link References#CHILD_OF} reference to the {@link ScopeManager#activeSpan()}).
          */
         SpanBuilder ignoreActiveSpan();
 

opentracing-mock/src/main/java/io/opentracing/mock/MockTracer.java

@@ -272,8 +272,7 @@ public <C> SpanContext extract(Format<C> format, C carrier) {
 
     @Override
     public Span activeSpan() {
-        Scope scope = this.scopeManager.active();
-        return scope == null ? null : scope.span();
+        return this.scopeManager.activeSpan();
     }
 
     @Override

opentracing-testbed/README.md

@@ -12,11 +12,12 @@ It shows continuation as a solution to finish span when last action is completed
 - [active_span_replacement](src/test/java/io/opentracing/testbed/active_span_replacement) - start an isolated task and query for its result in another task/thread
 - [actor_propagation](src/test/java/io/opentracing/testbed/actor_propagation) - tracing for blocking and non-blocking actor based tracing
 - [client_server](src/test/java/io/opentracing/testbed/client_server) - typical client-server example
-- [common_request_handler](src/test/java/io/opentracing/testbed/common_request_handler) - one request handler for all requests
+- [concurrent_common_request_handler](src/test/java/io/opentracing/testbed/concurrent_common_request_handler) - one request handler for concurrent requests
 - [error_reporting](src/test/java/io/opentracing/testbed/error_reporting) - a few common cases of error reporting
 - [late_span_finish](src/test/java/io/opentracing/testbed/late_span_finish) - late parent span finish
 - [listener_per_request](src/test/java/io/opentracing/testbed/listener_per_request) - one listener per request
 - [multiple_callbacks](src/test/java/io/opentracing/testbed/multiple_callbacks) - many callbacks spawned at the same time
 - [nested_callbacks](src/test/java/io/opentracing/testbed/nested_callbacks) - one callback at the time, defined in a pipeline fashion
 - [promise_propagation](src/test/java/io/opentracing/testbed/promise_propagation) - tracing patterns for promises with callbacks
 - [suspend_resume_propagation](src/test/java/io/opentracing/testbed/suspend_resume_propagation) - tracing pattern for interleaving of spans
+- [stateless_common_request_handler](src/test/java/io/opentracing/testbed/stateless_common_request_handler) - one stateless request handler for requests

opentracing-testbed/src/test/java/io/opentracing/testbed/active_span_replacement/ActiveSpanReplacementTest.java

@@ -66,7 +66,7 @@ public void test() throws Exception {
         assertNotEquals(spans.get(0).context().traceId(), spans.get(1).context().traceId());
         assertEquals(0, spans.get(0).parentId());
 
-        assertNull(tracer.scopeManager().active());
+        assertNull(tracer.scopeManager().activeSpan());
     }
 
     private void submitAnotherTask(final Span initialSpan) {

opentracing-testbed/src/test/java/io/opentracing/testbed/actor_propagation/ActorPropagationTest.java

@@ -84,7 +84,7 @@ public void testActorTell() {
           .isEqualTo(finished.get(1).context().traceId());
       assertThat(getByTag(finished, Tags.SPAN_KIND, Tags.SPAN_KIND_CONSUMER)).hasSize(2);
       assertThat(getOneByTag(finished, Tags.SPAN_KIND, Tags.SPAN_KIND_PRODUCER)).isNotNull();
-      assertThat(tracer.scopeManager().active()).isNull();
+      assertThat(tracer.scopeManager().activeSpan()).isNull();
     }
   }
 
@@ -126,7 +126,7 @@ public void testActorAsk() throws ExecutionException, InterruptedException {
           .isEqualTo(finished.get(1).context().traceId());
       assertThat(getByTag(finished, Tags.SPAN_KIND, Tags.SPAN_KIND_CONSUMER)).hasSize(2);
       assertThat(getOneByTag(finished, Tags.SPAN_KIND, Tags.SPAN_KIND_PRODUCER)).isNotNull();
-      assertThat(tracer.scopeManager().active()).isNull();
+      assertThat(tracer.scopeManager().activeSpan()).isNull();
     }
   }
 }

opentracing-testbed/src/test/java/io/opentracing/testbed/client_server/TestClientServerTest.java

@@ -65,6 +65,6 @@ public void test() throws Exception {
         assertEquals(finished.get(0).context().traceId(), finished.get(1).context().traceId());
         assertNotNull(getOneByTag(finished, Tags.SPAN_KIND, Tags.SPAN_KIND_CLIENT));
         assertNotNull(getOneByTag(finished, Tags.SPAN_KIND, Tags.SPAN_KIND_SERVER));
-        assertNull(tracer.scopeManager().active());
+        assertNull(tracer.scopeManager().activeSpan());
     }
 }

opentracing-testbed/src/test/java/io/opentracing/testbed/common_request_handler/Client.java → opentracing-testbed/src/test/java/io/opentracing/testbed/concurrent_common_request_handler/Client.java

@@ -11,7 +11,7 @@
  * or implied. See the License for the specific language governing permissions and limitations under
  * the License.
  */
-package io.opentracing.testbed.common_request_handler;
+package io.opentracing.testbed.concurrent_common_request_handler;
 
 import io.opentracing.testbed.TestUtils;
 import org.slf4j.Logger;

opentracing-testbed/src/test/java/io/opentracing/testbed/common_request_handler/Context.java → opentracing-testbed/src/test/java/io/opentracing/testbed/concurrent_common_request_handler/Context.java

@@ -11,7 +11,7 @@
  * or implied. See the License for the specific language governing permissions and limitations under
  * the License.
  */
-package io.opentracing.testbed.common_request_handler;
+package io.opentracing.testbed.concurrent_common_request_handler;
 
 import java.util.HashMap;
 

opentracing-testbed/src/test/java/io/opentracing/testbed/common_request_handler/HandlerTest.java → opentracing-testbed/src/test/java/io/opentracing/testbed/concurrent_common_request_handler/HandlerTest.java

@@ -11,7 +11,7 @@
  * or implied. See the License for the specific language governing permissions and limitations under
  * the License.
  */
-package io.opentracing.testbed.common_request_handler;
+package io.opentracing.testbed.concurrent_common_request_handler;
 
 import io.opentracing.Scope;
 import io.opentracing.Span;
@@ -68,7 +68,7 @@ public void two_requests() throws Exception {
         assertEquals(0, finished.get(0).parentId());
         assertEquals(0, finished.get(1).parentId());
 
-        assertNull(tracer.scopeManager().active());
+        assertNull(tracer.scopeManager().activeSpan());
     }
 
     /**

opentracing-testbed/src/test/java/io/opentracing/testbed/common_request_handler/README.md → opentracing-testbed/src/test/java/io/opentracing/testbed/concurrent_common_request_handler/README.md

@@ -1,6 +1,6 @@
-# Common Request Handler example.
+# Concurrent common Request Handler example.
 
-This example shows a `Span` used with `RequestHandler`, which is used as a middleware (as in web frameworks) to manage a new `Span` per operation through its `beforeRequest()`/`afterResponse()` methods.
+This example shows a `Span` used with `RequestHandler`, which is used as a middleware (as in web frameworks) to concurrently manage a new `Span` per operation through its `beforeRequest()`/`afterResponse()` methods.
 
 Since its methods are not guaranteed to be run in the same thread, activation of such `Span`s is not done.
 

opentracing-testbed/src/test/java/io/opentracing/testbed/common_request_handler/RequestHandler.java → opentracing-testbed/src/test/java/io/opentracing/testbed/concurrent_common_request_handler/RequestHandler.java

@@ -11,7 +11,7 @@
  * or implied. See the License for the specific language governing permissions and limitations under
  * the License.
  */
-package io.opentracing.testbed.common_request_handler;
+package io.opentracing.testbed.concurrent_common_request_handler;
 
 import io.opentracing.Span;
 import io.opentracing.SpanContext;

opentracing-testbed/src/test/java/io/opentracing/testbed/error_reporting/ErrorReportingTest.java

@@ -52,7 +52,6 @@ public void testSimpleError() {
             span.finish();
         }
 
-        assertNull(tracer.scopeManager().active());
         assertNull(tracer.scopeManager().activeSpan());
 
         List<MockSpan> spans = tracer.finishedSpans();
@@ -112,7 +111,6 @@ public void testErrorRecovery() {
         }
         span.finish();
 
-        assertNull(tracer.scopeManager().active());
         assertNull(tracer.scopeManager().activeSpan());
 
         List<MockSpan> spans = tracer.finishedSpans();

opentracing-testbed/src/test/java/io/opentracing/testbed/late_span_finish/LateSpanFinishTest.java

@@ -58,7 +58,7 @@ public void test() throws Exception {
 
         assertSameTrace(spans);
 
-        assertNull(tracer.scopeManager().active());
+        assertNull(tracer.scopeManager().activeSpan());
     }
 
 

opentracing-testbed/src/test/java/io/opentracing/testbed/listener_per_request/ListenerTest.java

@@ -44,6 +44,6 @@ public void test() throws Exception {
         List<MockSpan> finished = tracer.finishedSpans();
         assertEquals(1, finished.size());
         assertNotNull(getOneByTag(finished, Tags.SPAN_KIND, Tags.SPAN_KIND_CLIENT));
-        assertNull(tracer.scopeManager().active());
+        assertNull(tracer.scopeManager().activeSpan());
     }
 }

opentracing-testbed/src/test/java/io/opentracing/testbed/multiple_callbacks/Client.java

@@ -18,6 +18,7 @@
 import io.opentracing.Tracer;
 import io.opentracing.util.AutoFinishScope;
 import io.opentracing.util.AutoFinishScope.Continuation;
+import io.opentracing.util.AutoFinishScopeManager;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -40,8 +41,7 @@ public Client(Tracer tracer) {
     }
 
     public Future<Object> send(final Object message, final long milliseconds) {
-        Scope scope = tracer.scopeManager().active();
-        final Continuation cont = ((AutoFinishScope)scope).capture();
+        final Continuation cont = ((AutoFinishScopeManager)tracer.scopeManager()).captureScope();
 
         return executor.submit(new Callable<Object>() {
             @Override

opentracing-testbed/src/test/java/io/opentracing/testbed/multiple_callbacks/MultipleCallbacksTest.java

@@ -58,6 +58,6 @@ public void test() throws Exception {
             assertEquals(parentSpan.context().spanId(), spans.get(i).parentId());
         }
 
-        assertNull(tracer.scopeManager().active());
+        assertNull(tracer.scopeManager().activeSpan());
     }
 }

opentracing-testbed/src/test/java/io/opentracing/testbed/multiple_callbacks/README.md

@@ -6,8 +6,7 @@ This example shows a `Span` created for a top-level operation, covering a set of
 
 ```java
 // Client.send()
-Scope scope = tracer.scopeManager().active();
-final Continuation cont = ((AutoFinishScope)scope).capture();
+final Continuation cont = ((AutoFinishScopeManager)tracer.scopeManager()).captureScope();
 
 return executor.submit(new Callable<Object>() {
     @Override

opentracing-testbed/src/test/java/io/opentracing/testbed/nested_callbacks/NestedCallbacksTest.java

@@ -57,7 +57,7 @@ public void test() throws Exception {
             assertEquals(Integer.toString(i), tags.get("key" + i));
         }
 
-        assertNull(tracer.scopeManager().active());
+        assertNull(tracer.scopeManager().activeSpan());
     }
 
     private void submitCallbacks(final Span span) {

opentracing-testbed/src/test/java/io/opentracing/testbed/stateless_common_request_handler/Client.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2016-2019 The OpenTracing Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
+ */
+package io.opentracing.testbed.stateless_common_request_handler;
+
+import io.opentracing.testbed.TestUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.concurrent.Callable;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.Future;
+
+public class Client {
+
+    private static final Logger logger = LoggerFactory.getLogger(Client.class);
+
+    private final ExecutorService executor = Executors.newCachedThreadPool();
+
+    private final RequestHandler requestHandler;
+
+    public Client(RequestHandler requestHandler) {
+        this.requestHandler = requestHandler;
+    }
+
+    public Future<String> send(final Object message) {
+
+        return executor.submit(new Callable<String>() {
+            @Override
+            public String call() throws Exception {
+                logger.info("send {}", message);
+                TestUtils.sleep();
+                requestHandler.beforeRequest(message);
+
+                TestUtils.sleep();
+                requestHandler.afterResponse(message);
+
+                return message + ":response";
+            }
+        });
+
+    }
+}

opentracing-testbed/src/test/java/io/opentracing/testbed/stateless_common_request_handler/HandlerTest.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2016-2019 The OpenTracing Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
+ */
+package io.opentracing.testbed.stateless_common_request_handler;
+
+import io.opentracing.mock.MockSpan;
+import io.opentracing.mock.MockTracer;
+import io.opentracing.mock.MockTracer.Propagator;
+import io.opentracing.util.ThreadLocalScopeManager;
+import org.junit.Before;
+import org.junit.Test;
+
+import java.util.List;
+import java.util.concurrent.Future;
+import java.util.concurrent.TimeUnit;
+
+import static org.junit.Assert.assertEquals;
+
+/**
+ * There is only one instance of 'RequestHandler' per 'Client'. Methods of 'RequestHandler' are
+ * executed in the same thread (beforeRequest() and its resulting afterRequest(), that is).
+ */
+public class HandlerTest {
+
+    private final MockTracer tracer = new MockTracer(new ThreadLocalScopeManager(),
+            Propagator.TEXT_MAP);
+    private final Client client = new Client(new RequestHandler(tracer));
+
+    @Before
+    public void before() {
+        tracer.reset();
+    }
+
+    @Test
+    public void test_requests() throws Exception {
+        Future<String> responseFuture = client.send("message");
+        Future<String> responseFuture2 = client.send("message2");
+        Future<String> responseFuture3 = client.send("message3");
+
+        assertEquals("message3:response", responseFuture3.get(5, TimeUnit.SECONDS));
+        assertEquals("message2:response", responseFuture2.get(5, TimeUnit.SECONDS));
+        assertEquals("message:response", responseFuture.get(5, TimeUnit.SECONDS));
+
+        List<MockSpan> finished = tracer.finishedSpans();
+        assertEquals(3, finished.size());
+    }
+}