handle route rejections in the path matchers instrumentation

kamon-io · Oct 19, 2021 · bac02a9 · bac02a9
1 parent f55e9f5
commit bac02a9
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 30 deletions.
diff --git a/...p/src/main/scala-2.11/kamon/instrumentation/akka/http/AkkaHttpServerInstrumentation.scala b/...p/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
     }
   }
 }

diff --git a/...p/src/main/scala-2.12/kamon/instrumentation/akka/http/AkkaHttpServerInstrumentation.scala b/...p/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
     }
   }
 }

diff --git a/...p/src/main/scala-2.13/kamon/instrumentation/akka/http/AkkaHttpServerInstrumentation.scala b/...p/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
     }
   }
 }

diff --git a/...umentation/kamon-akka-http/src/test/scala/kamon/akka/http/AkkaHttpServerTracingSpec.scala b/...umentation/kamon-akka-http/src/test/scala/kamon/akka/http/AkkaHttpServerTracingSpec.scala
@@ -75,12 +75,6 @@ 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"
 
-        // this endpoint isn't affected
-//        okHttp.newCall(new Request.Builder()
-//          .post(RequestBody.create(MediaType.get("application/json"), "{}"))
-//          .url(target).build())
-//          .execute()
-
         okHttp.newCall(new Request.Builder()
           .get()
           .url(target).build())