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(FetchRecommendedShardsOptions): account for large bot sharding #6184

Merged
merged 6 commits into from Jul 29, 2021
Merged

feat(FetchRecommendedShardsOptions): account for large bot sharding #6184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d9f0749
feat(FetchRecommendedShardsOptions): account for large bot sharding
scottbucher Jul 26, 2021
03837ce
Update src/util/Util.js
scottbucher Jul 26, 2021
9847623
Update src/util/Util.js
scottbucher Jul 26, 2021
8ceda82
Update Util.js
scottbucher Jul 26, 2021
ec1848f
feat(FetchRecommendedShardsOptions): replace boolean with multiple of
scottbucher Jul 28, 2021
aae5217
Update datatype of multipleOf
scottbucher Jul 28, 2021
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
12 changes: 9 additions & 3 deletions src/util/Util.js
View file
Open in desktop
Expand Up @@ -254,13 +254,19 @@ class Util extends null {
return text.replace(/\|\|/g, '\\|\\|');
}

/**
* @typedef {Object} FetchRecommendedShardsOptions
* @property {number} [guildsPerShard=1000] Number of guilds assigned per shard
* @property {number} [multipleOf=1] The multiple the shard count should round up to. (16 for large bot sharding)
*/

/**
* Gets the recommended shard count from Discord.
* @param {string} token Discord auth token
* @param {number} [guildsPerShard=1000] Number of guilds per shard
* @param {FetchRecommendedShardsOptions} [options] Options for fetching the recommended shard count
* @returns {Promise<number>} The recommended number of shards
*/
static fetchRecommendedShards(token, guildsPerShard = 1000) {
static fetchRecommendedShards(token, { guildsPerShard = 1000, multipleOf = 1 } = {}) {
if (!token) throw new DiscordError('TOKEN_MISSING');
const defaults = Options.createDefault();
return fetch(`${defaults.http.api}/v${defaults.http.version}${Endpoints.botGateway}`, {
Expand All @@ -272,7 +278,7 @@ class Util extends null {
if (res.status === 401) throw new DiscordError('TOKEN_INVALID');
throw res;
})
.then(data => data.shards * (1000 / guildsPerShard));
.then(data => Math.ceil((data.shards * (1000 / guildsPerShard)) / multipleOf) * multipleOf);
}

/**
Expand Down
7 changes: 6 additions & 1 deletion typings/index.d.ts
View file
Open in desktop
Expand Up @@ -1531,6 +1531,11 @@ export class ShardingManager extends EventEmitter {
public once(event: 'shardCreate', listener: (shard: Shard) => Awaited<void>): this;
}

export interface FetchRecommendedShardsOptions {
guildsPerShard?: number;
multipleOf?: number;
}

export class SnowflakeUtil extends null {
private constructor();
public static deconstruct(snowflake: Snowflake): DeconstructedSnowflake;
Expand Down Expand Up @@ -1791,7 +1796,7 @@ export class Util extends null {
public static escapeStrikethrough(text: string): string;
public static escapeSpoiler(text: string): string;
public static cleanCodeBlockContent(text: string): string;
public static fetchRecommendedShards(token: string, guildsPerShard?: number): Promise<number>;
public static fetchRecommendedShards(token: string, options?: FetchRecommendedShardsOptions): Promise<number>;
public static flatten(obj: unknown, ...props: Record<string, boolean | string>[]): unknown;
public static idToBinary(num: Snowflake): string;
public static makeError(obj: MakeErrorOptions): Error;
Expand Down