Prepare for new release

Author: kklisura

README.md

@@ -91,6 +91,16 @@ public class LogRequestsExample {
 
 For more examples, see [examples](cdt-examples/src/main/java/com/github/kklisura/cdt/examples).
 
+## Known-issues
+
+### API hangs when printing PDFs
+
+**What:** If you're using `cdt-java-client` before version `2.1.0` for printing to PDF and the resulting PDF is more than 4MB, API will hang and will never respond with requesting print.
+
+**Why:** This is due to underlying WebSocket library having 4MB buffer for receiving data from browser.
+
+**How to fix:** With the version `2.1.0` and above, this buffer was increased to 8MB and can be further increased if necessary by setting the appropriate [configuration property](cdt-examples/src/main/java/com/github/kklisura/cdt/examples/IncreasedIncomingBufferInTyrusExample.java).
+
 ## Running unit tests
 
 `make verify`

cdt-examples/src/main/java/com/github/kklisura/cdt/examples/IncreasedIncomingBufferInTyrusExample.java

@@ -6,7 +6,7 @@
 import com.github.kklisura.cdt.protocol.types.page.PrintToPDFTransferMode;
 import com.github.kklisura.cdt.services.ChromeDevToolsService;
 import com.github.kklisura.cdt.services.ChromeService;
-import com.github.kklisura.cdt.services.factory.impl.ConfigurableTyrusClientFactory;
+import com.github.kklisura.cdt.services.factory.impl.DefaultWebSocketContainerFactory;
 import com.github.kklisura.cdt.services.types.ChromeTab;
 import java.io.File;
 import java.io.FileOutputStream;
@@ -21,10 +21,12 @@
  * @author Kenan Klisura
  */
 public class IncreasedIncomingBufferInTyrusExample {
+
   static {
+    // Set the incoming buffer to 24MB
     System.setProperty(
-        "com.github.kklisura.cdt.services.config.webSocketContainerFactory",
-        ConfigurableTyrusClientFactory.class.getName());
+        DefaultWebSocketContainerFactory.WEBSOCKET_INCOMING_BUFFER_PROPERTY,
+        Long.toString((long) DefaultWebSocketContainerFactory.MB * 24));
   }
 
   public static void main(String[] args) {

cdt-java-client/src/main/java/com/github/kklisura/cdt/services/factory/impl/ConfigurableTyrusClientFactory.java

@@ -20,8 +20,7 @@
  * #L%
  */
 
-import static com.github.kklisura.cdt.services.factory.impl.ConfigurableTyrusClientFactory.INCOMING_BUFFER_SIZE_PROPERTY;
-import static com.github.kklisura.cdt.services.factory.impl.ConfigurableTyrusClientFactory.MB;
+import static com.github.kklisura.cdt.services.utils.ConfigurationUtils.systemProperty;
 
 import com.github.kklisura.cdt.services.factory.WebSocketContainerFactory;
 import javax.websocket.WebSocketContainer;
@@ -30,11 +29,36 @@
 
 /**
  * Default WebSocketContainer factory creates a WebSocketContainer from GrizzlyContainerProvider.
+ * This class sets 8MB as internal receiving buffer, which was 4MB by default. By using {@link
+ * #WEBSOCKET_INCOMING_BUFFER_PROPERTY} this can further be increased if required. The following
+ * code sets the the incoming buffer size to 24 MB.
+ *
+ * <pre>
+ *   static {
+ *     System.setProperty(
+ *         DefaultWebSocketContainerFactory.WEBSOCKET_INCOMING_BUFFER_PROPERTY,
+ *         Long.toString((long) DefaultWebSocketContainerFactory.MB * 24)
+ *     );
+ *   }
+ * </pre>
  *
  * @author Kenan Klisura
  */
 public class DefaultWebSocketContainerFactory implements WebSocketContainerFactory {
-  private static final int INCOMING_BUFFER_SIZE = 8 * MB;
+
+  public static final String WEBSOCKET_INCOMING_BUFFER_PROPERTY =
+      "com.github.kklisura.cdt.services.config.incomingBuffer";
+
+  public static final int KB = 1024;
+  public static final int MB = 1024 * KB;
+
+  private static final int DEFAULT_INCOMING_BUFFER_SIZE = 8 * MB;
+
+  private static final long INCOMING_BUFFER_SIZE =
+      systemProperty(WEBSOCKET_INCOMING_BUFFER_PROPERTY, DEFAULT_INCOMING_BUFFER_SIZE);
+
+  public static final String INCOMING_BUFFER_SIZE_PROPERTY =
+      "org.glassfish.tyrus.incomingBufferSize";
 
   @Override
   public WebSocketContainer getWebSocketContainer() {

cdt-java-client/src/main/java/com/github/kklisura/cdt/services/factory/impl/DefaultWebSocketContainerFactory.java

@@ -30,7 +30,13 @@
 import java.io.IOException;
 import java.net.URI;
 import java.util.function.Consumer;
-import javax.websocket.*;
+import javax.websocket.CloseReason;
+import javax.websocket.DeploymentException;
+import javax.websocket.Endpoint;
+import javax.websocket.EndpointConfig;
+import javax.websocket.MessageHandler;
+import javax.websocket.Session;
+import javax.websocket.WebSocketContainer;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -173,10 +179,10 @@ private void onClose(Session session, CloseReason closeReason) {
         closeReason.getReasonPhrase());
 
     if (isTyrusBufferOverflowCloseReason(closeReason)) {
-      LOGGER.info(
+      LOGGER.error(
           "Web socket connection closed due to BufferOverflow raised by Tyrus client. This indicates the message "
               + "about to be received is larger than the incoming buffer in Tyrus client. "
-              + "See ConfigurableTyrusClientFactory class source on how to increase the incoming buffer size in Tyrus or visit https://github.com/kklisura/chrome-devtools-java-client/blob/master/cdt-examples/src/main/java/com/github/kklisura/cdt/examples/IncreasedIncomingBufferInTyrusExample.java");
+              + "See DefaultWebSocketContainerFactory class source on how to increase the incoming buffer size in Tyrus or visit https://github.com/kklisura/chrome-devtools-java-client/blob/master/cdt-examples/src/main/java/com/github/kklisura/cdt/examples/IncreasedIncomingBufferInTyrusExample.java");
     }
   }