From 9afbe5035efa3e2130d824b741383bc40ae24f8a Mon Sep 17 00:00:00 2001
From: Artyom Gabeev <artyom.gabeev@gmail.com>
Date: Sat, 21 Sep 2024 16:11:46 +0300
Subject: [PATCH] Allow to enable netty http compression

---
 .../sttp/tapir/server/netty/NettyConfig.scala | 21 ++++++++++++++++---
 1 file changed, 18 insertions(+), 3 deletions(-)

diff --git a/server/netty-server/src/main/scala/sttp/tapir/server/netty/NettyConfig.scala b/server/netty-server/src/main/scala/sttp/tapir/server/netty/NettyConfig.scala
index dc799c362a..364fdb3f0d 100644
--- a/server/netty-server/src/main/scala/sttp/tapir/server/netty/NettyConfig.scala
+++ b/server/netty-server/src/main/scala/sttp/tapir/server/netty/NettyConfig.scala
@@ -5,7 +5,7 @@ import io.netty.channel.kqueue.{KQueue, KQueueEventLoopGroup, KQueueServerSocket
 import io.netty.channel.nio.NioEventLoopGroup
 import io.netty.channel.socket.nio.NioServerSocketChannel
 import io.netty.channel.{ChannelHandler, ChannelPipeline, EventLoopGroup, ServerChannel}
-import io.netty.handler.codec.http.HttpServerCodec
+import io.netty.handler.codec.http.{HttpContentCompressor, HttpServerCodec}
 import io.netty.handler.logging.LoggingHandler
 import io.netty.handler.ssl.SslContext
 import org.playframework.netty.http.HttpStreamsServerHandler
@@ -50,6 +50,13 @@ import scala.concurrent.duration._
   *
   * @param serverHeader
   *   If set, send this value in the 'Server' response header. If None, don't set the header.
+  *
+  * @param compressionEnabled
+  *   If set to true, the server will compress responses.
+  *
+  * @param compressionContentSizeThreshold
+  *   The minimum size of the response content that will be compressed. If the response content is smaller than this value, it will not be
+  *   compressed.
   */
 case class NettyConfig(
     host: String,
@@ -68,7 +75,9 @@ case class NettyConfig(
     initPipeline: NettyConfig => (ChannelPipeline, ChannelHandler) => Unit,
     gracefulShutdownTimeout: Option[FiniteDuration],
     idleTimeout: Option[FiniteDuration],
-    serverHeader: Option[String]
+    serverHeader: Option[String],
+    compressionEnabled: Boolean,
+    compressionContentSizeThreshold: Int
 ) {
   def host(h: String): NettyConfig = copy(host = h)
 
@@ -109,6 +118,9 @@ case class NettyConfig(
 
   def serverHeader(h: String): NettyConfig = copy(serverHeader = Some(h))
 
+  def withCompressionEnabled: NettyConfig = copy(compressionEnabled = true)
+  def compressionContentSizeThreshold(t: Int): NettyConfig = copy(compressionContentSizeThreshold = t)
+
   def isSsl: Boolean = sslContext.isDefined
 }
 
@@ -131,12 +143,15 @@ object NettyConfig {
     eventLoopConfig = EventLoopConfig.auto,
     socketConfig = NettySocketConfig.default,
     initPipeline = cfg => defaultInitPipeline(cfg)(_, _),
-    serverHeader = Some(s"tapir/${buildinfo.BuildInfo.version}")
+    serverHeader = Some(s"tapir/${buildinfo.BuildInfo.version}"),
+    compressionEnabled = false,
+    compressionContentSizeThreshold = 0
   )
 
   def defaultInitPipeline(cfg: NettyConfig)(pipeline: ChannelPipeline, handler: ChannelHandler): Unit = {
     cfg.sslContext.foreach(s => pipeline.addLast(s.newHandler(pipeline.channel().alloc())))
     pipeline.addLast(ServerCodecHandlerName, new HttpServerCodec())
+    if (cfg.compressionEnabled) pipeline.addLast(new HttpContentCompressor(cfg.compressionContentSizeThreshold, Seq.empty: _*))
     pipeline.addLast(new HttpStreamsServerHandler())
     pipeline.addLast(handler)
     if (cfg.addLoggingHandler) pipeline.addLast(new LoggingHandler())