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

fix(device): prevent while true loop high cpu usage bug #298

Merged
merged 4 commits into from
Sep 21, 2024
Merged

Conversation

wuwentao
Copy link
Member

@wuwentao wuwentao commented Sep 21, 2024

add a sleep in while true loop and prevent high cpu usage bug

Summary by CodeRabbit

  • Bug Fixes
    • Improved performance by adding a delay in the processing loop to reduce CPU resource consumption.
    • Enhanced logging detail for socket error messages to aid in debugging.

@wuwentao wuwentao requested a review from chemelli74 September 21, 2024 13:08
Copy link
Contributor

coderabbitai bot commented Sep 21, 2024

Walkthrough

The changes introduce a modification to the run method in the midealocal/device.py file. A time.sleep(0.1) statement has been added within the while True loop to reduce CPU resource consumption by introducing a delay of 0.1 seconds during each iteration. Additionally, the logging level for socket error messages in the _recovery_timeout method has been changed from warning to debug.

Changes

Files Change Summary
midealocal/device.py Added time.sleep(0.1) in the run method's while True loop to reduce CPU usage; changed logging level from warning to debug for socket errors in _recovery_timeout.

Possibly related PRs

  • chore: ruff PLR0915 #145: This PR modifies the run method in midealocal/device.py, which is directly related to the changes made in the main PR that also modifies the run method in the same file.
  • fix(device)!: socket exception and process rebuild #296: This PR introduces significant modifications to the device.py file, enhancing error handling and refining socket communication, which aligns with the changes in the main PR that also modifies the _recovery_timeout method and the run method.

Suggested reviewers

  • rokam

Poem

In the burrow, we hop with glee,
A pause in the run, oh so free!
One tenth of a second, a soft little snooze,
Less CPU churn, we can't lose!
With each gentle tick, we dance and play,
Thank you, dear coder, for this fine day! 🐇✨


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 198af7e and 7455aff.

Files selected for processing (1)
  • midealocal/device.py (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • midealocal/device.py

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 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.

@github-actions github-actions bot added the bug Something isn't working label Sep 21, 2024
@wuwentao wuwentao requested a review from rokam September 21, 2024 13:09
@codecov-commenter
Copy link

codecov-commenter commented Sep 21, 2024

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Project coverage is 39.93%. Comparing base (7b4bf8f) to head (7455aff).
Report is 4 commits behind head on main.

Files with missing lines Patch % Lines
midealocal/device.py 0.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #298      +/-   ##
==========================================
- Coverage   39.93%   39.93%   -0.01%     
==========================================
  Files          84       84              
  Lines        7534     7535       +1     
==========================================
  Hits         3009     3009              
- Misses       4525     4526       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@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)
midealocal/device.py (1)

743-744: Consider using a shorter delay to balance CPU usage and responsiveness.

Adding a time.sleep(5) statement within the while True loop is a good approach to prevent high CPU usage. However, a delay of 5 seconds might be too long and could potentially impact the responsiveness of the device.

Consider using a shorter delay, such as 0.1 or 0.5 seconds, to strike a balance between reducing CPU usage and maintaining responsiveness.

-                time.sleep(5)
+                time.sleep(0.5)  # Adjust the delay as needed

Could you please clarify the reasoning behind choosing a 5-second delay? Is there any specific requirement or constraint that led to this choice?

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7b4bf8f and d7ff752.

Files selected for processing (1)
  • midealocal/device.py (1 hunks)

@wuwentao
Copy link
Member Author

wuwentao commented Sep 21, 2024

@rokam @chemelli74 please help to review and publish a new release with v3.0.1 for it.

once midea-local done, please help to approve/merge below PR:
wuwentao/midea_ac_lan#316
wuwentao/midea_ac_lan#317

and quickly publish a new release with v0.5.9

@wuwentao
Copy link
Member Author

once it done, please rerun the action job in midea_ac_lan repo, as midea-local v3.0.1 not exist now, so the PR action failed.
just quickly post 4 PRs to trigger a new release, also required 4 approve to merge it.

Copy link
Contributor

@rokam rokam left a comment

Choose a reason for hiding this comment

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

Let's try this.

@rokam rokam merged commit 3bdec5c into main Sep 21, 2024
8 checks passed
@rokam rokam deleted the fix_high_cpu branch September 21, 2024 16:03
@rokam rokam mentioned this pull request Sep 21, 2024
rokam added a commit that referenced this pull request Sep 22, 2024
🤖 I have created a release *beep* *boop*
---


## [3.0.1](v3.0.0...v3.0.1)
(2024-09-21)


### Bug Fixes

* **device:** prevent while true loop high cpu usage bug
([#298](#298))
([3bdec5c](3bdec5c))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants