Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Increase time between update checks #5413

Merged
merged 1 commit into from
Nov 14, 2024
Merged

Conversation

mdegat01
Copy link
Contributor

@mdegat01 mdegat01 commented Nov 12, 2024

Proposed change

Increase time between update checks from 2 hours to ~8 hours (staggered with the other tasks as per our existing pattern). This is in response of our recent issues around updates hitting rate limits.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (which adds functionality to the supervisor)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to cli pull request:
  • Link to client library pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Ruff (ruff format supervisor tests)
  • Tests have been added to verify that the new code works.

If API endpoints or add-on configuration are added/changed:

Summary by CodeRabbit

  • Chores
    • Updated the timing for the updater task, increasing the reload interval from 7200 seconds to 27100 seconds. This change optimizes the scheduling of update tasks while maintaining existing functionality.

@mdegat01 mdegat01 added the refactor A code change that neither fixes a bug nor adds a feature label Nov 12, 2024
Copy link

coderabbitai bot commented Nov 12, 2024

📝 Walkthrough

Walkthrough

The changes involve a modification to the constant RUN_RELOAD_UPDATER in the file supervisor/misc/tasks.py, changing its value from 7200 to 27100. This adjustment affects the timing for reloading the updater task within the Tasks class. The overall functionality and structure of the code remain unchanged, with no new methods introduced or existing methods modified beyond this constant value update.

Changes

File Change Summary
supervisor/misc/tasks.py Updated constant RUN_RELOAD_UPDATER from 7200 to 27100

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Tasks
    participant Updater

    User->>Tasks: Schedule task
    Tasks->>Updater: Set reload interval (27100 seconds)
    Updater-->>Tasks: Acknowledge scheduling
    Tasks-->>User: Task scheduled successfully
Loading

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, 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 or @coderabbitai title 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
supervisor/misc/tasks.py (1)

36-36: LGTM! Consider documenting the rationale.

The increase from 7200 to 27100 seconds (~2h to ~7.5h) aligns with the PR objective to reduce update check frequency and address rate limiting issues.

Consider adding a comment explaining why this specific interval was chosen and its relationship to rate limits. This will help future maintainers understand the rationale behind this value.

+# Increased from 2h to ~7.5h to prevent rate limiting issues with update checks
RUN_RELOAD_UPDATER = 27100
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9f414ee and f8b8f26.

📒 Files selected for processing (1)
  • supervisor/misc/tasks.py (1 hunks)
🔇 Additional comments (1)
supervisor/misc/tasks.py (1)

36-36: Verify impact on critical updates.

While reducing update frequency helps with rate limits, we should ensure this doesn't delay critical updates too much. The code shows that supervisor updates are still handled immediately when detected:

  1. _reload_updater checks for updates
  2. If supervisor needs update, it calls _update_supervisor immediately
  3. Other components wait for their next scheduled check

This implementation maintains a good balance between reducing API calls and ensuring critical updates are applied promptly.

Also applies to: 442-450

Copy link
Member

@agners agners left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will pace our rollout similar to how things were before #5375. It will take slightly below 8h to complete a Supervisor rollout from Supervisor client perspective.

Before it took up to 2h for a Supervisor to learn about the update, then depending on timing of the Supervisor update task up to another 8h for the update to actually happen, so worst case 10h.

Note however that this will slowdown rollout of plug-ins a bit, since they themself test for updates roughly every 8h. Since the updater reload task is now 8h, it can take up to 16h for a plug-in to be rolled out. Which is fine, but something to keep in mind.

LGTM, thanks! 🙏

@agners agners merged commit 756a5f8 into main Nov 14, 2024
21 checks passed
@agners agners deleted the increase-update-check-time branch November 14, 2024 08:42
@github-actions github-actions bot locked and limited conversation to collaborators Nov 16, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed refactor A code change that neither fixes a bug nor adds a feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants