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

Update progress bar only once every 100ms #717

Merged
merged 1 commit into from
Feb 7, 2025

Conversation

ericcurtin
Copy link
Collaborator

@ericcurtin ericcurtin commented Feb 3, 2025

To help with CPU usage

Summary by Sourcery

Enhancements:

  • Limit progress bar updates to once every 100ms.

Copy link
Contributor

sourcery-ai bot commented Feb 3, 2025

Reviewer's Guide by Sourcery

The progress bar update was changed to only update every 100ms to reduce CPU usage.

Sequence diagram for throttled progress bar updates

sequenceDiagram
    participant Client
    participant ProgressBar
    loop Every data chunk
        Client->>Client: Read 1024 bytes
        Client->>Client: Check time elapsed
        alt >100ms since last update
            Client->>ProgressBar: Update progress
            Note right of ProgressBar: Progress updated
        else <100ms since last update
            Note right of Client: Skip update
        end
    end
Loading

State diagram for progress bar update logic

stateDiagram-v2
    [*] --> ReadingData
    ReadingData --> CheckTime: Read 1024 bytes
    CheckTime --> UpdateProgress: >100ms elapsed
    CheckTime --> ReadingData: <100ms elapsed
    UpdateProgress --> ReadingData
    ReadingData --> [*]: No more data
Loading

File-Level Changes

Change Details Files
The progress bar update was changed to only update every 100ms.
  • Added a last_update_time variable to track the last time the progress bar was updated.
  • Added a check to see if 100ms has passed since the last update before updating the progress bar.
ramalama/http_client.py

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

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

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

Overall Comments:

  • The progress tracking needs to accumulate all bytes downloaded since the last update, not just the last chunk. Currently it only passes the most recent chunk size to update_progress(), which will make the progress reporting inaccurate when throttled.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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 ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

ramalama/http_client.py Show resolved Hide resolved
Copy link
Collaborator

@maxamillion maxamillion left a comment

Choose a reason for hiding this comment

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

+1 LGTM

@rhatdan
Copy link
Member

rhatdan commented Feb 3, 2025

@ericcurtin waiting for you to update based on Sorcery update. Otherwise merge.

@ericcurtin ericcurtin force-pushed the update-progress-once-per-100 branch from 6b514de to 1126431 Compare February 7, 2025 12:21
To help with CPU usage

Signed-off-by: Eric Curtin <[email protected]>
@ericcurtin ericcurtin force-pushed the update-progress-once-per-100 branch from 1126431 to 79c6d19 Compare February 7, 2025 12:28
@ericcurtin
Copy link
Collaborator Author

This is ready @rhatdan @maxamillion @jhjaggars

@rhatdan rhatdan merged commit 9d02f7d into main Feb 7, 2025
12 of 16 checks passed
@ericcurtin ericcurtin deleted the update-progress-once-per-100 branch February 7, 2025 15:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants