Merge branch 'release/1.5.0'

Author: mostroverkhov

.github/workflows/ci-build.yml

@@ -15,7 +15,7 @@ jobs:
 
     strategy:
       matrix:
-        os: [ ubuntu-20.04, macos-13, windows-2019 ]
+        os: [ ubuntu-24.04, macos-13, windows-2022 ]
         jdk: [ 8, 11, 17, 21 ]
       fail-fast: false
 

README.md

@@ -14,7 +14,7 @@ callbacks codec (described below).
 * Websocket multiprotocol: for application servers, It provides transparent use of existing http1 websocket handlers to process both http1 and http2 websockets. 
 Compatible with callbacks codec (described below).
 
-[https://jauntsdn.com/post/netty-websocket-http2/](https://jauntsdn.com/post/netty-websocket-http2/)
+[https://jauntsdn.com/post/netty-websocket-http2/](https://jauntsdn.github.io/post/netty-websocket-http2/)
 
 ### much faster http1 codec
 Integration with [jauntsdn/netty-websocket-http1](https://github.com/jauntsdn/netty-websocket-http1) codec (callbacks codec) for websocket-http1 
@@ -95,7 +95,7 @@ EchoWebSocketHandler http1WebSocketHandler = new EchoWebSocketHandler();
 Http2WebSocketClientHandshaker handShaker = Http2WebSocketClientHandshaker.create(channel);
 
 Http2Headers headers =
-   new DefaultHttp2Headers().set("user-agent", "jauntsdn-websocket-http2-client/1.3.0");
+   new DefaultHttp2Headers().set("user-agent", "jauntsdn-websocket-http2-client/1.4.0");
 ChannelFuture handshakeFuture =
    /*http1 websocket handler*/
    handShaker.handshake("/echo", headers, new EchoWebSocketHandler());
@@ -320,7 +320,7 @@ repositories {
 }
 
 dependencies {
-    implementation 'com.jauntsdn.netty:netty-websocket-http2:1.3.0'
+    implementation 'com.jauntsdn.netty:netty-websocket-http2:1.4.0'
 }
 ```
 

gradle.properties

@@ -1,22 +1,22 @@
 group=com.jauntsdn.netty
-version=1.4.0
+version=1.5.0
 
 googleJavaFormatPluginVersion=0.9
 dependencyManagementPluginVersion=1.1.0
 gitPluginVersion=0.13.0
 osDetectorPluginVersion=1.7.3
 versionsPluginVersion=0.45.0
 
-nettyVersion=4.1.116.Final
-jauntNettyWebsocketHttp1=1.3.0
-nettyTcnativeVersion=2.0.69.Final
+nettyVersion=4.1.122.Final
+jauntNettyWebsocketHttp1=1.4.0
+nettyTcnativeVersion=2.0.72.Final
 hdrHistogramVersion=2.1.12
 slf4jVersion=1.7.36
 logbackVersion=1.2.13
 jsr305Version=3.0.2
 
 junitVersion=5.11.4
-assertjVersion=3.27.0
+assertjVersion=3.27.3
 
 org.gradle.parallel=true
 org.gradle.configureondemand=true

netty-websocket-http2-callbacks-codec/gradle.lockfile

@@ -7,15 +7,15 @@ com.google.errorprone:javac-shaded:9+181-r4173-1=googleJavaFormat1.6
 com.google.googlejavaformat:google-java-format:1.6=googleJavaFormat1.6
 com.google.guava:guava:22.0=googleJavaFormat1.6
 com.google.j2objc:j2objc-annotations:1.1=googleJavaFormat1.6
-com.jauntsdn.netty:netty-websocket-http1:1.3.0=compileClasspath
-io.netty:netty-buffer:4.1.116.Final=compileClasspath
-io.netty:netty-codec-http2:4.1.116.Final=compileClasspath
-io.netty:netty-codec-http:4.1.116.Final=compileClasspath
-io.netty:netty-codec:4.1.116.Final=compileClasspath
-io.netty:netty-common:4.1.116.Final=compileClasspath
-io.netty:netty-handler:4.1.116.Final=compileClasspath
-io.netty:netty-resolver:4.1.116.Final=compileClasspath
-io.netty:netty-transport-native-unix-common:4.1.116.Final=compileClasspath
-io.netty:netty-transport:4.1.116.Final=compileClasspath
+com.jauntsdn.netty:netty-websocket-http1:1.4.0=compileClasspath
+io.netty:netty-buffer:4.1.122.Final=compileClasspath
+io.netty:netty-codec-http2:4.1.122.Final=compileClasspath
+io.netty:netty-codec-http:4.1.122.Final=compileClasspath
+io.netty:netty-codec:4.1.122.Final=compileClasspath
+io.netty:netty-common:4.1.122.Final=compileClasspath
+io.netty:netty-handler:4.1.122.Final=compileClasspath
+io.netty:netty-resolver:4.1.122.Final=compileClasspath
+io.netty:netty-transport-native-unix-common:4.1.122.Final=compileClasspath
+io.netty:netty-transport:4.1.122.Final=compileClasspath
 org.codehaus.mojo:animal-sniffer-annotations:1.14=googleJavaFormat1.6
 empty=annotationProcessor

netty-websocket-http2-callbacks-codec/src/main/java/com/jauntsdn/netty/handler/codec/http2/websocketx/WebSocketCallbacksCodec.java

@@ -4,6 +4,7 @@
 import io.netty.handler.codec.http.websocketx.WebSocketDecoderConfig;
 import io.netty.handler.codec.http.websocketx.WebSocketFrameDecoder;
 import io.netty.handler.codec.http.websocketx.WebSocketFrameEncoder;
+import java.util.function.IntSupplier;
 
 /** Provides integration with jauntsdn/netty-websocket-http1 - high performance websocket codec. */
 public final class WebSocketCallbacksCodec implements Http1WebSocketCodec {
@@ -20,6 +21,11 @@ public WebSocketFrameEncoder encoder(boolean maskPayload) {
     return WebSocketProtocol.frameEncoder(maskPayload);
   }
 
+  @Override
+  public WebSocketFrameEncoder encoder(boolean maskPayload, IntSupplier externalMask) {
+    return WebSocketProtocol.frameEncoder(maskPayload, externalMask);
+  }
+
   @Override
   public WebSocketFrameDecoder decoder(WebSocketDecoderConfig config) {
     return WebSocketProtocol.frameDecoder(

netty-websocket-http2/gradle.lockfile

@@ -9,21 +9,21 @@ com.google.errorprone:javac-shaded:9+181-r4173-1=googleJavaFormat1.6
 com.google.googlejavaformat:google-java-format:1.6=googleJavaFormat1.6
 com.google.guava:guava:22.0=googleJavaFormat1.6
 com.google.j2objc:j2objc-annotations:1.1=googleJavaFormat1.6
-com.jauntsdn.netty:netty-websocket-http1:1.3.0=testCompileClasspath,testRuntimeClasspath
-io.netty:netty-buffer:4.1.116.Final=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
-io.netty:netty-codec-http2:4.1.116.Final=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
-io.netty:netty-codec-http:4.1.116.Final=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
-io.netty:netty-codec:4.1.116.Final=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
-io.netty:netty-common:4.1.116.Final=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
-io.netty:netty-handler:4.1.116.Final=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
-io.netty:netty-resolver:4.1.116.Final=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
-io.netty:netty-tcnative-boringssl-static:2.0.69.Final=testRuntimeClasspath
-io.netty:netty-tcnative-classes:2.0.69.Final=testRuntimeClasspath
-io.netty:netty-transport-native-unix-common:4.1.116.Final=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
-io.netty:netty-transport:4.1.116.Final=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
+com.jauntsdn.netty:netty-websocket-http1:1.4.0=testCompileClasspath,testRuntimeClasspath
+io.netty:netty-buffer:4.1.122.Final=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
+io.netty:netty-codec-http2:4.1.122.Final=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
+io.netty:netty-codec-http:4.1.122.Final=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
+io.netty:netty-codec:4.1.122.Final=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
+io.netty:netty-common:4.1.122.Final=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
+io.netty:netty-handler:4.1.122.Final=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
+io.netty:netty-resolver:4.1.122.Final=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
+io.netty:netty-tcnative-boringssl-static:2.0.72.Final=testRuntimeClasspath
+io.netty:netty-tcnative-classes:2.0.72.Final=testRuntimeClasspath
+io.netty:netty-transport-native-unix-common:4.1.122.Final=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
+io.netty:netty-transport:4.1.122.Final=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
 net.bytebuddy:byte-buddy:1.15.11=testCompileClasspath,testRuntimeClasspath
 org.apiguardian:apiguardian-api:1.1.2=testCompileClasspath
-org.assertj:assertj-core:3.27.0=testCompileClasspath,testRuntimeClasspath
+org.assertj:assertj-core:3.27.3=testCompileClasspath,testRuntimeClasspath
 org.codehaus.mojo:animal-sniffer-annotations:1.14=googleJavaFormat1.6
 org.junit.jupiter:junit-jupiter-api:5.11.4=testCompileClasspath,testRuntimeClasspath
 org.junit.jupiter:junit-jupiter-engine:5.11.4=testRuntimeClasspath

netty-websocket-http2/src/main/java/com/jauntsdn/netty/handler/codec/http2/websocketx/Http1WebSocketCodec.java

@@ -21,11 +21,16 @@
 import io.netty.handler.codec.http.websocketx.WebSocketDecoderConfig;
 import io.netty.handler.codec.http.websocketx.WebSocketFrameDecoder;
 import io.netty.handler.codec.http.websocketx.WebSocketFrameEncoder;
+import java.util.function.IntSupplier;
 
 public interface Http1WebSocketCodec {
 
   WebSocketFrameEncoder encoder(boolean maskPayload);
 
+  default WebSocketFrameEncoder encoder(boolean maskPayload, IntSupplier externalMask) {
+    return null;
+  }
+
   WebSocketFrameDecoder decoder(WebSocketDecoderConfig config);
 
   default WebSocketFrameDecoder decoder(boolean maskPayload, WebSocketDecoderConfig config) {

netty-websocket-http2/src/main/java/com/jauntsdn/netty/handler/codec/http2/websocketx/Http2WebSocketChannel.java

@@ -68,6 +68,7 @@
 import java.util.concurrent.RejectedExecutionException;
 import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
 import java.util.concurrent.atomic.AtomicLongFieldUpdater;
+import java.util.function.IntSupplier;
 import javax.annotation.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -94,6 +95,7 @@ final class Http2WebSocketChannel extends DefaultAttributeMap
   private final ChannelPipeline pipeline;
   private final WebSocketsParent webSocketChannelParent;
   private final int websocketChannelSerial;
+  private final String authority;
   private final String path;
   private final String subprotocol;
   private final ChannelPromise closePromise;
@@ -142,6 +144,7 @@ final class Http2WebSocketChannel extends DefaultAttributeMap
   Http2WebSocketChannel(
       WebSocketsParent webSocketChannelParent,
       int websocketChannelSerial,
+      String authority,
       String path,
       String subprotocol,
       WebSocketDecoderConfig config,
@@ -153,6 +156,7 @@ final class Http2WebSocketChannel extends DefaultAttributeMap
     this.isHandshakeCompleted = true;
     this.webSocketChannelParent = webSocketChannelParent;
     this.websocketChannelSerial = websocketChannelSerial;
+    this.authority = authority;
     this.path = path;
     this.subprotocol = subprotocol;
     this.decoderConfig = config;
@@ -185,12 +189,15 @@ final class Http2WebSocketChannel extends DefaultAttributeMap
   Http2WebSocketChannel(
       WebSocketsParent webSocketChannelParent,
       int websocketChannelSerial,
+      String authority,
       String path,
       String subprotocol,
       Http1WebSocketCodec webSocketCodec,
+      IntSupplier externalMask,
       ChannelHandler websocketHandler) {
     this.webSocketChannelParent = webSocketChannelParent;
     this.websocketChannelSerial = websocketChannelSerial;
+    this.authority = authority;
     this.path = path;
     this.subprotocol = subprotocol;
     channelId = new Http2WebSocketChannelId(parent().id(), websocketChannelSerial);
@@ -200,7 +207,8 @@ final class Http2WebSocketChannel extends DefaultAttributeMap
 
     closePromise = pl.newPromise();
     handshakePromise = pl.newPromise();
-    handshakePromiseListener = new CompleteClientHandshake(preHandshakeHandler, webSocketCodec);
+    handshakePromiseListener =
+        new CompleteClientHandshake(preHandshakeHandler, webSocketCodec, externalMask);
   }
 
   /*called on user thread, done outside constructor to not publish
@@ -217,11 +225,15 @@ Http2WebSocketChannel initialize() {
   class CompleteClientHandshake implements GenericFutureListener<ChannelFuture> {
     private final PreHandshakeHandler preHandshakeHandler;
     private final Http1WebSocketCodec webSocketCodec;
+    private final IntSupplier externalMask;
 
     public CompleteClientHandshake(
-        PreHandshakeHandler preHandshakeHandler, Http1WebSocketCodec webSocketCodec) {
+        PreHandshakeHandler preHandshakeHandler,
+        Http1WebSocketCodec webSocketCodec,
+        IntSupplier externalMask) {
       this.preHandshakeHandler = preHandshakeHandler;
       this.webSocketCodec = webSocketCodec;
+      this.externalMask = externalMask;
     }
 
     @Override
@@ -246,7 +258,10 @@ public void operationComplete(ChannelFuture future) {
       if (decoder == null) {
         decoder = codec.decoder(config);
       }
-      WebSocketFrameEncoder encoder = codec.encoder(maskPayload);
+      WebSocketFrameEncoder encoder = codec.encoder(maskPayload, externalMask);
+      if (encoder == null) {
+        encoder = codec.encoder(maskPayload);
+      }
       if (comprEncoder != null && comprDecoder != null) {
         pl.addFirst(decoder, comprDecoder, encoder, comprEncoder);
       } else {
@@ -260,6 +275,10 @@ int serial() {
     return websocketChannelSerial;
   }
 
+  String authority() {
+    return authority;
+  }
+
   String path() {
     return path;
   }
@@ -324,7 +343,8 @@ public int onDataRead(
   public void onRstStreamRead(ChannelHandlerContext ctx, int streamId, long errorCode) {
     pipeline()
         .fireUserEventTriggered(
-            Http2WebSocketRemoteCloseEvent.reset(serial(), path, subprotocol, System.nanoTime()));
+            Http2WebSocketRemoteCloseEvent.reset(
+                serial(), authority, path, subprotocol, System.nanoTime()));
     streamClosed();
   }
 
@@ -334,7 +354,7 @@ public void onGoAwayRead(
     pipeline()
         .fireUserEventTriggered(
             new Http2WebSocketEvent.Http2WebSocketRemoteGoAwayEvent(
-                serial(), path, subprotocol, System.nanoTime(), errorCode));
+                serial(), authority, path, subprotocol, System.nanoTime(), errorCode));
     streamClosed();
   }
 
@@ -747,7 +767,7 @@ void fireChildRead(ByteBuf data, boolean endOfStream) {
       pipeline()
           .fireUserEventTriggered(
               Http2WebSocketRemoteCloseEvent.endStream(
-                  serial(), path, subprotocol, System.nanoTime()));
+                  serial(), authority, path, subprotocol, System.nanoTime()));
     }
   }
 

netty-websocket-http2/src/main/java/com/jauntsdn/netty/handler/codec/http2/websocketx/Http2WebSocketClientBuilder.java

@@ -19,6 +19,8 @@
 import io.netty.handler.codec.http.websocketx.WebSocketDecoderConfig;
 import io.netty.handler.codec.http.websocketx.extensions.compression.PerMessageDeflateClientExtensionHandshaker;
 import java.util.Objects;
+import java.util.function.IntSupplier;
+import javax.annotation.Nullable;
 
 /** Builder for {@link Http2WebSocketClientHandler} */
 public final class Http2WebSocketClientBuilder {
@@ -33,6 +35,7 @@ public final class Http2WebSocketClientBuilder {
   private boolean isSingleWebSocketPerConnection;
   private boolean isMaskPayload = true;
   private boolean isNomaskingExtension;
+  private IntSupplier externalMask;
 
   Http2WebSocketClientBuilder() {}
 
@@ -70,6 +73,16 @@ public Http2WebSocketClientBuilder maskPayload(boolean maskPayload) {
     return this;
   }
 
+  /**
+   * @param externalMask generator for payload masking key, used if underlying http1 codec supports
+   *     It. May be null.
+   * @return this {@link Http2WebSocketClientBuilder} instance
+   */
+  public Http2WebSocketClientBuilder mask(@Nullable IntSupplier externalMask) {
+    this.externalMask = externalMask;
+    return this;
+  }
+
   /**
    * @param handshakeTimeoutMillis websocket handshake timeout. Must be positive
    * @return this {@link Http2WebSocketClientBuilder} instance
@@ -205,6 +218,7 @@ public Http2WebSocketClientHandler build() {
         config,
         maskPayload,
         isNomaskingExtension,
+        externalMask,
         weight,
         handshakeTimeoutMillis,
         closedWebSocketRemoveTimeoutMillis,

netty-websocket-http2/src/main/java/com/jauntsdn/netty/handler/codec/http2/websocketx/Http2WebSocketClientHandler.java

@@ -27,6 +27,7 @@
 import io.netty.handler.codec.http2.Http2Settings;
 import io.netty.handler.ssl.SslHandler;
 import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
+import java.util.function.IntSupplier;
 import javax.annotation.Nullable;
 
 /**
@@ -45,6 +46,7 @@ public final class Http2WebSocketClientHandler extends Http2WebSocketChannelHand
 
   private final long handshakeTimeoutMillis;
   private final PerMessageDeflateClientExtensionHandshaker compressionHandshaker;
+  private final IntSupplier externalMask;
   private final short streamWeight;
 
   private CharSequence scheme;
@@ -58,6 +60,7 @@ public final class Http2WebSocketClientHandler extends Http2WebSocketChannelHand
       WebSocketDecoderConfig webSocketDecoderConfig,
       boolean isEncoderMaskPayload,
       boolean isNomaskingExtension,
+      IntSupplier externalMask,
       short streamWeight,
       long handshakeTimeoutMillis,
       long closedWebSocketRemoveTimeoutMillis,
@@ -70,6 +73,7 @@ public final class Http2WebSocketClientHandler extends Http2WebSocketChannelHand
         isNomaskingExtension,
         closedWebSocketRemoveTimeoutMillis,
         isSingleWebSocketPerConnection);
+    this.externalMask = externalMask;
     this.streamWeight = streamWeight;
     this.handshakeTimeoutMillis = handshakeTimeoutMillis;
     this.compressionHandshaker = compressionHandshaker;
@@ -105,6 +109,7 @@ public void onSettingsRead(ChannelHandlerContext ctx, Http2Settings settings)
         settings.get(Http2WebSocketProtocol.SETTINGS_ENABLE_CONNECT_PROTOCOL);
     boolean supports =
         supportsWebSocket = extendedConnectEnabled != null && extendedConnectEnabled == 1;
+    Http2WebSocketEvent.fireWebSocketSupported(webSocketsParent.context().channel(), supports);
     Http2WebSocketClientHandshaker listener = HANDSHAKER.get(this);
     if (listener != null) {
       supportsWebSocketCalled = true;
@@ -166,6 +171,7 @@ Http2WebSocketClientHandshaker handShaker() {
             config,
             isEncoderMaskPayload,
             nomaskingExtension,
+            externalMask,
             streamWeight,
             scheme,
             handshakeTimeoutMillis,