client websocket lifecycle events: add Http2WebSocketSupportedEvent

Author: mostroverkhov

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

@@ -105,6 +105,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;

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

@@ -33,6 +33,13 @@ public abstract class Http2WebSocketEvent {
     this.type = type;
   }
 
+  static void fireWebSocketSupported(Channel parentChannel, boolean webSocketSupported) {
+    long timestamp = System.nanoTime();
+    ChannelPipeline parentPipeline = parentChannel.pipeline();
+    parentPipeline.fireUserEventTriggered(
+        new Http2WebSocketSupportedEvent(webSocketSupported, timestamp));
+  }
+
   static void fireFrameWriteError(Channel parentChannel, Throwable t) {
     ChannelPipeline parentPipeline = parentChannel.pipeline();
     if (parentChannel.config().isAutoClose()) {
@@ -242,7 +249,8 @@ public enum Type {
     CLOSE_REMOTE_RESET,
     CLOSE_REMOTE_GOAWAY,
     WEIGHT_UPDATE,
-    WRITE_ERROR
+    WRITE_ERROR,
+    WEBSOCKET_SUPPORTED
   }
 
   /**
@@ -514,6 +522,26 @@ public static Short streamWeight(Channel webSocketChannel) {
     }
   }
 
+  /** websocket-over-http2 support event */
+  public static final class Http2WebSocketSupportedEvent extends Http2WebSocketEvent {
+    private final boolean webSocketSupported;
+    private final long timestampNanos;
+
+    Http2WebSocketSupportedEvent(boolean webSocketSupported, long timestampNanos) {
+      super(Type.WEBSOCKET_SUPPORTED);
+      this.webSocketSupported = webSocketSupported;
+      this.timestampNanos = timestampNanos;
+    }
+
+    public boolean isWebSocketSupported() {
+      return webSocketSupported;
+    }
+
+    public long timestampNanos() {
+      return timestampNanos;
+    }
+  }
+
   private static String nonNullString(@Nullable CharSequence seq) {
     if (seq == null) {
       return "";

netty-websocket-http2/src/test/java/com/jauntsdn/netty/handler/codec/http2/websocketx/AbstractTest.java

@@ -16,6 +16,7 @@
 
 package com.jauntsdn.netty.handler.codec.http2.websocketx;
 
+import com.jauntsdn.netty.handler.codec.http2.websocketx.Http2WebSocketEvent.Http2WebSocketSupportedEvent;
 import io.netty.bootstrap.Bootstrap;
 import io.netty.bootstrap.ServerBootstrap;
 import io.netty.channel.ChannelFuture;
@@ -127,37 +128,47 @@ static SslProvider sslProvider() {
   }
 
   static class WebsocketEventsHandler extends ChannelInboundHandlerAdapter {
-    private final int eventsCount;
-    private final List<Http2WebSocketEvent> events = new ArrayList<>();
-    private volatile ChannelPromise eventsReceived;
+    private final int orderedEventsCount;
+    private final List<Http2WebSocketEvent> orderedEvents = new ArrayList<>();
+    private Http2WebSocketEvent webSocketSupportedEvent;
+    private volatile ChannelPromise orderedEventsReceived;
 
-    public WebsocketEventsHandler(int eventsCount) {
-      this.eventsCount = eventsCount;
+    public WebsocketEventsHandler(int orderedEventsCount) {
+      this.orderedEventsCount = orderedEventsCount;
     }
 
     @Override
     public void handlerAdded(ChannelHandlerContext ctx) throws Exception {
-      eventsReceived = ctx.newPromise();
+      orderedEventsReceived = ctx.newPromise();
       super.handlerAdded(ctx);
     }
 
     @Override
     public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {
       if (evt instanceof Http2WebSocketEvent) {
-        events.add((Http2WebSocketEvent) evt);
-        if (events.size() == eventsCount) {
-          eventsReceived.setSuccess();
+        /*may occur in any order relative to other events so accounted separately*/
+        if (evt instanceof Http2WebSocketSupportedEvent) {
+          webSocketSupportedEvent = (Http2WebSocketEvent) evt;
+          return;
+        }
+        orderedEvents.add((Http2WebSocketEvent) evt);
+        if (orderedEvents.size() == orderedEventsCount) {
+          orderedEventsReceived.setSuccess();
         }
       }
       super.userEventTriggered(ctx, evt);
     }
 
     ChannelFuture eventsReceived() {
-      return eventsReceived;
+      return orderedEventsReceived;
     }
 
     public List<Http2WebSocketEvent> events() {
-      return events;
+      return orderedEvents;
+    }
+
+    public Http2WebSocketEvent webSocketSupportedEvent() {
+      return webSocketSupportedEvent;
     }
   }
 

netty-websocket-http2/src/test/java/com/jauntsdn/netty/handler/codec/http2/websocketx/ProtocolHandshakeTest.java

@@ -19,6 +19,7 @@
 import com.jauntsdn.netty.handler.codec.http2.websocketx.Http2WebSocketEvent.Http2WebSocketHandshakeErrorEvent;
 import com.jauntsdn.netty.handler.codec.http2.websocketx.Http2WebSocketEvent.Http2WebSocketHandshakeStartEvent;
 import com.jauntsdn.netty.handler.codec.http2.websocketx.Http2WebSocketEvent.Http2WebSocketHandshakeSuccessEvent;
+import com.jauntsdn.netty.handler.codec.http2.websocketx.Http2WebSocketEvent.Http2WebSocketSupportedEvent;
 import com.jauntsdn.netty.handler.codec.http2.websocketx.WebSocketEvent.WebSocketHandshakeErrorEvent;
 import com.jauntsdn.netty.handler.codec.http2.websocketx.WebSocketEvent.WebSocketHandshakeStartEvent;
 import com.jauntsdn.netty.handler.codec.http2.websocketx.WebSocketEvent.WebSocketHandshakeSuccessEvent;
@@ -103,6 +104,8 @@ void settingsEnableConnectAccepted() throws Exception {
 
     eventsRecorder.eventsReceived().await(5, TimeUnit.SECONDS);
     List<Http2WebSocketEvent> events = eventsRecorder.events();
+    Http2WebSocketEvent webSocketSupportedEvent = eventsRecorder.webSocketSupportedEvent();
+
     Assertions.assertThat(events).hasSize(4);
     Http2WebSocketEvent http2startEvent = events.get(0);
     Http2WebSocketEvent startEvent = events.get(1);
@@ -118,6 +121,13 @@ void settingsEnableConnectAccepted() throws Exception {
     Assertions.assertThat(startEvent.<WebSocketHandshakeStartEvent>cast().path())
         .isEqualTo("/test");
 
+    Assertions.assertThat(webSocketSupportedEvent)
+        .isNotNull()
+        .isExactlyInstanceOf(Http2WebSocketSupportedEvent.class);
+    Assertions.assertThat(
+            webSocketSupportedEvent.<Http2WebSocketSupportedEvent>cast().isWebSocketSupported())
+        .isTrue();
+
     Assertions.assertThat(http2successEvent)
         .isExactlyInstanceOf(Http2WebSocketHandshakeSuccessEvent.class);
 
@@ -167,6 +177,8 @@ void settingsNoEnableConnectRejected() throws Exception {
 
     eventsRecorder.eventsReceived().await(5, TimeUnit.SECONDS);
     List<Http2WebSocketEvent> events = eventsRecorder.events();
+    Http2WebSocketEvent webSocketSupportedEvent = eventsRecorder.webSocketSupportedEvent();
+
     Assertions.assertThat(events).hasSize(4);
     Http2WebSocketEvent http2startEvent = events.get(0);
     Http2WebSocketEvent startEvent = events.get(1);
@@ -182,6 +194,13 @@ void settingsNoEnableConnectRejected() throws Exception {
     Assertions.assertThat(startEvent.<WebSocketHandshakeStartEvent>cast().path())
         .isEqualTo("/test");
 
+    Assertions.assertThat(webSocketSupportedEvent)
+        .isNotNull()
+        .isExactlyInstanceOf(Http2WebSocketSupportedEvent.class);
+    Assertions.assertThat(
+            webSocketSupportedEvent.<Http2WebSocketSupportedEvent>cast().isWebSocketSupported())
+        .isFalse();
+
     Assertions.assertThat(http2errorEvent)
         .isExactlyInstanceOf(Http2WebSocketHandshakeErrorEvent.class);
     Assertions.assertThat(http2errorEvent.<Http2WebSocketHandshakeErrorEvent>cast().error())