Reworking jetty-compression for JPMS

jetty-core/jetty-compression/jetty-compression-api/pom.xml

@@ -19,7 +19,15 @@
   <dependencies>
     <dependency>
       <groupId>org.eclipse.jetty</groupId>
-      <artifactId>jetty-server</artifactId>
+      <artifactId>jetty-http</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.eclipse.jetty</groupId>
+      <artifactId>jetty-io</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.eclipse.jetty</groupId>
+      <artifactId>jetty-util</artifactId>
     </dependency>
     <dependency>
       <groupId>org.eclipse.jetty</groupId>

jetty-core/jetty-compression/jetty-compression-api/src/main/java/module-info.java

@@ -0,0 +1,20 @@
+//
+// ========================================================================
+// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
+// which is available at https://www.apache.org/licenses/LICENSE-2.0.
+//
+// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
+// ========================================================================
+//
+
+module org.eclipse.jetty.compression
+{
+    requires transitive org.eclipse.jetty.http;
+    requires org.slf4j;
+
+    exports org.eclipse.jetty.compression;
+}

jetty-core/jetty-compression/jetty-compression-api/src/main/java/org/eclipse/jetty/compression/Compression.java

@@ -48,34 +48,6 @@ public Compression(String encoding)
         etagSuffixQuote = etagSuffix + "\"";
     }
 
-    /**
-     * Test if the {@code Accept-Encoding} request header and {@code Content-Length} response
-     * header are suitable to allow compression for the response compression implementation.
-     *
-     * @param headers the request headers
-     * @param contentLength the content length
-     * @return true if compression is allowed
-     */
-    public boolean acceptsCompression(HttpFields headers, long contentLength)
-    {
-        if (contentLength >= 0 && contentLength < getMinCompressSize())
-        {
-            if (LOG.isDebugEnabled())
-                LOG.debug("{} excluded minCompressSize {}", this, headers);
-            return false;
-        }
-
-        // check the accept encoding header
-        if (!headers.contains(HttpHeader.ACCEPT_ENCODING, getEncodingName()))
-        {
-            if (LOG.isDebugEnabled())
-                LOG.debug("{} excluded not {} acceptable {}", this, getEncodingName(), headers);
-            return false;
-        }
-
-        return true;
-    }
-
     /**
      * Acquire a {@link RetainableByteBuffer} that is managed by this {@link Compression} implementation
      * which is suitable for compressed output from an {@link EncoderSink} or compressed input from a {@link DecoderSource}.

jetty-core/jetty-compression/jetty-compression-api/src/main/java/org/eclipse/jetty/compression/EncoderSink.java

@@ -45,7 +45,6 @@ public void write(boolean last, ByteBuffer content, Callback callback)
         }
         catch (Throwable t)
         {
-            // TODO: do we need to tell the delegate that we failed?
             callback.failed(t);
             return;
         }
@@ -86,7 +85,7 @@ private enum State
             COMPRESSING,
             // The last content is being encoded and is being flushed
             FINISHING,
-            // The final content has been send (final state)
+            // The final content has been sent (final state)
             FINISHED
         }
 
@@ -128,7 +127,7 @@ protected void onCompleteFailure(Throwable x)
         }
 
         @Override
-        protected Action process() throws Throwable
+        protected Action process()
         {
             if (state.get() == State.FINISHED)
                 return Action.SUCCEEDED;

jetty-core/jetty-compression/jetty-compression-brotli/pom.xml

@@ -23,11 +23,6 @@
       <artifactId>brotli4j</artifactId>
       <version>${brotli4j.version}</version>
     </dependency>
-    <dependency>
-      <groupId>io.netty</groupId>
-      <artifactId>netty-buffer</artifactId>
-      <version>${netty.version}</version>
-    </dependency>
     <dependency>
       <groupId>org.eclipse.jetty.compression</groupId>
       <artifactId>jetty-compression-api</artifactId>

jetty-core/jetty-compression/jetty-compression-brotli/src/main/java/module-info.java

@@ -0,0 +1,21 @@
+//
+// ========================================================================
+// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
+// which is available at https://www.apache.org/licenses/LICENSE-2.0.
+//
+// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
+// ========================================================================
+//
+
+module org.eclipse.jetty.compression.brotli
+{
+    requires transitive org.eclipse.jetty.compression;
+    requires org.slf4j;
+    requires com.aayushatharva.brotli4j;
+
+    exports org.eclipse.jetty.compression.brotli;
+}

jetty-core/jetty-compression/jetty-compression-brotli/src/main/java/org/eclipse/jetty/compression/brotli/BrotliCompression.java

@@ -28,6 +28,8 @@
 import org.eclipse.jetty.compression.DecoderSource;
 import org.eclipse.jetty.compression.EncoderConfig;
 import org.eclipse.jetty.compression.EncoderSink;
+import org.eclipse.jetty.compression.brotli.internal.BrotliDecoderSource;
+import org.eclipse.jetty.compression.brotli.internal.BrotliEncoderSink;
 import org.eclipse.jetty.http.CompressedContentFormat;
 import org.eclipse.jetty.http.HttpField;
 import org.eclipse.jetty.http.HttpHeader;
@@ -159,7 +161,7 @@ public InputStream newDecoderInputStream(InputStream in, DecoderConfig config) t
     public DecoderSource newDecoderSource(Content.Source source, DecoderConfig config)
     {
         BrotliDecoderConfig brotliDecoderConfig = BrotliDecoderConfig.class.cast(config);
-        return new BrotliDecoderSource(this, source, brotliDecoderConfig);
+        return new BrotliDecoderSource(source, brotliDecoderConfig);
     }
 
     @Override
@@ -173,7 +175,7 @@ public OutputStream newEncoderOutputStream(OutputStream out, EncoderConfig confi
     public EncoderSink newEncoderSink(Content.Sink sink, EncoderConfig config)
     {
         BrotliEncoderConfig brotliEncoderConfig = BrotliEncoderConfig.class.cast(config);
-        return new BrotliEncoderSink(this, sink, brotliEncoderConfig);
+        return new BrotliEncoderSink(sink, brotliEncoderConfig);
     }
 
     private ByteOrder getByteOrder()

jetty-core/jetty-compression/jetty-compression-brotli/src/main/java/org/eclipse/jetty/compression/brotli/BrotliDecoderConfig.java

@@ -33,6 +33,6 @@ public int getBufferSize()
     @Override
     public void setBufferSize(int size)
     {
-        this.bufferSize = this.bufferSize = Math.max(MIN_BUFFER_SIZE, size);
+        this.bufferSize = Math.max(MIN_BUFFER_SIZE, size);
     }
 }

jetty-core/jetty-compression/jetty-compression-brotli/src/main/java/org/eclipse/jetty/compression/brotli/BrotliEncoderConfig.java

@@ -25,12 +25,6 @@ public class BrotliEncoderConfig implements EncoderConfig
      * @see <a href="https://www.brotli.org/encode.html">Encoder Defaults</a>
      */
     public static final int DEFAULT_QUALITY = 11;
