feat: fetch gateway information without requiring rest in ws

[vladfrangu]

Please describe the changes this PR makes and why it should be merged:

Currently the only way to override the gateway URL that /ws will connect to is by intercepting the rest request and overriding it. This PR lets you pick a different ws url, if you may be proxying it or have custom implementations or what not.

Status and versioning classification:

• Code changes have been tested against the Discord API, or there are no code changes
• This PR changes the library's interface (methods or parameters added)

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
discord-js	⬜️ Ignored (Inspect)	Visit Preview		Jan 13, 2025 10:21am
discord-js-guide	⬜️ Ignored (Inspect)	Visit Preview		Jan 13, 2025 10:21am

[codecov]

Codecov Report

Attention: Patch coverage is 64.70588% with 6 lines in your changes missing coverage. Please review.

Project coverage is 37.29%. Comparing base (ae0265e) to head (03ca1d6).
Report is 4 commits behind head on main.

Files with missing lines	Patch %	Lines
packages/ws/src/ws/WebSocketManager.ts	62.50%	5 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #10651      +/-   ##
==========================================
- Coverage   38.00%   37.29%   -0.71%     
==========================================
  Files         239      239              
  Lines       14884    15164     +280     
  Branches     1385     1386       +1     
==========================================
- Hits         5657     5656       -1     
- Misses       9216     9496     +280     
- Partials       11       12       +1     

Flag	Coverage Δ
ws	34.68% <64.70%> (+0.23%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[didinele]

This looks good. Just one classic mistake I've made a few times too, callbacks aren't encodeable over worker_threads, so this needs updating, otherwise we get hard crashes:

discord.js/packages/ws/src/strategies/context/IContextFetchingStrategy.ts

Lines 5 to 18 in 5d00332

	export interface FetchingStrategyOptions
	extends Omit<
	WebSocketManagerOptions,
	| 'buildIdentifyThrottler'
	| 'buildStrategy'
	| 'rest'
	| 'retrieveSessionInfo'
	| 'shardCount'
	| 'shardIds'
	| 'updateSessionInfo'
	> {
	readonly gatewayInformation: APIGatewayBotInfo;
	readonly shardCount: number;
	}

Along with its runtime counter-part:

discord.js/packages/ws/src/strategies/context/IContextFetchingStrategy.ts

Lines 35 to 53 in 5d00332

	export async function managerToFetchingStrategyOptions(manager: WebSocketManager): Promise<FetchingStrategyOptions> {
	const {
	buildIdentifyThrottler,
	buildStrategy,
	retrieveSessionInfo,
	updateSessionInfo,
	shardCount,
	shardIds,
	rest,
	...managerOptions
	} = manager.options;
	return {
	...managerOptions,
	token: manager.token,
	gatewayInformation: await manager.fetchGatewayInformation(),
	shardCount: await manager.getShardCount(),
	};
	}

In the future I'll probably rewrite this to a Pick 😅

[almeidx]

Seems the README and tests need updating

[didinele]

this needs a rebase now

Stale