Merge branch 'protocol-overhaul' into dev

Author: freyacodes

IMPLEMENTATION.md

@@ -21,16 +21,7 @@ User-Id: The user id of the bot you are playing music with
 ```
 
 ### Outgoing messages
-Make the server queue a voice connection
-```json
-{
-    "op": "connect",
-    "guildId": "...",
-    "channelId": "..."
-}
-```
-
-Provide an intercepted voice server update
+Provide an intercepted voice server update. This causes the server to connect to the voice channel
 ```json
 {
     "op": "voiceUpdate",
@@ -40,33 +31,6 @@ Provide an intercepted voice server update
 }
 ```
 
-Close a voice connection
-```json
-{
-    "op": "disconnect",
-    "guildId": "123"
-}
-```
-
-Response to `validationReq`. `channelId` is omitted if the request does not display the channel id.
-```json
-{
-    "op": "validationRes",
-    "guildId": "...",
-    "channelId": "...",
-    "valid": true
-}
-```
-
-Response to `isConnectedRes`.
-```json
-{
-    "op": "isConnectedRes",
-    "shardId": 1337,
-    "connected": true
-}
-```
-
 Cause the player to play a track.
 `startTime` is an optional setting that determines the number of milliseconds to offset the track by. Defaults to 0.
 `endTime` is an optional setting that determines at the number of milliseconds at which point the track should stop playing. Helpful if you only want to play a snippet of a bigger track. By default the track plays until it's end as per the encoded data.
@@ -117,35 +81,9 @@ Set player volume. Volume may range from 0 to 150. 100 is default.
 
 ### Incoming messages
 See 
-[LavalinkSocket.java](https://github.com/Frederikam/Lavalink/blob/91bc0ef4dab6ca5d5efcba12203ee4054bb55ae9/LavalinkClient/src/main/java/lavalink/client/io/LavalinkSocket.java)
+[LavalinkSocket.java](https://github.com/Frederikam/Lavalink/blob/dev/LavalinkClient/src/main/java/lavalink/client/io/LavalinkSocket.java)
 for client implementation
 
-Incoming message to forward to mainWS
-```json
-{
-    "op": "sendWS",
-    "shardId": 1337,
-    "message": "..."
-}
-```
-
-Request to check if the VC or Guild exists, and that we have access to the VC. Note that the channelId may be omitted, in which case you should only check if we are in the guild.
-```json
-{
-    "op": "validationReq",
-    "guildId": "...",
-    "channelId": "..."
-}
-```
-
-Request to check if a shard's mainWS is connected
-```json
-{
-    "op": "isConnectedReq",
-    "shardId": 1337
-}
-```
-
 Position information about a player. Includes unix timestamp.
 ```json
 {

LavalinkClient/.gitignore

@@ -2,4 +2,5 @@
 /logs/
 /target/
 /dependency-reduced-pom.xml
-build/*
+build/*
+/out/

LavalinkClient/build.gradle

@@ -5,10 +5,11 @@ ext {
 }
 dependencies {
     compile group: 'com.sedmelluq', name: 'lavaplayer', version: '1.2.45'
-    compile group: 'org.java-websocket', name: 'Java-WebSocket', version: '1.3.4'
+    compile group: 'org.java-websocket', name: 'Java-WebSocket', version: '1.3.7'
     compile group: 'org.slf4j', name: 'slf4j-api', version: '1.7.25'
-    compile group: 'org.json', name: 'json', version: '20170516'
-    compile group: 'net.dv8tion', name: 'JDA', version: '3.3.1_307'
+    compile group: 'org.json', name: 'json', version: '20171018'
+    compile group: 'net.dv8tion', name: 'JDA', version: '3.5.0_328'
+    compileOnly group: 'io.prometheus', name: 'simpleclient', version: '0.1.0'
     testCompile group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.0.0-M4'
     testCompile group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.0.0-M4'
     testCompile group: 'org.junit.platform', name: 'junit-platform-launcher', version: '1.0.0-M4'

LavalinkClient/src/main/java/lavalink/client/LavalinkUtil.java

@@ -45,7 +45,6 @@ public class LavalinkUtil {
 
     static {
         PLAYER_MANAGER = new DefaultAudioPlayerManager();
-        PLAYER_MANAGER.enableGcMonitoring();
 
         /* These are only to encode/decode messages */
         PLAYER_MANAGER.registerSourceManager(new YoutubeAudioSourceManager());
@@ -65,7 +64,7 @@ public static AudioTrack toAudioTrack(String message) throws IOException {
     public static String toMessage(AudioTrack track) throws IOException {
         ByteArrayOutputStream baos = new ByteArrayOutputStream();
         PLAYER_MANAGER.encodeTrack(new MessageOutput(baos), track);
-        return new String(Base64.encodeBytesToBytes(baos.toByteArray()));
+        return Base64.encodeBytes(baos.toByteArray());
     }
 
     public static int getShardFromSnowflake(String snowflake, int numShards) {

LavalinkClient/src/main/java/lavalink/client/io/Lavalink.java

@@ -23,33 +23,31 @@
 package lavalink.client.io;
 
 import lavalink.client.LavalinkUtil;
-import lavalink.client.player.LavalinkPlayer;
 import net.dv8tion.jda.core.JDA;
 import net.dv8tion.jda.core.entities.Guild;
-import net.dv8tion.jda.core.entities.VoiceChannel;
 import net.dv8tion.jda.core.entities.impl.JDAImpl;
-import net.dv8tion.jda.core.events.DisconnectEvent;
 import net.dv8tion.jda.core.events.ReadyEvent;
 import net.dv8tion.jda.core.events.ReconnectedEvent;
-import net.dv8tion.jda.core.events.ResumedEvent;
-import net.dv8tion.jda.core.events.ShutdownEvent;
-import net.dv8tion.jda.core.events.guild.voice.GuildVoiceJoinEvent;
-import net.dv8tion.jda.core.events.guild.voice.GuildVoiceLeaveEvent;
-import net.dv8tion.jda.core.events.guild.voice.GuildVoiceMoveEvent;
+import net.dv8tion.jda.core.events.channel.voice.VoiceChannelDeleteEvent;
+import net.dv8tion.jda.core.events.guild.GuildLeaveEvent;
+import net.dv8tion.jda.core.handle.SocketHandler;
 import net.dv8tion.jda.core.hooks.ListenerAdapter;
 import org.java_websocket.drafts.Draft_6455;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import javax.annotation.Nonnull;
 import java.net.URI;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.CopyOnWriteArrayList;
 import java.util.concurrent.Executors;
 import java.util.concurrent.ScheduledExecutorService;
 import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicInteger;
 import java.util.function.Function;
 
 public class Lavalink extends ListenerAdapter {
@@ -79,6 +77,7 @@ public Lavalink(String userId, int numShards, Function<Integer, JDA> jdaProvider
         reconnectService.scheduleWithFixedDelay(new ReconnectTask(this), 0, 500, TimeUnit.MILLISECONDS);
     }
 
+
     @SuppressWarnings("unused")
     public void setAutoReconnect(boolean autoReconnect) {
         this.autoReconnect = autoReconnect;
@@ -89,13 +88,27 @@ public boolean getAutoReconnect() {
         return autoReconnect;
     }
 
-    public void addNode(URI serverUri, String password) {
+    private static final AtomicInteger nodeCounter = new AtomicInteger(0);
+
+    public void addNode(@Nonnull URI serverUri, @Nonnull String password) {
+        addNode("Lavalink_Node_#" + nodeCounter.getAndIncrement(), serverUri, password);
+    }
+
+    /**
+     * @param name
+     *         A name to identify this node. May show up in metrics and other places.
+     * @param serverUri
+     *         uri of the node to be added
+     * @param password
+     *         password of the node to be added
+     */
+    public void addNode(@Nonnull String name, @Nonnull URI serverUri, @Nonnull String password) {
         HashMap<String, String> headers = new HashMap<>();
         headers.put("Authorization", password);
         headers.put("Num-Shards", Integer.toString(numShards));
         headers.put("User-Id", userId);
 
-        nodes.add(new LavalinkSocket(this, serverUri, new Draft_6455(), headers));
+        nodes.add(new LavalinkSocket(name, this, serverUri, new Draft_6455(), headers));
     }
 
     @SuppressWarnings("unused")
@@ -104,16 +117,20 @@ public void removeNode(int key) {
         node.close();
     }
 
+    @SuppressWarnings("unused")
+    @Nonnull
+    public LavalinkLoadBalancer getLoadBalancer() {
+        return loadBalancer;
+    }
+
     @SuppressWarnings("WeakerAccess")
+    @Nonnull
     public Link getLink(String guildId) {
         return links.computeIfAbsent(guildId, __ -> new Link(this, guildId));
     }
 
-    public LavalinkLoadBalancer getLoadBalancer() {
-        return loadBalancer;
-    }
-
     @SuppressWarnings("WeakerAccess")
+    @Nonnull
     public Link getLink(Guild guild) {
         return getLink(guild.getId());
     }
@@ -124,21 +141,25 @@ public int getNumShards() {
     }
 
     @SuppressWarnings("WeakerAccess")
+    @Nonnull
     public Collection<Link> getLinks() {
         return links.values();
     }
 
     @SuppressWarnings("WeakerAccess")
+    @Nonnull
     public List<LavalinkSocket> getNodes() {
         return nodes;
     }
 
     @SuppressWarnings("WeakerAccess")
+    @Nonnull
     public JDA getJda(int shardId) {
         return jdaProvider.apply(shardId);
     }
 
     @SuppressWarnings("WeakerAccess")
+    @Nonnull
     public JDA getJdaFromSnowflake(String snowflake) {
         return jdaProvider.apply(LavalinkUtil.getShardFromSnowflake(snowflake, numShards));
     }
@@ -153,107 +174,47 @@ void removeDestroyedLink(Link link) {
         links.remove(link.getGuildId());
     }
 
-    /*
-     *  Deprecated, will be removed in v2.0
-     */
-
-    @Deprecated
-    LavalinkSocket getSocket(String guildId) {
-        return getLink(guildId).getNode(false);
-    }
-
-    @Deprecated
-    public VoiceChannel getConnectedChannel(Guild guild) {
-        return getLink(guild).getCurrentChannel();
-    }
-
-    @Deprecated
-    public String getConnectedChannel(String guildId) {
-        return getLink(guildId).getCurrentChannel().getId();
-    }
-
-    @Deprecated
-    public LavalinkSocket getNodeForGuild(Guild guild) {
-        return getLink(guild).getNode(false);
-    }
-
-    @Deprecated
-    public LavalinkPlayer getPlayer(String guildId) {
-        return getLink(guildId).getPlayer();
-    }
-
-    @Deprecated
-    public void openVoiceConnection(VoiceChannel channel) {
-        getLink(channel.getGuild()).connect(channel);
-    }
-
-    @Deprecated
-    public void closeVoiceConnection(Guild guild) {
-        getLink(guild).disconnect();
-    }
-
     /*
      *  JDA event handling
      */
 
     @Override
     public void onReady(ReadyEvent event) {
-        ((JDAImpl) event.getJDA()).getClient().getHandlers()
-                .put("VOICE_SERVER_UPDATE", new VoiceServerUpdateInterceptor(this, (JDAImpl) event.getJDA()));
+        Map<String, SocketHandler> handlers = ((JDAImpl) event.getJDA()).getClient().getHandlers();
+        handlers.put("VOICE_SERVER_UPDATE", new VoiceServerUpdateInterceptor(this, (JDAImpl) event.getJDA()));
+        handlers.put("VOICE_STATE_UPDATE", new VoiceStateUpdateInterceptor(this, (JDAImpl) event.getJDA()));
     }
 
     @Override
-    public void onDisconnect(DisconnectEvent event) {
-        disconnectVoiceConnection(event.getJDA());
-    }
-
-    @Override
-    public void onShutdown(ShutdownEvent event) {
-        disconnectVoiceConnection(event.getJDA());
-    }
-
-    @Override
-    public void onReconnect(ReconnectedEvent event) {
-        reconnectVoiceConnections(event.getJDA());
-    }
+    public void onGuildLeave(GuildLeaveEvent event) {
+        Link link = links.get(event.getGuild().getId());
+        if (link == null) return;
 
-    @Override
-    public void onResume(ResumedEvent event) {
-        reconnectVoiceConnections(event.getJDA());
+        link.removeConnection();
     }
 
     @Override
-    public void onGuildVoiceJoin(GuildVoiceJoinEvent event) {
-        // Check if not ourselves
-        if (!event.getMember().getUser().equals(event.getJDA().getSelfUser())) return;
+    public void onVoiceChannelDelete(VoiceChannelDeleteEvent event) {
+        Link link = links.get(event.getGuild().getId());
+        if (link == null || !event.getChannel().equals(link.getLastChannel())) return;
 
-        getLink(event.getGuild()).onVoiceJoin();
+        link.removeConnection();
     }
 
     @Override
-    public void onGuildVoiceLeave(GuildVoiceLeaveEvent event) {
-        // Check if not ourselves
-        if (!event.getMember().getUser().equals(event.getJDA().getSelfUser())) return;
-
-        getLink(event.getGuild()).onVoiceLeave();
+    public void onReconnect(ReconnectedEvent event) {
+        reconnectVoiceConnections(event.getJDA());
     }
 
-    @Override
-    public void onGuildVoiceMove(GuildVoiceMoveEvent event) {
-        // Check if not ourselves
-        if (!event.getMember().getUser().equals(event.getJDA().getSelfUser())) return;
-
-        getLink(event.getGuild()).onGuildVoiceMove(event);
-    }
 
     private void reconnectVoiceConnections(JDA jda) {
         if (autoReconnect) {
             links.forEach((guildId, link) -> {
                 try {
                     //Note: We also ensure that the link belongs to the JDA object
-                    if (link.getCurrentChannel() != null
+                    if (link.getLastChannel() != null
                             && jda.getGuildById(guildId) != null) {
-                        link.connect(link.getCurrentChannel());
+                        link.connect(link.getLastChannel(), false);
                     }
                 } catch (Exception e) {
                     log.error("Caught exception while trying to reconnect link " + link, e);
@@ -262,16 +223,4 @@ private void reconnectVoiceConnections(JDA jda) {
         }
     }
 
-    private void disconnectVoiceConnection(JDA jda) {
-        links.forEach((guildId, link) -> {
-            try {
-                if (jda.getGuildById(guildId) != null) {
-                    link.disconnect();
-                }
-            } catch (Exception e) {
-                log.error("Caught exception while trying to disconnect link " + link, e);
-            }
-        });
-    }
-
 }