Supports configurable compression level #3567

raccoonback · 2024-12-29T08:10:28Z

Motivation

Hello,

I have added a feature to support compression level configuration in Reactor Netty's SimpleCompressionHandler.

Feature Details:

Compression methods such as gzip, deflate, zstd now allow specifying the compression level.
For brotli and snappy, since it does not support compression level configuration, the existing default behavior remains unchanged.

This enhancement is expected to enable users to better balance compression efficiency and performance.

Thanks.

Issue

Previously closed Pull-Request: Supports compression level #3565
Fixes: Support for changing the default compression level when enabling server response compression #3244

fix: reactor#3244

- gzip: only the range 0 to 9 is allowed - deflate: only the range 0 to 9 is allowed - zstd: only the range -7 to 22 is allowed brotli and snappy compression are supported by default. fix: reactor#3244

fix: reactor#3244

raccoonback · 2025-01-01T15:03:55Z

reactor-netty-http/src/main/java/reactor/netty/http/server/SimpleCompressionHandler.java

-	SimpleCompressionHandler() {
-		super((CompressionOptions[]) null);


Remove unnecessary constructors

raccoonback · 2025-01-01T15:06:11Z

reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerOperations.java

@@ -1320,7 +1324,7 @@ static final class FailedHttpServerRequest extends HttpServerOperations {
 				ZonedDateTime timestamp,
 				ConnectionInfo connectionInfo,
 				boolean validateHeaders) {
-			super(c, listener, nettyRequest, null, connectionInfo,
+			super(c, listener, nettyRequest, null, HttpCompressionSettingsSpec.provideDefault(), connectionInfo,


Specifies the default compression level supported for each compression.

gzip, deflate: 6

zstd: 3

raccoonback · 2025-01-01T15:07:26Z

reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerOperations.java

@@ -757,7 +761,7 @@ public HttpServerResponse compression(boolean compress) {
 			removeHandler(NettyPipeline.CompressionHandler);
 		}
 		else if (channel().pipeline().get(NettyPipeline.CompressionHandler) == null) {
-			SimpleCompressionHandler handler = new SimpleCompressionHandler();
+			SimpleCompressionHandler handler = SimpleCompressionHandler.create(compressionSettings);


Applies the user-defined compression settings to the Netty's compression settings.

raccoonback · 2025-01-01T15:08:21Z

reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServer.java

+	public final HttpServer compressSettings(Consumer<HttpCompressionSettingsSpec.Builder> compressionSettings) {
+		Objects.requireNonNull(compressionSettings, "compressionSettings");
+
+		HttpCompressionSettingsSpec.Builder builder = HttpCompressionSettingsSpec.builder();
+		compressionSettings.accept(builder);
+
+		HttpServer dup = duplicate();
+		dup.configuration().compressionSettings = builder.build();
+		return dup;
+	}


This method takes compression settings from the user.

raccoonback · 2025-01-01T15:09:33Z

reactor-netty-http/src/main/java/reactor/netty/http/server/HttpCompressionSettingsSpec.java

+		return new Build();
+	}
+
+	static HttpCompressionSettingsSpec provideDefault() {
+		return new HttpCompressionSettingsSpec();
+	}
+
+	CompressionOptions[] adaptToOptions() {
+		List<CompressionOptions> options = new ArrayList<>();
+		options.add(this.gzipOptions);
+		options.add(this.deflateOptions);
+		options.add(this.snappyOptions);
+
+		if (brotliOptions != null) {
+			options.add(this.brotliOptions);
+		}
+
+		if (zstdOptions != null) {
+			options.add(this.zstdOptions);
+		}
+
+		return options.toArray(new CompressionOptions[0]);
+	}
+
+	public interface Builder {
+
+		/**
+		 * Build a new {@link HttpCompressionSettingsSpec}.
+		 *
+		 * @return a new {@link HttpCompressionSettingsSpec}
+		 */
+		HttpCompressionSettingsSpec build();
+
+		/**
+		 * Sets the gzip compression level.
+		 *
+		 * @return a new {@link HttpCompressionSettingsSpec.Builder}
+		 */
+		Builder gzip(int compressionLevel);
+
+		/**
+		 * Sets the deflate compression level.
+		 *
+		 * @return a new {@link HttpCompressionSettingsSpec.Builder}
+		 */
+		Builder deflate(int compressionLevel);
+
+		/**
+		 * Sets the zstd compression level.
+		 *
+		 * @return a new {@link HttpCompressionSettingsSpec.Builder}
+		 */
+		Builder zstd(int compressionLevel);
+	}
+
+	private static final class Build implements Builder {
+
+		GzipOptions gzipOptions = StandardCompressionOptions.gzip();
+		DeflateOptions deflateOptions = StandardCompressionOptions.deflate();
+		ZstdOptions zstdOptions;
+
+		private static final int DEFLATE_DEFAULT_WINDOW_BITS = 15;
+		private static final int DEFLATE_DEFAULT_MEMORY_LEVEL = 8;
+		private static final int ZSTD_DEFAULT_COMPRESSION_LEVEL = 3;
+		private static final int ZSTD_DEFAULT_BLOCK_SIZE = 65536;
+		private static final int ZSTD_MAX_BLOCK_SIZE = 1 << ZSTD_DEFAULT_COMPRESSION_LEVEL + 7 + 15;
+
+		@Override
+		public HttpCompressionSettingsSpec build() {
+			return new HttpCompressionSettingsSpec(this);
+		}
+
+		@Override
+		public Builder gzip(int compressionLevel) {
+			ObjectUtil.checkInRange(compressionLevel, 0, 9, "compressionLevel");
+
+			gzipOptions = StandardCompressionOptions.gzip(compressionLevel, DEFLATE_DEFAULT_WINDOW_BITS, DEFLATE_DEFAULT_MEMORY_LEVEL);
+			return this;
+		}
+
+		@Override
+		public Builder deflate(int compressionLevel) {
+			ObjectUtil.checkInRange(compressionLevel, 0, 9, "compressionLevel");
+
+			this.deflateOptions = StandardCompressionOptions.deflate(compressionLevel, DEFLATE_DEFAULT_WINDOW_BITS, DEFLATE_DEFAULT_MEMORY_LEVEL);
+			return this;
+		}
+
+		@Override
+		public Builder zstd(int compressionLevel) {
+			if (!Zstd.isAvailable()) {
+				throw new IllegalStateException("Unable to set compression level on zstd.");
+			}
+			ObjectUtil.checkInRange(compressionLevel, -7, 22, "compressionLevel");
+
+			this.zstdOptions = StandardCompressionOptions.zstd(compressionLevel, ZSTD_DEFAULT_BLOCK_SIZE, ZSTD_MAX_BLOCK_SIZE);
+			return this;
+		}
+	}
+}


Defines a spec for configuring HTTP compression.

raccoonback · 2025-01-01T15:11:30Z

reactor-netty-http/src/main/java/reactor/netty/http/server/HttpCompressionSettingsSpec.java

+	private HttpCompressionSettingsSpec() {
+		gzipOptions = StandardCompressionOptions.gzip();
+		deflateOptions = StandardCompressionOptions.deflate();
+		snappyOptions = StandardCompressionOptions.snappy();
+
+		if (Brotli.isAvailable()) {
+			brotliOptions = StandardCompressionOptions.brotli();
+		}
+
+		if (Zstd.isAvailable()) {
+			zstdOptions = StandardCompressionOptions.zstd();
+		}
+	}


The default constructor sets the available compression to default settings.

raccoonback · 2025-01-01T15:13:13Z

reactor-netty-http/src/main/java/reactor/netty/http/server/HttpCompressionSettingsSpec.java

+	private HttpCompressionSettingsSpec(Build build) {
+		gzipOptions = build.gzipOptions;
+		deflateOptions = build.gzipOptions;
+		snappyOptions = StandardCompressionOptions.snappy();
+
+		if (Brotli.isAvailable()) {
+			brotliOptions = StandardCompressionOptions.brotli();
+		}
+
+		if (Zstd.isAvailable() && build.zstdOptions != null) {
+			zstdOptions = build.zstdOptions;
+		}
+	}


Initializes to each compression setting entered by the Builder.

raccoonback · 2025-01-01T15:16:00Z

reactor-netty-http/src/main/java/reactor/netty/http/server/HttpCompressionSettingsSpec.java

+	CompressionOptions[] adaptToOptions() {
+		List<CompressionOptions> options = new ArrayList<>();
+		options.add(this.gzipOptions);
+		options.add(this.deflateOptions);
+		options.add(this.snappyOptions);
+
+		if (brotliOptions != null) {
+			options.add(this.brotliOptions);
+		}
+
+		if (zstdOptions != null) {
+			options.add(this.zstdOptions);
+		}
+
+		return options.toArray(new CompressionOptions[0]);
+	}


Adapts to the type to be provided to the constructor argument of Netty's HttpContentCompressor.

raccoonback · 2025-01-01T15:16:53Z

reactor-netty-http/src/main/java/reactor/netty/http/server/HttpCompressionSettingsSpec.java

+	private static final class Build implements Builder {
+
+		GzipOptions gzipOptions = StandardCompressionOptions.gzip();
+		DeflateOptions deflateOptions = StandardCompressionOptions.deflate();
+		ZstdOptions zstdOptions;
+
+		private static final int DEFLATE_DEFAULT_WINDOW_BITS = 15;
+		private static final int DEFLATE_DEFAULT_MEMORY_LEVEL = 8;
+		private static final int ZSTD_DEFAULT_COMPRESSION_LEVEL = 3;
+		private static final int ZSTD_DEFAULT_BLOCK_SIZE = 65536;
+		private static final int ZSTD_MAX_BLOCK_SIZE = 1 << ZSTD_DEFAULT_COMPRESSION_LEVEL + 7 + 15;
+
+		@Override
+		public HttpCompressionSettingsSpec build() {
+			return new HttpCompressionSettingsSpec(this);
+		}
+
+		@Override
+		public Builder gzip(int compressionLevel) {
+			ObjectUtil.checkInRange(compressionLevel, 0, 9, "compressionLevel");
+
+			gzipOptions = StandardCompressionOptions.gzip(compressionLevel, DEFLATE_DEFAULT_WINDOW_BITS, DEFLATE_DEFAULT_MEMORY_LEVEL);
+			return this;
+		}
+
+		@Override
+		public Builder deflate(int compressionLevel) {
+			ObjectUtil.checkInRange(compressionLevel, 0, 9, "compressionLevel");
+
+			this.deflateOptions = StandardCompressionOptions.deflate(compressionLevel, DEFLATE_DEFAULT_WINDOW_BITS, DEFLATE_DEFAULT_MEMORY_LEVEL);
+			return this;
+		}
+
+		@Override
+		public Builder zstd(int compressionLevel) {
+			if (!Zstd.isAvailable()) {
+				throw new IllegalStateException("Unable to set compression level on zstd.");
+			}
+			ObjectUtil.checkInRange(compressionLevel, -7, 22, "compressionLevel");
+
+			this.zstdOptions = StandardCompressionOptions.zstd(compressionLevel, ZSTD_DEFAULT_BLOCK_SIZE, ZSTD_MAX_BLOCK_SIZE);
+			return this;
+		}
+	}


A builder that takes each compression setting as input from the user.

raccoonback · 2025-01-01T15:17:47Z

reactor-netty-http/src/main/java/reactor/netty/http/server/Http3Codec.java

 		                 forwardedHeaderHandler, httpMessageLogFactory, listener, mapHandle, readTimeout, requestTimeout));

 		boolean alwaysCompress = compressPredicate == null && minCompressionSize == 0;

 		if (alwaysCompress) {
-			p.addLast(NettyPipeline.CompressionHandler, new SimpleCompressionHandler());
+			p.addLast(NettyPipeline.CompressionHandler, SimpleCompressionHandler.create(compressionSettings));


Apply the configured compression settings.

violetagg · 2025-01-03T10:42:09Z

reactor-netty-http/src/main/java/reactor/netty/http/server/HttpCompressionSettingsSpec.java

+		 *
+		 * @return a new {@link HttpCompressionSettingsSpec.Builder}
+		 */
+		Builder gzip(int compressionLevel);


@raccoonback If in the future you need to extend the configuration API with window Bits, memory level etc. How will we introduce them?

@violetagg
Thank you for the great question!

The reason why windowBits and memoryLevel are not currently configurable is that their default settings in GZIP are optimized for most use cases. Exposing these options could lead to unnecessary increases in memory usage or make configuration overly complex.

For now, we’ve chosen to rely on default values without exposing these settings directly to users. However, we’ve considered the need for extensibility in future requirements.

If it becomes necessary to make windowBits and memoryLevel configurable, the API can be extended using with method overloading:

Builder gzip(int compressionLevel); Builder gzip(int compressionLevel, int windowBits); Builder gzip(int compressionLevel, int windowBits, int memoryLevel); // ...

Additionally, if required, we can extend the API to provide these as optional settings while maintaining the default values. Let me know your thoughts, and I’ll adjust the design accordingly.

Mmm ... method overloading is not something that I would like to see in the API. Can we use a similar approach to Netty's CompressionOptions. Thus the API will be "please provide CompressionOptions[]" and the API will stay stable and we can touch only particular CompressionOption if needed.

@violetagg
Thank you for your feedback!
I will revise the implementation to follow a structure similar to Netty's CompressionOptions as you suggested.

- Updated the interface to accept `CompressionOptions[]` instead of using method overloading. - Aligns with Netty's design for consistency and maintainability, addressing feedback from PR reactor#3567.

raccoonback · 2025-01-07T15:12:17Z

reactor-netty-http/src/main/java/reactor/netty/http/server/compression/BrotliOption.java

+final class BrotliOption implements HttpCompressionOption {
+
+	private final CompressionOptions option;
+
+	BrotliOption() {
+		this.option = StandardCompressionOptions.brotli();
+	}
+
+	CompressionOptions adapt() {
+		return option;
+	}
+}


Brotli compression option

raccoonback · 2025-01-07T15:12:32Z

reactor-netty-http/src/main/java/reactor/netty/http/server/compression/DeflateOption.java

+final class DeflateOption implements HttpCompressionOption {
+
+	private final CompressionOptions option;
+
+	DeflateOption() {
+		this.option = StandardCompressionOptions.gzip();
+	}
+
+	DeflateOption(int compressionLevel, int windowBits, int memoryLevel) {
+		this.option = StandardCompressionOptions.gzip(
+				compressionLevel,
+				windowBits,
+				memoryLevel
+		);
+	}
+
+	CompressionOptions adapt() {
+		return option;
+	}
+}


Deflate compression option

raccoonback · 2025-01-07T15:12:42Z

reactor-netty-http/src/main/java/reactor/netty/http/server/compression/GzipOption.java

+final class GzipOption implements HttpCompressionOption {
+
+	private final CompressionOptions option;
+
+	GzipOption() {
+		this.option = StandardCompressionOptions.gzip();
+	}
+
+	GzipOption(int compressionLevel, int windowBits, int memoryLevel) {
+		this.option = StandardCompressionOptions.gzip(
+				compressionLevel,
+				windowBits,
+				memoryLevel
+		);
+	}
+
+	CompressionOptions adapt() {
+		return option;
+	}
+}


Gzip compression option

raccoonback · 2025-01-07T15:13:41Z

...tty-http/src/main/java/reactor/netty/http/server/compression/HttpCompressionOptionsSpec.java

+	private HttpCompressionOptionsSpec() {
+		gzip = StandardHttpCompressionOptions.gzip();
+		deflate = StandardHttpCompressionOptions.deflate();
+		snappy = StandardHttpCompressionOptions.snappy();
+
+		if (Brotli.isAvailable()) {
+			brotli = StandardHttpCompressionOptions.brotli();
+		}
+
+		if (Zstd.isAvailable()) {
+			zstd = StandardHttpCompressionOptions.zstd();
+		}
+	}


Set all supported compression settings to their default settings, as before.

raccoonback · 2025-01-07T15:15:23Z

...tty-http/src/main/java/reactor/netty/http/server/compression/HttpCompressionOptionsSpec.java

+	public HttpCompressionOptionsSpec(HttpCompressionOption... compressionOptions) {
+		this();
+		Arrays.stream(compressionOptions)
+				.forEach(this::initializeOption);
+	}
+
+	private void initializeOption(HttpCompressionOption option) {
+		if (option instanceof GzipOption) {
+			this.gzip = (GzipOption) option;
+		}
+		else if (option instanceof DeflateOption) {
+			this.deflate = (DeflateOption) option;
+		}
+		else if (option instanceof SnappyOption) {
+			this.snappy = (SnappyOption) option;
+		}
+		else if (Brotli.isAvailable() && option instanceof BrotliOption) {
+			this.brotli = (BrotliOption) option;
+		}
+		else if (Zstd.isAvailable() && option instanceof ZstdOption) {
+			this.zstd = (ZstdOption) option;
+		}
+	}


After setting the default compression settings, it overwrites the user's compression settings afterwards.

raccoonback · 2025-01-07T15:15:56Z

...tty-http/src/main/java/reactor/netty/http/server/compression/HttpCompressionOptionsSpec.java

+	public CompressionOptions[] adapt() {
+		List<CompressionOptions> options = new ArrayList<>(
+				Arrays.asList(
+						gzip.adapt(),
+						deflate.adapt(),
+						snappy.adapt()
+				)
+		);
+
+		if (brotli != null) {
+			options.add(brotli.adapt());
+		}
+
+		if (zstd != null) {
+			options.add(zstd.adapt());
+		}
+
+		return options.toArray(new CompressionOptions[0]);
+	}


Convert this to compression settings to provide to Netty.

raccoonback · 2025-01-07T15:16:17Z

reactor-netty-http/src/main/java/reactor/netty/http/server/compression/SnappyOption.java

+final class SnappyOption implements HttpCompressionOption {
+
+	private final CompressionOptions option;
+
+	SnappyOption() {
+		this.option = StandardCompressionOptions.snappy();
+	}
+
+	CompressionOptions adapt() {
+		return option;
+	}
+}


Snappy compression option

raccoonback · 2025-01-07T15:17:31Z

...http/src/main/java/reactor/netty/http/server/compression/StandardHttpCompressionOptions.java

+	}
+
+	/**
+	 * Default GZIP options.
+	 * The default compression level is 6.
+	 *
+	 * @return a new {@link GzipOption}
+	 */
+	public static GzipOption gzip() {
+		return new GzipOption();
+	}
+
+	/**
+	 * Set GZIP options.
+	 *
+	 * @return a new {@link GzipOption}
+	 * @throws IllegalStateException If invalid parameters.
+	 */
+	public static GzipOption gzip(int compressionLevel, int windowBits, int memoryLevel) {
+		ObjectUtil.checkInRange(compressionLevel, 0, 9, "compressionLevel");
+		ObjectUtil.checkInRange(windowBits, 9, 15, "windowBits");
+		ObjectUtil.checkInRange(memoryLevel, 1, 9, "memLevel");
+
+		return new GzipOption(compressionLevel, windowBits, memoryLevel);
+	}
+
+	/**
+	 * Default Deflate options.
+	 * The default compression level is 6.
+	 *
+	 * @return a new {@link DeflateOption}
+	 */
+	public static DeflateOption deflate() {
+		return new DeflateOption();
+	}
+
+	/**
+	 * Set Deflate options.
+	 *
+	 * @return a new {@link DeflateOption}
+	 * @throws IllegalStateException If invalid parameters.
+	 */
+	public static DeflateOption deflate(int compressionLevel, int windowBits, int memoryLevel) {
+		ObjectUtil.checkInRange(compressionLevel, 0, 9, "compressionLevel");
+		ObjectUtil.checkInRange(windowBits, 9, 15, "windowBits");
+		ObjectUtil.checkInRange(memoryLevel, 1, 9, "memLevel");
+
+		return new DeflateOption(compressionLevel, windowBits, memoryLevel);
+	}
+
+	/**
+	 * Default ZSTD options.
+	 * The default compression level is 3.
+	 *
+	 * @return a new {@link ZstdOption}
+	 */
+	public static ZstdOption zstd() {
+		return new ZstdOption();
+	}
+
+	/**
+	 * Set ZSTD options.
+	 *
+	 * @return a new {@link ZstdOption}
+	 * @throws IllegalStateException If invalid parameters.
+	 */
+	public static ZstdOption zstd(int compressionLevel, int blockSize, int maxEncodeSize) {
+		ObjectUtil.checkInRange(compressionLevel, -(1 << 17), 22, "compressionLevel");
+		ObjectUtil.checkPositive(blockSize, "blockSize");
+		ObjectUtil.checkPositive(maxEncodeSize, "maxEncodeSize");
+
+		if (!Zstd.isAvailable()) {
+			throw new IllegalStateException("ZSTD is not available", Zstd.cause());
+		}
+
+		return new ZstdOption(compressionLevel, blockSize, maxEncodeSize);
+	}
+
+	/**
+	 * Default Brotli options.
+	 *
+	 * @return a new {@link BrotliOption}
+	 */
+	public static BrotliOption brotli() {
+		if (!Brotli.isAvailable()) {
+			throw new IllegalStateException("Brotli is not available", Brotli.cause());
+		}
+
+		return new BrotliOption();
+	}
+
+	/**
+	 * Default Snappy options.
+	 *
+	 * @return a new {@link SnappyOption}
+	 */
+	public static SnappyOption snappy() {
+		return new SnappyOption();
+	}
+}


