WebSocketClient optimization/enhancements (discord-jda#645)

* Optimize gc time
* Cleaned up WebSocketClient
* Invalidate gateway url when we encounter an exception on connect()
* Use AtomicInteger for rate-limit counter
* Make everything protected rather than private
* Added switch to disable stream compression
* Moved some things around for better event handling

Author: MinnDevelopment

src/main/java/net/dv8tion/jda/bot/sharding/DefaultShardManager.java

@@ -206,6 +206,11 @@ public class DefaultShardManager implements ShardManager
      */
     protected boolean enableMDC;
 
+    /**
+     * Whether to enable transport compression
+     */
+    protected boolean enableCompression;
+
     /**
      * Creates a new DefaultShardManager instance.
      * @param  shardsTotal
@@ -259,6 +264,8 @@ public class DefaultShardManager implements ShardManager
      *         Whether MDC should be enabled
      * @param  contextProvider
      *         The MDC context provider new JDA instances should use on startup
+     * @param  enableCompression
+     *         Whether to enable transport compression
      */
     protected DefaultShardManager(final int shardsTotal, final Collection<Integer> shardIds,
                                   final SessionController controller, final List<Object> listeners,
@@ -271,7 +278,8 @@ protected DefaultShardManager(final int shardsTotal, final Collection<Integer> s
                                   final boolean enableShutdownHook, final boolean enableBulkDeleteSplitting,
                                   final boolean autoReconnect, final IntFunction<Boolean> idleProvider,
                                   final boolean retryOnTimeout, final boolean useShutdownNow,
-                                  final boolean enableMDC, final IntFunction<ConcurrentMap<String, String>> contextProvider)
+                                  final boolean enableMDC, final IntFunction<ConcurrentMap<String, String>> contextProvider,
+                                  final boolean enableCompression)
     {
         this.shardsTotal = shardsTotal;
         this.listeners = listeners;
@@ -296,6 +304,7 @@ protected DefaultShardManager(final int shardsTotal, final Collection<Integer> s
         this.useShutdownNow = useShutdownNow;
         this.contextProvider = contextProvider;
         this.enableMDC = enableMDC;
+        this.enableCompression = enableCompression;
 
         synchronized (queue)
         {
@@ -626,7 +635,7 @@ protected JDAImpl buildInstance(final int shardId) throws LoginException, Interr
 
         final JDA.ShardInfo shardInfo = new JDA.ShardInfo(shardId, this.shardsTotal);
 
-        final int shardTotal = jda.login(this.gatewayURL, shardInfo);
+        final int shardTotal = jda.login(this.gatewayURL, shardInfo, this.enableCompression);
         if (this.shardsTotal == -1)
             this.shardsTotal = shardTotal;
 

src/main/java/net/dv8tion/jda/bot/sharding/DefaultShardManagerBuilder.java

@@ -25,11 +25,7 @@
 import okhttp3.OkHttpClient;
 
 import javax.security.auth.login.LoginException;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.List;
+import java.util.*;
 import java.util.concurrent.ConcurrentMap;
 import java.util.concurrent.ThreadFactory;
 import java.util.function.IntFunction;
@@ -57,6 +53,7 @@ public class DefaultShardManagerBuilder
     protected boolean autoReconnect = true;
     protected boolean retryOnTimeout = true;
     protected boolean useShutdownNow = false;
+    protected boolean enableCompression = true;
     protected int shardsTotal = -1;
     protected int maxReconnectDelay = 900;
     protected int corePoolSize = 2;
@@ -140,6 +137,28 @@ public DefaultShardManagerBuilder setContextEnabled(boolean enable)
         return this;
     }
 
+    /**
+     * Enable stream-compression on the gateway connection,
+     * this will decrease the amount of used bandwidth for the running bot instance
+     * for the cost of a few extra cycles for decompression.
+     * <br><b>Default: true</b>
+     *
+     * <p><b>We recommend to keep this enabled unless you have issues with the decompression</b>
+     * <br>This mode might become obligatory in a future version, do not rely on this switch to stay.
+     *
+     * @param  enable
+     *         True, if the gateway connection should use compression
+     *
+     * @return The {@link net.dv8tion.jda.bot.sharding.DefaultShardManagerBuilder DefaultShardManagerBuilder} instance. Useful for chaining.
+     *
+     * @see    <a href="https://discordapp.com/developers/docs/topics/gateway#transport-compression" target="_blank">Official Discord Documentation - Transport Compression</a>
+     */
+    public DefaultShardManagerBuilder setCompressionEnabled(boolean enable)
+    {
+        this.enableCompression = enable;
+        return this;
+    }
+
     /**
      * Adds all provided listeners to the list of listeners that will be used to populate the {@link DefaultShardManager DefaultShardManager} object.
      * <br>This uses the {@link net.dv8tion.jda.core.hooks.InterfacedEventManager InterfacedEventListener} by default.
@@ -813,7 +832,7 @@ public ShardManager build() throws LoginException, IllegalArgumentException
             this.audioSendFactory, this.gameProvider, this.statusProvider,
             this.httpClientBuilder, this.wsFactory, this.threadFactory,
             this.maxReconnectDelay, this.corePoolSize, this.enableVoice, this.enableShutdownHook, this.enableBulkDeleteSplitting,
-            this.autoReconnect, this.idleProvider, this.retryOnTimeout, this.useShutdownNow, this.enableContext, this.contextProvider);
+            this.autoReconnect, this.idleProvider, this.retryOnTimeout, this.useShutdownNow, this.enableContext, this.contextProvider, this.enableCompression);
 
         manager.login();
 

src/main/java/net/dv8tion/jda/core/JDABuilder.java

@@ -70,6 +70,7 @@ public class JDABuilder
     protected boolean autoReconnect = true;
     protected boolean idle = false;
     protected boolean requestTimeoutRetry = true;
+    protected boolean enableCompression = true;
 
     /**
      * Creates a completely empty JDABuilder.
@@ -134,6 +135,28 @@ public JDABuilder setContextEnabled(boolean enable)
         return this;
     }
 
+    /**
+     * Enable stream-compression on the gateway connection,
+     * this will decrease the amount of used bandwidth for the running bot instance
+     * for the cost of a few extra cycles for decompression.
+     * <br><b>Default: true</b>
+     *
+     * <p><b>We recommend to keep this enabled unless you have issues with the decompression</b>
+     * <br>This mode might become obligatory in a future version, do not rely on this switch to stay.
+     *
+     * @param  enable
+     *         True, if the gateway connection should use compression
+     *
+     * @return The JDABuilder instance. Useful for chaining
+     *
+     * @see    <a href="https://discordapp.com/developers/docs/topics/gateway#transport-compression" target="_blank">Official Discord Documentation - Transport Compression</a>
+     */
+    public JDABuilder setCompressionEnabled(boolean enable)
+    {
+        this.enableCompression = enable;
+        return this;
+    }
+
     /**
      * Whether the Requester should retry when
      * a {@link java.net.SocketTimeoutException SocketTimeoutException} occurs.
@@ -582,7 +605,7 @@ public JDA buildAsync() throws LoginException
                 .setCacheGame(game)
                 .setCacheIdle(idle)
                 .setCacheStatus(status);
-        jda.login(gateway, shardInfo);
+        jda.login(gateway, shardInfo, enableCompression);
         return jda;
     }
 

src/main/java/net/dv8tion/jda/core/entities/impl/JDAImpl.java

@@ -136,7 +136,7 @@ public SessionController getSessionController()
         return sessionController;
     }
 
-    public int login(String gatewayUrl, ShardInfo shardInfo) throws LoginException
+    public int login(String gatewayUrl, ShardInfo shardInfo, boolean compression) throws LoginException
     {
         this.gatewayUrl = gatewayUrl;
         this.shardInfo = shardInfo;
@@ -161,7 +161,7 @@ public int login(String gatewayUrl, ShardInfo shardInfo) throws LoginException
         verifyToken();
         LOG.info("Login Successful!");
 
-        client = new WebSocketClient(this);
+        client = new WebSocketClient(this, compression);
         // remove our MDC metadata when we exit our code
         if (previousContext != null)
             previousContext.forEach(MDC::put);
@@ -773,4 +773,9 @@ public String getGatewayUrl()
     {
         return gatewayUrl;
     }
+
+    public void resetGatewayUrl()
+    {
+        this.gatewayUrl = getGateway();
+    }
 }