Add ws_proxy option for connecting gateway through a proxy. #2709

zzzzRuby · 2024-01-12T13:42:10Z

cheesycod · 2024-01-12T17:47:37Z

This would help me as well. I forked nirn to hackily replace the ws url.

GnomedDev · 2024-01-12T18:05:37Z

I'm kinda wondering why this is required at all, can't the gateway url just be exposed (if not already) to point to the proxy, instead of having this proxy option, and why is the manual http-over-tcp required? None of this is commented or explained.

zzzzRuby · 2024-01-13T08:01:54Z

I'm kinda wondering why this is required at all, can't the gateway url just be exposed (if not already) to point to the proxy, instead of having this proxy option, and why is the manual http-over-tcp required? None of this is commented or explained.

Sorry I'm new to opensource.
In some network environments like Chinese networks, there must be a proxy to connect with discord gateway. There're two options to do this, the first one is open a tunnel to the proxy likes this pr does, the second one is creating a custom gateway and redirect all message through a tunnel to the proxy. The second one seems too complex.
As to the manual http-over-tcp, I'm not sure if I can add a new dependency in Cargo.toml.

GnomedDev · 2024-01-13T13:08:35Z

Can you not perform this proxying system wide, instead of coding support for it into every application? I'm honestly not familar with this.

zzzzRuby · 2024-01-13T16:04:17Z

Can you not perform this proxying system wide, instead of coding support for it into every application? I'm honestly not familar with this.

Normally, libraries like libcurl or reqwest get a default proxy from environment or system. But tungstenite doesn't support this and they seem have no interest in this (snapview/tungstenite-rs#177), the only choice to perform a proxy system wide is proxychains-like-tools. But I don't think proxychains is a good idea, it depends on linking libc dynamically, so on some distro like alpine it's hard to use with rust program and sometimes not work.

GnomedDev

Okay, I understand now, the situation sucks (this should be on tungstenite) but if we can make a positive impact lets go for this

src/client/mod.rs

GnomedDev · 2024-01-13T17:12:14Z

src/client/mod.rs

