Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/twilight-rs/gateway-queue
Ratelimited gateway queue for multiserviced bots.
https://github.com/twilight-rs/gateway-queue
cache discord discord-api discord-bot ratelimiter rust twilight-rs
Last synced: about 2 months ago
JSON representation
Ratelimited gateway queue for multiserviced bots.
- Host: GitHub
- URL: https://github.com/twilight-rs/gateway-queue
- Owner: twilight-rs
- License: isc
- Created: 2019-10-09T20:52:02.000Z (about 5 years ago)
- Default Branch: trunk
- Last Pushed: 2024-06-15T20:12:51.000Z (7 months ago)
- Last Synced: 2024-06-15T21:26:13.723Z (7 months ago)
- Topics: cache, discord, discord-api, discord-bot, ratelimiter, rust, twilight-rs
- Language: Rust
- Size: 104 KB
- Stars: 20
- Watchers: 6
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-discord-bot-tools - gateway-queue - Ratelimited gateway queue for multiserviced bots. (MISC / Rust)
- awesome-discord-bot-tools - gateway-queue - Ratelimited gateway queue for multiserviced bots. (MISC / Rust)
README
[![ci-badge][]][ci] [![license-badge][]][license] [![docs-badge][]][docs] [![rust badge]][rust link]
# Gateway Queue
If your bot's shards are multi-processed, then a good choice is to use the
[Gateway Queue]. The Gateway Queue is a lightweight but powerful application
that you can host to queue shards across all of your processes.
The Gateway Queue is library and language agnostic, it's an HTTP server that you
call whenever a shard needs to reconnect to the gateway.
### How it works
When one of your shards disconnects and needs to perform a full reconnect, it
needs to start a new session with the gateway. If you have multiple processes
managing shards, you may not have communication between these processes. The
problems start to happen when multiple shards from these processes try to
reconnect at the same time, all but 1 will get rate-limited.
This is because there's a 5 second ratelimit between new sessions. By sending an
HTTP request to the Gateway Queue, it will ratelimit the requests and "stall"
them, responding with a friendly message once that shard can reconnect:
```json
{
"message": "You're free to connect now! :)"
}
```
### Example
The API is pretty minimal. It's just an HTTP request:
```rust
reqwest::get("http://gateway-queue").await?;
```
No headers, body, or particular method need to be set, they're all ignored.
The request will get a response once the request has gone through the queue.
### Using with large bots
If the bot has access to bucketed identify, you will have to make slight
configuration changes. Firstly you will need to set the `DISCORD_TOKEN`
environment variable so that it is able to fetch the remaining identifies and what
the `max_concurrency` is. Secondly, you will need to set the query parameter
`shard` to the ID of the identifying shard.
```rust
reqwest::get("http://gateway-queue?shard=42").await?;
```
### Running it
If you're using Docker, you can use the prebuilt Docker images from [Github's container registry].
```sh
$ docker run -itd -e HOST=0.0.0.0 -e PORT=5000 ghcr.io/twilight-rs/gateway-queue
```
If you're not, you can compile it via Cargo:
```sh
$ cargo build --release
$ HOST=0.0.0.0 PORT=5000 ./target/release/twilight-gateway-queue
```
`HOST` and `PORT` are the only two environment variables.
[ci-badge]: https://github.com/twilight-rs/gateway-queue/workflows/Test/badge.svg
[ci]: https://github.com/twilight-rs/gateway-queue/actions
[docs]: https://twilight-rs.github.io/chapter_3_services/section_5_gateway_queue.html
[docs-badge]: https://img.shields.io/badge/docs-online-5023dd.svg?style=flat-square
[Github's container registry]: https://github.com/twilight-rs/gateway-queue/pkgs/container/gateway-queue
[license-badge]: https://img.shields.io/badge/license-ISC-blue.svg?style=flat-square
[license]: https://opensource.org/licenses/ISC
[LICENSE.md]: https://github.com/twilight-rs/gateway-queue/blob/master/LICENSE.md
[rust badge]: https://img.shields.io/badge/rust-1.44+-93450a.svg?style=flat-square
[rust link]: https://blog.rust-lang.org/2020/06/04/Rust-1.44.0.html