Skip to content
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

Jump to bottom

feat: support resume urls #8784

Merged
merged 8 commits into from
Oct 31, 2022
Merged

feat: support resume urls #8784

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a38a1eb
feat: support resume url
Deivu Oct 25, 2022
f66ccae
feat: support resume url
Deivu Oct 25, 2022
ab99369
chore: update typings
Deivu Oct 25, 2022
9634ca4
refactor: use ?? instead of ||
Deivu Oct 25, 2022
213d210
chore: lint project
Deivu Oct 26, 2022
9377a26
Merge branch 'main' of https://github.com/Deivu/discord.js
Deivu Oct 26, 2022
a64dc18
fix: reset resumeUrl if requested
Deivu Oct 27, 2022
7abccd1
chore: capitalize abbreviations
Deivu Oct 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 14 additions & 3 deletions packages/discord.js/src/client/websocket/WebSocketShard.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,13 @@ class WebSocketShard extends EventEmitter {
*/
this.sessionId = null;

/**
* The resume url for this shard
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The resume url for this shard
* The resume URL for this shard

* @type {?string}
* @private
*/
this.resumeURL = null;

/**
* The previous heartbeat ping of the shard
* @type {number}
Expand Down Expand Up @@ -193,12 +200,14 @@ class WebSocketShard extends EventEmitter {
* or reject if we couldn't connect
*/
connect() {
const { gateway, client } = this.manager;
const { client } = this.manager;

if (this.connection?.readyState === WebSocket.OPEN && this.status === Status.Ready) {
return Promise.resolve();
}

const gateway = this.resumeURL ?? this.manager.gateway;

return new Promise((resolve, reject) => {
const cleanup = () => {
this.removeListener(WebSocketShardEvents.Close, onClose);
Expand Down Expand Up @@ -416,9 +425,10 @@ class WebSocketShard extends EventEmitter {
this.emit(WebSocketShardEvents.Ready);

this.sessionId = packet.d.session_id;
this.resumeURL = packet.d.resume_gateway_url;
this.expectedGuilds = new Set(packet.d.guilds.map(d => d.id));
this.status = Status.WaitingForGuilds;
this.debug(`[READY] Session ${this.sessionId}.`);
this.debug(`[READY] Session ${this.sessionId} | Resume url ${this.resumeURL}.`);
this.lastHeartbeatAcked = true;
this.sendHeartbeat('ReadyHeartbeat');
break;
Expand Down Expand Up @@ -842,10 +852,11 @@ class WebSocketShard extends EventEmitter {
// Step 4: Cache the old sequence (use to attempt a resume)
if (this.sequence !== -1) this.closeSequence = this.sequence;

// Step 5: Reset the sequence and session id if requested
// Step 5: Reset the sequence, resume url and session id if requested
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Step 5: Reset the sequence, resume url and session id if requested
// Step 5: Reset the sequence, resume URL and session id if requested

if (reset) {
this.sequence = -1;
this.sessionId = null;
this.resumeURL = null;
}

// Step 6: reset the rate limit data
Expand Down
1 change: 1 addition & 0 deletions packages/discord.js/typings/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2994,6 +2994,7 @@ export class WebSocketShard extends EventEmitter {
private sequence: number;
private closeSequence: number;
private sessionId: string | null;
private resumeURL: string | null;
private lastPingTimestamp: number;
private lastHeartbeatAcked: boolean;
private readonly ratelimit: {
Expand Down