airframe-http: #1128 Add Router.verifyRoutes to check duplicated endp…

…oints (#1137)

* airframe-http: #1128 Add a helper method to find RPC method overload early

* Verify Router before generating HTTP client

airframe-http/.jvm/src/main/scala/wvlet/airframe/http/Router.scala

@@ -82,6 +82,14 @@ case class Router(
   private lazy val routeMatcher                                            = RouteMatcher.build(routes)
   def findRoute[Req: HttpRequestAdapter](request: Req): Option[RouteMatch] = routeMatcher.findRoute(request)
 
+  /**
+    * Call this method to verify duplicated routes in an early phase
+    */
+  def verifyRoutes: Unit = {
+    // Instantiate the route mappings to check duplicate routes
+    routeMatcher
+  }
+
   /**
     * Add methods annotated with @Endpoint to the routing table
     */
@@ -126,7 +134,7 @@ case class Router(
     val endpointOpt = controllerSurface.findAnnotationOf[Endpoint]
     val rpcOpt      = controllerSurface.findAnnotationOf[RPC]
 
-    val newRoutes: Seq[Route] = {
+    val newRoutes: Seq[ControllerRoute] = {
       (endpointOpt, rpcOpt) match {
         case (Some(endpoint), Some(rpcOpt)) =>
           throw new IllegalArgumentException(
@@ -158,7 +166,7 @@ case class Router(
           } else {
             s"${rpc.path()}/${serviceFullName}"
           }
-          controllerMethodSurfaces
+          val routes = controllerMethodSurfaces
             .filter(_.isPublic)
             .map { m => (m, m.findAnnotationOf[RPC]) }
             .collect {
@@ -168,6 +176,7 @@ case class Router(
               case (m: ReflectMethodSurface, None) =>
                 ControllerRoute(rpcInterfaceCls, controllerSurface, HttpMethod.POST, prefixPath + s"/${m.name}", m)
             }
+          routes
       }
     }
 

airframe-http/.jvm/src/main/scala/wvlet/airframe/http/codegen/RouteScanner.scala

@@ -83,6 +83,8 @@ object RouteScanner extends LogSupport {
         router = router.addInternal(s, methods)
       }
     }
+    // Check whether the route is valid or not
+    router.verifyRoutes
     router
   }
 

airframe-http/.jvm/src/test/scala/wvlet/airframe/http/RPCTest.scala

@@ -70,4 +70,18 @@ object RPCTest extends AirSpec {
     m.get.method shouldBe HttpMethod.POST
     m.get.methodSurface.name shouldBe "hello"
   }
+
+  @RPC
+  trait RPCOverload {
+    def hello: String
+    def hello(s: String): String
+  }
+
+  test("Should detect RPC method overload") {
+    val r = Router.add[RPCOverload]
+    val e = intercept[IllegalArgumentException] {
+      r.verifyRoutes
+    }
+    e.getMessage.contains("RPCOverload/hello")
+  }
 }