Expose VoiceServerUpdate events #984

devoxin · 2018-03-16T23:32:34Z

Resolves #983 by exposing VoiceServerUpdates to the user.

This should not break any existing functionality within the lib, and adds an event that will be helpful in supporting external audio clients such as Lavalink.

foxbot · 2018-03-16T23:34:50Z

src/Discord.Net.WebSocket/Entities/Guilds/SocketVoiceServer.cs

@@ -0,0 +1,19 @@
+using System.Diagnostics;
+
+namespace Discord.WebSocket.Entities.Guilds


This should be namespaced just to Discord.WebSocket

foxbot · 2018-03-16T23:35:24Z

src/Discord.Net.WebSocket/DiscordSocketClient.cs

@@ -1474,6 +1475,9 @@ public override RestVoiceRegion GetVoiceRegion(string id)
                                        await UnknownGuildAsync(type, data.GuildId).ConfigureAwait(false);
                                        return;
                                    }
+
+                                    SocketVoiceServer VoiceServer = new SocketVoiceServer(data.GuildId, data.Endpoint, data.Token);


We prefer to use var, and local variables should be camel-cased

foxbot · 2018-03-16T23:36:36Z

src/Discord.Net.WebSocket/DiscordSocketClient.cs

@@ -1474,6 +1475,9 @@ public override RestVoiceRegion GetVoiceRegion(string id)
                                        await UnknownGuildAsync(type, data.GuildId).ConfigureAwait(false);
                                        return;
                                    }
+
+                                    SocketVoiceServer VoiceServer = new SocketVoiceServer(data.GuildId, data.Endpoint, data.Token);
+                                    await TimedInvokeAsync(_voiceServerUpdatedEvent, nameof(UserVoiceStateUpdated), VoiceServer).ConfigureAwait(false);


I reckon this should probably be moved up a few lines, so that Lavalink implementations can properly intercept the event and throw an exception to stop the event handler before the library opens its own voice connection.

foxbot · 2018-03-16T23:37:54Z

src/Discord.Net.WebSocket/Entities/Guilds/SocketVoiceServer.cs

+    [DebuggerDisplay(@"{DebuggerDisplay,nq}")]
+    public class SocketVoiceServer
+    {
+        public ulong GuildId { get; private set; }


This could probably be a Cacheable<ulong, IGuild> instead.

Hmm, not really sure how I'd go about using the Cacheable class...

There are quite a few events in the DiscordSocketClass that use Cacheable<TId,TEntity>, take a look at them for a guideline. Basically gist is you're going to have a bool for if the entity is cached, check the cache for the item, and construct a new Cacheable<,> with the guild id, the cached guild, the isCached boolean, and a Func<> to retrieve the object via REST if it is not cached.

Alright, done

AntiTcb · 2018-03-17T01:31:50Z

src/Discord.Net.WebSocket/SocketVoiceServer.cs

+        public string Endpoint { get; private set; }
+        public string Token { get; private set; }
+
+        internal SocketVoiceServer(ulong GuildId, string Endpoint, string Token)


Parameters should be camelCased, and this should be avoided per style consistency with the lib.

AntiTcb · 2018-03-17T01:34:29Z

src/Discord.Net.WebSocket/BaseSocketClient.Events.cs

@@ -165,6 +165,13 @@ public partial class BaseSocketClient
            remove { _userVoiceStateUpdatedEvent.Remove(value); }
        }
        internal readonly AsyncEvent<Func<SocketUser, SocketVoiceState, SocketVoiceState, Task>> _userVoiceStateUpdatedEvent = new AsyncEvent<Func<SocketUser, SocketVoiceState, SocketVoiceState, Task>>();
+        /// <summary> Fired when the bot connects/disconnects to a Discord voice server. </summary>


According to Discord's docs, this event fires only on connecting, not disconnecting, as well as when the current voice instances changes servers.

AntiTcb · 2018-03-17T01:36:02Z

src/Discord.Net.WebSocket/SocketVoiceServer.cs

