V0.33.0 (#348)

* Remove Deprecated members. (#339)
* Set version to 0.33.1-SNAPSHOT. (#345)
* Update CHANGELOG to include v0.33.0 (#347)

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changes by Version
 
+## v0.33.0 (2019-05-06)
+
+* Deprecated members removed:
+  - `ScopeManager.active()`
+  - `ScopeManager.activate(Span, boolean)`
+  - `Scope.span()`
+  - `SpanBuilder.startActive()`
+  - `Tracer.startManual()`
+  - `AutoFinishScopeManager`
+
 ## v0.32.0 (2019-03-20)
 
 * Trace Identifiers added to `SpanContext`.

opentracing-api/pom.xml

@@ -20,7 +20,7 @@
     <parent>
         <groupId>io.opentracing</groupId>
         <artifactId>parent</artifactId>
-        <version>0.32.1-SNAPSHOT</version>
+        <version>0.33.1-SNAPSHOT</version>
     </parent>
 
     <artifactId>opentracing-api</artifactId>

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

@@ -36,13 +36,4 @@ public interface Scope extends Closeable {
      */
     @Override
     void close();
-
-    /**
-     * @deprecated use {@link Span} directly or access it through {@link ScopeManager#activeSpan()}
-     * Return the corresponding active {@link Span} for this instance.
-     *
-     * @return the {@link Span} that's been scoped by this {@link Scope}
-     */
-    @Deprecated
-    Span span();
 }

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

@@ -61,24 +61,6 @@ 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}.
-     *
-     * <p>
-     * Observe that {@link Scope} is expected to be used only in the same thread where it was
-     * created, and thus should not be passed across threads.
-     *
-     * <p>
-     * Because both {@link #active()} and {@link #activeSpan()} reference the current
-     * active state, they both will be either null or non-null.
-     *
-     * @return the {@link Scope active scope}, or null if none could be found.
-     */
-    @Deprecated
-    Scope active();
-
     /**
      * Return the currently active {@link Span}.
      *
@@ -89,28 +71,4 @@ public interface ScopeManager {
      * @return the {@link Span active span}, or null if none could be found.
      */
     Span activeSpan();
-
-    /**
-     * @deprecated use {@link #activate(Span)} instead.
-     * Set the specified {@link Span} as the active instance for the current
-     * context (usually a thread).
-     *
-     * <p>
-     * Finishing the {@link Span} upon {@link Scope#close()} is discouraged,
-     * as reporting errors becomes impossible:
-     * <pre><code>
-     *     try (Scope scope = tracer.scopeManager().activate(span, true)) {
-     *     } catch (Exception e) {
-     *         // Not possible to report errors, as
-     *         // the span has been already finished.
-     *     }
-     * </code></pre>
-     *
-     * @param span the {@link Span} that should become the {@link #activeSpan()}
-     * @param finishSpanOnClose whether span should automatically be finished when {@link Scope#close()} is called
-     * @return a {@link Scope} instance to control the end of the active period for the {@link Span}. It is a
-     * programming error to neglect to call {@link Scope#close()} on the returned instance.
-     */
-    @Deprecated
-    Scope activate(Span span, boolean finishSpanOnClose);
 }

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

@@ -195,12 +195,6 @@ interface SpanBuilder {
         /** Specify a timestamp of when the Span was started, represented in microseconds since epoch. */
         SpanBuilder withStartTimestamp(long microseconds);
 
-        /**
-         * @deprecated use {@link #start} instead.
-         */
-        @Deprecated
-        Span startManual();
-
         /**
          * Returns a newly-started {@link Span}.
          *
@@ -219,47 +213,5 @@ interface SpanBuilder {
          *         via the {@link ScopeManager}
          */
         Span start();
-
-        /**
-         * @deprecated use {@link #start()} and {@link ScopeManager#activate(Span span)} instead.
-         * Returns a newly started and activated {@link Scope}.
-         *
-         * <p>
-         * {@link SpanBuilder#startActive()} is a shorthand for
-         * {@code tracer.scopeManager().activate(spanBuilder.start())}.
-         * The returned {@link Scope} supports try-with-resources, but using this method is
-         * discouraged as the {@link Span} reference could be easily lost, and reporting
-         * errors on {@link Span} through this method becomes impossible:
-         * <pre><code>
-         *     try (Scope scope = tracer.buildSpan("...").startActive(true)) {
-         *         // (Do work)
-         *         scope.span().setTag( ... );  // etc, etc
-         *     } catch (Exception e) {
-         *         // Not possible to report errors, as
-         *         // the span reference has been lost,
-         *         // and span has been already finished too.
-         *     }
-         * </code></pre>
-         *
-         * <p>
-         * It is recommended to use {@link #start()} with a subsequent call to
-         * {@link ScopeManager#activate(Span)}
-         * <pre><code>
-         *     Span span = tracer.buildSpan("...").start();
-         *     try (Scope scope = tracer.activateSpan(span)) {
-         *     } catch (Exception e) {
-         *         span.log(...); // Report any errors properly.
-         *     } finally {
-         *         span.finish(); // Optionally close the Span.
-         *     }
-         * </code></pre>
-         *
-         * @return a {@link Scope}, already registered via the {@link ScopeManager}
-         *
-         * @see ScopeManager
-         * @see Scope
-         */
-        @Deprecated
-        Scope startActive(boolean finishSpanOnClose);
     }
 }

opentracing-api/src/main/java/io/opentracing/tag/StringTag.java

@@ -24,12 +24,4 @@ public StringTag(String key) {
     public void set(Span span, String tagValue) {
         span.setTag(super.key, tagValue);
     }
-
-    /**
-     * @deprecated as using the tag *key* as tag value is not usually required.
-     */
-    @Deprecated
-    public void set(Span span, StringTag tag) {
-        span.setTag(super.key, tag.key);
-    }
 }

opentracing-api/src/test/java/io/opentracing/tag/StringTagTest.java

@@ -32,15 +32,4 @@ public void testSetString() {
 
         verify(span).setTag(key, value);
     }
-
-    @Test
-    public void testSetOtherTag() {
-        String key = "expected.key";
-
-        Span span = mock(Span.class);
-        StringTag tag = new StringTag(key);
-        tag.set(span, new StringTag(key));
-
-        verify(span).setTag(key, key);
-    }
 }

opentracing-mock/pom.xml

@@ -20,7 +20,7 @@
     <parent>
         <groupId>io.opentracing</groupId>
         <artifactId>parent</artifactId>
-        <version>0.32.1-SNAPSHOT</version>
+        <version>0.33.1-SNAPSHOT</version>
     </parent>
 
     <artifactId>opentracing-mock</artifactId>

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

@@ -372,18 +372,8 @@ public SpanBuilder withStartTimestamp(long microseconds) {
             return this;
         }
 
-        @Override
-        public Scope startActive(boolean finishOnClose) {
-            return MockTracer.this.scopeManager().activate(this.startManual(), finishOnClose);
-        }
-
         @Override
         public MockSpan start() {
-            return startManual();
-        }
-
-        @Override
-        public MockSpan startManual() {
             if (this.startMicros == 0) {
                 this.startMicros = MockSpan.nowMicros();
             }

opentracing-mock/src/test/java/io/opentracing/mock/MockTracerTest.java

@@ -264,29 +264,12 @@ public void testActiveSpan() {
         Assert.assertTrue(mockTracer.finishedSpans().isEmpty());
     }
 
-    @Test
-    public void testActiveSpanFinish() {
-        MockTracer mockTracer = new MockTracer();
-        Assert.assertNull(mockTracer.activeSpan());
-
-        Scope scope = null;
-        try {
-            scope = mockTracer.buildSpan("foo").startActive(true);
-            Assert.assertEquals(mockTracer.scopeManager().activeSpan(), mockTracer.activeSpan());
-        } finally {
-            scope.close();
-        }
-
-        Assert.assertNull(mockTracer.activeSpan());
-        Assert.assertFalse(mockTracer.finishedSpans().isEmpty());
-    }
-
     @Test
     public void testReset() {
         MockTracer mockTracer = new MockTracer();
 
         mockTracer.buildSpan("foo")
-            .startManual()
+            .start()
             .finish();
 
         assertEquals(1, mockTracer.finishedSpans().size());
@@ -297,11 +280,11 @@ public void testReset() {
     @Test
     public void testFollowFromReference() {
         MockTracer tracer = new MockTracer(MockTracer.Propagator.TEXT_MAP);
-        final MockSpan precedent = tracer.buildSpan("precedent").startManual();
+        final MockSpan precedent = tracer.buildSpan("precedent").start();
 
         final MockSpan followingSpan = tracer.buildSpan("follows")
             .addReference(References.FOLLOWS_FROM, precedent.context())
-            .startManual();
+            .start();
 
         assertEquals(precedent.context().spanId(), followingSpan.parentId());
         assertEquals(1, followingSpan.references().size());
@@ -314,13 +297,13 @@ public void testFollowFromReference() {
     @Test
     public void testMultiReferences() {
         MockTracer tracer = new MockTracer(MockTracer.Propagator.TEXT_MAP);
-        final MockSpan parent = tracer.buildSpan("parent").startManual();
-        final MockSpan precedent = tracer.buildSpan("precedent").startManual();
+        final MockSpan parent = tracer.buildSpan("parent").start();
+        final MockSpan precedent = tracer.buildSpan("precedent").start();
 
         final MockSpan followingSpan = tracer.buildSpan("follows")
             .addReference(References.FOLLOWS_FROM, precedent.context())
             .asChildOf(parent.context())
-            .startManual();
+            .start();
 
         assertEquals(parent.context().spanId(), followingSpan.parentId());
         assertEquals(2, followingSpan.references().size());
@@ -335,15 +318,15 @@ public void testMultiReferences() {
     @Test
     public void testMultiReferencesBaggage() {
         MockTracer tracer = new MockTracer(MockTracer.Propagator.TEXT_MAP);
-        final MockSpan parent = tracer.buildSpan("parent").startManual();
+        final MockSpan parent = tracer.buildSpan("parent").start();
         parent.setBaggageItem("parent", "foo");
-        final MockSpan precedent = tracer.buildSpan("precedent").startManual();
+        final MockSpan precedent = tracer.buildSpan("precedent").start();
         precedent.setBaggageItem("precedent", "bar");
 
         final MockSpan followingSpan = tracer.buildSpan("follows")
             .addReference(References.FOLLOWS_FROM, precedent.context())
             .asChildOf(parent.context())
-            .startManual();
+            .start();
 
         assertEquals("foo", followingSpan.getBaggageItem("parent"));
         assertEquals("bar", followingSpan.getBaggageItem("precedent"));
@@ -352,11 +335,11 @@ public void testMultiReferencesBaggage() {
     @Test
     public void testNonStandardReference() {
         MockTracer tracer = new MockTracer(MockTracer.Propagator.TEXT_MAP);
-        final MockSpan parent = tracer.buildSpan("parent").startManual();
+        final MockSpan parent = tracer.buildSpan("parent").start();
 
         final MockSpan nextSpan = tracer.buildSpan("follows")
             .addReference("a_reference", parent.context())
-            .startManual();
+            .start();
 
         assertEquals(parent.context().spanId(), nextSpan.parentId());
         assertEquals(1, nextSpan.references().size());
@@ -384,11 +367,10 @@ public void testDefaultConstructor() {
         MockTracer mockTracer = new MockTracer();
         Span span = mockTracer.buildSpan("foo").start();
         Scope scope = mockTracer.activateSpan(span);
-        assertEquals(scope, mockTracer.scopeManager().active());
         assertEquals(span, mockTracer.scopeManager().activeSpan());
 
         Map<String, String> propag = new HashMap<>();
-        mockTracer.inject(scope.span().context(), Format.Builtin.TEXT_MAP, new TextMapAdapter(propag));
+        mockTracer.inject(span.context(), Format.Builtin.TEXT_MAP, new TextMapAdapter(propag));
         assertFalse(propag.isEmpty());
     }
 

opentracing-noop/pom.xml

@@ -20,7 +20,7 @@
     <parent>
         <groupId>io.opentracing</groupId>
         <artifactId>parent</artifactId>
-        <version>0.32.1-SNAPSHOT</version>
+        <version>0.33.1-SNAPSHOT</version>
     </parent>
 
     <artifactId>opentracing-noop</artifactId>

opentracing-noop/src/main/java/io/opentracing/noop/NoopScopeManager.java

@@ -29,21 +29,12 @@ interface NoopScope extends Scope {
  * A noop (i.e., cheap-as-possible) implementation of an ScopeManager.
  */
 class NoopScopeManagerImpl implements NoopScopeManager {
-    @Override
-    public Scope activate(Span span, boolean finishOnClose) {
-        return NoopScope.INSTANCE;
-    }
 
     @Override
     public Scope activate(Span span) {
         return NoopScope.INSTANCE;
     }
 
-    @Override
-    public Scope active() {
-        return NoopScope.INSTANCE;
-    }
-
     @Override
     public Span activeSpan() {
         return NoopSpan.INSTANCE;
@@ -52,10 +43,5 @@ public Span activeSpan() {
     static class NoopScopeImpl implements NoopScopeManager.NoopScope {
         @Override
         public void close() {}
-
-        @Override
-        public Span span() {
-            return NoopSpan.INSTANCE;
-        }
     }
 }

opentracing-noop/src/main/java/io/opentracing/noop/NoopSpanBuilder.java

@@ -68,18 +68,8 @@ public Tracer.SpanBuilder withStartTimestamp(long microseconds) {
         return this;
     }
 
-    @Override
-    public Scope startActive(boolean finishOnClose) {
-        return NoopScopeManager.NoopScope.INSTANCE;
-    }
-
     @Override
     public Span start() {
-        return startManual();
-    }
-
-    @Override
-    public Span startManual() {
         return NoopSpanImpl.INSTANCE;
     }
 

opentracing-noop/src/test/java/io/opentracing/noop/NoopScopeManagerTest.java

@@ -24,11 +24,11 @@ public class NoopScopeManagerTest {
     @Test
     public void activeValueToleratesUseTest() {
         try{
-            final Scope active = NoopScopeManager.INSTANCE.active();
+            final Scope active = NoopScopeManager.INSTANCE.activate(NoopSpanImpl.INSTANCE);
             assertNotNull(active);
             active.close();
         } catch (final NullPointerException e) {
             fail("NoopScopeManagerImpl.active() should return a usable scope");
         }
     }
-}
+}