Add GatewayPingEvent (discord-jda#1028)

Log raw close reason if the close code is not handled

Author: MinnDevelopment

Diff for: src/main/java/net/dv8tion/jda/api/JDA.java

@@ -196,6 +196,8 @@ public boolean equals(Object o)
      * <p><b>{@link net.dv8tion.jda.api.requests.RestAction RestAction} request times do not
      * correlate to this value!</b>
      *
+     * <p>The {@link net.dv8tion.jda.api.events.GatewayPingEvent GatewayPingEvent} indicates an update to this value.
+     *
      * @return time in milliseconds between heartbeat and the heartbeat ack response
      *
      * @see    #getRestPing() Getting RestAction ping

Diff for: src/main/java/net/dv8tion/jda/api/events/GatewayPingEvent.java

@@ -0,0 +1,96 @@
+/*
+ * Copyright 2015-2019 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package net.dv8tion.jda.api.events;
+
+import net.dv8tion.jda.api.JDA;
+
+import javax.annotation.Nonnull;
+
+/**
+ * Indicates that the gateway ping has been updated by the heartbeat cycle.
+ * <br>You can always get the last ping update with {@link net.dv8tion.jda.api.JDA#getGatewayPing()}.
+ *
+ * <p>Can be used to detect changes to the gateway ping.
+ *
+ * <p>Identifier: {@code gateway-ping}
+ */
+public class GatewayPingEvent extends Event implements UpdateEvent<JDA, Long>
+{
+    public static final String IDENTIFIER = "gateway-ping";
+    private final long next, prev;
+
+    public GatewayPingEvent(@Nonnull JDA api, long old)
+    {
+        super(api);
+        this.next = api.getGatewayPing();
+        this.prev = old;
+    }
+
+    /**
+     * The new ping for the current JDA session
+     *
+     * @return The new ping in milliseconds
+     */
+    public long getNewPing()
+    {
+        return next;
+    }
+
+    /**
+     * The previous ping for the current JDA session
+     *
+     * @return The previous ping in milliseconds, or -1 if no ping was available yet
+     */
+    public long getOldPing()
+    {
+        return prev;
+    }
+
+    @Nonnull
+    @Override
+    public String getPropertyIdentifier()
+    {
+        return IDENTIFIER;
+    }
+
+    @Nonnull
+    @Override
+    public JDA getEntity()
+    {
+        return getJDA();
+    }
+
+    @Nonnull
+    @Override
+    public Long getOldValue()
+    {
+        return prev;
+    }
+
+    @Nonnull
+    @Override
+    public Long getNewValue()
+    {
+        return next;
+    }
+
+    @Override
+    public String toString()
+    {
+        return "GatewayUpdate[ping](" + getOldValue() + "->" + getNewValue() + ')';
+    }
+}

Diff for: src/main/java/net/dv8tion/jda/api/hooks/ListenerAdapter.java

@@ -111,6 +111,7 @@ public abstract class ListenerAdapter implements EventListener
     public void onGenericEvent(@Nonnull GenericEvent event) {}
     public void onGenericUpdate(@Nonnull UpdateEvent<?, ?> event) {}
     public void onRawGateway(@Nonnull RawGatewayEvent event) {}
+    public void onGatewayPing(@Nonnull GatewayPingEvent event) {}
 
     //JDA Events
     public void onReady(@Nonnull ReadyEvent event) {}
@@ -335,6 +336,8 @@ else if (event instanceof StatusChangeEvent)
             onStatusChange((StatusChangeEvent) event);
         else if (event instanceof ExceptionEvent)
             onException((ExceptionEvent) event);
+        else if (event instanceof GatewayPingEvent)
+            onGatewayPing((GatewayPingEvent) event);
 
         //Message Events
         //Guild (TextChannel) Message Events

Diff for: src/main/java/net/dv8tion/jda/internal/JDAImpl.java

@@ -25,6 +25,7 @@
 import net.dv8tion.jda.api.audio.factory.IAudioSendFactory;
 import net.dv8tion.jda.api.audio.hooks.ConnectionStatus;
 import net.dv8tion.jda.api.entities.*;
+import net.dv8tion.jda.api.events.GatewayPingEvent;
 import net.dv8tion.jda.api.events.GenericEvent;
 import net.dv8tion.jda.api.events.StatusChangeEvent;
 import net.dv8tion.jda.api.exceptions.AccountTypeException;
@@ -116,7 +117,7 @@ public class JDAImpl implements JDA
     protected SelfUser selfUser;
     protected ShardInfo shardInfo;
     protected long responseTotal;
-    protected long ping = -1;
+    protected long gatewayPing = -1;
     protected String gatewayUrl;
 
     protected String clientId = null;
@@ -418,7 +419,7 @@ public Status getStatus()
     @Override
     public long getGatewayPing()
     {
-        return ping;
+        return gatewayPing;
     }
 
     @Nonnull
@@ -835,9 +836,11 @@ public void setAudioSendFactory(IAudioSendFactory factory)
         this.audioSendFactory = factory;
     }
 
-    public void setPing(long ping)
+    public void setGatewayPing(long ping)
     {
-        this.ping = ping;
+        long oldPing = this.gatewayPing;
+        this.gatewayPing = ping;
+        handleEvent(new GatewayPingEvent(this, oldPing));
     }
 
     public Requester getRequester()

Diff for: src/main/java/net/dv8tion/jda/internal/requests/WebSocketClient.java

@@ -380,11 +380,14 @@ public void onDisconnected(WebSocket websocket, WebSocketFrame serverCloseFrame,
         if (serverCloseFrame != null)
         {
             rawCloseCode = serverCloseFrame.getCloseCode();
+            String rawCloseReason = serverCloseFrame.getCloseReason();
             closeCode = CloseCode.from(rawCloseCode);
             if (closeCode == CloseCode.RATE_LIMITED)
                 LOG.error("WebSocket connection closed due to ratelimit! Sent more than 120 websocket messages in under 60 seconds!");
             else if (closeCode != null)
                 LOG.debug("WebSocket connection closed with code {}", closeCode);
+            else if (rawCloseReason != null)
+                LOG.warn("WebSocket connection closed with code {}: {}", rawCloseCode, rawCloseReason);
             else
                 LOG.warn("WebSocket connection closed with unknown meaning for close-code {}", rawCloseCode);
         }
@@ -764,7 +767,7 @@ protected void onEvent(DataObject content)
                 break;
             case WebSocketCode.HEARTBEAT_ACK:
                 LOG.trace("Got Heartbeat Ack (OP 11).");
-                api.setPing(System.currentTimeMillis() - heartbeatStartTime);
+                api.setGatewayPing(System.currentTimeMillis() - heartbeatStartTime);
                 break;
             default:
                 LOG.debug("Got unknown op-code: {} with content: {}", opCode, content);