Refactor compression options interface to follow Netty's style

- Updated the interface to accept `CompressionOptions[]` instead of using method overloading. - Aligns with Netty's design for consistency and maintainability, addressing feedback from PR #3567.
reactor · Jan 7, 2025 · 2c653c1 · 2c653c1
1 parent 38f3bcc
commit 2c653c1
Show file tree

Hide file tree

Showing 21 changed files with 562 additions and 271 deletions.
diff --git a/docs/modules/ROOT/pages/http-server.adoc b/docs/modules/ROOT/pages/http-server.adoc
@@ -162,15 +162,15 @@ You can configure the `HTTP` server to send a compressed response, depending on
 * `compress(int)`: The compression is performed once the response size exceeds the given value (in bytes).
 * `compress(BiPredicate<HttpServerRequest, HttpServerResponse>)`: The compression is performed if
 the predicate returns `true`.
-* `compressSettings(Consumer<HttpCompressionSettingsSpec.Builder> compressionSettings`: Specifies the compression level for GZIP, DEFLATE, and ZSTD.
+* `compressOptions(HttpCompressionOption... compressionOptions)`: Specifies the compression level for GZIP, DEFLATE, and ZSTD.
 +
 [NOTE]
 ====
 Supported Compression Levels
 
 * gzip : only the range 0 to 9 is allowed. (default: 6)
 * deflate : only the range 0 to 9 is allowed. (default: 6)
-* zstd : only the range -7 to 22 is allowed. (default: 3)
+* zstd : only the range -131072 to 22 is allowed. (default: 3)
 ====
 
 The following example uses the `compress` method (set to `true`) to enable compression:

diff --git a/...or-netty-http/src/main/java/reactor/netty/http/server/Http2StreamBridgeServerHandler.java b/...or-netty-http/src/main/java/reactor/netty/http/server/Http2StreamBridgeServerHandler.java
@@ -47,6 +47,7 @@
 import reactor.netty.ReactorNetty;
 import reactor.netty.http.logging.HttpMessageArgProviderFactory;
 import reactor.netty.http.logging.HttpMessageLogFactory;
+import reactor.netty.http.server.compression.HttpCompressionOptionsSpec;
 import reactor.util.annotation.Nullable;
 
 import static io.netty.handler.codec.http.LastHttpContent.EMPTY_LAST_CONTENT;
