api: split voice gateway and udp features, test for voice gateway in WASM

.github/workflows/build_and_test.yml

@@ -100,7 +100,7 @@ jobs:
         rustup target add wasm32-unknown-unknown
         curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
         cargo binstall --no-confirm wasm-bindgen-cli --version "0.2.88" --force
-        GECKODRIVER=$(which geckodriver) cargo test --target wasm32-unknown-unknown --no-default-features --features="client, rt"
+        GECKODRIVER=$(which geckodriver) cargo test --target wasm32-unknown-unknown --no-default-features --features="client, rt, voice_gateway"
   wasm-chrome:
     runs-on: macos-latest
     steps:
@@ -128,4 +128,4 @@ jobs:
         rustup target add wasm32-unknown-unknown
         curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
         cargo binstall --no-confirm wasm-bindgen-cli --version "0.2.88" --force
-        CHROMEDRIVER=$(which chromedriver) cargo test --target wasm32-unknown-unknown --no-default-features --features="client, rt"
+        CHROMEDRIVER=$(which chromedriver) cargo test --target wasm32-unknown-unknown --no-default-features --features="client, rt, voice_gateway"

Cargo.toml

@@ -15,8 +15,10 @@ default = ["client", "rt-multi-thread"]
 backend = ["dep:poem", "dep:sqlx"]
 rt-multi-thread = ["tokio/rt-multi-thread"]
 rt = ["tokio/rt"]
-client = ["voice"]
-voice = ["dep:discortp", "dep:crypto_secretbox"]
+client = []
+voice = ["voice_udp", "voice_gateway"]
+voice_udp = ["dep:discortp", "dep:crypto_secretbox"]
+voice_gateway = []
 
 [dependencies]
 tokio = { version = "1.34.0", features = ["macros", "sync"] }

README.md

@@ -125,7 +125,7 @@ like "proxy connection checking" are already disabled on this version, which oth
 ### wasm
 
 To test for wasm, you will need to `cargo install wasm-pack`. You can then run
-`wasm-pack test --<chrome/firefox/safari> --headless -- --target wasm32-unknown-unknown --features="rt, client" --no-default-features`
+`wasm-pack test --<chrome/firefox/safari> --headless -- --target wasm32-unknown-unknown --features="rt, client, voice_gateway" --no-default-features`
 to run the tests for wasm.
 
 ## Versioning

src/lib.rs

@@ -128,7 +128,7 @@ pub mod instance;
 #[cfg(feature = "client")]
 pub mod ratelimiter;
 pub mod types;
-#[cfg(feature = "client")]
+#[cfg(all(feature = "client", any(feature = "voice_udp", feature = "voice_gateway")))]
 pub mod voice;
 
 #[derive(Clone, Default, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]

src/voice/gateway/backends/mod.rs

@@ -1,23 +1,23 @@
-#[cfg(all(not(target_arch = "wasm32"), feature = "client"))]
+#[cfg(all(not(target_arch = "wasm32"), feature = "voice_gateway"))]
 pub mod tungstenite;
-#[cfg(all(not(target_arch = "wasm32"), feature = "client"))]
+#[cfg(all(not(target_arch = "wasm32"), feature = "voice_gateway"))]
 pub use tungstenite::*;
 
-#[cfg(all(target_arch = "wasm32", feature = "client"))]
+#[cfg(all(target_arch = "wasm32", feature = "voice_gateway"))]
 pub mod wasm;
-#[cfg(all(target_arch = "wasm32", feature = "client"))]
+#[cfg(all(target_arch = "wasm32", feature = "voice_gateway"))]
 pub use wasm::*;
 
-#[cfg(all(not(target_arch = "wasm32"), feature = "client"))]
+#[cfg(all(not(target_arch = "wasm32"), feature = "voice_gateway"))]
 pub type Sink = tungstenite::TungsteniteSink;
-#[cfg(all(not(target_arch = "wasm32"), feature = "client"))]
+#[cfg(all(not(target_arch = "wasm32"), feature = "voice_gateway"))]
 pub type Stream = tungstenite::TungsteniteStream;