-    /**
-     * Default Brotli Mode (Strategy).
-     *
-     * @see <a href="https://www.brotli.org/encode.html">Encoder Defaults</a>
-     */
-    public static final Encoder.Mode DEFAULT_MODE = Encoder.Mode.GENERIC;
     /**
      * Default Brotli Window.
      *
@@ -41,15 +35,15 @@ public class BrotliEncoderConfig implements EncoderConfig
     public static final int MIN_BUFFER_SIZE = 32;
 
     private int bufferSize = 4096;
+    private int strategy = 0;
     private int quality = DEFAULT_QUALITY;
-    private Encoder.Mode mode = DEFAULT_MODE;
     private int lgWindow = DEFAULT_WINDOW;
 
     public Parameters asEncoderParams()
     {
         Parameters params = new Parameters();
         params.setQuality(getCompressionLevel());
-        params.setMode(getMode());
+        params.setMode(Encoder.Mode.of(getStrategy()));
         params.setWindow(getLgWindow());
         return params;
     }
@@ -122,15 +116,10 @@ public void setLgWindow(int window)
         this.lgWindow = window;
     }
 
-    public Encoder.Mode getMode()
-    {
-        return mode;
-    }
-
     @Override
     public int getStrategy()
     {
-        return mode.ordinal();
+        return strategy;
     }
 
     /**
@@ -151,6 +140,6 @@ public void setStrategy(int strategy)
         if ((strategy < 0) || (strategy > Encoder.Mode.values().length))
             throw new IllegalArgumentException("Unsupported brotli strategy mode: " + strategy);
 
-        mode = Encoder.Mode.of(strategy);
+        this.strategy = strategy;
     }
 }

jetty-core/jetty-compression/jetty-compression-brotli/src/main/java/org/eclipse/jetty/compression/brotli/BrotliDecoderSource.java → jetty-core/jetty-compression/jetty-compression-brotli/src/main/java/org/eclipse/jetty/compression/brotli/internal/BrotliDecoderSource.java

@@ -11,29 +11,27 @@
 // ========================================================================
 //
 
-package org.eclipse.jetty.compression.brotli;
+package org.eclipse.jetty.compression.brotli.internal;
 
 import java.io.IOException;
 import java.nio.ByteBuffer;
 
 import com.aayushatharva.brotli4j.decoder.DecoderJNI;
 import org.eclipse.jetty.compression.DecoderSource;
+import org.eclipse.jetty.compression.brotli.BrotliDecoderConfig;
 import org.eclipse.jetty.io.Content;
 import org.eclipse.jetty.util.BufferUtil;
 
 public class BrotliDecoderSource extends DecoderSource
 {
-    private static final ByteBuffer EMPTY_BUFFER = BufferUtil.EMPTY_BUFFER;
-    private final BrotliCompression compression;
     private final DecoderJNI.Wrapper decoder;
 
-    public BrotliDecoderSource(BrotliCompression compression, Content.Source source, BrotliDecoderConfig config)
+    public BrotliDecoderSource(Content.Source source, BrotliDecoderConfig config)
     {
         super(source);
-        this.compression = compression;
         try
         {
-            this.decoder = new DecoderJNI.Wrapper(compression.getBufferSize());
+            this.decoder = new DecoderJNI.Wrapper(config.getBufferSize());
         }
         catch (IOException e)
         {
@@ -58,10 +56,7 @@ protected Content.Chunk nextChunk(Content.Chunk readChunk) throws IOException
                 {
                     return last ? Content.Chunk.EOF : Content.Chunk.EMPTY;
                 }
-                case OK ->
-                {
-                    decoder.push(0);
-                }
+                case OK -> decoder.push(0);
                 case NEEDS_MORE_INPUT ->
                 {
                     ByteBuffer input = decoder.getInputBuffer();
@@ -81,10 +76,7 @@ protected Content.Chunk nextChunk(Content.Chunk readChunk) throws IOException
                     // rely on status.OK to go to EOF
                     return Content.Chunk.from(output, false);
                 }
-                default ->
-                {
-                    throw new IOException("Decoder failure: Corrupted input buffer");
-                }
+                default -> throw new IOException("Decoder failure: Corrupted input buffer");
             }
         }
     }

jetty-core/jetty-compression/jetty-compression-brotli/src/main/java/org/eclipse/jetty/compression/brotli/BrotliEncoderSink.java → jetty-core/jetty-compression/jetty-compression-brotli/src/main/java/org/eclipse/jetty/compression/brotli/internal/BrotliEncoderSink.java

@@ -11,19 +11,19 @@
 // ========================================================================
 //
 
-package org.eclipse.jetty.compression.brotli;
+package org.eclipse.jetty.compression.brotli.internal;
 
 import java.io.IOException;
 import java.nio.ByteBuffer;
 import java.util.concurrent.atomic.AtomicReference;
 
+import com.aayushatharva.brotli4j.encoder.Encoder;
 import com.aayushatharva.brotli4j.encoder.EncoderJNI;
 import org.eclipse.jetty.compression.EncoderSink;
+import org.eclipse.jetty.compression.brotli.BrotliEncoderConfig;
 import org.eclipse.jetty.io.Content;
 import org.eclipse.jetty.util.BufferUtil;
 import org.eclipse.jetty.util.Callback;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 public class BrotliEncoderSink extends EncoderSink
 {
@@ -44,23 +44,21 @@ enum State
         /**
          * Finish operation completed.
          */
