Reproducer: Span operation name duplicated when more than 1 endpoint defined per route

instrumentation/kamon-akka-http/src/main/scala-2.11/kamon/instrumentation/akka/http/AkkaHttpServerInstrumentation.scala

@@ -1,7 +1,6 @@
 package kamon.instrumentation.akka.http
 
 import java.util.concurrent.Callable
-
 import akka.http.scaladsl.marshalling.{ToEntityMarshaller, ToResponseMarshallable, ToResponseMarshaller}
 import akka.http.scaladsl.model.StatusCodes.Redirection
 import akka.http.scaladsl.model.{HttpHeader, HttpRequest, HttpResponse, StatusCode, Uri}
@@ -22,8 +21,8 @@ import scala.concurrent.{ExecutionContext, Future, Promise}
 import scala.util.control.NonFatal
 import scala.util.{Failure, Success, Try}
 import java.util.regex.Pattern
-
 import akka.NotUsed
+import akka.http.scaladsl.server.RouteResult.Rejected
 import akka.stream.scaladsl.Flow
 import kamon.context.Context
 import kanela.agent.libs.net.bytebuddy.matcher.ElementMatchers.isPublic
@@ -103,6 +102,7 @@ trait HasMatchingContext {
   def setMatchingContext(ctx: Seq[PathMatchingContext]): Unit
   def setDefaultOperationName(defaultOperationName: String): Unit
   def prependMatchingContext(matched: PathMatchingContext): Unit
+  def popOneMatchingContext(): Unit
 }
 
 object HasMatchingContext {
@@ -123,6 +123,9 @@ object HasMatchingContext {
     override def prependMatchingContext(matched: PathMatchingContext): Unit =
       matchingContext = matched +: matchingContext
 
+    override def popOneMatchingContext(): Unit =
+      matchingContext = matchingContext.tail
+
     @Initializer
     def initialize(): Unit =
       matchingContext = Seq.empty
@@ -280,18 +283,29 @@ object PathDirectivesRawPathPrefixInterceptor {
   def rawPathPrefix[T](@Argument(1) matcher: PathMatcher[T]): Directive[T] = {
     implicit val LIsTuple = matcher.ev
 
-    extract(ctx => {
+    extract { ctx =>
       val fullPath = ctx.unmatchedPath.toString()
       val matching = matcher(ctx.unmatchedPath)
+
       matching match {
         case m: Matched[_] =>
-          ctx.asInstanceOf[HasMatchingContext].prependMatchingContext(PathMatchingContext(fullPath, m))
+          ctx.asInstanceOf[HasMatchingContext]
+            .prependMatchingContext(PathMatchingContext(fullPath, m))
         case _ =>
       }
-      matching
-    }).flatMap {
-      case Matched(rest, values) => tprovide(values) & mapRequestContext(_ withUnmatchedPath rest)
-      case Unmatched             => reject
+
+      (ctx, matching)
+    } flatMap {
+      case (ctx, Matched(rest, values)) =>
+        tprovide(values) & mapRequestContext(_ withUnmatchedPath rest) & mapRouteResult { routeResult =>
+
+          if(routeResult.isInstanceOf[Rejected])
+            ctx.asInstanceOf[HasMatchingContext].popOneMatchingContext()
+
+          routeResult
+        }
+
+      case (_, Unmatched) => reject
     }
   }
 }

instrumentation/kamon-akka-http/src/main/scala-2.12/kamon/instrumentation/akka/http/AkkaHttpServerInstrumentation.scala

@@ -17,7 +17,6 @@
 package kamon.instrumentation.akka.http
 
 import java.util.concurrent.Callable
-
 import akka.http.scaladsl.marshalling.{ToEntityMarshaller, ToResponseMarshallable, ToResponseMarshaller}
 import akka.http.scaladsl.model.StatusCodes.Redirection
 import akka.http.scaladsl.model.{HttpHeader, HttpRequest, HttpResponse, StatusCode, Uri}
@@ -38,8 +37,8 @@ import scala.concurrent.{ExecutionContext, Future, Promise}
 import scala.util.control.NonFatal
 import scala.util.{Failure, Success, Try}
 import java.util.regex.Pattern
-
 import akka.NotUsed
+import akka.http.scaladsl.server.RouteResult.Rejected
 import akka.stream.scaladsl.Flow
 import kamon.context.Context
 import kanela.agent.libs.net.bytebuddy.matcher.ElementMatchers.isPublic
@@ -127,6 +126,7 @@ trait HasMatchingContext {
   def setMatchingContext(ctx: Seq[PathMatchingContext]): Unit
   def setDefaultOperationName(defaultOperationName: String): Unit
   def prependMatchingContext(matched: PathMatchingContext): Unit
+  def popOneMatchingContext(): Unit
 }
 
 object HasMatchingContext {
@@ -147,6 +147,9 @@ object HasMatchingContext {
     override def prependMatchingContext(matched: PathMatchingContext): Unit =
       matchingContext = matched +: matchingContext
 
+    override def popOneMatchingContext(): Unit =
+      matchingContext = matchingContext.tail
+
     @Initializer
     def initialize(): Unit =
       matchingContext = Seq.empty
@@ -303,18 +306,29 @@ object PathDirectivesRawPathPrefixInterceptor {
   def rawPathPrefix[T](@Argument(0) matcher: PathMatcher[T]): Directive[T] = {
     implicit val LIsTuple = matcher.ev
 
-    extract(ctx => {
+    extract { ctx =>
       val fullPath = ctx.unmatchedPath.toString()
       val matching = matcher(ctx.unmatchedPath)
+
       matching match {
         case m: Matched[_] =>
-          ctx.asInstanceOf[HasMatchingContext].prependMatchingContext(PathMatchingContext(fullPath, m))
+          ctx.asInstanceOf[HasMatchingContext]
+            .prependMatchingContext(PathMatchingContext(fullPath, m))
         case _ =>
       }
-      matching
-    }).flatMap {
-      case Matched(rest, values) => tprovide(values) & mapRequestContext(_ withUnmatchedPath rest)
-      case Unmatched             => reject
+
+      (ctx, matching)
+    } flatMap {
+      case (ctx, Matched(rest, values)) =>
+        tprovide(values) & mapRequestContext(_ withUnmatchedPath rest) & mapRouteResult { routeResult =>
+
+          if(routeResult.isInstanceOf[Rejected])
+            ctx.asInstanceOf[HasMatchingContext].popOneMatchingContext()
+
+          routeResult
+        }
+
+      case (_, Unmatched) => reject
     }
   }
 }

instrumentation/kamon-akka-http/src/main/scala-2.13/kamon/instrumentation/akka/http/AkkaHttpServerInstrumentation.scala

@@ -1,7 +1,6 @@
 package kamon.instrumentation.akka.http
 
 import java.util.concurrent.Callable
-
 import akka.http.scaladsl.marshalling.{ToEntityMarshaller, ToResponseMarshallable, ToResponseMarshaller}
 import akka.http.scaladsl.model.StatusCodes.Redirection
 import akka.http.scaladsl.model.{HttpHeader, HttpRequest, HttpResponse, StatusCode, Uri}
@@ -22,8 +21,8 @@ import scala.concurrent.{Batchable, ExecutionContext, Future, Promise}
 import scala.util.control.NonFatal
 import scala.util.{Failure, Success, Try}
 import java.util.regex.Pattern
-
 import akka.NotUsed
+import akka.http.scaladsl.server.RouteResult.Rejected
 import akka.stream.scaladsl.Flow
 import kamon.context.Context
 import kanela.agent.libs.net.bytebuddy.matcher.ElementMatchers.isPublic
@@ -110,6 +109,7 @@ trait HasMatchingContext {
   def setMatchingContext(ctx: Seq[PathMatchingContext]): Unit
   def setDefaultOperationName(defaultOperationName: String): Unit
   def prependMatchingContext(matched: PathMatchingContext): Unit
+  def popOneMatchingContext(): Unit
 }
 
 object HasMatchingContext {
@@ -130,6 +130,9 @@ object HasMatchingContext {
     override def prependMatchingContext(matched: PathMatchingContext): Unit =
       matchingContext = matched +: matchingContext
 
+    override def popOneMatchingContext(): Unit =
+      matchingContext = matchingContext.tail
+
     @Initializer
     def initialize(): Unit =
       matchingContext = Seq.empty
@@ -286,18 +289,29 @@ object PathDirectivesRawPathPrefixInterceptor {
   def rawPathPrefix[T](@Argument(0) matcher: PathMatcher[T]): Directive[T] = {
     implicit val LIsTuple = matcher.ev
 
-    extract(ctx => {
+    extract { ctx =>
       val fullPath = ctx.unmatchedPath.toString()
       val matching = matcher(ctx.unmatchedPath)
+
       matching match {
         case m: Matched[_] =>
-          ctx.asInstanceOf[HasMatchingContext].prependMatchingContext(PathMatchingContext(fullPath, m))
+          ctx.asInstanceOf[HasMatchingContext]
+            .prependMatchingContext(PathMatchingContext(fullPath, m))
         case _ =>
       }
-      matching
-    }).flatMap {
-      case Matched(rest, values) => tprovide(values) & mapRequestContext(_ withUnmatchedPath rest)
-      case Unmatched             => reject
+
+      (ctx, matching)
+    } flatMap {
+      case (ctx, Matched(rest, values)) =>
+        tprovide(values) & mapRequestContext(_ withUnmatchedPath rest) & mapRouteResult { routeResult =>
+
+          if(routeResult.isInstanceOf[Rejected])
+            ctx.asInstanceOf[HasMatchingContext].popOneMatchingContext()
+
+          routeResult
+        }
+
+      case (_, Unmatched) => reject
     }
   }
 }

instrumentation/kamon-akka-http/src/test/scala/kamon/akka/http/AkkaHttpServerTracingSpec.scala

@@ -72,6 +72,17 @@ class AkkaHttpServerTracingSpec extends WordSpecLike with Matchers with ScalaFut
         }
       }
 
+      "return the correct operation name with overloaded route" in {
+        val target = s"$protocol://$interface:$port/some_endpoint"
+
+        okHttp.newCall(new Request.Builder()
+          .get()
+          .url(target).build())
+          .execute()
+
+        val span = eventually(timeout(10 seconds))(testSpanReporter().nextSpan().value)
+        span.operationName shouldBe "/some_endpoint"
+      }
       "not include variables in operation name" when {
         "including nested directives" in {
           val path = s"extraction/nested/42/fixed/anchor/32/${UUID.randomUUID().toString}/fixed/44/CafE"

instrumentation/kamon-akka-http/src/test/scala/kamon/testkit/TestWebServer.scala

@@ -170,6 +170,12 @@ trait TestWebServer extends TracingDirectives {
         path("name-will-be-changed") {
           complete("OK")
         }
+      } ~
+      path("some_endpoint") {
+        post(complete(OK))
+      } ~
+      path("some_endpoint") {
+        get(complete(OK))
       }
     }