1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
//! Routes are used for ratelimiting. These are to differentiate between the different _types_ of
//! routes - such as getting the current user's channels - for the most part, with the exception
//! being major parameters.
//!
//! [Taken from] the Discord docs, major parameters are:
//!
//! > Additionally, rate limits take into account major parameters in the URL. For example,
//! > `/channels/:channel_id` and `/channels/:channel_id/messages/:message_id` both take
//! > `channel_id` into account when generating rate limits since it's the major parameter. The
//! > only current major parameters are `channel_id`, `guild_id` and `webhook_id`.
//!
//! This results in the two URLs of `GET /channels/4/messages/7` and `GET /channels/5/messages/8`
//! being rate limited _separately_. However, the two URLs of `GET /channels/10/messages/11` and
//! `GET /channels/10/messages/12` will count towards the "same ratelimit", as the major parameter
//! - `10` is equivalent in both URLs' format.
//!
//! # Examples
//!
//! First: taking the first two URLs - `GET /channels/4/messages/7` and `GET
//! /channels/5/messages/8` - and assuming both buckets have a `limit` of `10`, requesting the
//! first URL will result in the response containing a `remaining` of `9`. Immediately after -
//! prior to buckets resetting - performing a request to the _second_ URL will also contain a
//! `remaining` of `9` in the response, as the major parameter - `channel_id` - is different in the
//! two requests (`4` and `5`).
//!
//! Second: take for example the last two URLs. Assuming the bucket's `limit` is `10`, requesting
//! the first URL will return a `remaining` of `9` in the response. Immediately after - prior to
//! buckets resetting - performing a request to the _second_ URL will return a `remaining` of `8`
//! in the response, as the major parameter - `channel_id` - is equivalent for the two requests
//! (`10`).
//!
//! Major parameters are why some variants (i.e. all of the channel/guild variants) have an
//! associated u64 as data. This is the Id of the parameter, differentiating between different
//! ratelimits.
//!
//! [Taken from]: https://discord.com/developers/docs/topics/rate-limits#rate-limits
use std::collections::HashMap;
use std::fmt;
use std::str::{self, FromStr};
use std::sync::Arc;
use std::time::SystemTime;
use reqwest::header::HeaderMap;
use reqwest::{Client, Response, StatusCode};
use secrecy::{ExposeSecret, SecretString};
use tokio::sync::{Mutex, RwLock};
use tokio::time::{sleep, Duration};
use tracing::{debug, instrument};
pub use super::routing::RatelimitingBucket;
use super::{HttpError, LightMethod, Request};
use crate::internal::prelude::*;
/// Passed to the [`Ratelimiter::set_ratelimit_callback`] callback. If using Client, that callback
/// is initialized to call the `EventHandler::ratelimit()` method.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct RatelimitInfo {
pub timeout: std::time::Duration,
pub limit: i64,
pub method: LightMethod,
pub path: String,
pub global: bool,
}
/// Ratelimiter for requests to the Discord API.
///
/// This keeps track of ratelimit data for known routes through the [`Ratelimit`] implementation
/// for each route: how many tickets are [`remaining`] until the user needs to wait for the known
/// [`reset`] time, and the [`limit`] of requests that can be made within that time.
///
/// When no tickets are available for some time, then the thread sleeps until that time passes. The
/// mechanism is known as "pre-emptive ratelimiting".
///
/// Occasionally for very high traffic bots, a global ratelimit may be reached which blocks all
/// future requests until the global ratelimit is over, regardless of route. The value of this
/// global ratelimit is never given through the API, so it can't be pre-emptively ratelimited. This
/// only affects the largest of bots.
///
/// [`limit`]: Ratelimit::limit
/// [`remaining`]: Ratelimit::remaining
/// [`reset`]: Ratelimit::reset
pub struct Ratelimiter {
client: Client,
global: Arc<Mutex<()>>,
// When futures is implemented, make tasks clear out their respective entry when the 'reset'
// passes.
routes: Arc<RwLock<HashMap<RatelimitingBucket, Arc<Mutex<Ratelimit>>>>>,
token: SecretString,
absolute_ratelimits: bool,
ratelimit_callback: Box<dyn Fn(RatelimitInfo) + Send + Sync>,
}
impl fmt::Debug for Ratelimiter {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Ratelimiter")
.field("client", &self.client)
.field("global", &self.global)
.field("routes", &self.routes)
.field("token", &self.token)
.field("absolute_ratelimits", &self.absolute_ratelimits)
.field("ratelimit_callback", &"Fn(RatelimitInfo)")
.finish()
}
}
impl Ratelimiter {
/// Creates a new ratelimiter, with a shared [`reqwest`] client and the bot's token.
///
/// The bot token must be prefixed with `"Bot "`. The ratelimiter does not prefix it.
#[must_use]
pub fn new(client: Client, token: impl Into<String>) -> Self {
Self::_new(client, token.into())
}
fn _new(client: Client, token: String) -> Self {
Self {
client,
global: Arc::default(),
routes: Arc::default(),
token: SecretString::new(token),
ratelimit_callback: Box::new(|_| {}),
absolute_ratelimits: false,
}
}
/// Sets a callback to be called when a route is rate limited.
pub fn set_ratelimit_callback(
&mut self,
ratelimit_callback: Box<dyn Fn(RatelimitInfo) + Send + Sync>,
) {
self.ratelimit_callback = ratelimit_callback;
}
// Sets whether absolute ratelimits should be used.
pub fn set_absolute_ratelimits(&mut self, absolute_ratelimits: bool) {
self.absolute_ratelimits = absolute_ratelimits;
}
/// The routes mutex is a HashMap of each [`RatelimitingBucket`] and their respective ratelimit
/// information.
///
/// See the documentation for [`Ratelimit`] for more information on how the library handles
/// ratelimiting.
///
/// # Examples
///
/// View the `reset` time of the route for `ChannelsId(7)`:
///
/// ```rust,no_run
/// use serenity::http::Route;
/// # use serenity::http::Http;
/// # use serenity::model::prelude::*;
///
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// # let http: Http = unimplemented!();
/// let routes = http.ratelimiter.unwrap().routes();
/// let reader = routes.read().await;
///
/// let channel_id = ChannelId::new(7);
/// let route = Route::Channel {
/// channel_id,
/// };
/// if let Some(route) = reader.get(&route.ratelimiting_bucket()) {
/// if let Some(reset) = route.lock().await.reset() {
/// println!("Reset time at: {:?}", reset);
/// }
/// }
/// # Ok(())
/// # }
/// ```
#[must_use]
pub fn routes(&self) -> Arc<RwLock<HashMap<RatelimitingBucket, Arc<Mutex<Ratelimit>>>>> {
Arc::clone(&self.routes)
}
/// # Errors
///
/// Only error kind that may be returned is [`Error::Http`].
#[instrument]
pub async fn perform(&self, req: Request<'_>) -> Result<Response> {
loop {
// This will block if another thread hit the global ratelimit.
drop(self.global.lock().await);
// Perform pre-checking here:
// - get the route's relevant rate
// - sleep if that route's already rate-limited until the end of the 'reset' time;
// - get the global rate;
// - sleep if there is 0 remaining
// - then, perform the request
let ratelimiting_bucket = req.route.ratelimiting_bucket();
let bucket =
Arc::clone(self.routes.write().await.entry(ratelimiting_bucket).or_default());
bucket.lock().await.pre_hook(&req, &self.ratelimit_callback).await;
let request = req.clone().build(&self.client, self.token.expose_secret(), None)?;
let response = self.client.execute(request.build()?).await?;
// Check if the request got ratelimited by checking for status 429, and if so, sleep
// for the value of the header 'retry-after' - which is in milliseconds - and then
// `continue` to try again
//
// If it didn't ratelimit, subtract one from the Ratelimit's 'remaining'.
//
// Update `reset` with the value of 'x-ratelimit-reset' header. Similarly, update
// `reset-after` with the 'x-ratelimit-reset-after' header.
//
// It _may_ be possible for the limit to be raised at any time, so check if it did from
// the value of the 'x-ratelimit-limit' header. If the limit was 5 and is now 7, add 2
// to the 'remaining'
if ratelimiting_bucket.is_none() {
return Ok(response);
}
let redo = if response.headers().get("x-ratelimit-global").is_some() {
drop(self.global.lock().await);
Ok(
if let Some(retry_after) =
parse_header::<f64>(response.headers(), "retry-after")?
{
debug!(
"Ratelimited on route {:?} for {:?}s",
ratelimiting_bucket, retry_after
);
(self.ratelimit_callback)(RatelimitInfo {
timeout: Duration::from_secs_f64(retry_after),
limit: 50,
method: req.method,
path: req.route.path().to_string(),
global: true,
});
sleep(Duration::from_secs_f64(retry_after)).await;
true
} else {
false
},
)
} else {
bucket
.lock()
.await
.post_hook(&response, &req, &self.ratelimit_callback, self.absolute_ratelimits)
.await
};
if !redo.unwrap_or(true) {
return Ok(response);
}
}
}
}
/// A set of data containing information about the ratelimits for a particular
/// [`RatelimitingBucket`], which is stored in [`Http`].
///
/// See the [Discord docs] on ratelimits for more information.
///
/// **Note**: You should _not_ mutate any of the fields, as this can help cause 429s.
///
/// [`Http`]: super::Http
/// [Discord docs]: https://discord.com/developers/docs/topics/rate-limits
#[derive(Debug)]
pub struct Ratelimit {
/// The total number of requests that can be made in a period of time.
limit: i64,
/// The number of requests remaining in the period of time.
remaining: i64,
/// The absolute time when the interval resets.
reset: Option<SystemTime>,
/// The total time when the interval resets.
reset_after: Option<Duration>,
}
impl Ratelimit {
#[instrument(skip(ratelimit_callback))]
pub async fn pre_hook(
&mut self,
req: &Request<'_>,
ratelimit_callback: &(dyn Fn(RatelimitInfo) + Send + Sync),
) {
if self.limit() == 0 {
return;
}
let Some(reset) = self.reset else {
// We're probably in the past.
self.remaining = self.limit;
return;
};
let Ok(delay) = reset.duration_since(SystemTime::now()) else {
// if duration is negative (i.e. adequate time has passed since last call to this api)
if self.remaining() != 0 {
self.remaining -= 1;
}
return;
};
if self.remaining() == 0 {
debug!(
"Pre-emptive ratelimit on route {:?} for {}ms",
req.route.ratelimiting_bucket(),
delay.as_millis(),
);
ratelimit_callback(RatelimitInfo {
timeout: delay,
limit: self.limit,
method: req.method,
path: req.route.path().to_string(),
global: false,
});
sleep(delay).await;
return;
}
self.remaining -= 1;
}
#[instrument(skip(ratelimit_callback))]
pub async fn post_hook(
&mut self,
response: &Response,
req: &Request<'_>,
ratelimit_callback: &(dyn Fn(RatelimitInfo) + Send + Sync),
absolute_ratelimits: bool,
) -> Result<bool> {
if let Some(limit) = parse_header(response.headers(), "x-ratelimit-limit")? {
self.limit = limit;
}
if let Some(remaining) = parse_header(response.headers(), "x-ratelimit-remaining")? {
self.remaining = remaining;
}
if absolute_ratelimits {
if let Some(reset) = parse_header::<f64>(response.headers(), "x-ratelimit-reset")? {
self.reset = Some(std::time::UNIX_EPOCH + Duration::from_secs_f64(reset));
}
}
if let Some(reset_after) =
parse_header::<f64>(response.headers(), "x-ratelimit-reset-after")?
{
if !absolute_ratelimits {
self.reset = Some(SystemTime::now() + Duration::from_secs_f64(reset_after));
}
self.reset_after = Some(Duration::from_secs_f64(reset_after));
}
Ok(if response.status() != StatusCode::TOO_MANY_REQUESTS {
false
} else if let Some(retry_after) = parse_header::<f64>(response.headers(), "retry-after")? {
debug!(
"Ratelimited on route {:?} for {:?}s",
req.route.ratelimiting_bucket(),
retry_after
);
ratelimit_callback(RatelimitInfo {
timeout: Duration::from_secs_f64(retry_after),
limit: self.limit,
method: req.method,
path: req.route.path().to_string(),
global: false,
});
sleep(Duration::from_secs_f64(retry_after)).await;
true
} else {
false
})
}
/// The total number of requests that can be made in a period of time.
#[inline]
#[must_use]
pub const fn limit(&self) -> i64 {
self.limit
}
/// The number of requests remaining in the period of time.
#[inline]
#[must_use]
pub const fn remaining(&self) -> i64 {
self.remaining
}
/// The absolute time in milliseconds when the interval resets.
#[inline]
#[must_use]
pub const fn reset(&self) -> Option<SystemTime> {
self.reset
}
/// The total time in milliseconds when the interval resets.
#[inline]
#[must_use]
pub const fn reset_after(&self) -> Option<Duration> {
self.reset_after
}
}
impl Default for Ratelimit {
fn default() -> Self {
Self {
limit: i64::MAX,
remaining: i64::MAX,
reset: None,
reset_after: None,
}
}
}
fn parse_header<T: FromStr>(headers: &HeaderMap, header: &str) -> Result<Option<T>> {
let Some(header) = headers.get(header) else { return Ok(None) };
let unicode =
str::from_utf8(header.as_bytes()).map_err(|_| Error::from(HttpError::RateLimitUtf8))?;
let num = unicode.parse().map_err(|_| Error::from(HttpError::RateLimitI64F64))?;
Ok(Some(num))
}
#[cfg(test)]
mod tests {
use std::error::Error as StdError;
use std::result::Result as StdResult;
use reqwest::header::{HeaderMap, HeaderName, HeaderValue};
use super::parse_header;
use crate::error::Error;
use crate::http::HttpError;
type Result<T> = StdResult<T, Box<dyn StdError>>;
fn headers() -> HeaderMap {
let pairs = &[
(HeaderName::from_static("x-ratelimit-limit"), HeaderValue::from_static("5")),
(HeaderName::from_static("x-ratelimit-remaining"), HeaderValue::from_static("4")),
(
HeaderName::from_static("x-ratelimit-reset"),
HeaderValue::from_static("1560704880.423"),
),
(HeaderName::from_static("x-bad-num"), HeaderValue::from_static("abc")),
(
HeaderName::from_static("x-bad-unicode"),
HeaderValue::from_bytes(&[255, 255, 255, 255]).unwrap(),
),
];
let mut map = HeaderMap::with_capacity(pairs.len());
for (name, val) in pairs {
map.insert(name, val.clone());
}
map
}
#[test]
#[allow(clippy::float_cmp)]
fn test_parse_header_good() -> Result<()> {
let headers = headers();
assert_eq!(parse_header::<i64>(&headers, "x-ratelimit-limit")?.unwrap(), 5);
assert_eq!(parse_header::<i64>(&headers, "x-ratelimit-remaining")?.unwrap(), 4,);
assert_eq!(parse_header::<f64>(&headers, "x-ratelimit-reset")?.unwrap(), 1_560_704_880.423);
Ok(())
}
#[test]
fn test_parse_header_errors() {
let headers = headers();
assert!(matches!(
parse_header::<i64>(&headers, "x-bad-num").unwrap_err(),
Error::Http(HttpError::RateLimitI64F64)
));
assert!(matches!(
parse_header::<i64>(&headers, "x-bad-unicode").unwrap_err(),
Error::Http(HttpError::RateLimitUtf8)
));
}
}