Add onCreate callback to WebFluxSpanDecorator

opentracing-spring-web-starter/src/test/java/io/opentracing/contrib/spring/web/starter/WebFluxTracingAutoConfigurationTest.java

@@ -1,5 +1,5 @@
 /**
- * Copyright 2016-2019 The OpenTracing Authors
+ * Copyright 2016-2021 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
@@ -126,8 +126,8 @@ public void testDecoratedProviderIsUsed() {
         Awaitility.await().until(reportedSpansSize(), IsEqual.equalTo(1));
 
         assertThat(mockTracer.finishedSpans()).hasSize(1);
-        assertThat(Mockito.mockingDetails(mockDecorator1).getInvocations()).hasSize(2);
-        assertThat(Mockito.mockingDetails(mockDecorator2).getInvocations()).hasSize(2);
+        assertThat(Mockito.mockingDetails(mockDecorator1).getInvocations()).hasSize(3);
+        assertThat(Mockito.mockingDetails(mockDecorator2).getInvocations()).hasSize(3);
     }
 
     @Test

opentracing-spring-web/src/main/java/io/opentracing/contrib/spring/web/webfilter/TracingOperator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2019 the original author or authors. Copyright 2019 The OpenTracing Authors.
+ * Copyright 2013-2021 the original author or authors. Copyright 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.
@@ -21,6 +21,8 @@
 import io.opentracing.Tracer;
 import io.opentracing.propagation.Format;
 import io.opentracing.tag.Tags;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
 import org.springframework.http.server.reactive.ServerHttpRequest;
 import org.springframework.web.server.ServerWebExchange;
 import reactor.core.CoreSubscriber;
@@ -36,6 +38,9 @@
  * @author Csaba Kos
  */
 class TracingOperator extends MonoOperator<Void, Void> {
+
+    private static final Log LOG = LogFactory.getLog(TracingOperator.class);
+
     private final Tracer tracer;
     private final ServerWebExchange exchange;
     private final List<WebFluxSpanDecorator> spanDecorators;
@@ -70,8 +75,17 @@ public void subscribe(final CoreSubscriber<? super Void> subscriber) {
                 .withTag(Tags.SPAN_KIND.getKey(), Tags.SPAN_KIND_SERVER)
                 .start();
 
+        exchange.getAttributes().put(TracingWebFilter.SERVER_SPAN_CONTEXT, span.context());
+
+        for (WebFluxSpanDecorator spanDecorator : spanDecorators) {
+            try {
+                spanDecorator.onCreate(exchange, span);
+            } catch (RuntimeException exDecorator) {
+                LOG.error("Exception during decorating span", exDecorator);
+            }
+        }
+
         try (final Scope scope = tracer.scopeManager().activate(span)) {
-            exchange.getAttributes().put(TracingWebFilter.SERVER_SPAN_CONTEXT, span.context());
             source.subscribe(new TracingSubscriber(subscriber, exchange, context, span, spanDecorators));
         }
     }

opentracing-spring-web/src/main/java/io/opentracing/contrib/spring/web/webfilter/WebFluxSpanDecorator.java

@@ -1,5 +1,5 @@
 /**
- * Copyright 2016-2019 The OpenTracing Authors
+ * Copyright 2016-2021 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
@@ -34,8 +34,17 @@
 public interface WebFluxSpanDecorator {
 
     /**
-     * Decorate span before {@code .onSubscribe()} is called. This is called right after span in created. Span
-     * context is already present in request attributes with name {@link TracingWebFilter#SERVER_SPAN_CONTEXT}.
+     * Decorate span right after its creation.
+     * Span context is already present in request attributes with name {@link TracingWebFilter#SERVER_SPAN_CONTEXT}.
+     *
+     * @param exchange web exchange
+     * @param span span to decorate
+     */
+    default void onCreate(ServerWebExchange exchange, Span span) { }
+
+    /**
+     * Decorate span when {@code .onSubscribe()} is called.
+     * Span context is already present in request attributes with name {@link TracingWebFilter#SERVER_SPAN_CONTEXT}.
      *
      * @param exchange web exchange
      * @param span span to decorate

opentracing-spring-web/src/test/java/io/opentracing/contrib/spring/web/webfilter/TracingSubscriberTest.java

@@ -1,5 +1,5 @@
 /**
- * Copyright 2016-2020 The OpenTracing Authors
+ * Copyright 2016-2021 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
@@ -20,6 +20,7 @@
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
+import org.mockito.InOrder;
 import org.mockito.Mock;
 import org.mockito.junit.MockitoJUnitRunner;
 import org.springframework.http.HttpMethod;
@@ -38,8 +39,8 @@
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.BDDMockito.given;
-import static org.mockito.Mockito.never;
-import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.inOrder;
+import static org.mockito.Mockito.verifyNoMoreInteractions;
 
 @RunWith(MockitoJUnitRunner.class)
 public class TracingSubscriberTest {
@@ -91,9 +92,12 @@ public void testSpanIsFinishedWhenMonoHasCompleted() throws InterruptedException
         assertEquals(SignalType.ON_COMPLETE, finalSignalType.get());
 
         Span finishedSpan = tracer.finishedSpans().get(0);
-        verify(spanDecorator).onRequest(exchange, finishedSpan);
-        verify(spanDecorator).onResponse(exchange, finishedSpan);
-        verify(spanDecorator, never()).onError(any(ServerWebExchange.class), any(Throwable.class), any(Span.class));
+
+        InOrder inOrder = inOrder(spanDecorator);
+        inOrder.verify(spanDecorator).onCreate(exchange, finishedSpan);
+        inOrder.verify(spanDecorator).onRequest(exchange, finishedSpan);
+        inOrder.verify(spanDecorator).onResponse(exchange, finishedSpan);
+        verifyNoMoreInteractions(spanDecorator);
     }
 
     @Test
@@ -122,9 +126,12 @@ public void testSpanIsFinishedWhenMonoHasError() throws InterruptedException {
         assertEquals(SignalType.ON_ERROR, finalSignalType.get());
 
         Span finishedSpan = tracer.finishedSpans().get(0);
-        verify(spanDecorator).onRequest(exchange, finishedSpan);
-        verify(spanDecorator).onError(eq(exchange), any(Throwable.class), eq(finishedSpan));
-        verify(spanDecorator, never()).onResponse(any(ServerWebExchange.class), any(Span.class));
+
+        InOrder inOrder = inOrder(spanDecorator);
+        inOrder.verify(spanDecorator).onCreate(exchange, finishedSpan);
+        inOrder.verify(spanDecorator).onRequest(exchange, finishedSpan);
+        inOrder.verify(spanDecorator).onError(eq(exchange), any(Throwable.class), eq(finishedSpan));
+        verifyNoMoreInteractions(spanDecorator);
     }
 
     @Test
@@ -168,8 +175,10 @@ public void testSpanIsFinishedWhenMonoHasCanceled() throws InterruptedException
         assertEquals(SignalType.CANCEL, finalSignalType.get());
 
         Span finishedSpan = tracer.finishedSpans().get(0);
-        verify(spanDecorator).onRequest(exchange, finishedSpan);
-        verify(spanDecorator, never()).onError(any(ServerWebExchange.class), any(Throwable.class), any(Span.class));
-        verify(spanDecorator, never()).onResponse(any(ServerWebExchange.class), any(Span.class));
+
+        InOrder inOrder = inOrder(spanDecorator);
+        inOrder.verify(spanDecorator).onCreate(exchange, finishedSpan);
+        inOrder.verify(spanDecorator).onRequest(exchange, finishedSpan);
+        verifyNoMoreInteractions(spanDecorator);
     }
 }