Skip to content

refactor(WebSocketShard): error event handling #10436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 15, 2024
Merged

refactor(WebSocketShard): error event handling #10436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3cf1d56
refactor(WebSocketShard): error event handling
didinele Aug 8, 2024
7b273a1
chore: blehhhh :pppp
didinele Aug 8, 2024
be331e3
Merge branch 'main' into fix/ws-retry-5xx
kodiakhq[bot] Aug 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions packages/ws/src/utils/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,5 +82,3 @@ export function getInitialSendRateLimitState(): SendRateLimitState {
resetAt: Date.now() + 60_000,
};
}

export const KnownNetworkErrorCodes = new Set(['ECONNRESET', 'ECONNREFUSED', 'ETIMEDOUT', 'EAI_AGAIN']);
1 change: 1 addition & 0 deletions packages/ws/src/ws/WebSocketManager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,7 @@ export interface ManagerShardEventsMap {
stats: { ackAt: number; heartbeatAt: number; latency: number },
shardId: number,
];
[WebSocketShardEvents.SocketError]: [error: Error, shardId: number];
}

export class WebSocketManager extends AsyncEventEmitter<ManagerShardEventsMap> implements AsyncDisposable {
Expand Down
12 changes: 4 additions & 8 deletions packages/ws/src/ws/WebSocketShard.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ import {
CompressionMethod,
CompressionParameterMap,
ImportantGatewayOpcodes,
KnownNetworkErrorCodes,
getInitialSendRateLimitState,
} from '../utils/constants.js';
import type { SessionInfo } from './WebSocketManager.js';
Expand All @@ -45,6 +44,7 @@ export enum WebSocketShardEvents {
Hello = 'hello',
Ready = 'ready',
Resumed = 'resumed',
SocketError = 'socketError',
}

export enum WebSocketShardStatus {
Expand All @@ -68,6 +68,7 @@ export interface WebSocketShardEventsMap {
[WebSocketShardEvents.Ready]: [payload: GatewayReadyDispatchData];
[WebSocketShardEvents.Resumed]: [];
[WebSocketShardEvents.HeartbeatComplete]: [stats: { ackAt: number; heartbeatAt: number; latency: number }];
[WebSocketShardEvents.SocketError]: [error: Error];
}

export interface WebSocketShardDestroyOptions {
Expand Down Expand Up @@ -791,13 +792,8 @@ export class WebSocketShard extends AsyncEventEmitter<WebSocketShardEventsMap> {
}

private onError(error: Error) {
if ('code' in error && KnownNetworkErrorCodes.has(error.code as string)) {
this.debug(['Failed to connect to the gateway URL specified due to a network error']);
this.failedToConnectDueToNetworkError = true;
return;
}

this.emit(WebSocketShardEvents.Error, error);
this.emit(WebSocketShardEvents.SocketError, error);
this.failedToConnectDueToNetworkError = true;
}

private async onClose(code: number) {
Expand Down