feat (#3): better router builders

* feat: better router builders

* Optimized emptyRSocket builder

Author: y9vad9

router-core/src/commonMain/kotlin/com.y9vad9.rsocket.router/Router.kt

@@ -1,14 +1,13 @@
 package com.y9vad9.rsocket.router
 
 import io.ktor.utils.io.core.*
-import io.rsocket.kotlin.RSocketError
-import io.rsocket.kotlin.RSocketRequestHandlerBuilder
 import com.y9vad9.rsocket.router.annotations.ExperimentalRouterApi
 import com.y9vad9.rsocket.router.annotations.InternalRouterApi
 import com.y9vad9.rsocket.router.annotations.RouterDsl
 import com.y9vad9.rsocket.router.builders.RouterBuilder
 import com.y9vad9.rsocket.router.interceptors.Preprocessor
 import com.y9vad9.rsocket.router.interceptors.RouteInterceptor
+import io.rsocket.kotlin.*
 
 /**
  * The RSocket router with all registered routes, configurations, preprocessors
@@ -49,32 +48,49 @@ public sealed interface Router {
 
 // -- builders --
 
-@OptIn(ExperimentalRouterApi::class, InternalRouterApi::class)
 @RouterDsl
-public fun RSocketRequestHandlerBuilder.router(builder: RouterBuilder.() -> Unit): Router {
-    val router = RouterBuilder().apply(builder).build()
+public fun RSocketRequestHandlerBuilder.router(block: RouterBuilder.() -> Unit): Router {
+    return router(builder = block).also { router -> router.installOn(this) }
+}
+
+@OptIn(InternalRouterApi::class)
+public fun router(builder: RouterBuilder.() -> Unit): Router = RouterBuilder().apply(builder).build()
 
+/**
+ * Applies [Router] to given [RSocketRequestHandlerBuilder]. All registered routes are listened.
+ *
+ * **Implementation note**: As [Router] does not provide `metadataPush` feature, this function is especially
+ * useful if you want to additionally provide it for your [RSocket] instance.
+ */
+@OptIn(ExperimentalRouterApi::class, InternalRouterApi::class)
+public fun Router.installOn(handlerBuilder: RSocketRequestHandlerBuilder): Unit = with(handlerBuilder) {
     requestResponse { payload ->
-        router.routeAtOrFail(router.getRoutePathFromMetadata(payload.metadata))
+        routeAtOrFail(getRoutePathFromMetadata(payload.metadata))
             .requestResponseOrThrow(this, payload)
     }
 
     requestStream { payload ->
-        router.routeAtOrFail(router.getRoutePathFromMetadata(payload.metadata))
+        routeAtOrFail(getRoutePathFromMetadata(payload.metadata))
             .requestStreamOrThrow(this, payload)
     }
 
     requestChannel { initPayload, payloads ->
-        router.routeAtOrFail(router.getRoutePathFromMetadata(initPayload.metadata))
+        routeAtOrFail(getRoutePathFromMetadata(initPayload.metadata))
             .requestChannelOrThrow(this, initPayload, payloads)
     }
 
     fireAndForget { payload ->
-        router.routeAtOrFail(router.getRoutePathFromMetadata(payload.metadata))
+        routeAtOrFail(getRoutePathFromMetadata(payload.metadata))
             .fireAndForgetOrThrow(this, payload)
     }
+}
 
-    return router
+
+@Suppress("UnusedReceiverParameter")
+public fun ConnectionAcceptor.installRouter(router: Router): RSocket {
+    return RSocketRequestHandler {
+        router.installOn(this)
+    }
 }
 
 

router-test/build.gradle.kts

@@ -28,7 +28,7 @@ deployLibrary {
         password = System.getenv("SSH_PASSWORD")
         deployPath = System.getenv("SSH_DEPLOY_PATH")
 
-        group = "com.y9vad9.rsocket.router.test"
+        group = "com.y9vad9.rsocket.router"
         componentName = "kotlin"
         artifactId = "router-test"
         name = "router-test"

router-test/src/commonMain/kotlin/com/y9vad9/rsocket/router/test/TestBuilders.kt

@@ -1,18 +1,12 @@
 package com.y9vad9.rsocket.router.test
 
-import com.y9vad9.rsocket.router.Router
-import com.y9vad9.rsocket.router.annotations.InternalRouterApi
-import com.y9vad9.rsocket.router.builders.RouterBuilder
 import io.rsocket.kotlin.RSocket
 import kotlin.coroutines.CoroutineContext
 import kotlin.coroutines.EmptyCoroutineContext
 
-@OptIn(InternalRouterApi::class)
-public fun testRouter(block: RouterBuilder.() -> Unit): Router {
-    return RouterBuilder().apply(block).build()
-}
-
-public fun emptyRSocket(): RSocket = object : RSocket {
+public object EmptyRSocket : RSocket {
     override val coroutineContext: CoroutineContext
         get() = EmptyCoroutineContext
-}
+}
+
+public fun emptyRSocket(): RSocket = EmptyRSocket

router-test/src/jvmTest/kotlin/com/y9vad9/rsocket/router/test/RouterTest.kt

@@ -2,6 +2,7 @@ package com.y9vad9.rsocket.router.test
 
 import com.y9vad9.rsocket.router.annotations.ExperimentalRouterApi
 import com.y9vad9.rsocket.router.interceptors.RouteInterceptor
+import com.y9vad9.rsocket.router.router
 import io.rsocket.kotlin.payload.Payload
 import io.rsocket.kotlin.payload.buildPayload
 import io.rsocket.kotlin.payload.data
@@ -29,7 +30,7 @@ class RouterTest {
         }
     }
 
-    private val router = testRouter {
+    private val router = router {
         routeSeparator = '.'
         sharedInterceptors {
             forCoroutineContext(MyInterceptor())