feat(ClientOptions): waitGuildTimeout amount client option #6576

kylerchin · 2021-09-01T06:09:05Z

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

Sometimes bots hang while connecting for 15 seconds because 1 single guild is messed up. For bots with Continuous integration, this can create significant impacts to uptime, user experience, and lag.

This adds the optional fetchGuildTimeout option under ClientOptions, where the bot developer can optionally specify how long the client should hang for. If not specified, this will remain the default 15 seconds.

I'm happy to discuss how this can be improved, including the names of the options and variables, and I'd also be happy to write documentation!

👉🏻👈🏻 my first pr to this repo, I'm honoured I can be a part of this community.

EDIT: I'm wondering if the "in X sec" should be changed to "in X ms".

Status and versioning classification:

Code changes have been tested against the Discord API, or there are no code changes
I know how to update typings and have done so, or typings don't need updating
This PR changes the library's interface (methods or parameters added)

kylerchin · 2021-09-01T06:22:32Z

P.S. I've added this to my own bot, cutting the startup time in half in 1 line of code
Before

After 3000ms setting, exact reduction of 12 sec

DTrombett

This is also missing documentation and validation in the Client class.

src/client/websocket/WebSocketShard.js

manuelvleeuwen · 2021-09-01T08:20:57Z

Wouldn't shardReadyTimeout be a more appropriate name for this?

Co-authored-by: D Trombett <73136330+DTrombett@users.noreply.github.com>

kylerchin · 2021-09-01T18:50:55Z

I've tried my best to make the recommended changes, let me know if we need to change anything else or we have any other thoughts about this before merging.