Provides a method that allows users to set compression settings in a similar way to Netty.

raccoonback · 2025-01-07T15:18:19Z

reactor-netty-http/src/main/java/reactor/netty/http/server/compression/ZstdOption.java

+final class ZstdOption implements HttpCompressionOption {
+
+	private final CompressionOptions option;
+
+	ZstdOption() {
+		this.option = StandardCompressionOptions.zstd();
+	}
+
+	ZstdOption(int compressionLevel, int windowBits, int memoryLevel) {
+		this.option = StandardCompressionOptions.zstd(
+				compressionLevel,
+				windowBits,
+				memoryLevel
+		);
+	}
+
+	CompressionOptions adapt() {
+		return option;
+	}
+}


Zstd compression option

raccoonback · 2025-01-07T15:23:13Z

@violetagg
I have reflected the review comments in commit 2c653c1!
Please check and let me know if there’s anything else.
Thank you!

violetagg · 2025-01-09T07:46:58Z

reactor-netty-http/src/main/java/reactor/netty/http/server/HttpServerConfig.java

@@ -344,6 +346,7 @@ public Function<String, String> uriTagValue() {
 		this.httpMessageLogFactory = ReactorNettyHttpMessageLogFactory.INSTANCE;
 		this.maxKeepAliveRequests = -1;
 		this.minCompressionSize = -1;
+		this.compressionOptions = HttpCompressionOptionsSpec.provideDefault();


Can we not initialise this with a default, or maybe it can be empty? The default will be used only when the compression is enabled. In Reactor Netty we try to not initialise things that will not be used.

@violetagg
Thank you for the suggestion!
I’ve updated the implementation in commit c28d954 to set compressionOptions to null as the default state when compression is disabled.

…is disabled - Updated compressionOptions to default to null when compression is not explicitly configured. - Ensures a clean default state, reflecting that no compression settings are applied unless enabled.

violetagg · 2025-01-10T10:18:43Z

reactor-netty-http/src/main/java/reactor/netty/http/server/compression/DeflateOption.java

+		this.option = StandardCompressionOptions.gzip();
+	}
+
+	DeflateOption(int compressionLevel, int windowBits, int memoryLevel) {


I imagined some kind of a builder because I don't see how this is different than what was before. Let me play with the PR to see what we can achieve.

Thank you for the feedback! 😃
In 2c653c1, I have implemented the compression settings to only be configurable via the methods provided by StandardHttpCompressionOptions.

Before

HttpServer.create() .compress(true) .compressOptions( builder -> builder.gzip(6) .zstd(12) ) .bindNow();

After

HttpServer.create() .compress(true) .compressOptions( StandardHttpCompressionOptions.gzip(6, 15, 8), StandardHttpCompressionOptions.zstd(12, 65536, 65536) ) .bindNow();

By Builder approach, did you mean a method where each compression setting is handled through chainable calls, as shown below? 😊

HttpServer.create() .compress(true) .compressOptions( GzipOptions.builder() .compressionLevel(6) .windowBits(15) .windowBits(8) .build(), ZstdOptions.builder() .compressionLevel(12) .blockSize(65536) .maxEncodeSize(65536) .build() ) .bindNow();

violetagg · 2025-01-10T11:20:23Z

Yes, basically if you want to configure compression level, you configure only this the rest stays the default and if in the future we need to add something else then we just add only this new configuration to the builder

…

On Fri, 10 Jan 2025 at 13:00, KOSEUNGBIN ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In reactor-netty-http/src/main/java/reactor/netty/http/server/compression/DeflateOption.java <#3567 (comment)> : > +import io.netty.handler.codec.compression.StandardCompressionOptions; + +/** + * Deflate compression option configuration. + * + * @author raccoonback + */ +final class DeflateOption implements HttpCompressionOption { + + private final CompressionOptions option; + + DeflateOption() { + this.option = StandardCompressionOptions.gzip(); + } + + DeflateOption(int compressionLevel, int windowBits, int memoryLevel) { Thank you for the feedback! In this PR, I have implemented the compression settings to only be configurable via the methods provided by StandardHttpCompressionOptions. HttpServer.create() .compress(true) .compressOptions( StandardHttpCompressionOptions.gzip(6, 15, 8), StandardHttpCompressionOptions.zstd(12, 65536, 65536) ) .bindNow(); By Builder approach, did you mean a method where each compression setting is handled through chainable calls, as shown below? 😊 HttpServer.create() .compress(true) .compressOptions( GzipOptions.builder() .compressionLevel(6) .windowBits(15) .windowBits(8) .build(), ZstdOptions.builder() .compressionLevel(12) .blockSize(65536) .maxEncodeSize(65536) .build() ) .bindNow(); — Reply to this email directly, view it on GitHub <#3567 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAFKCVM43LJ5NXQ35WPOMGD2J6R4FAVCNFSM6AAAAABUKSI4SKVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDKNBSGE2TKNZUGY> . You are receiving this because you were mentioned.Message ID: ***@***.***>

raccoonback · 2025-01-10T11:29:23Z

@violetagg
I understand!
Then, I will modify the compression settings to be configurable using the builder pattern as you suggested and request the review again.
Thank you for your feedback.

HttpServer.create()
	.compress(true)
	.compressOptions(
           GzipOptions.builder()
                .compressionLevel(6)
                .windowBits(15)
                .windowBits(8)
                .build(),
           ZstdOptions.builder()
                .compressionLevel(12)
                .blockSize(65536)
                .maxEncodeSize(65536)
                .build()
	)
	.bindNow();

- Refactor compression settings to use a Builder pattern for easier configuration and improved flexibility.

raccoonback · 2025-01-10T15:22:31Z

reactor-netty-http/src/main/java/reactor/netty/http/server/compression/GzipOption.java

+		private int compressionLevel = 6;
+		private int windowBits = 12;
+		private int memoryLevel = 8;


Set it the same as Netty's default GZip option.

raccoonback · 2025-01-10T15:26:33Z

reactor-netty-http/src/main/java/reactor/netty/http/server/compression/ZstdOption.java

+		private int compressionLevel = 3;
+		private int blockSize = 1 << 16;  // 64KB
+		private int maxEncodeSize = 1 << (compressionLevel + 7 + 0x0F);   //  32MB


Netty also uses the default values provided by zstd-jni for block size and max encode size.
I check in zstd-jni and set the default values.

raccoonback · 2025-01-10T15:28:03Z

reactor-netty-http/src/main/java/reactor/netty/http/server/compression/DeflateOption.java

+		private int compressionLevel = 6;
+		private int windowBits = 12;
+		private int memoryLevel = 8;


Set it the same as Netty's default Deflate option.

raccoonback · 2025-01-10T15:55:10Z

@violetagg
I have updated the implementation to reflect the Builder approach you suggested. (99287f4)
Please take a look and let me know if there are any further adjustments needed!

raccoonback added 3 commits December 29, 2024 17:00

Supports compression level setting

94a3d1d

fix: reactor#3244

Supports gzip, deflate, zstd compression level setting

a060024

- gzip: only the range 0 to 9 is allowed - deflate: only the range 0 to 9 is allowed - zstd: only the range -7 to 22 is allowed brotli and snappy compression are supported by default. fix: reactor#3244

Write a guide document

38f3bcc

fix: reactor#3244

raccoonback force-pushed the issue-3244 branch from 41bd91e to 38f3bcc Compare December 29, 2024 08:26

raccoonback commented Jan 1, 2025

View reviewed changes

violetagg added the type/enhancement A general enhancement label Jan 2, 2025

violetagg added this to the 1.2.2 milestone Jan 2, 2025

violetagg reviewed Jan 3, 2025

View reviewed changes

raccoonback requested a review from violetagg January 4, 2025 01:27

raccoonback added 2 commits January 7, 2025 23:55

Refactor compression options interface to follow Netty's style

2c653c1

- Updated the interface to accept `CompressionOptions[]` instead of using method overloading. - Aligns with Netty's design for consistency and maintainability, addressing feedback from PR reactor#3567.

Update license year

5373a2a

raccoonback commented Jan 7, 2025

View reviewed changes

Fix checkstyle

100d2da

violetagg requested changes Jan 9, 2025

View reviewed changes

raccoonback requested a review from violetagg January 9, 2025 12:55

raccoonback force-pushed the issue-3244 branch from c28d954 to 3de0d82 Compare January 9, 2025 13:03

Set compressionOptions to null as the default state when compression …

7eee9c9

…is disabled - Updated compressionOptions to default to null when compression is not explicitly configured. - Ensures a clean default state, reflecting that no compression settings are applied unless enabled.

raccoonback force-pushed the issue-3244 branch from 3de0d82 to 7eee9c9 Compare January 9, 2025 13:58

violetagg reviewed Jan 10, 2025

View reviewed changes

Enhance compression configuration with Builder

99287f4

- Refactor compression settings to use a Builder pattern for easier configuration and improved flexibility.

raccoonback commented Jan 10, 2025

View reviewed changes

raccoonback requested a review from violetagg January 10, 2025 15:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Supports configurable compression level #3567

Supports configurable compression level #3567

raccoonback commented Dec 29, 2024 •

edited by violetagg

Loading

raccoonback Jan 1, 2025

raccoonback Jan 1, 2025

raccoonback Jan 1, 2025

raccoonback Jan 1, 2025

raccoonback Jan 1, 2025

raccoonback Jan 1, 2025

raccoonback Jan 1, 2025

raccoonback Jan 1, 2025

raccoonback Jan 1, 2025

raccoonback Jan 1, 2025

violetagg Jan 3, 2025

raccoonback Jan 3, 2025

violetagg Jan 6, 2025 •

edited

Loading

raccoonback Jan 6, 2025

raccoonback Jan 7, 2025

raccoonback Jan 7, 2025

raccoonback Jan 7, 2025

raccoonback Jan 7, 2025

raccoonback Jan 7, 2025

raccoonback Jan 7, 2025

raccoonback Jan 7, 2025

raccoonback Jan 7, 2025

raccoonback Jan 7, 2025

raccoonback commented Jan 7, 2025

violetagg Jan 9, 2025

raccoonback Jan 9, 2025

violetagg Jan 10, 2025 •

edited

Loading

raccoonback Jan 10, 2025 •

edited

Loading

violetagg commented Jan 10, 2025 via email

raccoonback commented Jan 10, 2025

raccoonback Jan 10, 2025

raccoonback Jan 10, 2025

raccoonback Jan 10, 2025

raccoonback commented Jan 10, 2025

		SimpleCompressionHandler() {
		super((CompressionOptions[]) null);

Supports configurable compression level #3567

Are you sure you want to change the base?

Supports configurable compression level #3567

Conversation

raccoonback commented Dec 29, 2024 • edited by violetagg Loading

Motivation

Issue

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

violetagg Jan 6, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raccoonback commented Jan 7, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

violetagg Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

raccoonback Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

Before

After

violetagg commented Jan 10, 2025 via email

raccoonback commented Jan 10, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raccoonback commented Jan 10, 2025

raccoonback commented Dec 29, 2024 •

edited by violetagg

Loading

violetagg Jan 6, 2025 •

edited

Loading

violetagg Jan 10, 2025 •

edited

Loading

raccoonback Jan 10, 2025 •

edited

Loading