+
+namespace Discord.WebSocket
+{
+    [DebuggerDisplay(@"{DebuggerDisplay,nq}")]


You need to implement a function named DebuggerDisplay for attribute to do its job. See SocketRole for an example.

AntiTcb · 2018-03-17T01:36:59Z

src/Discord.Net.WebSocket/DiscordSocketClient.cs

@@ -5,6 +5,7 @@
 using Discord.Net.Udp;
 using Discord.Net.WebSockets;
 using Discord.Rest;
+using Discord.WebSocket;


This namespace shouldn't need to be imported given that the DiscordSocketClient class is already defined within it.

devoxin · 2018-03-18T12:25:19Z

Anything else need changing?

AntiTcb · 2018-03-18T19:03:11Z

src/Discord.Net.WebSocket/SocketVoiceServer.cs

            Endpoint = endpoint;
            Token = token;
        }

-        private string DebuggerDisplay => $"SocketVoiceServer ({GuildId})";
+        private string DebuggerDisplay => $"SocketVoiceServer ({Guild.Id})";


This will null ref if the guild isn't cached (literally should never happen, but worth pointing out. Opt for using the ID directly from the cacheable.

I thought .Id did return the ID (ulong)?

Ah, my bad, misread.

AntiTcb · 2018-03-18T19:05:15Z

src/Discord.Net.WebSocket/DiscordSocketClient.cs

@@ -1464,6 +1464,12 @@ public override RestVoiceRegion GetVoiceRegion(string id)

                                    var data = (payload as JToken).ToObject<VoiceServerUpdateEvent>(_serializer);
                                    var guild = State.GetGuild(data.GuildId);
+                                    var cacheable = new Cacheable<IGuild, ulong>(guild, data.GuildId, guild != null,
+                                        async () => (IGuild) await ApiClient.GetGuildAsync(data.GuildId));


Was the cast necessary? Not sure if the compiler would actually complain about that or not, but my first instinct just from reading is that it shouldn't.

It did https://i.serux.pro/6c425faf71.png

devoxin · 2018-03-21T20:35:51Z

@foxbot?

- Removed unnecessary parameter in SocketVoiceServer - Moved SocketVoiceServer into Entities/Voice - Fixed a bug where trying to download the cached guild would throw - Fixed a potential bug where Discord might not give us a port when connecting to voice

* Expose VoiceServerUpdate events * Amend based on feedback * Move this out of guild entity * Fix namespace issue * Adjust based on feedback discord-net#2 * Use cacheable instead * Change based on feedback

…d-net#1051) - Removed unnecessary parameter in SocketVoiceServer - Moved SocketVoiceServer into Entities/Voice - Fixed a bug where trying to download the cached guild would throw - Fixed a potential bug where Discord might not give us a port when connecting to voice

