Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-10 00:23:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

refactor(WebSocketShard): payload sending (#10098)

Browse Source 
* refactor(WebSocketShard): payload sending

* fix: adjust ratelimit state onopen

* fix: use >=

* chore: spelling

Co-authored-by: space <spaceeec@yahoo.com>

---------

Co-authored-by: space <spaceeec@yahoo.com>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
DD
2024-02-05 20:42:33 +02:00
committed by GitHub
parent f401cff3f4
commit c878b65ef5
2 changed files with 42 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
packages/ws/src/utils/constants.ts
View File

@@ -71,7 +71,7 @@ export const ImportantGatewayOpcodes = new Set([
export function getInitialSendRateLimitState(): SendRateLimitState {
return {
remaining: 120,
sent: 0,
resetAt: Date.now() + 60_000,
};
}

69
packages/ws/src/ws/WebSocketShard.ts
View File

@@ -75,8 +75,8 @@ export enum CloseCodes {
}
export interface SendRateLimitState {
remaining: number;
resetAt: number;
sent: number;
}
const WebSocketConstructor: typeof WebSocket = shouldUseGlobalFetchAndWebSocket()
@@ -203,12 +203,14 @@ export class WebSocketShard extends AsyncEventEmitter<WebSocketShardEventsMap> {
void this.onClose(event.code);
};
connection.onopen = () => {
this.sendRateLimitState = getInitialSendRateLimitState();
};
this.connection = connection;
this.#status = WebSocketShardStatus.Connecting;
this.sendRateLimitState = getInitialSendRateLimitState();
const { ok } = await this.waitForEvent(WebSocketShardEvents.Hello, this.strategy.options.helloTimeout);
if (!ok) {
return;
@@ -357,6 +359,15 @@ export class WebSocketShard extends AsyncEventEmitter<WebSocketShardEventsMap> {
throw new Error("WebSocketShard wasn't connected");
}
// Generally, the way we treat payloads is 115/60 seconds. The actual limit is 120/60, so we have a bit of leeway.
// We use that leeway for those special payloads that we just fire with no checking, since there's no shot we ever
// send more than 5 of those in a 60 second interval. This way we can avoid more complex queueing logic.
if (ImportantGatewayOpcodes.has(payload.op)) {
this.connection.send(JSON.stringify(payload));
return;
}
if (this.#status !== WebSocketShardStatus.Ready && !ImportantGatewayOpcodes.has(payload.op)) {
this.debug(['Tried to send a non-crucial payload before the shard was ready, waiting']);
// This will throw if the shard throws an error event in the meantime, just requeue the payload
@@ -369,34 +380,36 @@ export class WebSocketShard extends AsyncEventEmitter<WebSocketShardEventsMap> {
await this.sendQueue.wait();
if (--this.sendRateLimitState.remaining <= 0) {
const now = Date.now();
if (this.sendRateLimitState.resetAt > now) {
const sleepFor = this.sendRateLimitState.resetAt - now;
this.debug([`Was about to hit the send rate limit, sleeping for ${sleepFor}ms`]);
const controller = new AbortController();
// Sleep for the remaining time, but if the connection closes in the meantime, we shouldn't wait the remainder to avoid blocking the new conn
const interrupted = await Promise.race([
sleep(sleepFor).then(() => false),
once(this, WebSocketShardEvents.Closed, { signal: controller.signal }).then(() => true),
]);
if (interrupted) {
this.debug(['Connection closed while waiting for the send rate limit to reset, re-queueing payload']);
this.sendQueue.shift();
return this.send(payload);
}
// This is so the listener from the `once` call is removed
controller.abort();
}
const now = Date.now();
if (now >= this.sendRateLimitState.resetAt) {
this.sendRateLimitState = getInitialSendRateLimitState();
}
if (this.sendRateLimitState.sent + 1 >= 115) {
// Sprinkle in a little randomness just in case.
const sleepFor = this.sendRateLimitState.resetAt - now + Math.random() * 1_500;
this.debug([`Was about to hit the send rate limit, sleeping for ${sleepFor}ms`]);
const controller = new AbortController();
// Sleep for the remaining time, but if the connection closes in the meantime, we shouldn't wait the remainder to avoid blocking the new conn
const interrupted = await Promise.race([
sleep(sleepFor).then(() => false),
once(this, WebSocketShardEvents.Closed, { signal: controller.signal }).then(() => true),
]);
if (interrupted) {
this.debug(['Connection closed while waiting for the send rate limit to reset, re-queueing payload']);
this.sendQueue.shift();
return this.send(payload);
}
// This is so the listener from the `once` call is removed
controller.abort();
}
this.sendRateLimitState.sent++;
this.sendQueue.shift();
this.connection.send(JSON.stringify(payload));
}