Keep-alive data support & Server acceptor setup rejection support (#34)

* * Possibility to reject setup by Server acceptor

* Client Keep-alive data support

* Client Keep-alive handler responds to Frames with `respond` flag set

* Introduce RSocketFactory ClientOptions & ServerOptions

* fix rare NoSuchElementException on Request-Response interaction

* update reactor-netty to 0.7.8.RELEASE, fixing Websocket client critical bug reactor/reactor-netty#345, which prevented RSocket Netty-Websocket transport from sending its close event via onClose()

Author: mostroverkhov

README.md

@@ -103,7 +103,6 @@ private fun handler(setup: Setup, rSocket: RSocket): Single<RSocket> {
 ### LICENSE
 
 Copyright 2015-2018 Netflix, Inc.
-Maksym Ostroverkhov
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

rsocket-core/src/main/kotlin/io/rsocket/kotlin/ClientOptions.kt

@@ -0,0 +1,7 @@
+package io.rsocket.kotlin
+
+class ClientOptions : Options<ClientOptions>() {
+
+    override fun copy(): ClientOptions =
+            ClientOptions().streamRequestLimit(streamRequestLimit())
+}

rsocket-core/src/main/kotlin/io/rsocket/kotlin/Duration.kt

@@ -2,10 +2,6 @@ package io.rsocket.kotlin
 
 import java.util.concurrent.TimeUnit
 
-/**
- * Created by Maksym Ostroverkhov on 27.10.17.
- */
-
 data class Duration(private val value: Long, val unit: TimeUnit) {
 
     val millis = unit.toMillis(value)

rsocket-core/src/main/kotlin/io/rsocket/kotlin/KeepAliveData.kt

@@ -0,0 +1,11 @@
+package io.rsocket.kotlin
+
+import java.nio.ByteBuffer
+
+interface KeepAliveData {
+
+    fun producer(): () -> ByteBuffer
+
+    fun handler(): (ByteBuffer) -> Unit
+}
+

rsocket-core/src/main/kotlin/io/rsocket/kotlin/KeepAliveOptions.kt

@@ -1,8 +1,11 @@
 package io.rsocket.kotlin
 
+import io.rsocket.kotlin.internal.EmptyKeepAliveData
+
 class KeepAliveOptions : KeepAlive {
     private var interval: Duration = Duration.ofMillis(100)
     private var maxLifeTime: Duration = Duration.ofSeconds(1)
+    private var keepAliveData: KeepAliveData = EmptyKeepAliveData()
 
     fun keepAliveInterval(interval: Duration): KeepAliveOptions {
         assertDuration(interval, "keepAliveInterval")
@@ -20,9 +23,17 @@ class KeepAliveOptions : KeepAlive {
 
     override fun keepAliveMaxLifeTime() = maxLifeTime
 
+    fun keepAliveData(keepAliveData: KeepAliveData): KeepAliveOptions {
+        this.keepAliveData = keepAliveData
+        return this
+    }
+
+    fun keepAliveData(): KeepAliveData = keepAliveData
+
     fun copy(): KeepAliveOptions = KeepAliveOptions()
             .keepAliveInterval(interval)
             .keepAliveMaxLifeTime(maxLifeTime)
+            .keepAliveData(keepAliveData)
 
     private fun assertDuration(duration: Duration, name: String) {
         if (duration.millis <= 0) {

rsocket-core/src/main/kotlin/io/rsocket/kotlin/Options.kt

@@ -0,0 +1,22 @@
+package io.rsocket.kotlin
+
+abstract class Options<T:Options<T>> internal constructor() {
+    private var streamRequestLimit: Int = 128
+
+    @Suppress("UNCHECKED_CAST")
+    open fun streamRequestLimit(streamRequestLimit: Int): T {
+        assertRequestLimit(streamRequestLimit)
+        this.streamRequestLimit = streamRequestLimit
+        return this as T
+    }
+
+    abstract fun copy(): T
+
+    internal fun streamRequestLimit(): Int = streamRequestLimit
+
+    private fun assertRequestLimit(streamRequestLimit: Int) {
+        if (streamRequestLimit <= 0) {
+            throw IllegalArgumentException("stream request limit must be positive")
+        }
+    }
+}

rsocket-core/src/main/kotlin/io/rsocket/kotlin/RSocketFactory.kt

@@ -55,7 +55,7 @@ object RSocketFactory {
         private var setupPayload: Payload = DefaultPayload.EMPTY
         private val keepAlive = KeepAliveOptions()
         private val mediaType = MediaTypeOptions()
-        private var streamRequestLimit = defaultStreamRequestLimit
+        private val options = ClientOptions()
 
         fun interceptors(configure: (InterceptorOptions) -> Unit): ClientRSocketFactory {
             configure(interceptors)
@@ -79,7 +79,7 @@ object RSocketFactory {
             return this
         }
 
-        fun enableLease(leaseRefConsumer: (LeaseRef) -> Unit): ClientRSocketFactory {
+        fun lease(leaseRefConsumer: (LeaseRef) -> Unit): ClientRSocketFactory {
             this.flags = Frame.Setup.enableLease(flags)
             this.leaseRefConsumer = leaseRefConsumer
             return this
@@ -95,9 +95,8 @@ object RSocketFactory {
             return this
         }
 
-        fun streamRequestLimit(streamRequestLimit: Int): ClientRSocketFactory {
-            assertRequestLimit(streamRequestLimit)
-            this.streamRequestLimit = streamRequestLimit
+        fun options(configure: (ClientOptions) -> Unit): ClientRSocketFactory {
+            configure(options)
             return this
         }
 
@@ -126,7 +125,7 @@ object RSocketFactory {
                         setupPayload,
                         keepAlive.copy(),
                         mediaType.copy(),
-                        streamRequestLimit,
+                        options.copy(),
                         transport,
                         interceptors.copy())
 
@@ -137,13 +136,17 @@ object RSocketFactory {
                 private val leaseRef: ((LeaseRef) -> Unit)?,
                 private val flags: Int,
                 private val setupPayload: Payload,
-                private val keepAlive: KeepAlive,
+                keepAliveOpts: KeepAliveOptions,
                 private val mediaType: MediaType,
-                private val streamRequestLimit: Int,
+                options: ClientOptions,
                 private val transportClient: () -> ClientTransport,
                 private val parentInterceptors: InterceptorRegistry)
             : Start<RSocket> {
 
+            private val streamRequestLimit = options.streamRequestLimit()
+            private val keepALive = keepAliveOpts as KeepAlive
+            private val keepAliveData = keepAliveOpts.keepAliveData()
+
             override fun start(): Single<RSocket> {
                 return transportClient()
                         .connect()
@@ -184,7 +187,8 @@ object RSocketFactory {
 
                             ClientServiceHandler(
                                     demuxer.serviceConnection(),
-                                    keepAlive,
+                                    keepALive,
+                                    keepAliveData,
                                     errorConsumer)
 
                             val setupFrame = createSetupFrame()
@@ -205,8 +209,8 @@ object RSocketFactory {
             private fun createSetupFrame(): Frame {
                 return Frame.Setup.from(
                         flags,
-                        keepAlive.keepAliveInterval().intMillis,
-                        keepAlive.keepAliveMaxLifeTime().intMillis,
+                        keepALive.keepAliveInterval().intMillis,
+                        keepALive.keepAliveMaxLifeTime().intMillis,
                         mediaType.metadataMimeType(),
                         mediaType.dataMimeType(),
                         setupPayload)
@@ -229,7 +233,7 @@ object RSocketFactory {
         private var mtu = 0
         private var leaseRefConsumer: ((LeaseRef) -> Unit)? = null
         private val interceptors = GlobalInterceptors.create()
-        private var streamRequestLimit = defaultStreamRequestLimit
+        private val options = ServerOptions()
 
         fun interceptors(configure: (InterceptorOptions) -> Unit): ServerRSocketFactory {
             configure(interceptors)
@@ -242,7 +246,7 @@ object RSocketFactory {
             return this
         }
 
-        fun enableLease(leaseRefConsumer: (LeaseRef) -> Unit): ServerRSocketFactory {
+        fun lease(leaseRefConsumer: (LeaseRef) -> Unit): ServerRSocketFactory {
             this.leaseRefConsumer = leaseRefConsumer
             return this
         }
@@ -252,8 +256,8 @@ object RSocketFactory {
             return this
         }
 
-        fun streamRequestLimit(streamRequestLimit: Int): ServerRSocketFactory {
-            this.streamRequestLimit = streamRequestLimit
+        fun options(configure: (ServerOptions) -> Unit): ServerRSocketFactory {
+            configure(options)
             return this
         }
 
@@ -268,7 +272,7 @@ object RSocketFactory {
                                 mtu,
                                 leaseRefConsumer,
                                 interceptors.copy(),
-                                streamRequestLimit)
+                                options.copy())
             }
         }
 
@@ -279,7 +283,9 @@ object RSocketFactory {
                 private val mtu: Int,
                 private val leaseRef: ((LeaseRef) -> Unit)?,
                 private val parentInterceptors: InterceptorRegistry,
-                private val streamRequestLimit: Int) : Start<T> {
+                options: ServerOptions) : Start<T> {
+
+            private val streamRequestLimit = options.streamRequestLimit()
 
             override fun start(): Single<T> {
                 return transportServer().start(object
@@ -331,12 +337,15 @@ object RSocketFactory {
 
                 ServerServiceHandler(
                         demuxer.serviceConnection(),
-                        setup as KeepAlive,
+                        setup,
                         errorConsumer)
 
                 val handlerRSocket = acceptor()(setup, wrappedRequester)
 
-                return handlerRSocket
+                val rejectingHandlerRSocket = RejectingRSocket(handlerRSocket)
+                                .with(demuxer.requesterConnection())
+
+                return rejectingHandlerRSocket
                         .map { handler -> interceptors.interceptHandler(handler) }
                         .doOnSuccess { handler ->
                             RSocketResponder(
@@ -374,12 +383,6 @@ object RSocketFactory {
         }
     }
 
-    private fun assertRequestLimit(streamRequestLimit: Int) {
-        if (streamRequestLimit <= 0) {
-            throw IllegalArgumentException("stream request limit must be positive")
-        }
-    }
-
     private fun assertFragmentation(mtu: Int) {
         if (mtu < 0) {
             throw IllegalArgumentException("fragmentation mtu must be non-negative")
@@ -405,8 +408,6 @@ object RSocketFactory {
                 transport { transport }
     }
 
-    private const val defaultStreamRequestLimit = 128
-
     private val emptyRSocket = object : AbstractRSocket() {}
 }
 

rsocket-core/src/main/kotlin/io/rsocket/kotlin/ServerOptions.kt

@@ -0,0 +1,7 @@
+package io.rsocket.kotlin
+
+class ServerOptions : Options<ServerOptions>() {
+
+    override fun copy(): ServerOptions =
+            ServerOptions().streamRequestLimit(streamRequestLimit())
+}

rsocket-core/src/main/kotlin/io/rsocket/kotlin/internal/ClientServiceHandler.kt

@@ -6,18 +6,23 @@ import io.reactivex.Flowable
 import io.reactivex.disposables.Disposable
 import io.rsocket.kotlin.DuplexConnection
 import io.rsocket.kotlin.Frame
-import io.rsocket.kotlin.exceptions.ConnectionException
 import io.rsocket.kotlin.KeepAlive
+import io.rsocket.kotlin.KeepAliveData
+import io.rsocket.kotlin.exceptions.ConnectionException
+import java.nio.ByteBuffer
 import java.util.concurrent.TimeUnit
 
 internal class ClientServiceHandler(serviceConnection: DuplexConnection,
                                     keepAlive: KeepAlive,
+                                    keepAliveData: KeepAliveData,
                                     errorConsumer: (Throwable) -> Unit)
     : ServiceHandler(serviceConnection, errorConsumer) {
 
     @Volatile
     private var keepAliveReceivedMillis = System.currentTimeMillis()
     private var subscription: Disposable? = null
+    private val dataProducer: () -> ByteBuffer = keepAliveData.producer()
+    private val dataHandler: (ByteBuffer) -> Unit = keepAliveData.handler()
 
     init {
         val tickPeriod = keepAlive.keepAliveInterval().millis
@@ -35,6 +40,9 @@ internal class ClientServiceHandler(serviceConnection: DuplexConnection,
     override fun handleKeepAlive(frame: Frame) {
         if (!Frame.Keepalive.hasRespondFlag(frame)) {
             keepAliveReceivedMillis = System.currentTimeMillis()
+            dataHandler(frame.data)
+        } else {
+            sendKeepAliveFrame(frame.data, false)
         }
     }
 
@@ -51,8 +59,12 @@ internal class ClientServiceHandler(serviceConnection: DuplexConnection,
                         "keep-alive timed out: $duration of $timeout ms"
                 throw ConnectionException(message)
             }
-            sentFrames.onNext(
-                    Frame.Keepalive.from(Unpooled.EMPTY_BUFFER, true))
+            sendKeepAliveFrame(dataProducer(), true)
         }
     }
+
+    private fun sendKeepAliveFrame(data: ByteBuffer, respond: Boolean) {
+        sentFrames.onNext(
+                Frame.Keepalive.from(Unpooled.wrappedBuffer(data), respond))
+    }
 }

rsocket-core/src/main/kotlin/io/rsocket/kotlin/internal/EmptyKeepAliveData.kt

@@ -0,0 +1,17 @@
+package io.rsocket.kotlin.internal
+
+import io.rsocket.kotlin.KeepAliveData
+import java.nio.ByteBuffer
+
+internal class EmptyKeepAliveData : KeepAliveData {
+
+    override fun producer(): () -> ByteBuffer = noopProducer
+
+    override fun handler(): (ByteBuffer) -> Unit = noopHandler
+
+    companion object {
+        private val emptyBuffer = ByteBuffer.allocateDirect(0)
+        private val noopProducer = { emptyBuffer }
+        private val noopHandler: (ByteBuffer) -> Unit = { }
+    }
+}