@@ -62,7 +63,7 @@
 final class Http2StreamBridgeServerHandler extends ChannelDuplexHandler {
 
 	final BiPredicate<HttpServerRequest, HttpServerResponse>      compress;
-	final HttpCompressionSettingsSpec compressionSettings;
+	final HttpCompressionOptionsSpec compressionOptions;
 	final ServerCookieDecoder                                     cookieDecoder;
 	final ServerCookieEncoder                                     cookieEncoder;
 	final HttpServerFormDecoderProvider                           formDecoderProvider;
@@ -85,7 +86,7 @@ final class Http2StreamBridgeServerHandler extends ChannelDuplexHandler {
 
 	Http2StreamBridgeServerHandler(
 			@Nullable BiPredicate<HttpServerRequest, HttpServerResponse> compress,
-			HttpCompressionSettingsSpec compressionSettings,
+			HttpCompressionOptionsSpec compressionOptions,
 			ServerCookieDecoder decoder,
 			ServerCookieEncoder encoder,
 			HttpServerFormDecoderProvider formDecoderProvider,
@@ -96,7 +97,7 @@ final class Http2StreamBridgeServerHandler extends ChannelDuplexHandler {
 			@Nullable Duration readTimeout,
 			@Nullable Duration requestTimeout) {
 		this.compress = compress;
-		this.compressionSettings = compressionSettings;
+		this.compressionOptions = compressionOptions;
 		this.cookieDecoder = decoder;
 		this.cookieEncoder = encoder;
 		this.formDecoderProvider = formDecoderProvider;
@@ -143,7 +144,7 @@ public void channelRead(ChannelHandlerContext ctx, Object msg) {
 						listener,
 						request,
 						compress,
-						compressionSettings,
+						compressionOptions,
 						connectionInfo,
 						cookieDecoder,
 						cookieEncoder,

diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/Http3Codec.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/Http3Codec.java
@@ -31,6 +31,7 @@
 import reactor.netty.channel.ChannelMetricsRecorder;
 import reactor.netty.channel.ChannelOperations;
 import reactor.netty.http.logging.HttpMessageLogFactory;
+import reactor.netty.http.server.compression.HttpCompressionOptionsSpec;
 import reactor.netty.http.server.logging.AccessLog;
 import reactor.netty.http.server.logging.AccessLogArgProvider;
 import reactor.netty.http.server.logging.AccessLogHandlerFactory;
@@ -63,7 +64,7 @@ final class Http3Codec extends ChannelInitializer<QuicStreamChannel> {
 	final Function<String, String>                                methodTagValue;
 	final ChannelMetricsRecorder                                  metricsRecorder;
 	final int                                                     minCompressionSize;
-	final HttpCompressionSettingsSpec compressionSettings;
+	final HttpCompressionOptionsSpec compressionOptions;
 	final ChannelOperations.OnSetup                               opsFactory;
 	final Duration                                                readTimeout;
 	final Duration                                                requestTimeout;
@@ -84,7 +85,7 @@ final class Http3Codec extends ChannelInitializer<QuicStreamChannel> {
 			@Nullable Function<String, String> methodTagValue,
 			@Nullable ChannelMetricsRecorder metricsRecorder,
 			int minCompressionSize,
-			HttpCompressionSettingsSpec compressionSettings,
+			HttpCompressionOptionsSpec compressionOptions,
 			ChannelOperations.OnSetup opsFactory,
 			@Nullable Duration readTimeout,
 			@Nullable Duration requestTimeout,
@@ -103,7 +104,7 @@ final class Http3Codec extends ChannelInitializer<QuicStreamChannel> {
 		this.methodTagValue = methodTagValue;
 		this.metricsRecorder = metricsRecorder;
 		this.minCompressionSize = minCompressionSize;
-		this.compressionSettings = compressionSettings;
+		this.compressionOptions = compressionOptions;
 		this.opsFactory = opsFactory;
 		this.readTimeout = readTimeout;
 		this.requestTimeout = requestTimeout;
@@ -121,13 +122,13 @@ protected void initChannel(QuicStreamChannel channel) {
 
 		p.addLast(NettyPipeline.H3ToHttp11Codec, new Http3FrameToHttpObjectCodec(true, validate))
 		 .addLast(NettyPipeline.HttpTrafficHandler,
-		         new Http3StreamBridgeServerHandler(compressPredicate, compressionSettings, cookieDecoder, cookieEncoder, formDecoderProvider,
+		         new Http3StreamBridgeServerHandler(compressPredicate, compressionOptions, cookieDecoder, cookieEncoder, formDecoderProvider,
 		                 forwardedHeaderHandler, httpMessageLogFactory, listener, mapHandle, readTimeout, requestTimeout));
 
 		boolean alwaysCompress = compressPredicate == null && minCompressionSize == 0;
 
 		if (alwaysCompress) {
-			p.addLast(NettyPipeline.CompressionHandler, SimpleCompressionHandler.create(compressionSettings));
+			p.addLast(NettyPipeline.CompressionHandler, SimpleCompressionHandler.create(compressionOptions));
 		}
 
 		ChannelOperations.addReactiveBridge(channel, opsFactory, listener);
@@ -169,15 +170,15 @@ static ChannelHandler newHttp3ServerConnectionHandler(
 			@Nullable Function<String, String> methodTagValue,
 			@Nullable ChannelMetricsRecorder metricsRecorder,
 			int minCompressionSize,
-			HttpCompressionSettingsSpec compressionSettings,
+			HttpCompressionOptionsSpec compressionOptions,
 			ChannelOperations.OnSetup opsFactory,
 			@Nullable Duration readTimeout,
 			@Nullable Duration requestTimeout,
 			@Nullable Function<String, String> uriTagValue,
 			boolean validate) {
 		return new Http3ServerConnectionHandler(
 				new Http3Codec(accessLogEnabled, accessLog, compressPredicate, decoder, encoder, formDecoderProvider, forwardedHeaderHandler,
-						httpMessageLogFactory, listener, mapHandle, methodTagValue, metricsRecorder, minCompressionSize, compressionSettings,
+						httpMessageLogFactory, listener, mapHandle, methodTagValue, metricsRecorder, minCompressionSize, compressionOptions,
 						opsFactory, readTimeout, requestTimeout, uriTagValue, validate));
 	}
 }
diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/Http3ServerOperations.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/Http3ServerOperations.java
@@ -24,6 +24,7 @@
 import reactor.netty.Connection;
 import reactor.netty.ConnectionObserver;
 import reactor.netty.http.logging.HttpMessageLogFactory;
+import reactor.netty.http.server.compression.HttpCompressionOptionsSpec;
 import reactor.util.annotation.Nullable;
 
 import java.net.SocketAddress;
@@ -43,7 +44,7 @@ final class Http3ServerOperations extends HttpServerOperations {
 			ConnectionObserver listener,
 			HttpRequest nettyRequest,
 			@Nullable BiPredicate<HttpServerRequest, HttpServerResponse> compressionPredicate,
-			HttpCompressionSettingsSpec compressionSettings,
+			HttpCompressionOptionsSpec compressionOptions,
 			ConnectionInfo connectionInfo,
 			ServerCookieDecoder decoder,
 			ServerCookieEncoder encoder,
@@ -55,7 +56,7 @@ final class Http3ServerOperations extends HttpServerOperations {
 			@Nullable Duration requestTimeout,
 			boolean secured,
 			ZonedDateTime timestamp) {
-		super(c, listener, nettyRequest, compressionPredicate, compressionSettings, connectionInfo, decoder, encoder, formDecoderProvider,
+		super(c, listener, nettyRequest, compressionPredicate, compressionOptions, connectionInfo, decoder, encoder, formDecoderProvider,
 				httpMessageLogFactory, isHttp2, mapHandle, readTimeout, requestTimeout, secured, timestamp, true);
 	}
 

diff --git a/...or-netty-http/src/main/java/reactor/netty/http/server/Http3StreamBridgeServerHandler.java b/...or-netty-http/src/main/java/reactor/netty/http/server/Http3StreamBridgeServerHandler.java
@@ -41,6 +41,7 @@
 import reactor.netty.ReactorNetty;
 import reactor.netty.http.logging.HttpMessageArgProviderFactory;
 import reactor.netty.http.logging.HttpMessageLogFactory;
+import reactor.netty.http.server.compression.HttpCompressionOptionsSpec;
 import reactor.util.annotation.Nullable;
 
 import java.net.SocketAddress;
@@ -54,7 +55,7 @@
 
 final class Http3StreamBridgeServerHandler extends ChannelDuplexHandler {
 	final BiPredicate<HttpServerRequest, HttpServerResponse>      compress;
-	final HttpCompressionSettingsSpec compressionSettings;
+	final HttpCompressionOptionsSpec compressionOptions;
 	final ServerCookieDecoder                                     cookieDecoder;
 	final ServerCookieEncoder                                     cookieEncoder;
 	final HttpServerFormDecoderProvider                           formDecoderProvider;
@@ -75,7 +76,7 @@ final class Http3StreamBridgeServerHandler extends ChannelDuplexHandler {
 
 	Http3StreamBridgeServerHandler(
 			@Nullable BiPredicate<HttpServerRequest, HttpServerResponse> compress,
-			HttpCompressionSettingsSpec compressionSettings,
+			HttpCompressionOptionsSpec compressionOptions,
 			ServerCookieDecoder decoder,
 			ServerCookieEncoder encoder,
 			HttpServerFormDecoderProvider formDecoderProvider,
@@ -86,7 +87,7 @@ final class Http3StreamBridgeServerHandler extends ChannelDuplexHandler {
 			@Nullable Duration readTimeout,
 			@Nullable Duration requestTimeout) {
 		this.compress = compress;
-		this.compressionSettings = compressionSettings;
+		this.compressionOptions = compressionOptions;
 		this.cookieDecoder = decoder;
 		this.cookieEncoder = encoder;
 		this.formDecoderProvider = formDecoderProvider;
@@ -134,7 +135,7 @@ public void channelRead(ChannelHandlerContext ctx, Object msg) {
 						listener,
 						request,
 						compress,
-						compressionSettings,
+						compressionOptions,
 						connectionInfo,
 						cookieDecoder,
 						cookieEncoder,

diff --git a/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpCompressionSettingsSpec.java b/reactor-netty-http/src/main/java/reactor/netty/http/server/HttpCompressionSettingsSpec.java