Add `fetchGatewayInformation` to ws 1.x

[Digital39999]

Which package is this bug report for?

discord.js

Issue description

When passing custom WebSocket options to the Client constructor, the ws property is currently typed to only allow large_threshold, version, buildStrategy, and buildIdentifyThrottler.
Even though WebSocketManager internally supports these options, the typings in ClientOptions block their use and specifically overrides fetchGatewayInformation.

I have tried to go around that in #11070 before realization that this should already be supported in different way, would've directly made pr for that, but I have no clue where/how WebSocketOptions are generated.

Issue location: Client.js lines 166–167

Code sample

const client = new Client({
	intents: [
		GatewayIntentBits.Guilds,
		GatewayIntentBits.GuildMessages,
		GatewayIntentBits.MessageContent,
	],
	ws: {
		// 'fetchGatewayInformation' does not exist in type 'WebSocketOptions'.
		fetchGatewayInformation: () => {
			return {
				url: 'wss://gateway.discord.gg',
			};
		},
	},
});

Versions

• discord.js 14.22.1
• Node.js 22.12.0
• TypeScript 5.1.6

Issue priority

Medium (should be fixed soon)

Which partials do you have configured?

Not applicable

Which gateway intents are you subscribing to?

Not applicable

I have tested this issue on a development release

No response

[Jiralite]

It seems you are tallking about v14. So:

Even though WebSocketManager internally supports these options, the typings in ClientOptions block their use and specifically overrides fetchGatewayInformation.

Does not seem true:

discord.js/packages/discord.js/src/client/websocket/WebSocketManager.js

Lines 139 to 166 in fe025c0

	async connect() {
	const invalidToken = new DiscordjsError(ErrorCodes.TokenInvalid);
	const { shards, shardCount, intents, ws } = this.client.options;
	if (this._ws && this._ws.options.token !== this.client.token) {
	await this._ws.destroy({ code: CloseCodes.Normal, reason: 'Login with differing token requested' });
	this._ws = null;
	}
	if (!this._ws) {
	const wsOptions = {
	intents: intents.bitfield,
	rest: this.client.rest,
	token: this.client.token,
	largeThreshold: ws.large_threshold,
	version: ws.version,
	shardIds: shards === 'auto' ? null : shards,
	shardCount: shards === 'auto' ? null : shardCount,
	initialPresence: ws.presence,
	retrieveSessionInfo: shardId => this.shards.get(shardId).sessionInfo,
	updateSessionInfo: (shardId, sessionInfo) => {
	this.shards.get(shardId).sessionInfo = sessionInfo;
	},
	compression: zlib ? CompressionMethod.ZlibStream : null,
	};
	if (ws.buildIdentifyThrottler) wsOptions.buildIdentifyThrottler = ws.buildIdentifyThrottler;
	if (ws.buildStrategy) wsOptions.buildStrategy = ws.buildStrategy;
	this._ws = new WSWebSocketManager(wsOptions);
	this.attachEvents();
	}

Furthermore, your code sample does not make sense as v14 does not have that as an option (@discordjs/ws does not even expose that as an option). I noticed you are linking main of that package, but v14 is not using that. It is using v1.

So I have to ask what you are trying to accomplish, as it seems everything in this issue is not true.

[Digital39999]

My goal was to accomplish what was described in this comment on #11070: passing a fetchGatewayInformation function via the WebSocket options so that the /gateway/bot request could be customized, including changing the resulting gateway URL.

This was the purpose of PR #10651 (merged into main), which explicitly added support for fetching gateway information without requiring @discordjs/rest and allowing custom gateway URLs.

It now seems that, in v14, this is no longer possible because the typings for ClientOptions.ws do not expose fetchGatewayInformation, even though that functionality was meant to be supported in @discordjs/ws.

Is there any way to achieve this at the moment with v14, or is it entirely unavailable?

[almeidx]

It seems you might be misunderstanding the branches here. main is currently v15-dev of discord.js, and v3-dev of /ws.

discord.js v14 is in the v14 branch, which uses /ws v1 through a compatibility layer, which is in the ws/1.x branch.

Additionally, the #10651 pull request is actually not on any stable version of /ws yet

[Digital39999]

Thanks for the clarification. That makes a lot more sense now. I had assumed #10651 was already available in the version of @discordjs/ws used by discord.js v14. Sorry for misunderstanding.

Where all this supposed to be addressed now if it doesn’t exist at all?