typings: Collector filter parameter inference (discordjs#6574)

ImRodry · 2021-09-01T19:16:13Z

Yeah I’m pretty sure that text you added goes over the 120 char limit, you should install ESLint to be aware of these things since the CI requires approval to run

src/client/websocket/WebSocketShard.js

Co-authored-by: Hackerboi 69 <62872992+thehackerboi69github@users.noreply.github.com>

src/client/websocket/WebSocketShard.js

DTrombett · 2021-09-01T22:07:13Z

You can add the default value for this option in the Options.createDefault() static method:

discord.js/src/util/Options.js

Line 110 in 0841956

static createDefault() {

And add validation in the Client#_validateOptions() method:

discord.js/src/client/Client.js

Line 542 in 0841956

_validateOptions(options = this.options) {

kylerchin · 2021-09-01T22:33:55Z

I'm debating if this should be titled "fetchGuildTimeout" or "fetchGuildsTimeout" or something else. I'm happy to discuss this and improve the experience for developers.

src/client/websocket/WebSocketShard.js

Co-authored-by: monbrey <rsm999@uowmail.edu.au>

src/util/Options.js

Co-authored-by: Hackerboi 69 <62872992+thehackerboi69github@users.noreply.github.com>

kylerchin · 2021-11-11T20:38:32Z

everything in here looks done!

let me know if anything else needs to be changed, otherwise, this will be it! happy that this will get merged soon!

manuelvleeuwen · 2021-11-11T20:43:09Z

The default value is still not in Options.createDefault()

Jiralite · 2021-11-11T20:44:44Z

Check the reviews I submitted also.

dfsdfsdfsdfsdf

merge back

manuelvleeuwen · 2021-11-28T07:52:41Z

What does.that last commit have to do with this PR?

kylerchin · 2021-11-28T20:04:02Z

It fixes a bug in the discord name acronym system. Apologies.

…

On Sat, Nov 27, 2021 at 11:52 PM Hackerboi 69 ***@***.***> wrote: What does.that last commit have to do with this PR? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#6576 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABZQTZVQWAA2UTSZKG33KM3UOHNVHANCNFSM5DFV2GAA> .

src/structures/BaseGuild.js

kylerchin · 2021-11-29T22:22:12Z

I reverted the changes. Really sorry.

kylerchin · 2021-11-29T22:33:01Z

Those changes have been moved to #7050

manuelvleeuwen · 2021-11-30T06:56:03Z

The default value is still not in Options.createDefault()

vladfrangu

The default is still not added in Options.createDefault()

kylerchin · 2021-12-23T21:57:47Z

Apologies for not updating this, I will change it.

Sorry, i've been busy with finals.

kylerchin · 2021-12-23T22:02:55Z

Again, i'm really sorry about the delay. I added it to options now

vladfrangu · 2021-12-24T12:58:57Z

All I want for Christmas..issss... a rebaseeeeee 🎵

Stale

fetch guild timeout amount option

3b846b9

DTrombett reviewed Sep 1, 2021

View reviewed changes

src/client/websocket/WebSocketShard.js Outdated Show resolved Hide resolved

src/client/websocket/WebSocketShard.js Outdated Show resolved Hide resolved

kylerchin and others added 4 commits September 1, 2021 09:53

Update src/client/websocket/WebSocketShard.js

6d5a426

Co-authored-by: D Trombett <73136330+DTrombett@users.noreply.github.com>

Options for client

08a088e

change to milliseconds

8805731

additional timeout what zero means

2980212

kylerchin added 2 commits September 1, 2021 12:10

if not specified note

aa5b300

Merge pull request #1 from discordjs/main

f6ca9e9

typings: Collector filter parameter inference (discordjs#6574)

manuelvleeuwen reviewed Sep 1, 2021

View reviewed changes

src/client/websocket/WebSocketShard.js Outdated Show resolved Hide resolved

kylerchin and others added 2 commits September 1, 2021 13:36

Update src/client/websocket/WebSocketShard.js

0650264

Co-authored-by: Hackerboi 69 <62872992+thehackerboi69github@users.noreply.github.com>

fix line length lint issue

895da0d

ImRodry reviewed Sep 1, 2021

View reviewed changes

src/client/websocket/WebSocketShard.js Outdated Show resolved Hide resolved

kylerchin added 3 commits September 1, 2021 15:26

prettier style formatting

ce80fc8

Add validation

32f6459

Add default value

3a2c32a

monbrey reviewed Sep 1, 2021

View reviewed changes

src/client/websocket/WebSocketShard.js Outdated Show resolved Hide resolved

Update src/client/websocket/WebSocketShard.js

5373716

Co-authored-by: monbrey <rsm999@uowmail.edu.au>

manuelvleeuwen reviewed Sep 2, 2021

View reviewed changes

src/util/Options.js Outdated Show resolved Hide resolved

kylerchin and others added 2 commits September 2, 2021 15:13

Update src/util/Options.js

a8e686e

Co-authored-by: Hackerboi 69 <62872992+thehackerboi69github@users.noreply.github.com>

fix doccumentation

4460fdc

iCrawl requested review from SpaceEEC, kyranet and vladfrangu September 3, 2021 12:03

iCrawl added the semver:minor label Sep 3, 2021

kyranet approved these changes Nov 11, 2021

View reviewed changes

iCrawl modified the milestones: Version 13.4, Version 13.x Nov 11, 2021

kylerchin added 3 commits November 22, 2021 19:15

Merge pull request #4 from discordjs/main

0e53da5

dfsdfsdfsdfsdf

Merge pull request #5 from discordjs/main

e97ed36

merge back

Update BaseGuild.js

dfeaa93

kyranet requested changes Nov 29, 2021

View reviewed changes

src/structures/BaseGuild.js Outdated Show resolved Hide resolved

Update BaseGuild.js

0e35afa

kyranet approved these changes Nov 30, 2021

View reviewed changes

thebigwolfy approved these changes Nov 30, 2021

View reviewed changes

vladfrangu previously requested changes Dec 3, 2021

View reviewed changes

Update Options.js

c94018a

iCrawl requested a review from vladfrangu December 24, 2021 10:57

Merge branch 'main' into main

7ce42b6

iCrawl approved these changes Dec 24, 2021

View reviewed changes

vladfrangu approved these changes Dec 24, 2021

View reviewed changes

iCrawl changed the title ~~Creates the waitGuildTimeout amount client option~~ feat(ClientOptions): waitGuildTimeout amount client option Dec 24, 2021

iCrawl merged commit 2bfc638 into discordjs:main Dec 24, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(ClientOptions): waitGuildTimeout amount client option #6576

feat(ClientOptions): waitGuildTimeout amount client option #6576

kylerchin commented Sep 1, 2021 •

edited

kylerchin commented Sep 1, 2021 •

edited

DTrombett left a comment

manuelvleeuwen commented Sep 1, 2021

kylerchin commented Sep 1, 2021

ImRodry commented Sep 1, 2021

DTrombett commented Sep 1, 2021 •

edited

kylerchin commented Sep 1, 2021

kylerchin commented Nov 11, 2021

manuelvleeuwen commented Nov 11, 2021

Jiralite commented Nov 11, 2021

manuelvleeuwen commented Nov 28, 2021

kylerchin commented Nov 28, 2021 via email

kylerchin commented Nov 29, 2021

kylerchin commented Nov 29, 2021

manuelvleeuwen commented Nov 30, 2021

vladfrangu left a comment

kylerchin commented Dec 23, 2021

kylerchin commented Dec 23, 2021

vladfrangu commented Dec 24, 2021

feat(ClientOptions): waitGuildTimeout amount client option #6576

feat(ClientOptions): waitGuildTimeout amount client option #6576

Conversation

kylerchin commented Sep 1, 2021 • edited

kylerchin commented Sep 1, 2021 • edited

DTrombett left a comment

Choose a reason for hiding this comment

manuelvleeuwen commented Sep 1, 2021

kylerchin commented Sep 1, 2021

ImRodry commented Sep 1, 2021

DTrombett commented Sep 1, 2021 • edited

kylerchin commented Sep 1, 2021

kylerchin commented Nov 11, 2021

manuelvleeuwen commented Nov 11, 2021

Jiralite commented Nov 11, 2021

manuelvleeuwen commented Nov 28, 2021

kylerchin commented Nov 28, 2021 via email

kylerchin commented Nov 29, 2021

kylerchin commented Nov 29, 2021

manuelvleeuwen commented Nov 30, 2021

vladfrangu left a comment

Choose a reason for hiding this comment

kylerchin commented Dec 23, 2021

kylerchin commented Dec 23, 2021

vladfrangu commented Dec 24, 2021

kylerchin commented Sep 1, 2021 •

edited

kylerchin commented Sep 1, 2021 •

edited

DTrombett commented Sep 1, 2021 •

edited