dan/discord.js
1
0
Fork 0
mirror of https://github.com/danbulant/discord.js synced 2026-06-24 01:01:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add ClientOptions.restTimeOffset for better performance for bots with a good network connection

Browse source
This commit is contained in:
Amish Shah 2016-12-24 12:13:42 +00:00
parent 3eca3ba95e
commit 544e456302
4 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/client/rest/RequestHandlers/Burst.js
View file

@ -29,7 +29,7 @@ class BurstRequestHandler extends RequestHandler {
this.requestResetTime = Number(res.headers['x-ratelimit-reset']) * 1000;
this.requestRemaining = Number(res.headers['x-ratelimit-remaining']);
this.timeDifference = Date.now() - new Date(res.headers.date).getTime();
this.handleNext((this.requestResetTime - Date.now()) + this.timeDifference + 1000);
this.handleNext((this.requestResetTime - Date.now()) + this.timeDifference + this.restManager.client.options.restTimeOffset);
}
if (err) {
if (err.status === 429) {
@ -38,7 +38,7 @@ class BurstRequestHandler extends RequestHandler {
this.restManager.client.setTimeout(() => {
this.globalLimit = false;
this.handle();
}, Number(res.headers['retry-after']) + 500);
}, Number(res.headers['retry-after']) + this.restManager.client.options.restTimeOffset);
if (res.headers['x-ratelimit-global']) {
this.globalLimit = true;
}

4
src/client/rest/RequestHandlers/Sequential.js
View file

@ -60,7 +60,7 @@ class SequentialRequestHandler extends RequestHandler {
this.waiting = false;
this.globalLimit = false;
resolve();
}, Number(res.headers['retry-after']) + 500);
}, Number(res.headers['retry-after']) + this.restManager.client.options.restTimeOffset);
if (res.headers['x-ratelimit-global']) {
this.globalLimit = true;
}
@ -79,7 +79,7 @@ class SequentialRequestHandler extends RequestHandler {
this.restManager.client.setTimeout(() => {
this.waiting = false;
resolve(data);
}, (this.requestResetTime - Date.now()) + this.timeDifference + 1000);
}, (this.requestResetTime - Date.now()) + this.timeDifference + this.restManager.client.options.restTimeOffset);
} else {
this.waiting = false;
resolve(data);

3
src/util/Constants.js
View file

@ -20,6 +20,8 @@ exports.Package = require('../../package.json');
* @property {boolean} [sync=false] Whether to periodically sync guilds (for userbots)
* @property {number} [restWsBridgeTimeout=5000] Maximum time permitted between REST responses and their
* corresponding websocket events
* @property {number} [restTimeOffset=500] The extra time in millseconds to wait before continuing to make REST
* requests (higher values will reduce rate-limiting errors on bad connections)
* @property {WSEventType[]} [disabledEvents] An array of disabled websocket events. Events in this array will not be
* processed, potentially resulting in performance improvements for larger bots. Only disable events you are
* 100% certain you don't need, as many are important, but not obviously so. The safest one to disable with the
@ -38,6 +40,7 @@ exports.DefaultOptions = {
sync: false,
restWsBridgeTimeout: 5000,
disabledEvents: [],
restTimeOffset: 500,
/**
* Websocket options. These are left as snake_case to match the API.

5
test/random.js
View file

@ -117,10 +117,15 @@ client.on('message', message => {
if (message.content === 'ratelimittest') {
let i = 1;
const start = Date.now();
while (i <= 20) {
message.channel.sendMessage(`Testing my rates, item ${i} of 20`);
i++;
}
message.channel.sendMessage('last one...').then(m => {
const diff = Date.now() - start;
m.reply(`Each message took ${diff / 21}ms to send`);
});
}
if (message.content === 'makerole') {