-#[cfg(all(not(target_arch = "wasm32"), feature = "client"))]
+#[cfg(all(not(target_arch = "wasm32"), feature = "voice_gateway"))]
 pub type WebSocketBackend = tungstenite::TungsteniteBackend;
 
-#[cfg(all(target_arch = "wasm32", feature = "client"))]
+#[cfg(all(target_arch = "wasm32", feature = "voice_gateway"))]
 pub type Sink = wasm::WasmSink;
-#[cfg(all(target_arch = "wasm32", feature = "client"))]
+#[cfg(all(target_arch = "wasm32", feature = "voice_gateway"))]
 pub type Stream = wasm::WasmStream;
-#[cfg(all(target_arch = "wasm32", feature = "client"))]
+#[cfg(all(target_arch = "wasm32", feature = "voice_gateway"))]
 pub type WebSocketBackend = wasm::WasmBackend;

src/voice/mod.rs

@@ -1,10 +1,15 @@
 //! Module for all voice functionality within chorus.
 
-mod crypto;
+#[cfg(feature = "voice_gateway")]
 pub mod gateway;
+mod crypto;
+#[cfg(all(feature = "voice_udp", feature = "voice_gateway"))]
 pub mod handler;
+#[cfg(feature = "voice_udp")]
 pub mod udp;
+#[cfg(feature = "voice_udp")]
 pub mod voice_data;
 
 // Pub use this so users can interact with packet types if they want
+#[cfg(feature = "voice_udp")]
 pub use discortp;

src/voice/udp/backends/mod.rs

@@ -1,19 +1,12 @@
-#[cfg(all(not(target_arch = "wasm32"), feature = "client"))]
+#[cfg(all(not(target_arch = "wasm32"), feature = "voice_udp"))]
 pub mod tokio;
-#[cfg(all(not(target_arch = "wasm32"), feature = "client"))]
+#[cfg(all(not(target_arch = "wasm32"), feature = "voice_udp"))]
 pub use tokio::*;
 
-#[cfg(all(target_arch = "wasm32", feature = "client"))]
-pub mod wasm;
-#[cfg(all(target_arch = "wasm32", feature = "client"))]
-pub use wasm::*;
-
-#[cfg(all(not(target_arch = "wasm32"), feature = "client"))]
+#[cfg(all(not(target_arch = "wasm32"), feature = "voice_udp"))]
 pub type UdpSocket = tokio::TokioSocket;
-#[cfg(all(not(target_arch = "wasm32"), feature = "client"))]
+#[cfg(all(not(target_arch = "wasm32"), feature = "voice_udp"))]
 pub type UdpBackend = tokio::TokioBackend;
 
-#[cfg(all(target_arch = "wasm32", feature = "client"))]
-pub type UdpSocket = wasm::WasmSocket;
-#[cfg(all(target_arch = "wasm32", feature = "client"))]
-pub type UdpBackend = wasm::WasmBackend;
+#[cfg(all(target_arch = "wasm32", feature = "voice_udp"))]
+compile_error!("UDP Voice support is not (and will likely never be) supported for WASM. This is because UDP cannot be used in the browser. We are however looking into Webrtc for WASM voice support.");

src/voice/udp/backends/wasm.rs

@@ -1,13 +0,0 @@
-use std::net::SocketAddr;
-
-// TODO: Add wasm websockets
-compile_error!("Udp voice support is not implemented yet for wasm.");
-
-#[derive(Debug, Clone)]
-pub struct WasmBackend;
-
-pub type WasmSocket;
-
-impl WasmBackend {
-    pub async fn connect(url: SocketAddr) -> Result<WasmSocket, VoiceUdpError> {}
-}

src/voice/voice_data.rs

@@ -3,7 +3,9 @@ use discortp::discord::IpDiscovery;
 use crate::types::{SessionDescription, Snowflake, VoiceReady, VoiceServerUpdate};
 
 #[derive(Debug, Default)]
-/// Saves data shared between parts of the voice architecture
+/// Saves data shared between parts of the voice architecture;
+///
+/// Struct used to give the Udp connection data received from the gateway.
 pub struct VoiceData {
     pub server_data: Option<VoiceServerUpdate>,
     pub ready_data: Option<VoiceReady>,