WebSocket API: Add unit test support + clean up

jknack · jknack · commit 51d6055c2ee9 · 2019-10-01T12:22:36.000-03:00
diff --git a/TODO b/TODO
@@ -1,8 +1,6 @@
-* Session set null context to Value API
+* Make Session.toMap() read-only
 * review toString on Value API (removal of QueryStringValue?)
 * tests and coverage
 * server options from application.conf MUST override hardcoded settings
 * make reset headers on error configurable
 * netty reports a leak in MVC body
-
-* websockets
diff --git a/examples/src/main/java/examples/WebSocketApp.java b/examples/src/main/java/examples/WebSocketApp.java
@@ -1,3 +1,8 @@
+/**
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
 package examples;
 
 import io.jooby.ExecutionMode;
diff --git a/jooby/src/main/java/io/jooby/Context.java b/jooby/src/main/java/io/jooby/Context.java
@@ -666,6 +666,12 @@ public interface Context extends Registry {
    */
   @Nonnull Context detach(@Nonnull Route.Handler next) throws Exception;
 
+  /**
+   * Perform a websocket handsake and upgrade a HTTP GET into a websocket protocol.
+   *
+   * @param handler Web socket initializer.
+   * @return This context.
+   */
   @Nonnull Context upgrade(@Nonnull WebSocket.Initializer handler);
 
   /*
diff --git a/jooby/src/main/java/io/jooby/Multipart.java b/jooby/src/main/java/io/jooby/Multipart.java
@@ -20,7 +20,13 @@
  */
 public interface Multipart extends Formdata {
 
-  void put(String name, FileUpload file);
+  /**
+   * Put/Add a file into this multipart request.
+   *
+   * @param name HTTP name.
+   * @param file File upload.
+   */
+  void put(@Nonnull String name, @Nonnull FileUpload file);
 
   /**
    * All file uploads. Only for <code>multipart/form-data</code> request.
diff --git a/jooby/src/main/java/io/jooby/Session.java b/jooby/src/main/java/io/jooby/Session.java
@@ -130,6 +130,11 @@ public interface Session {
    */
   @Nonnull ValueNode remove(@Nonnull String name);
 
+  /**
+   * Read-only copy of session attributes.
+   *
+   * @return Read-only attributes.
+   */
   @Nonnull Map<String, String> toMap();
 
   /**
diff --git a/jooby/src/main/java/io/jooby/Value.java b/jooby/src/main/java/io/jooby/Value.java
@@ -1,3 +1,8 @@
+/**
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
 package io.jooby;
 
 import io.jooby.internal.ArrayValue;
diff --git a/jooby/src/main/java/io/jooby/WebSocket.java b/jooby/src/main/java/io/jooby/WebSocket.java
@@ -1,3 +1,8 @@
+/**
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
 package io.jooby;
 
 import javax.annotation.Nonnull;
diff --git a/jooby/src/main/java/io/jooby/WebSocketCloseStatus.java b/jooby/src/main/java/io/jooby/WebSocketCloseStatus.java
@@ -1,3 +1,8 @@
+/**
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
 package io.jooby;
 
 import javax.annotation.Nullable;
diff --git a/jooby/src/main/java/io/jooby/WebSocketConfigurer.java b/jooby/src/main/java/io/jooby/WebSocketConfigurer.java
@@ -1,3 +1,8 @@
+/**
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
 package io.jooby;
 
 import javax.annotation.Nonnull;
diff --git a/jooby/src/main/java/io/jooby/WebSocketMessage.java b/jooby/src/main/java/io/jooby/WebSocketMessage.java
@@ -1,3 +1,8 @@
+/**
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
 package io.jooby;
 
 import io.jooby.internal.WebSocketMessageImpl;
diff --git a/jooby/src/main/java/io/jooby/internal/CookieSessionStore.java b/jooby/src/main/java/io/jooby/internal/CookieSessionStore.java
@@ -1,3 +1,8 @@
+/**
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
 package io.jooby.internal;
 
 import io.jooby.Context;
diff --git a/jooby/src/main/java/io/jooby/internal/MultipartNode.java b/jooby/src/main/java/io/jooby/internal/MultipartNode.java
@@ -1,3 +1,8 @@
+/**
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
 package io.jooby.internal;
 
 import io.jooby.Context;
diff --git a/jooby/src/main/java/io/jooby/internal/RouterImpl.java b/jooby/src/main/java/io/jooby/internal/RouterImpl.java
@@ -335,7 +335,7 @@ public Router encoder(@Nonnull MediaType contentType, @Nonnull MessageEncoder en
   }
 
   @Nonnull @Override public Route ws(@Nonnull String pattern, @Nonnull WebSocket.Initializer handler) {
-    return route(WS, pattern, new WebSocketHandler(handler));
+    return route(WS, pattern, new WebSocketHandler(handler)).setHandle(handler);
   }
 
   @Override
diff --git a/jooby/src/main/java/io/jooby/internal/WebSocketEncoder.java b/jooby/src/main/java/io/jooby/internal/WebSocketEncoder.java
@@ -1,3 +1,8 @@
+/**
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
 package io.jooby.internal;
 
 import io.jooby.Context;
diff --git a/jooby/src/main/java/io/jooby/internal/WebSocketMessageImpl.java b/jooby/src/main/java/io/jooby/internal/WebSocketMessageImpl.java
@@ -1,3 +1,8 @@
+/**
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
 package io.jooby.internal;
 
 import io.jooby.Body;
diff --git a/jooby/src/main/java/io/jooby/internal/WebSocketSender.java b/jooby/src/main/java/io/jooby/internal/WebSocketSender.java
@@ -1,3 +1,8 @@
+/**
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
 package io.jooby.internal;
 
 import io.jooby.Context;
diff --git a/jooby/src/main/java/io/jooby/internal/handler/WebSocketHandler.java b/jooby/src/main/java/io/jooby/internal/handler/WebSocketHandler.java
@@ -1,3 +1,8 @@
+/**
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
 package io.jooby.internal.handler;
 
 import io.jooby.Context;
diff --git a/modules/jooby-jackson/src/main/java/io/jooby/json/JacksonModule.java b/modules/jooby-jackson/src/main/java/io/jooby/json/JacksonModule.java
@@ -5,7 +5,6 @@
  */
 package io.jooby.json;
 
-import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.core.JsonParseException;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.Module;
@@ -26,10 +25,8 @@
 import io.jooby.StatusCode;
 
 import javax.annotation.Nonnull;
-import java.io.DataOutput;
 import java.io.InputStream;
 import java.lang.reflect.Type;
-import java.nio.charset.StandardCharsets;
 import java.util.HashSet;
 import java.util.Set;
 
diff --git a/modules/jooby-jetty/src/main/java/io/jooby/internal/jetty/JettyWebSocket.java b/modules/jooby-jetty/src/main/java/io/jooby/internal/jetty/JettyWebSocket.java
@@ -1,3 +1,8 @@
+/**
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
 package io.jooby.internal.jetty;
 
 import io.jooby.Context;
@@ -82,7 +87,7 @@ public JettyWebSocket(JettyContext ctx) {
     }
 
     if (onErrorCallback == null) {
-      ctx.getRouter().getLog().error("WS {} resulted in exception", ctx.pathString(), x);
+      ctx.getRouter().getLog().error("Websocket resulted in exception: {}", ctx.pathString(), x);
     } else {
       onErrorCallback.onError(this, x);
     }
@@ -176,7 +181,7 @@ public JettyWebSocket(JettyContext ctx) {
   }
 
   @Override public void writeFailed(Throwable x) {
-    ctx.getRouter().getLog().error("WebSocket.send resulted in exception", x);
+    ctx.getRouter().getLog().error("Websocket resulted in exception: {}", ctx.pathString(), x);
   }
 
   @Override public void writeSuccess() {
diff --git a/modules/jooby-netty/src/main/java/io/jooby/internal/netty/NettyWebSocket.java b/modules/jooby-netty/src/main/java/io/jooby/internal/netty/NettyWebSocket.java
@@ -1,3 +1,8 @@
+/**
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
 package io.jooby.internal.netty;
 
 import io.jooby.Context;
@@ -192,7 +197,7 @@ private void handleError(Throwable x) {
     }
 
     if (onErrorCallback == null) {
-      netty.getRouter().getLog().error("WS {} resulted in exception", netty.pathString(), x);
+      netty.getRouter().getLog().error("Websocket resulted in exception: {}", netty.pathString(), x);
     } else {
       onErrorCallback.onError(this, x);
     }
diff --git a/modules/jooby-netty/src/main/java/io/jooby/netty/Netty.java b/modules/jooby-netty/src/main/java/io/jooby/netty/Netty.java
@@ -18,7 +18,6 @@
 import io.netty.handler.codec.http.multipart.DiskAttribute;
 import io.netty.handler.codec.http.multipart.DiskFileUpload;
 import io.netty.handler.codec.http.multipart.HttpDataFactory;
-import io.netty.util.concurrent.DefaultEventExecutorGroup;
 import io.netty.util.concurrent.DefaultThreadFactory;
 
 import javax.annotation.Nonnull;
diff --git a/modules/jooby-test/src/main/java/io/jooby/MockContext.java b/modules/jooby-test/src/main/java/io/jooby/MockContext.java
@@ -240,7 +240,8 @@ public MockContext setPathString(@Nonnull String pathString) {
   /**
    * Set mock files.
    *
-   * @param files Mock files.
+   * @param name HTTP name.
+   * @param file Mock files.
    * @return This context.
    */
   public MockContext setFile(@Nonnull String name, @Nonnull FileUpload file) {
@@ -596,6 +597,10 @@ public MockContext sendError(@Nonnull Throwable cause, @Nonnull StatusCode statu
     return DefaultContext.super.convert(value, type);
   }
 
+  @Nonnull @Override public MockContext upgrade(@Nonnull WebSocket.Initializer handler) {
+    return this;
+  }
+
   @Override public String toString() {
     return method + " " + pathString;
   }
diff --git a/modules/jooby-test/src/main/java/io/jooby/MockRouter.java b/modules/jooby-test/src/main/java/io/jooby/MockRouter.java
@@ -71,6 +71,50 @@ public MockRouter(@Nonnull Jooby application) {
     return get(path, new MockContext());
   }
 
+  /**
+   * Execute a GET request and find a websocket, perform the upgrade and produces a websocket client.
+   *
+   * App:
+   * <pre>{@code
+   *   ws("/path", (ctx, initializer) -> {
+   *     initializer.onConnect(ws -> {
+   *       ws.send("OnConnect");
+   *     });
+   *   });
+   * }</pre>
+   *
+   * Test:
+   * <pre>{@code
+   *   MockRouter router = new MockRouter(new App());
+   *   router.ws("/path", ws -> {
+   *
+   *     ws.onMessage(message -> {
+   *       System.out.println("Got: " + message);
+   *     });
+   *
+   *     ws.send("Another message");
+   *   })
+   * }</pre>
+   *
+   *
+   * @param path Path to match.
+   * @param callback Websocket client callback.
+   * @return Web socket client.
+   */
+  public MockWebSocketClient ws(@Nonnull String path, Consumer<MockWebSocketClient> callback) {
+    MockValue value = get(path, new MockContext());
+    if (value.value() instanceof MockWebSocketConfigurer) {
+      MockWebSocketConfigurer configurer = value.value(MockWebSocketConfigurer.class);
+      MockWebSocketClient client = configurer.getClient();
+      configurer.ready();
+      callback.accept(client);
+      client.init();
+      return client;
+    } else {
+      throw new IllegalArgumentException("No websocket fount at: " + path);
+    }
+  }
+
   /**
    * Execute a GET request to the target application.
    *
@@ -352,18 +396,24 @@ private MockValue call(Jooby router, String method, String path, Context ctx,
     Object value;
     try {
       Route.Handler handler = fullExecution ? route.getPipeline() : route.getHandler();
-      value = handler.apply(ctx);
-      if (ctx instanceof MockContext) {
-        MockResponse response = ((MockContext) ctx).getResponse();
-        if (!(value instanceof Context)) {
-          response.setResult(value);
-        }
-        if (response.getContentLength() <= 0) {
-          response.setContentLength(contentLength(value));
+      if (route.getMethod().equals(Router.WS)) {
+        WebSocket.Initializer initializer = (WebSocket.Initializer) route.getHandle();
+        MockWebSocketConfigurer configurer = new MockWebSocketConfigurer(ctx, initializer);
+        return new SingleMockValue(configurer);
+      } else {
+        value = handler.apply(ctx);
+        if (ctx instanceof MockContext) {
+          MockResponse response = ((MockContext) ctx).getResponse();
+          if (!(value instanceof Context)) {
+            response.setResult(value);
+          }
+          if (response.getContentLength() <= 0) {
+            response.setContentLength(contentLength(value));
+          }
+          consumer.accept(response);
         }
-        consumer.accept(response);
+        return new SingleMockValue(value);
       }
-      return new SingleMockValue(value);
     } catch (Exception x) {
       throw SneakyThrows.propagate(x);
     }
diff --git a/modules/jooby-test/src/main/java/io/jooby/MockWebSocket.java b/modules/jooby-test/src/main/java/io/jooby/MockWebSocket.java
diff --git a/modules/jooby-test/src/main/java/io/jooby/MockWebSocketClient.java b/modules/jooby-test/src/main/java/io/jooby/MockWebSocketClient.java
diff --git a/modules/jooby-test/src/main/java/io/jooby/MockWebSocketConfigurer.java b/modules/jooby-test/src/main/java/io/jooby/MockWebSocketConfigurer.java
diff --git a/modules/jooby-test/src/test/java/io/jooby/UnitTest.java b/modules/jooby-test/src/test/java/io/jooby/UnitTest.java
diff --git a/modules/jooby-utow/src/main/java/io/jooby/internal/utow/UtowWebSocket.java b/modules/jooby-utow/src/main/java/io/jooby/internal/utow/UtowWebSocket.java