@@ -351,6 +371,7 @@ impl IntoFuture for ClientBuilder {
                #[cfg(feature = "voice")]
                voice_manager: voice_manager.as_ref().map(Arc::clone),
                ws_url: Arc::clone(&ws_url),
+                ws_proxy,


Can this be wrapped in Arc like ws_url, and preprocessed into Url to fail here if the user provides an invalid URL.

Yes it can. Finished

ws_url is only parsed into a Url inside of the gateway::shard::connect helper function. I think for consistency's sake the same should be done with ws_proxy - a followup PR could move the parsing logic for both to be earlier in the initialization stage.

GnomedDev · 2024-01-13T17:12:54Z

src/gateway/ws.rs

@@ -101,13 +108,72 @@ const TIMEOUT: Duration = Duration::from_millis(500);
 const DECOMPRESSION_MULTIPLIER: usize = 3;

 impl WsClient {
-    pub(crate) async fn connect(url: Url) -> Result<Self> {
+    async fn connect_with_proxy_async(


This whole method should be replaced with something using reqwest, which is already in the library.

This whole method should be replaced with something using reqwest, which is already in the library.

Reqwest doesn't expose API that can be used in websocket proxy. But there is an implementation that borrows from reqwest's design.
snapview/tungstenite-rs#177 (comment)

Just like Itsusinn said. I replaced the http connect code with async-http-proxy[https://crates.io/crates/async-http-proxy] which is mentioned in that issue.

I currently working with wasm on one of my personal projects. I'm would like to use `serenity` to get access to the discord API response models, but currently the library can not the compiled to wasm, because the `tokio/fs` feature is not supported in that target. I went ahead and removed the need to include that feature by default. By the looks of it, it only was used with the `builder` and `model` features, so I conditionally added `tokio/fs` back when those features are being used (the `model` feature already depends on `builder` so that doesn't need to be changed).

This has to be on the next branch as reqwest is exposed in a couple places.

…serenity-rs#2833)

This announcement was missed (around August 2022) and probably the cause of a lot of the disconnections.

The documentation was never updated after serenity-rs#2662 removed the user cache.

This field is documented as nullable but that isn't reflected in the model. I also took the opportunity to replace the Option<Vec> with a default Vec.

This was mistakenly removed in serenity-rs#2278 and wasn't caught because of the wildcard pattern in the match.

…-rs#2852)

Users should realistically be checking the permissions themselves, or handling the HTTP error from Discord. This removes any cases where permission checking inside the library is broken because of Discord's changes or due to oversights. This also changes the documentation on the prune functionality, this was recently changed to also require `MANAGE_GUILDS` as well as `KICK_MEMBERS`.

…enity-rs#2856)

This isn't needed anymore because simd-json has been removed on `next`.

mlesin · 2024-09-30T08:44:22Z

Are there any plans to merge this?

GnomedDev · 2024-09-30T13:18:24Z

As the author seems to be MIA, no. If anyone wants to rebase and solve outstanding reviews, feel free to open a new PR.

qthree · 2024-10-09T14:46:34Z

fyi, I cherry-picked commit from this PR on top of next branch and added socks4/5 proxy support, feel free to use it https://github.com/qthree/serenity/tree/ws-proxy

github-actions bot added client Related to the `client` module. gateway Related to the `gateway` module. labels Jan 12, 2024

zzzzRuby force-pushed the akira-bot-ws-proxy branch from b596a76 to 1735fbc Compare January 12, 2024 14:03

GnomedDev reviewed Jan 13, 2024

View reviewed changes

arqunis added the enhancement An improvement to Serenity. label Jan 13, 2024

arqunis force-pushed the next branch from fad3f0a to 810f38a Compare January 16, 2024 15:07

zzzzRuby force-pushed the akira-bot-ws-proxy branch 2 times, most recently from 782a253 to 15d9f25 Compare January 20, 2024 07:50

zzzzRuby force-pushed the akira-bot-ws-proxy branch from 15d9f25 to 0669294 Compare January 20, 2024 07:51

UserIsntAvailable and others added 18 commits May 28, 2024 14:52

Update reqwest to v0.12 (serenity-rs#2826)

b61153c

This has to be on the next branch as reqwest is exposed in a couple places.

Only include cache::Settings::time_to_live if temp cache is enabled (…

b0664bd

…serenity-rs#2833)

Add resume_gateway_url support (serenity-rs#2832)

d2be2ba

This announcement was missed (around August 2022) and probably the cause of a lot of the disconnections.

Correct documentation for UserId::to_user (serenity-rs#2809)

a79bb5f

The documentation was never updated after serenity-rs#2662 removed the user cache.

Use CreateAttachment for EditGuild::banner (serenity-rs#2844)

4ac1a11

Fix AuditLogEntry::user_id (serenity-rs#2846)

db1b6e0

This field is documented as nullable but that isn't reflected in the model. I also took the opportunity to replace the Option<Vec> with a default Vec.

Restore match arm for Error::Gateway variant (serenity-rs#2847)

13e3f9c

This was mistakenly removed in serenity-rs#2278 and wasn't caught because of the wildcard pattern in the match.

Remove multiple event handler support (serenity-rs#2849)

ad3eb13

Use RwLock for active collectors collection (serenity-rs#2851)

a422d35

Provide old presence data from the cache on presence update (serenity…

9082254

…-rs#2852)

Allow filtering events before they are dispatched (serenity-rs#2853)

f257da9

Implement ToArrayString for Mention (serenity-rs#2857)

3a8afed

Add PartialGuild::greater_member_hierarchy + member_highest_role (ser…

4d0a906

…enity-rs#2856)

Remove recently deprecated items

9c918c9

Update bool_to_bitflags to fix compilation without unstable

27d9a62

Remove RUSTFLAGS from .cargo/config.toml (serenity-rs#2875)

68e5e62

This isn't needed anymore because simd-json has been removed on `next`.

GnomedDev force-pushed the next branch from 8d52f25 to 68e5e62 Compare May 28, 2024 14:58

Add ws_proxy option for connecting gateway through a proxy.

a3d2438

zzzzRuby force-pushed the akira-bot-ws-proxy branch from b6226fb to a3d2438 Compare June 8, 2024 12:59

GnomedDev force-pushed the next branch from 68e5e62 to 3e03891 Compare June 9, 2024 23:04

GnomedDev force-pushed the next branch 2 times, most recently from c01e57d to 842373b Compare June 22, 2024 20:38

arqunis force-pushed the next branch from adf4673 to 61d6ddb Compare July 30, 2024 17:27

GnomedDev force-pushed the next branch from 9d41131 to b167b4d Compare August 16, 2024 13:22

GnomedDev closed this Sep 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ws_proxy option for connecting gateway through a proxy. #2709

Add ws_proxy option for connecting gateway through a proxy. #2709

zzzzRuby commented Jan 12, 2024 •

edited

Loading

cheesycod commented Jan 12, 2024

GnomedDev commented Jan 12, 2024

zzzzRuby commented Jan 13, 2024

GnomedDev commented Jan 13, 2024

zzzzRuby commented Jan 13, 2024

GnomedDev left a comment

GnomedDev Jan 13, 2024

zzzzRuby Jan 20, 2024

mkrasnitski Jan 20, 2024

GnomedDev Jan 13, 2024

Itsusinn Jan 14, 2024

zzzzRuby Jan 20, 2024

mlesin commented Sep 30, 2024

GnomedDev commented Sep 30, 2024

qthree commented Oct 9, 2024 •

edited

Loading

Add ws_proxy option for connecting gateway through a proxy. #2709

Add ws_proxy option for connecting gateway through a proxy. #2709

Conversation

zzzzRuby commented Jan 12, 2024 • edited Loading

cheesycod commented Jan 12, 2024

GnomedDev commented Jan 12, 2024

zzzzRuby commented Jan 13, 2024

GnomedDev commented Jan 13, 2024

zzzzRuby commented Jan 13, 2024

GnomedDev left a comment

Choose a reason for hiding this comment

GnomedDev Jan 13, 2024

Choose a reason for hiding this comment

zzzzRuby Jan 20, 2024

Choose a reason for hiding this comment

mkrasnitski Jan 20, 2024

Choose a reason for hiding this comment

GnomedDev Jan 13, 2024

Choose a reason for hiding this comment

Itsusinn Jan 14, 2024

Choose a reason for hiding this comment

zzzzRuby Jan 20, 2024

Choose a reason for hiding this comment

mlesin commented Sep 30, 2024

GnomedDev commented Sep 30, 2024

qthree commented Oct 9, 2024 • edited Loading

zzzzRuby commented Jan 12, 2024 •

edited

Loading

qthree commented Oct 9, 2024 •

edited

Loading