commit dece19d Merge: fdaa689 e764daf Author: Still Hsu <341464@gmail.com> Date: Mon May 21 11:47:47 2018 +0800 Merge branch 'dev' into docs/faq-n-patches-offline commit e764daf Author: Quahu <quahuu@gmail.com> Date: Sun May 13 15:34:40 2018 +0200 Add ViewChannel to Voice channel permissions (discord-net#1059) Previously, Voice channels did not have ViewChannel in their "all" permissions commit 32fc2df Author: Alex Gravely <tcbskater@hotmail.com> Date: Sat May 12 20:47:44 2018 -0400 Remove unused field in EmbedFieldBuilder. (discord-net#1018) commit 39dffe8 Author: Finite Reality <FiniteReality@users.noreply.github.com> Date: Sun May 13 01:46:07 2018 +0100 Audit Logs implementation (discord-net#1055) * Copy audit logs impl from old branch and clean up I suck at using git, so I'm gonna use brute force. * Remove unnecessary TODOs Category channels do not provide any new information, and the other I forgot to remove beforehand * Add invite update data, clean up after feedback * Remove TODOs, add WebhookType enum for future use WebhookType is a future-use type, as currently audit logs are the only thing which may return it. commit fdaa689 Author: Still Hsu <341464@gmail.com> Date: Wed May 9 06:04:59 2018 +0800 Add explanation for RunMode commit ea82c25 Author: Still Hsu <341464@gmail.com> Date: Tue May 8 16:30:48 2018 +0800 Initial proofread of the articles commit 124f1a2 Merge: 2555721 97c8931 Author: Still Hsu <341464@gmail.com> Date: Tue May 8 05:02:01 2018 +0800 Merge branch 'dev' into docs/faq-n-patches-offline commit 97c8931 Author: Still Hsu <341464@gmail.com> Date: Mon May 7 06:22:49 2018 +0800 Implement GetBanAsync (discord-net#1056) commit 2555721 Author: Still Hsu <341464@gmail.com> Date: Sun May 6 16:11:19 2018 +0800 Add details to SpotifyGame commit c7b236d Author: Still Hsu <341464@gmail.com> Date: Sun May 6 15:58:23 2018 +0800 Add more IGuild docs commit 1bb06cc Author: Still Hsu <341464@gmail.com> Date: Sun May 6 15:40:31 2018 +0800 Replace all langword placements with code block commit ac47d84 Author: Still Hsu <341464@gmail.com> Date: Sun May 6 15:22:17 2018 +0800 Replace langword null to code block null instead - Because DocFX sucks at rendering langword commit 0b15bbc Author: Still Hsu <341464@gmail.com> Date: Sun May 6 15:20:34 2018 +0800 Add XML docs commit 65d4e43 Author: Still Hsu <341464@gmail.com> Date: Sun May 6 06:57:53 2018 +0800 Add BaseSocketClient docs commit 8f64c04 Author: Still Hsu <341464@gmail.com> Date: Sun May 6 06:37:55 2018 +0800 Replace note block commit d8bb9e7 Author: Still Hsu <341464@gmail.com> Date: Sun May 6 06:31:50 2018 +0800 Add warning for bulk-delete endpoint commit adae5ff Author: Still Hsu <341464@gmail.com> Date: Sun May 6 06:07:28 2018 +0800 Fix missing Username prop commit 3e59197 Author: Still Hsu <341464@gmail.com> Date: Sun May 6 06:01:34 2018 +0800 Add properties examples to overwrite commit 0ad66f6 Author: Still Hsu <341464@gmail.com> Date: Sun May 6 04:55:15 2018 +0800 Fix minor consistencies & redundant impl commit 124efdf Author: Still Hsu <341464@gmail.com> Date: Sun May 6 04:40:14 2018 +0800 XML Docs commit 3aa5d36 Author: Still Hsu <341464@gmail.com> Date: Sat May 5 18:22:46 2018 +0800 Add 'last modified' plugin Source: https://github.com/Still34/DocFx.Plugin.LastModified Licensed under MIT License commit 2014870 Author: Still Hsu <341464@gmail.com> Date: Sat May 5 15:57:40 2018 +0800 Fix letter-casing for files commit f27d659 Author: Still Hsu <341464@gmail.com> Date: Sat May 5 15:50:00 2018 +0800 Document exposed TypeReaders commit 5a824a5 Author: Still Hsu <341464@gmail.com> Date: Sat May 5 15:44:15 2018 +0800 Add missing exceptions commit c2de0c0 Author: Still Hsu <341464@gmail.com> Date: Sat May 5 15:40:16 2018 +0800 Fix seealso for preconditions and add missing descriptions commit 3a7d7ee Author: Still Hsu <341464@gmail.com> Date: Sat May 5 15:36:22 2018 +0800 Minor fixes in documentations + Fix unescaped '<' + Fix typo commit 45839bd Author: Still Hsu <341464@gmail.com> Date: Sat May 5 15:29:47 2018 +0800 Add XML Docs commit 9e62546 Merge: aea0678 bb4bb13 Author: Still Hsu <341464@gmail.com> Date: Sat May 5 14:48:13 2018 +0800 Merge branch 'dev' into docs/faq-n-patches-offline commit aea0678 Merge: 27dc483 9ddd709 Author: Still Hsu <341464@gmail.com> Date: Sat May 5 13:51:07 2018 +0800 Merge branch 'docs/faq-n-patches-offline' of https://github.com/Still34/Discord.Net into docs/faq-n-patches-offline commit 27dc483 Author: Still Hsu <341464@gmail.com> Date: Sat May 5 13:50:27 2018 +0800 Add XML Docs commit baa8beb Author: Still Hsu <341464@gmail.com> Date: Sat May 5 13:49:42 2018 +0800 Add XML Docs commit 089f97a Author: Still Hsu <341464@gmail.com> Date: Sat May 5 13:43:04 2018 +0800 Add details regarding userbot support commit bb4bb13 Author: Finite Reality <FiniteReality@users.noreply.github.com> Date: Fri May 4 11:42:54 2018 +0100 Fix issues with discord-net#984, remove extraneous whitespace (discord-net#1051) - Removed unnecessary parameter in SocketVoiceServer - Moved SocketVoiceServer into Entities/Voice - Fixed a bug where trying to download the cached guild would throw - Fixed a potential bug where Discord might not give us a port when connecting to voice commit 9ddd709 Merge: f197174 7cfed7f Author: Still Hsu <341464@gmail.com> Date: Fri May 4 09:37:04 2018 +0800 Merge branch 'dev' into docs/faq-n-patches-offline commit f197174 Author: Still Hsu <341464@gmail.com> Date: Fri May 4 09:36:53 2018 +0800 Fix embed docs consistency commit 7cfed7f Author: Alex Gravely <tcbskater@hotmail.com> Date: Thu May 3 21:30:13 2018 -0400 Fix nullref when passing null to GetShardIdFor. (discord-net#1049) commit e775853 Author: Luke <dev@crimsonxv.pro> Date: Fri May 4 02:29:51 2018 +0100 Expose VoiceServerUpdate events (discord-net#984) * Expose VoiceServerUpdate events * Amend based on feedback * Move this out of guild entity * Fix namespace issue * Adjust based on feedback #2 * Use cacheable instead * Change based on feedback commit 157acc4 Author: Still Hsu <341464@gmail.com> Date: Thu May 3 23:03:35 2018 +0800 Add tag examples commit 57ea571 Author: Still Hsu <341464@gmail.com> Date: Thu May 3 22:48:33 2018 +0800 Fix sample link & add missing pictures commit 6769c37 Author: Still Hsu <341464@gmail.com> Date: Thu May 3 22:39:26 2018 +0800 Compress some assets & add OAuth2 URL generator

Expose VoiceServerUpdate events

7cce63a

foxbot requested changes Mar 16, 2018

View reviewed changes

foxbot added project: websocket version: minor priority: improvement labels Mar 16, 2018

devoxin added 3 commits March 16, 2018 23:47

Amend based on feedback

29db63d

Move this out of guild entity

66e5af9

Fix namespace issue

26bd283

AntiTcb suggested changes Mar 17, 2018

View reviewed changes

Adjust based on feedback #2

669ba37

Use cacheable instead

8e454fe

AntiTcb suggested changes Mar 18, 2018

View reviewed changes

AntiTcb reviewed Mar 18, 2018

View reviewed changes

AntiTcb approved these changes Mar 18, 2018

View reviewed changes

devoxin mentioned this pull request Mar 28, 2018

Expose VoiceServerUpdate event #983

Closed

Change based on feedback

a405913

foxbot merged commit e775853 into discord-net:dev May 4, 2018

NovusTheory mentioned this pull request May 9, 2018

Allow external VoiceChannel client API implementation #1057

Merged

NovusTheory mentioned this pull request Jun 17, 2018

Add missing VoiceServerUpdated event #1089

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expose VoiceServerUpdate events #984

Expose VoiceServerUpdate events #984

devoxin commented Mar 16, 2018

foxbot Mar 16, 2018

foxbot Mar 16, 2018

foxbot Mar 16, 2018

foxbot Mar 16, 2018

devoxin Mar 16, 2018

AntiTcb Mar 17, 2018

devoxin Mar 18, 2018

AntiTcb Mar 17, 2018

AntiTcb Mar 17, 2018

AntiTcb Mar 17, 2018

AntiTcb Mar 17, 2018

devoxin commented Mar 18, 2018

AntiTcb Mar 18, 2018

devoxin Mar 18, 2018

AntiTcb Mar 18, 2018

AntiTcb Mar 18, 2018

devoxin Mar 18, 2018

devoxin commented Mar 21, 2018

		@@ -0,0 +1,19 @@
		using System.Diagnostics;

		namespace Discord.WebSocket.Entities.Guilds

Expose VoiceServerUpdate events #984

Expose VoiceServerUpdate events #984

Conversation

devoxin commented Mar 16, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devoxin commented Mar 18, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devoxin commented Mar 21, 2018