feat!: implement adapters (#66)

* chore(Deps): update typescript and eslint

* feat: create DiscordGatewayAdapter interface

* feat: signalJoinVoiceChannel now uses adapter

* feat: integrate adapter into VoiceConnection

* refactor(DiscordGatewayAdapter): abstract class instead of interface

* feat(VoiceConnection): adapter drives packets

* chore: remove Discord.js client tracking

* feat: decouple library from Discord.js

* feat(Adapter): redesign adapter

* fix: adapter bugs

* chore: fix examples for adapter

* chore: update example README

Author: amishshah

examples/basic/README.md

@@ -22,6 +22,7 @@ import {
 	AudioPlayerStatus,
 	VoiceConnectionStatus,
 } from '@discordjs/voice';
+import { createDiscordJSAdapter } from './adapter';
 
 const player = createAudioPlayer();
 
@@ -36,7 +37,11 @@ function playSong() {
 }
 
 async function connectToChannel(channel: VoiceChannel) {
-	const connection = joinVoiceChannel(channel);
+	const connection = joinVoiceChannel({
+		channelId: channel.id,
+		guildId: channel.guild.id,
+		adapterCreator: createDiscordJSAdapter(channel),
+	});
 
 	try {
 		await entersState(connection, VoiceConnectionStatus.Ready, 30e3);

examples/basic/adapter.ts

@@ -0,0 +1,45 @@
+import { DiscordGatewayAdapterCreator, DiscordGatewayAdapterLibraryMethods } from '../../';
+import { VoiceChannel, Snowflake, Client, Constants } from 'discord.js';
+import {
+	GatewayVoiceServerUpdateDispatchData,
+	GatewayVoiceStateUpdateDispatchData,
+} from 'discord-api-types/v8/gateway';
+
+const adapters = new Map<Snowflake, DiscordGatewayAdapterLibraryMethods>();
+const trackedClients = new Set<Client>();
+
+/**
+ * Tracks a Discord.js client, listening to VOICE_SERVER_UPDATE and VOICE_STATE_UPDATE events.
+ * @param client The Discord.js Client to track
+ */
+function trackClient(client: Client) {
+	if (trackedClients.has(client)) return;
+	trackedClients.add(client);
+	client.ws.on(Constants.WSEvents.VOICE_SERVER_UPDATE, (payload: GatewayVoiceServerUpdateDispatchData) => {
+		adapters.get(payload.guild_id)?.onVoiceServerUpdate(payload);
+	});
+	client.ws.on(Constants.WSEvents.VOICE_STATE_UPDATE, (payload: GatewayVoiceStateUpdateDispatchData) => {
+		if (payload.guild_id && payload.session_id && payload.user_id === client.user?.id) {
+			adapters.get(payload.guild_id)?.onVoiceStateUpdate(payload);
+		}
+	});
+}
+
+/**
+ * Creates an adapter for a Voice Channel
+ * @param channel The channel to create the adapter for
+ */
+export function createDiscordJSAdapter(channel: VoiceChannel): DiscordGatewayAdapterCreator {
+	return (methods) => {
+		adapters.set(channel.guild.id, methods);
+		trackClient(channel.client);
+		return {
+			sendPayload(data) {
+				return channel.guild.shard.send(data);
+			},
+			destroy() {
+				return adapters.delete(channel.guild.id);
+			},
+		};
+	};
+}

examples/basic/basic-example.ts

@@ -10,6 +10,7 @@ import {
 	AudioPlayerStatus,
 	VoiceConnectionStatus,
 } from '@discordjs/voice';
+import { createDiscordJSAdapter } from './adapter';
 
 /*
 	In this example, we are creating a single audio player that plays to a number of
@@ -57,7 +58,11 @@ async function connectToChannel(channel: VoiceChannel) {
 		to this voice channel, @discordjs/voice will just return the existing connection for
 		us!
 	*/
-	const connection = joinVoiceChannel(channel);
+	const connection = joinVoiceChannel({
+		channelId: channel.id,
+		guildId: channel.guild.id,
+		adapterCreator: createDiscordJSAdapter(channel),
+	});
 
 	/*
 		If we're dealing with a connection that isn't yet Ready, we can set a reasonable

package-lock.json

@@ -47,15 +47,14 @@
 		"@typescript-eslint/eslint-plugin": "^4.14.2",
 		"@typescript-eslint/parser": "^4.14.2",
 		"discord-api-types": "^0.12.1",
-		"discord.js": "^12.5.1",
-		"eslint": "^7.19.0",
+		"eslint": "^7.20.0",
 		"eslint-config-marine": "^8.1.0",
 		"eslint-config-prettier": "^7.2.0",
 		"eslint-plugin-prettier": "^3.3.1",
 		"husky": "^4.3.8",
 		"lint-staged": "^10.5.4",
 		"prettier": "^2.2.1",
-		"typescript": "^4.2.0-dev.20210204"
+		"typescript": "^4.2.2"
 	},
 	"husky": {
 		"hooks": {