EionRobb / purple-discord

A libpurple/Pidgin plugin for Discord
GNU General Public License v3.0
382 stars 43 forks source link

Rate limits #464

Open Metalhead33 opened 1 month ago

Metalhead33 commented 1 month ago

Still a work in progress, but I decided to take matters into my own hands because #450 and #448 really get on my nerves.

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in the pull request focus on enhancing the rate limiting functionality within the libdiscord.c file. This includes the introduction of new static variables to manage rate limit information and the implementation of a new function, UpdateRateLimits, which updates these variables based on Discord API response headers. Modifications to existing functions ensure that rate limit values are processed correctly, allowing for dynamic adjustments to request delays in accordance with the API's rate limiting policies.

Changes

File Change Summary
libdiscord.c Added static variables for rate limit management and new functions UpdateRateLimits and parse_rate_limit_headers to process rate limit headers. Modified discord_response_callback to call parse_rate_limit_headers and updated discord_fetch_url_with_method_delay for dynamic request delays.

Poem

🐰 In the land where Discord chats,
Rate limits dance like friendly bats.
With updates swift, our requests align,
A smoother flow, oh how divine!
Hops of joy for every call,
Together we shall rise, not fall! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
Metalhead33 commented 1 month ago

I'm not sure this actually did anything. In the actual debug logs, I don't see any references to the X-RateLimit headers - still, at least it doesn't result in an instant temp-ban like it did before I implemented this change. Placebo effect, perhaps?

EionRobb commented 1 month ago

Thank you for getting this PR underway! Really appreciate the help. 🥳

With the rate limits, are they enforced per-account or per IP? One of the suggestions from the bot (thanks for working with that btw, I've only just started using it so wasn't sure how well it'd go) was to put the variables into the account so that they aren't global, but is that intentional?

Looks good so far though. I'll have to try it out tonight. We can point other users to the dll auto builds to try out too. I'll do that when I'm back at my desktop, unless someone else jumps into it first 🙂

Metalhead33 commented 1 month ago

Hello @EionRobb - thank you for your kind coment, this is a very special moment for me, as it is the first time I truly contribute to an open-source repository :)

I personally bleieve that he bot is mistaken - Discord's rate limits are enforced per-IP. I noticed that because whenever the temp-ban is triggered, it affects both my desktop PC and my phone's wi-fi (which ultimately leads to the same modem/router that my desktop PC uses), but when I switch my mobile phone to "using data", the temp-ban is gone. This suggests that it is NOT per-account, but per-IP.