-        FINISHED;
+        FINISHED
     }
 
-    private static final Logger LOG = LoggerFactory.getLogger(BrotliEncoderSink.class);
     private static final ByteBuffer EMPTY_BUFFER = ByteBuffer.allocate(0);
-    private final BrotliCompression compression;
     private final EncoderJNI.Wrapper encoder;
     private final ByteBuffer inputBuffer;
-    private final AtomicReference<State> state = new AtomicReference<State>(State.PROCESSING);
+    private final AtomicReference<State> state = new AtomicReference<>(State.PROCESSING);
 
-    public BrotliEncoderSink(BrotliCompression compression, Content.Sink sink, BrotliEncoderConfig config)
+    public BrotliEncoderSink(Content.Sink sink, BrotliEncoderConfig config)
     {
         super(sink);
-        this.compression = compression;
         try
         {
-            this.encoder = new EncoderJNI.Wrapper(config.getBufferSize(), config.getCompressionLevel(), config.getLgWindow(), config.getMode());
+            Encoder.Mode mode = Encoder.Mode.of(config.getStrategy());
+            this.encoder = new EncoderJNI.Wrapper(config.getBufferSize(), config.getCompressionLevel(), config.getLgWindow(), mode);
             this.inputBuffer = encoder.getInputBuffer();
         }
         catch (IOException e)
@@ -94,7 +92,7 @@ protected WriteRecord encode(boolean last, ByteBuffer content)
                             }
 
                             // the only place the input buffer gets set.
-                            int len = BufferUtil.put(content, inputBuffer);
+                            BufferUtil.put(content, inputBuffer);
                             // do not flip input buffer, that's not what Brotli4j expects/wants.
                         }
                         // content is fully consumed.
@@ -174,9 +172,4 @@ protected void release()
     {
         this.encoder.destroy();
     }
-
-    private State getState()
-    {
-        return state.get();
-    }
 }

jetty-core/jetty-compression/jetty-compression-gzip/src/main/java/module-info.java

@@ -0,0 +1,20 @@
+//
+// ========================================================================
+// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
+// which is available at https://www.apache.org/licenses/LICENSE-2.0.
+//
+// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
+// ========================================================================
+//
+
+module org.eclipse.jetty.compression.gzip
+{
+    requires transitive org.eclipse.jetty.compression;
+    requires org.slf4j;
+
+    exports org.eclipse.jetty.compression.gzip;
+}