fixed server support for request pipelining

2025-03-08 11:07:21 +08:00
parent 59a12d6218
commit 7ba7070693
19 changed files with 203 additions and 235 deletions
--- a/rbcs-server/src/main/kotlin/net/woggioni/rbcs/server/RemoteBuildCacheServer.kt
+++ b/rbcs-server/src/main/kotlin/net/woggioni/rbcs/server/RemoteBuildCacheServer.kt
@@ -298,6 +298,7 @@ class RemoteBuildCacheServer(private val cfg: Configuration) {
                    "Closed connection ${ch.id().asShortText()} with ${ch.remoteAddress()}"
                }
            }
+            ch.config().setAutoRead(false)
            val pipeline = ch.pipeline()
            cfg.connection.also { conn ->
                val readIdleTimeout = conn.readIdleTimeout.toMillis()
--- a/rbcs-server/src/main/kotlin/net/woggioni/rbcs/server/cache/FileSystemCacheHandler.kt
+++ b/rbcs-server/src/main/kotlin/net/woggioni/rbcs/server/cache/FileSystemCacheHandler.kt
@@ -5,6 +5,7 @@ import io.netty.channel.ChannelHandlerContext
 import io.netty.channel.SimpleChannelInboundHandler
 import io.netty.handler.codec.http.LastHttpContent
 import io.netty.handler.stream.ChunkedNioFile
+import net.woggioni.rbcs.api.CacheHandler
 import net.woggioni.rbcs.api.message.CacheMessage
 import net.woggioni.rbcs.api.message.CacheMessage.CacheContent
 import net.woggioni.rbcs.api.message.CacheMessage.CacheGetRequest
@@ -26,7 +27,7 @@ class FileSystemCacheHandler(
    private val compressionEnabled: Boolean,
    private val compressionLevel: Int,
    private val chunkSize: Int
-) : SimpleChannelInboundHandler<CacheMessage>() {
+) : CacheHandler() {

    private inner class InProgressPutRequest(
        val key : String,
@@ -70,7 +71,7 @@ class FileSystemCacheHandler(
    private fun handleGetRequest(ctx: ChannelHandlerContext, msg: CacheGetRequest) {
        val key = String(Base64.getUrlEncoder().encode(processCacheKey(msg.key, digestAlgorithm)))
        cache.get(key)?.also { entryValue ->
-            ctx.writeAndFlush(CacheValueFoundResponse(msg.key, entryValue.metadata))
+            sendMessageAndFlush(ctx, CacheValueFoundResponse(msg.key, entryValue.metadata))
            entryValue.channel.let { channel ->
                if(compressionEnabled) {
                    InflaterInputStream(Channels.newInputStream(channel)).use { stream ->
@@ -81,19 +82,19 @@ class FileSystemCacheHandler(
                            while(buf.readableBytes() < chunkSize) {
                                val read = buf.writeBytes(stream, chunkSize)
                                if(read < 0) {
-                                    ctx.writeAndFlush(LastCacheContent(buf))
+                                    sendMessageAndFlush(ctx, LastCacheContent(buf))
                                    break@outerLoop
                                }
                            }
-                            ctx.writeAndFlush(CacheContent(buf))
+                            sendMessageAndFlush(ctx, CacheContent(buf))
                        }
                    }
                } else {
-                    ctx.writeAndFlush(ChunkedNioFile(channel, entryValue.offset, entryValue.size - entryValue.offset, chunkSize))
-                    ctx.writeAndFlush(LastHttpContent.EMPTY_LAST_CONTENT)
+                    sendMessage(ctx, ChunkedNioFile(channel, entryValue.offset, entryValue.size - entryValue.offset, chunkSize))
+                    sendMessageAndFlush(ctx, LastHttpContent.EMPTY_LAST_CONTENT)
                }
            }
-        } ?: ctx.writeAndFlush(CacheValueNotFoundResponse())
+        } ?: sendMessageAndFlush(ctx, CacheValueNotFoundResponse())
    }

    private fun handlePutRequest(ctx: ChannelHandlerContext, msg: CachePutRequest) {
@@ -111,7 +112,7 @@ class FileSystemCacheHandler(
            inProgressPutRequest = null
            request.write(msg.content())
            request.commit()
-            ctx.writeAndFlush(CachePutResponse(request.key))
+            sendMessageAndFlush(ctx, CachePutResponse(request.key))
        }
    }

--- a/rbcs-server/src/main/kotlin/net/woggioni/rbcs/server/cache/InMemoryCacheHandler.kt
+++ b/rbcs-server/src/main/kotlin/net/woggioni/rbcs/server/cache/InMemoryCacheHandler.kt
@@ -3,6 +3,7 @@ package net.woggioni.rbcs.server.cache
 import io.netty.buffer.ByteBuf
 import io.netty.channel.ChannelHandlerContext
 import io.netty.channel.SimpleChannelInboundHandler
+import net.woggioni.rbcs.api.CacheHandler
 import net.woggioni.rbcs.api.message.CacheMessage
 import net.woggioni.rbcs.api.message.CacheMessage.CacheContent
 import net.woggioni.rbcs.api.message.CacheMessage.CacheGetRequest
@@ -13,6 +14,7 @@ import net.woggioni.rbcs.api.message.CacheMessage.CacheValueNotFoundResponse
 import net.woggioni.rbcs.api.message.CacheMessage.LastCacheContent
 import net.woggioni.rbcs.common.ByteBufOutputStream
 import net.woggioni.rbcs.common.RBCS.processCacheKey
+import net.woggioni.rbcs.common.trace
 import java.util.zip.Deflater
 import java.util.zip.DeflaterOutputStream
 import java.util.zip.InflaterOutputStream
@@ -22,7 +24,7 @@ class InMemoryCacheHandler(
    private val digestAlgorithm: String?,
    private val compressionEnabled: Boolean,
    private val compressionLevel: Int
-) : SimpleChannelInboundHandler<CacheMessage>() {
+) : CacheHandler() {

    private interface InProgressPutRequest : AutoCloseable {
        val request: CachePutRequest
@@ -86,7 +88,7 @@ class InMemoryCacheHandler(

    private fun handleGetRequest(ctx: ChannelHandlerContext, msg: CacheGetRequest) {
        cache.get(processCacheKey(msg.key, digestAlgorithm))?.let { value ->
-            ctx.writeAndFlush(CacheValueFoundResponse(msg.key, value.metadata))
+            sendMessageAndFlush(ctx, CacheValueFoundResponse(msg.key, value.metadata))
            if (compressionEnabled) {
                val buf = ctx.alloc().heapBuffer()
                InflaterOutputStream(ByteBufOutputStream(buf)).use {
@@ -94,11 +96,11 @@ class InMemoryCacheHandler(
                    value.content.release()
                    buf.retain()
                }
-                ctx.writeAndFlush(LastCacheContent(buf))
+                sendMessage(ctx, LastCacheContent(buf))
            } else {
-                ctx.writeAndFlush(LastCacheContent(value.content))
+                sendMessage(ctx, LastCacheContent(value.content))
            }
-        } ?: ctx.writeAndFlush(CacheValueNotFoundResponse())
+        } ?: sendMessage(ctx, CacheValueNotFoundResponse())
    }

    private fun handlePutRequest(ctx: ChannelHandlerContext, msg: CachePutRequest) {
@@ -122,7 +124,7 @@ class InMemoryCacheHandler(
            inProgressRequest.close()
            val cacheKey = processCacheKey(inProgressRequest.request.key, digestAlgorithm)
            cache.put(cacheKey, CacheEntry(inProgressRequest.request.metadata, buf))
-            ctx.writeAndFlush(CachePutResponse(inProgressRequest.request.key))
+            sendMessageAndFlush(ctx, CachePutResponse(inProgressRequest.request.key))
        }
    }

--- a/rbcs-server/src/main/kotlin/net/woggioni/rbcs/server/event/RequestCompletedEvent.kt
+++ b/rbcs-server/src/main/kotlin/net/woggioni/rbcs/server/event/RequestCompletedEvent.kt
@@ -1,4 +0,0 @@
-package net.woggioni.rbcs.server.event
-
-class RequestCompletedEvent {
-}
--- a/rbcs-server/src/main/kotlin/net/woggioni/rbcs/server/handler/CacheContentHandler.kt
+++ b/rbcs-server/src/main/kotlin/net/woggioni/rbcs/server/handler/CacheContentHandler.kt
@@ -1,79 +0,0 @@
-package net.woggioni.rbcs.server.handler
-
-import io.netty.channel.ChannelHandler
-import io.netty.channel.ChannelHandler.Sharable
-import io.netty.channel.ChannelHandlerContext
-import io.netty.channel.ChannelOutboundHandler
-import io.netty.channel.ChannelPromise
-import io.netty.channel.SimpleChannelInboundHandler
-import io.netty.handler.codec.http.HttpContent
-import io.netty.handler.codec.http.LastHttpContent
-import net.woggioni.rbcs.api.message.CacheMessage.CacheValueNotFoundResponse
-import net.woggioni.rbcs.api.message.CacheMessage.CacheContent
-import net.woggioni.rbcs.api.message.CacheMessage.CachePutResponse
-import net.woggioni.rbcs.api.message.CacheMessage.LastCacheContent
-import java.net.SocketAddress
-
-class CacheContentHandler(private val pairedHandler : ChannelHandler) : SimpleChannelInboundHandler<HttpContent>(), ChannelOutboundHandler {
-    private var requestFinished = false
-
-    override fun channelRead0(ctx: ChannelHandlerContext, msg: HttpContent) {
-        if(requestFinished) {
-            ctx.fireChannelRead(msg.retain())
-        } else {
-            when (msg) {
-                is LastHttpContent -> {
-                    ctx.fireChannelRead(LastCacheContent(msg.content().retain()))
-                    requestFinished = true
-                }
-                else -> ctx.fireChannelRead(CacheContent(msg.content().retain()))
-            }
-        }
-    }
-
-    override fun exceptionCaught(ctx: ChannelHandlerContext, cause: Throwable) {
-        super.exceptionCaught(ctx, cause)
-    }
-
-
-    override fun bind(ctx: ChannelHandlerContext, localAddress: SocketAddress, promise: ChannelPromise) {
-        ctx.bind(localAddress, promise)
-    }
-
-    override fun connect(
-        ctx: ChannelHandlerContext,
-        remoteAddress: SocketAddress,
-        localAddress: SocketAddress,
-        promise: ChannelPromise
-    ) {
-        ctx.connect(remoteAddress, localAddress, promise)
-    }
-
-    override fun disconnect(ctx: ChannelHandlerContext, promise: ChannelPromise) {
-        ctx.disconnect(promise)
-    }
-
-    override fun close(ctx: ChannelHandlerContext, promise: ChannelPromise) {
-        ctx.close(promise)
-    }
-
-    override fun deregister(ctx: ChannelHandlerContext, promise: ChannelPromise) {
-        ctx.deregister(promise)
-    }
-
-    override fun read(ctx: ChannelHandlerContext) {
-        ctx.read()
-    }
-
-    override fun flush(ctx: ChannelHandlerContext) {
-        ctx.flush()
-    }
-
-    override fun write(ctx: ChannelHandlerContext, msg: Any, promise: ChannelPromise) {
-        ctx.write(msg, promise)
-        if(msg is LastCacheContent || msg is CachePutResponse || msg is CacheValueNotFoundResponse || msg is LastHttpContent) {
-            ctx.pipeline().remove(pairedHandler)
-            ctx.pipeline().remove(this)
-        }
-    }
-}
--- a/rbcs-server/src/main/kotlin/net/woggioni/rbcs/server/handler/ResponseCapHandler.kt
+++ b/rbcs-server/src/main/kotlin/net/woggioni/rbcs/server/handler/ResponseCapHandler.kt
@@ -1,56 +0,0 @@
-package net.woggioni.rbcs.server.handler
-
-import io.netty.channel.ChannelHandlerContext
-import io.netty.channel.ChannelInboundHandlerAdapter
-import io.netty.channel.ChannelOutboundHandler
-import io.netty.channel.ChannelPromise
-import net.woggioni.rbcs.server.event.RequestCompletedEvent
-import java.net.SocketAddress
-
-class ResponseCapHandler : ChannelInboundHandlerAdapter(), ChannelOutboundHandler {
-    val bufferedMessages = mutableListOf<Any>()
-
-    override fun bind(ctx: ChannelHandlerContext, localAddress: SocketAddress, promise: ChannelPromise) {
-        ctx.bind(localAddress, promise)
-    }
-
-    override fun connect(
-        ctx: ChannelHandlerContext,
-        remoteAddress: SocketAddress,
-        localAddress: SocketAddress,
-        promise: ChannelPromise
-    ) {
-        ctx.connect(remoteAddress, localAddress, promise)
-    }
-
-    override fun disconnect(ctx: ChannelHandlerContext, promise: ChannelPromise) {
-        ctx.disconnect(promise)
-    }
-
-    override fun close(ctx: ChannelHandlerContext, promise: ChannelPromise) {
-        ctx.close(promise)
-    }
-
-    override fun deregister(ctx: ChannelHandlerContext, promise: ChannelPromise) {
-        ctx.deregister(promise)
-    }
-
-    override fun read(ctx: ChannelHandlerContext) {
-        ctx.read()
-    }
-
-    override fun write(ctx: ChannelHandlerContext, msg: Any, promise: ChannelPromise) {
-        bufferedMessages.add(msg)
-    }
-
-    override fun flush(ctx: ChannelHandlerContext) {
-    }
-
-    override fun userEventTriggered(ctx: ChannelHandlerContext, evt: Any) {
-        if(evt is RequestCompletedEvent) {
-            for(msg in bufferedMessages) ctx.write(msg)
-            ctx.flush()
-            ctx.pipeline().remove(this)
-        }
-    }
-}
--- a/rbcs-server/src/main/kotlin/net/woggioni/rbcs/server/handler/ServerHandler.kt
+++ b/rbcs-server/src/main/kotlin/net/woggioni/rbcs/server/handler/ServerHandler.kt
@@ -8,6 +8,7 @@ import io.netty.handler.codec.http.DefaultFullHttpResponse
 import io.netty.handler.codec.http.DefaultHttpContent
 import io.netty.handler.codec.http.DefaultHttpResponse
 import io.netty.handler.codec.http.DefaultLastHttpContent
+import io.netty.handler.codec.http.HttpContent
 import io.netty.handler.codec.http.HttpHeaderNames
 import io.netty.handler.codec.http.HttpHeaderValues
 import io.netty.handler.codec.http.HttpHeaders
@@ -17,7 +18,6 @@ import io.netty.handler.codec.http.HttpResponseStatus
 import io.netty.handler.codec.http.HttpUtil
 import io.netty.handler.codec.http.HttpVersion
 import io.netty.handler.codec.http.LastHttpContent
-import net.woggioni.rbcs.api.CacheHandlerFactory
 import net.woggioni.rbcs.api.CacheValueMetadata
 import net.woggioni.rbcs.api.message.CacheMessage
 import net.woggioni.rbcs.api.message.CacheMessage.CacheContent
@@ -30,10 +30,8 @@ import net.woggioni.rbcs.api.message.CacheMessage.LastCacheContent
 import net.woggioni.rbcs.common.createLogger
 import net.woggioni.rbcs.common.debug
 import net.woggioni.rbcs.common.warn
-import net.woggioni.rbcs.server.event.RequestCompletedEvent
 import net.woggioni.rbcs.server.exception.ExceptionHandler
 import java.nio.file.Path
-import java.util.Locale

 class ServerHandler(private val serverPrefix: Path, private val cacheHandlerSupplier : () -> ChannelHandler) :
    ChannelDuplexHandler() {
@@ -47,6 +45,15 @@ class ServerHandler(private val serverPrefix: Path, private val cacheHandlerSupp
    private var keepAlive = true
    private var pipelinedRequests = 0

+    private fun newRequest() {
+        pipelinedRequests += 1
+    }
+
+    private fun requestCompleted(ctx : ChannelHandlerContext) {
+        pipelinedRequests -= 1
+        if(pipelinedRequests == 0) ctx.read()
+    }
+
    private fun resetRequestMetadata() {
        httpVersion = HttpVersion.HTTP_1_1
        keepAlive = true
@@ -65,22 +72,44 @@ class ServerHandler(private val serverPrefix: Path, private val cacheHandlerSupp
        }
    }

+    private var cacheRequestInProgress : Boolean = false
+
+    override fun handlerAdded(ctx: ChannelHandlerContext) {
+        ctx.read()
+    }

    override fun channelRead(ctx: ChannelHandlerContext, msg: Any) {
        when (msg) {
            is HttpRequest -> handleRequest(ctx, msg)
+            is HttpContent -> {
+                if(cacheRequestInProgress) {
+                    if(msg is LastHttpContent) {
+                        super.channelRead(ctx, LastCacheContent(msg.content().retain()))
+                        cacheRequestInProgress = false
+                    } else {
+                        super.channelRead(ctx, CacheContent(msg.content().retain()))
+                    }
+                    msg.release()
+                } else {
+                    super.channelRead(ctx, msg)
+                }
+            }
            else -> super.channelRead(ctx, msg)
        }
    }

+    override fun channelReadComplete(ctx: ChannelHandlerContext) {
+        super.channelReadComplete(ctx)
+        if(cacheRequestInProgress) {
+            ctx.read()
+        }
+    }

    override fun write(ctx: ChannelHandlerContext, msg: Any, promise: ChannelPromise?) {
        if (msg is CacheMessage) {
            try {
                when (msg) {
                    is CachePutResponse -> {
-                        pipelinedRequests -= 1
-                        ctx.fireUserEventTriggered(RequestCompletedEvent())
                        val response = DefaultFullHttpResponse(httpVersion, HttpResponseStatus.CREATED)
                        val keyBytes = msg.key.toByteArray(Charsets.UTF_8)
                        response.headers().apply {
@@ -92,16 +121,18 @@ class ServerHandler(private val serverPrefix: Path, private val cacheHandlerSupp
                        val buf = ctx.alloc().buffer(keyBytes.size).apply {
                            writeBytes(keyBytes)
                        }
-                        ctx.writeAndFlush(DefaultLastHttpContent(buf))
+                        ctx.writeAndFlush(DefaultLastHttpContent(buf)).also {
+                            requestCompleted(ctx)
+                        }
                    }

                    is CacheValueNotFoundResponse -> {
-                        pipelinedRequests -= 1
-                        ctx.fireUserEventTriggered(RequestCompletedEvent())
                        val response = DefaultFullHttpResponse(httpVersion, HttpResponseStatus.NOT_FOUND)
                        response.headers()[HttpHeaderNames.CONTENT_LENGTH] = 0
                        setKeepAliveHeader(response.headers())
-                        ctx.writeAndFlush(response)
+                        ctx.writeAndFlush(response).also {
+                            requestCompleted(ctx)
+                        }
                    }

                    is CacheValueFoundResponse -> {
@@ -118,9 +149,9 @@ class ServerHandler(private val serverPrefix: Path, private val cacheHandlerSupp
                    }

                    is LastCacheContent -> {
-                        pipelinedRequests -= 1
-                        ctx.fireUserEventTriggered(RequestCompletedEvent())
-                        ctx.writeAndFlush(DefaultLastHttpContent(msg.content()))
+                        ctx.writeAndFlush(DefaultLastHttpContent(msg.content())).also {
+                            requestCompleted(ctx)
+                        }
                    }

                    is CacheContent -> {
@@ -140,9 +171,8 @@ class ServerHandler(private val serverPrefix: Path, private val cacheHandlerSupp
                resetRequestMetadata()
            }
        } else if(msg is LastHttpContent) {
-            pipelinedRequests -= 1
-            ctx.fireUserEventTriggered(RequestCompletedEvent())
            ctx.write(msg, promise)
+            requestCompleted(ctx)
        } else super.write(ctx, msg, promise)
    }

@@ -153,15 +183,12 @@ class ServerHandler(private val serverPrefix: Path, private val cacheHandlerSupp
        if (method === HttpMethod.GET) {
            val path = Path.of(msg.uri()).normalize()
            if (path.startsWith(serverPrefix)) {
+                cacheRequestInProgress = true
                val relativePath = serverPrefix.relativize(path)
-                val key = relativePath.toString()
-                if(pipelinedRequests > 0) {
-                    ctx.pipeline().addBefore(ExceptionHandler.NAME, null, ResponseCapHandler())
-                }
+                val key : String = relativePath.toString()
+                newRequest()
                val cacheHandler = cacheHandlerSupplier()
-                ctx.pipeline().addBefore(ExceptionHandler.NAME, null, CacheContentHandler(cacheHandler))
                ctx.pipeline().addBefore(ExceptionHandler.NAME, null, cacheHandler)
-                pipelinedRequests += 1
                key.let(::CacheGetRequest)
                    .let(ctx::fireChannelRead)
                    ?: ctx.channel().write(CacheValueNotFoundResponse())
@@ -176,18 +203,15 @@ class ServerHandler(private val serverPrefix: Path, private val cacheHandlerSupp
        } else if (method === HttpMethod.PUT) {
            val path = Path.of(msg.uri()).normalize()
            if (path.startsWith(serverPrefix)) {
+                cacheRequestInProgress = true
                val relativePath = serverPrefix.relativize(path)
                val key = relativePath.toString()
                log.debug(ctx) {
                    "Added value for key '$key' to build cache"
                }
-                if(pipelinedRequests > 0) {
-                    ctx.pipeline().addBefore(ExceptionHandler.NAME, null, ResponseCapHandler())
-                }
+                newRequest()
                val cacheHandler = cacheHandlerSupplier()
-                ctx.pipeline().addBefore(ExceptionHandler.NAME, null, CacheContentHandler(cacheHandler))
                ctx.pipeline().addBefore(ExceptionHandler.NAME, null, cacheHandler)
-                pipelinedRequests += 1

                path.fileName?.toString()
                    ?.let {
@@ -205,11 +229,8 @@ class ServerHandler(private val serverPrefix: Path, private val cacheHandlerSupp
                ctx.writeAndFlush(response)
            }
        } else if (method == HttpMethod.TRACE) {
-            if(pipelinedRequests > 0) {
-                ctx.pipeline().addBefore(ExceptionHandler.NAME, null, ResponseCapHandler())
-            }
+            newRequest()
            ctx.pipeline().addBefore(ExceptionHandler.NAME, null, TraceHandler)
-            pipelinedRequests += 1
            super.channelRead(ctx, msg)
        } else {
            log.warn(ctx) {