feat: added setting to disable discord message on rate limit

[TeKrop]

Summary by Sourcery

New Features:

• Adds a setting to disable Discord messages when the Blizzard API rate limit is reached.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces a new configuration setting that allows users to disable the Discord message that is sent when the Blizzard API rate limit is reached. This is implemented by adding a new boolean setting to the Settings class and modifying the _blizzard_forbidden_error method to conditionally send the Discord message based on the value of this setting.

Sequence diagram for Blizzard Rate Limit with Discord Message Toggle

sequenceDiagram
    participant OverfastClient
    participant Settings
    participant DiscordWebhook

    OverfastClient->>Settings: Check discord_message_on_rate_limit
    alt discord_message_on_rate_limit is true
        OverfastClient->>DiscordWebhook: Send rate limit message
        DiscordWebhook-->>OverfastClient: OK
    else discord_message_on_rate_limit is false
        OverfastClient-->>OverfastClient: Continue without sending message
    end
    OverfastClient-->>OverfastClient: Return Too Many Requests Response

Loading

Updated class diagram for Settings

classDiagram
    class Settings {
        +sentry_dsn: str
        +environment: str
        +debug: bool
        +fastapi_logs: bool
        +uvicorn_logs: bool
        +overfast_api_url: str
        +openapi_route: str
        +exception_handler: bool
        +cors_origins: list[str]
        +cors_allow_credentials: bool
        +cors_allow_methods: list[str]
        +cors_allow_headers: list[str]
        +cache_enabled: bool
        +cache_timeout: int
        +cache_size: int
        +blizzard_client_id: str
        +blizzard_client_secret: str
        +blizzard_api_url: str
        +blizzard_oauth_url: str
        +blizzard_rate_limit_requests: int
        +blizzard_rate_limit_time_frame: int
        +blizzard_rate_limit_retry_after: int
        +discord_webhook_url: str
        +github_repo_url: str
        +contact_email: str
        +discord_message_on_rate_limit: bool
    }
    note for Settings "Added discord_message_on_rate_limit attribute"

Loading

File-Level Changes

Change	Details	Files
Added a configuration setting to control whether a Discord message is sent when the Blizzard API rate limit is reached.	Introduced a new boolean setting discord_message_on_rate_limit in the Settings class. Modified the _blizzard_forbidden_error method to conditionally send a Discord message based on the value of the new setting. Added the new setting to the .env.dist file.	app/overfast_client.py app/config.py .env.dist

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @TeKrop - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider adding a comment to the config setting to explain when a user might want to disable the Discord message.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud