Use PriorityQueue.qsize() to obtain the queue depth by bouwew · Pull Request #291 · plugwise/python-plugwise-usb

bouwew · 2025-07-18T17:42:46Z

Summary by CodeRabbit

Refactor
- Removed internal message count tracking and correction mechanisms from connection management components, simplifying message processing.
- Updated queue management to rate-limit based on submit queue size with enhanced logging for queue status.
- Added a new constant to define the queue size threshold for reporting.
Chores
- Bumped project version to 0.44.8a8.
Tests
- Improved test reliability by updating node type change verification within network cache tests.
Documentation
- Updated changelog to mark release v0.44.8 and note improved send-queue depth measurement using PriorityQueue.qsize().

coderabbitai · 2025-07-18T17:42:52Z

Walkthrough

This update removes all code related to tracking and correcting the count of processed messages across the StickSender, StickReceiver, and StickConnectionManager classes. Related properties and methods are deleted, and logic that depended on these counters is refactored. The send queue depth measurement is changed to use the submit queue size. Additionally, the project version is incremented, and a test is updated for asynchronous cache updates.

Changes

File(s)	Change Summary
plugwise_usb/connection/manager.py	Removed `queue_depth` property and `correct_received_messages` method from `StickConnectionManager`.
plugwise_usb/connection/receiver.py	Removed processed messages counter, related property, and correction method from `StickReceiver`.
plugwise_usb/connection/sender.py	Removed processed messages counter and property from `StickSender`.
plugwise_usb/connection/queue.py	Removed calls to message correction; replaced stick queue depth checks with submit queue size checks and updated wait logic; added `REPORT_QUEUE_FILLING_UP` constant.
plugwise_usb/constants.py	Added constant `REPORT_QUEUE_FILLING_UP` with value 8.
pyproject.toml	Updated project version from 0.44.7 to 0.44.8a8.
tests/test_usb.py	Refactored cache update in test to occur asynchronously within a patch context; added assertions verifying update.
CHANGELOG.md	Updated changelog to release version 0.44.8; noted send-queue depth now collected via PriorityQueue.qsize().

Estimated code review effort

File(s)	Effort Estimate
plugwise_usb/connection/manager.py	2 (30–90 minutes)
plugwise_usb/connection/receiver.py	2 (30–90 minutes)
plugwise_usb/connection/sender.py	2 (30–90 minutes)
plugwise_usb/connection/queue.py	3 (90–240 minutes)
plugwise_usb/constants.py	1 (<30 minutes)
pyproject.toml	1 (<30 minutes)
tests/test_usb.py	2 (30–90 minutes)
CHANGELOG.md	1 (<30 minutes)

Suggested reviewers

dirixmjm

Poem

A bunny once counted each message with care,
But now those old counters have vanished from there.
The queues are more nimble, the code is more light,
The version hops forward, all tests running right.
🐇✨ Out with the old, let the new code take flight!

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c1b11c9 and e34bb76.

📒 Files selected for processing (1)

CHANGELOG.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

CHANGELOG.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: Run pytest using Python 3.13

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch alt_prio_queue

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this 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.

codecov · 2025-07-18T17:43:40Z

Codecov Report

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

Project coverage is 80.82%. Comparing base (c8fa3ea) to head (e34bb76).
Report is 12 commits behind head on main.

Files with missing lines	Patch %	Lines
plugwise_usb/connection/queue.py	60.00%	2 Missing ⚠️

Additional details and impacted files

@@ Coverage Diff @@## main #291 +/- ##
==========================================
- Coverage 80.88% 80.82% -0.06% 
==========================================
Files 36 36 Lines 7591 7574 -17 ==========================================
- Hits 6140 6122 -18 - Misses 1451 1452 +1

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

dirixmjm

Some nitpick comments, but generally looks good.

dirixmjm · 2025-07-19T08:52:26Z

- _LOGGER.warning(
- "Awaiting plugwise responses %d", self._stick.queue_depth
- )
+ if qsize > 3:


Shall we make the number 3 a constant?

I can do that. But I like to increase the number, to for instance 8 (this would mean power values are delayed by 1 second).

I was not referring to the exact number, just make a constant and then it can be finetuned?

Changed to: if qsize > REPORT_QUEUE_FILLING_UP:

using queue.qsize() is more accurate

sonarqubecloud · 2025-07-21T08:07:55Z

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

dirixmjm

Improvements make sense.

ArnoutD

I would check a live empty system if there is no message overload

bouwew temporarily deployed to testpypi July 18, 2025 17:43 — with GitHub Actions Inactive

coderabbitaiBot approved these changes Jul 18, 2025
View reviewed changes

bouwew temporarily deployed to testpypi July 18, 2025 17:48 — with GitHub Actions Inactive

bouwew marked this pull request as ready for review July 18, 2025 17:50

bouwew requested a review from a team as a code owner July 18, 2025 17:50

bouwew temporarily deployed to testpypi July 18, 2025 17:54 — with GitHub Actions Inactive

bouwew marked this pull request as draft July 18, 2025 18:13

bouwew mentioned this pull request Jul 19, 2025
Implement a send-queue with a settable max-size #289
Closed

dirixmjm reviewed Jul 19, 2025
View reviewed changes

bouwew temporarily deployed to testpypi July 20, 2025 14:07 — with GitHub Actions Inactive

bouwew marked this pull request as ready for review July 20, 2025 17:11

bouwewand others added 10 commits July 21, 2025 08:26

Use qsize() to obtain queue depth
e065b9e

Remove use of queue_depth
727ecc2
using queue.qsize() is more accurate

Remove all request/response counter related
f834e20

Add comment about queue rate limiting
c1e236a

Test: fix missing await by removing double line
5993262

Bump to v0.44.8a8 test-version
32a8cb2

Update CHANGELOG
3ce1384

Define constant REPORT_QUEUE_FILLING_UP and set it to 8
db7f11c

fixup: alt_prio_queue Python code reformatted using Ruff
e6aaf07

Import added constant from constants.py
00ecba2

bouwew force-pushed the alt_prio_queue branch from 7e89060 to c1b11c9Compare July 21, 2025 06:29

bouwew requested review from ArnoutD and dirixmjm July 21, 2025 06:30

bouwew force-pushed the alt_prio_queue branch from c1b11c9 to e34bb76Compare July 21, 2025 08:07

Update CHANGELOG
e34bb76

bouwew temporarily deployed to testpypi July 21, 2025 08:10 — with GitHub Actions Inactive

dirixmjm approved these changes Jul 21, 2025
View reviewed changes

ArnoutD mentioned this pull request Jul 21, 2025
Feature/arnout/correct message count #250
Closed

ArnoutD approved these changes Jul 21, 2025
View reviewed changes

bouwew merged commit 0aa4d87 into mainJul 21, 2025
15 of 17 checks passed

bouwew deleted the alt_prio_queue branch July 21, 2025 13:13

bouwew temporarily deployed to pypi July 21, 2025 13:13 — with GitHub Actions Inactive

This was referenced Jul 21, 2025
Streamline of loading SED nodes. #287
Closed
Fix spikes in Energy graphs #297
Merged

Uh oh!

Conversation

bouwew commented Jul 18, 2025• edited by coderabbitai BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitaiBot commented Jul 18, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Suggested reviewers

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecovBot commented Jul 18, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

dirixmjm left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dirixmjmJul 19, 2025

Choose a reason for hiding this comment

Uh oh!

bouwewJul 19, 2025

Choose a reason for hiding this comment

Uh oh!

dirixmjmJul 19, 2025

Choose a reason for hiding this comment

Uh oh!

bouwewJul 20, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sonarqubecloudBot commented Jul 21, 2025

Quality Gate passed

Uh oh!

dirixmjm left a comment

Choose a reason for hiding this comment

Uh oh!

ArnoutD left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bouwew commented Jul 18, 2025•
edited by coderabbitai Bot
Loading

coderabbitaiBot commented Jul 18, 2025•
edited
Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecovBot commented Jul 18, 2025•
edited
Loading

dirixmjm left a comment •
edited
Loading