Skip to content

Refactor connection polling#157

Merged
leynos merged 2 commits intomainfrom
codex/refactor-poll_sources-tokio-select-loop
Jul 1, 2025
Merged

Refactor connection polling#157
leynos merged 2 commits intomainfrom
codex/refactor-poll_sources-tokio-select-loop

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 30, 2025

Summary

  • factor out connection actor select branches

Testing

  • cargo clippy --all-targets --all-features -- -D warnings
  • RUSTFLAGS="-D warnings" cargo test --quiet

https://chatgpt.com/codex/tasks/task_e_68630f8d99308322bdbcb5b2d65a69a7

Summary by Sourcery

Extract the inline polling logic in the connection actor into dedicated helper methods for high-priority, low-priority, and response streams to simplify the select branches

Enhancements:

  • Introduce poll_high, poll_low, and poll_response helper functions to consolidate connection polling logic
  • Update the select loop to call the new polling methods instead of inline async closures
  • Remove the old next_response function since its logic has been subsumed by poll_response

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 30, 2025

Summary by CodeRabbit

  • Refactor
    • Improved internal handling of priority and response streams for more robust and maintainable processing.
    • Unified and streamlined the processing of incoming frames and receiver closures, reducing duplication and improving reliability.

Summary by CodeRabbit

  • Refactor
    • Improved the internal handling of message streams to enhance code clarity and reliability. No changes to user-facing features or behaviour.

Walkthrough

The polling logic for high-priority, low-priority, and response streams in ConnectionActor has been refactored. Inline async blocks within tokio::select! have been replaced with dedicated helper functions that return futures, improving modularity and handling Option values more gracefully without panics.

Changes

File(s) Change Summary
src/connection.rs Refactored polling logic: replaced inline async blocks with poll_receiver and poll_response helper functions; removed next_response; unified frame processing and closed receiver handling into new helper methods; improved handling of Option values in polling branches.

Sequence Diagram(s)

sequenceDiagram
    actor ConnectionActor
    participant HighPriorityRx as HighPriorityReceiver
    participant LowPriorityRx as LowPriorityReceiver
    participant ResponseStream

    loop poll_sources
        alt High-priority available
            ConnectionActor->>HighPriorityRx: poll_receiver()
            HighPriorityRx-->>ConnectionActor: Option<Frame>
            ConnectionActor->>ConnectionActor: process_frame_common()
        else Low-priority available
            ConnectionActor->>LowPriorityRx: poll_receiver()
            LowPriorityRx-->>ConnectionActor: Option<Frame>
            ConnectionActor->>ConnectionActor: process_frame_common()
        else Response available
            ConnectionActor->>ResponseStream: poll_response()
            ResponseStream-->>ConnectionActor: Option<Result<Frame, Error>>
            ConnectionActor->>ConnectionActor: process response frame
        end
    end
Loading

Possibly related issues

Possibly related PRs

Poem

In the warren of code, I hop with glee,
Refactoring streams for all to see.
No more expect!—just futures anew,
High and low, responses too.
With helper paws, I modularise the flow,
Making the code as neat as a rabbit’s burrow!
🐇✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dcd6140 and 7771721.

📒 Files selected for processing (1)
  • src/connection.rs (4 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
`**/*.rs`: Comment why, not what. Explain assumptions, edge cases, trade-offs, o...

**/*.rs: Comment why, not what. Explain assumptions, edge cases, trade-offs, or complexity. Don't echo the obvious.
Comments must use en-GB-oxendict spelling and grammar.
Function documentation must include clear examples.
Every module must begin with a module level (//!) comment explaining the module's purpose and utility.
Document public APIs using Rustdoc comments (///) so documentation can be generated with cargo doc.
Place function attributes after doc comments.
Do not use return in single-line functions.
Use predicate functions for conditional criteria with more than two branches.
Lints must not be silenced except as a last resort.
Lint rule suppressions must be tightly scoped and include a clear reason.
Prefer expect over allow.
Prefer .expect() over .unwrap().
Clippy warnings MUST be disallowed.
Fix any warnings emitted during tests in the code itself rather than silencing them.
Where a function is too long, extract meaningfully named helper functions adhering to separation of concerns and CQRS.
Where a function has too many parameters, group related parameters in meaningfully named structs.
Where a function is returning a large error consider using Arc to reduce the amount of data returned.
Write unit and behavioural tests for new functionality. Run both before and after making any change.
Prefer immutable data and avoid unnecessary mut bindings.
Handle errors with the Result type instead of panicking where feasible.
Avoid unsafe code unless absolutely necessary and document any usage clearly.

📄 Source: CodeRabbit Inference Engine (AGENTS.md)

List of files the instruction was applied to:

  • src/connection.rs
`**/*.rs`: * Seek to keep the cyclomatic complexity of functions no more than 12...

**/*.rs: * Seek to keep the cyclomatic complexity of functions no more than 12.

  • Adhere to single responsibility and CQRS

  • Place function attributes after doc comments.

  • Do not use return in single-line functions.

  • Move conditionals with >2 branches into a predicate function.

  • Avoid unsafe unless absolutely necessary.

  • Every module must begin with a //! doc comment that explains the module's purpose and utility.

  • Comments must use en-GB-oxendict spelling and grammar.

  • Lints must not be silenced except as a last resort.

    • #[allow] is forbidden.
    • Only narrowly scoped #[expect(lint, reason = "...")] is allowed.
    • No lint groups, no blanket or file-wide suppression.
    • Include FIXME: with link if a fix is expected.
  • Use rstest fixtures for shared setup and to avoid repetition between tests.

  • Replace duplicated tests with #[rstest(...)] parameterised cases.

  • Prefer mockall for mocks/stubs.

  • Prefer .expect() over .unwrap()

  • Ensure that any API or behavioural changes are reflected in the documentation in docs/

  • Ensure that any completed roadmap steps are recorded in the appropriate roadmap in docs/

⚙️ Source: CodeRabbit Configuration File

List of files the instruction was applied to:

  • src/connection.rs
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build-test
  • GitHub Check: Analyze (actions)
🔇 Additional comments (8)
src/connection.rs (8)

175-181: Polling refactor successfully eliminates inline async blocks.

The replacement of inline async blocks with dedicated helper function calls improves code readability and maintainability whilst preserving the same async behaviour.


188-188: Response polling follows the same clean pattern.

Consistent with the receiver polling approach, this change maintains the biased select behaviour whilst improving code organisation.


204-211: Processing logic successfully consolidated.

The refactoring addresses the code duplication concerns from past reviews by using the new process_frame_common and handle_closed_receiver helpers whilst maintaining the specific behaviour for high-priority processing.


214-221: Low-priority processing mirrors the high-priority refactor.

Good consistency in applying the same helper function pattern, reducing duplication whilst preserving the distinct behaviour differences.


223-228: Well-designed helper eliminates frame processing duplication.

The extracted common logic follows the single responsibility principle and properly handles the mutable frame modification pattern used throughout the codebase.


230-234: Closed receiver handling properly centralised.

This helper function effectively consolidates the receiver cleanup logic, addressing the duplication concerns whilst maintaining the correct state management.


344-359: Generic polling function addresses past duplication concerns.

This implementation successfully consolidates the previously duplicated poll_high and poll_low functions into a single generic solution. The lint suppression correctly uses #[expect] with a clear reason as required by the coding guidelines.


361-376: Response polling follows the established pattern.

The function correctly handles the Option case and uses proper lint suppression. The pattern is consistent with poll_receiver, maintaining code consistency across the polling helpers.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in a Comment
  • Commit Unit Tests in branch codex/refactor-poll_sources-tokio-select-loop

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

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 30, 2025

Reviewer's Guide

Refactors the connection’s polling loop by extracting inline async blocks for high-priority, low-priority, and response streams into dedicated poll_* functions, then updating the select arms to use these futures and removing the old next_response helper.

File-Level Changes

Change Details Files
Extract polling logic into dedicated poll_* methods
  • Introduce fn poll_high(...) returning a Future wrapping recv_push
  • Introduce fn poll_low(...) returning a Future wrapping recv_push
  • Introduce fn poll_response(...) returning a Future wrapping stream.next
src/connection.rs
Replace inline async blocks and remove next_response helper
  • Swap select arms’ inline async { recv_push(...) } blocks for poll_high and poll_low
  • Swap select arm’s inline next_response call for poll_response
  • Delete async fn next_response in favor of poll_response
src/connection.rs

Possibly linked issues

  • #0: The PR refactors the ConnectionActor::poll_sources select loop by extracting branches into helper functions, addressing the issue.

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!

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
Copy Markdown

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Choose a reason for hiding this comment

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

Gates Failed
Enforce advisory code health rules (1 file with Code Duplication)

Gates Passed
5 Quality Gates Passed

See analysis details in CodeScene

Reason for failure
Enforce advisory code health rules Violations Code Health Impact
connection.rs 1 advisory rule 10.00 → 9.39 Suppress

Quality Gate Profile: Pay Down Tech Debt
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

Comment thread src/connection.rs Outdated
Copy link
Copy Markdown
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 @leynos - I've reviewed your changes and found some issues that need to be addressed.

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `src/connection.rs:175` </location>
<code_context>
-                        .expect("high_rx should be Some when high_available is true")
-                ).await
-            }, if high_available => {
+            res = Self::poll_high(self.high_rx.as_mut()), if high_available => {
                 self.process_high(res, state, out);
             }
</code_context>

<issue_to_address>
Consider handling the case where high_rx is None more explicitly.

Ensure that process_high can handle None values from poll_high, as this differs from the previous expect() behavior.
</issue_to_address>

### Comment 2
<location> `src/connection.rs:179` </location>
<code_context>
-                        .expect("low_rx should be Some when low_available is true")
-                ).await
-            }, if low_available => {
+            res = Self::poll_low(self.low_rx.as_mut()), if low_available => {
                 self.process_low(res, state, out);
             }
</code_context>

<issue_to_address>
The change from expect() to Option may mask logic errors.

Previously, a panic made inconsistent state obvious; now, poll_low returns None silently. If this state is a logic error, consider adding a debug_assert or explicit error handling to aid debugging.
</issue_to_address>

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.

Comment thread src/connection.rs Outdated
.expect("high_rx should be Some when high_available is true")
).await
}, if high_available => {
res = Self::poll_high(self.high_rx.as_mut()), if high_available => {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

issue (bug_risk): Consider handling the case where high_rx is None more explicitly.

Ensure that process_high can handle None values from poll_high, as this differs from the previous expect() behavior.

Comment thread src/connection.rs Outdated
.expect("low_rx should be Some when low_available is true")
).await
}, if low_available => {
res = Self::poll_low(self.low_rx.as_mut()), if low_available => {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

issue (bug_risk): The change from expect() to Option may mask logic errors.

Previously, a panic made inconsistent state obvious; now, poll_low returns None silently. If this state is a logic error, consider adding a debug_assert or explicit error handling to aid debugging.

Copy link
Copy Markdown
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: 3

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2e290ab and dcd6140.

📒 Files selected for processing (1)
  • src/connection.rs (3 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
`**/*.rs`: Comment why, not what. Explain assumptions, edge cases, trade-offs, o...

**/*.rs: Comment why, not what. Explain assumptions, edge cases, trade-offs, or complexity. Don't echo the obvious.
Comments must use en-GB-oxendict spelling and grammar.
Function documentation must include clear examples.
Every module must begin with a module level (//!) comment explaining the module's purpose and utility.
Document public APIs using Rustdoc comments (///) so documentation can be generated with cargo doc.
Place function attributes after doc comments.
Do not use return in single-line functions.
Use predicate functions for conditional criteria with more than two branches.
Lints must not be silenced except as a last resort.
Lint rule suppressions must be tightly scoped and include a clear reason.
Prefer expect over allow.
Prefer .expect() over .unwrap().
Clippy warnings MUST be disallowed.
Fix any warnings emitted during tests in the code itself rather than silencing them.
Where a function is too long, extract meaningfully named helper functions adhering to separation of concerns and CQRS.
Where a function has too many parameters, group related parameters in meaningfully named structs.
Where a function is returning a large error consider using Arc to reduce the amount of data returned.
Write unit and behavioural tests for new functionality. Run both before and after making any change.
Prefer immutable data and avoid unnecessary mut bindings.
Handle errors with the Result type instead of panicking where feasible.
Avoid unsafe code unless absolutely necessary and document any usage clearly.

📄 Source: CodeRabbit Inference Engine (AGENTS.md)

List of files the instruction was applied to:

  • src/connection.rs
`**/*.rs`: * Seek to keep the cyclomatic complexity of functions no more than 12...

**/*.rs: * Seek to keep the cyclomatic complexity of functions no more than 12.

  • Adhere to single responsibility and CQRS

  • Place function attributes after doc comments.

  • Do not use return in single-line functions.

  • Move conditionals with >2 branches into a predicate function.

  • Avoid unsafe unless absolutely necessary.

  • Every module must begin with a //! doc comment that explains the module's purpose and utility.

  • Comments must use en-GB-oxendict spelling and grammar.

  • Lints must not be silenced except as a last resort.

    • #[allow] is forbidden.
    • Only narrowly scoped #[expect(lint, reason = "...")] is allowed.
    • No lint groups, no blanket or file-wide suppression.
    • Include FIXME: with link if a fix is expected.
  • Use rstest fixtures for shared setup and to avoid repetition between tests.

  • Replace duplicated tests with #[rstest(...)] parameterised cases.

  • Prefer mockall for mocks/stubs.

  • Prefer .expect() over .unwrap()

  • Ensure that any API or behavioural changes are reflected in the documentation in docs/

  • Ensure that any completed roadmap steps are recorded in the appropriate roadmap in docs/

⚙️ Source: CodeRabbit Configuration File

List of files the instruction was applied to:

  • src/connection.rs
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build-test
🔇 Additional comments (3)
src/connection.rs (3)

175-175: LGTM - Clean refactoring improves modularity.

The replacement of inline async blocks with dedicated helper functions makes the select branches more readable and maintainable.


179-179: LGTM - Consistent with high-priority polling pattern.

The low-priority polling follows the same clean pattern as the high-priority branch.


188-188: LGTM - Response polling refactored consistently.

The response polling now follows the same pattern as the queue polling, improving consistency across the codebase.

Comment thread src/connection.rs Outdated
Comment thread src/connection.rs
Comment thread src/connection.rs Outdated
Comment thread src/connection.rs Outdated
@leynos leynos merged commit 171e81f into main Jul 1, 2025
5 checks passed
@leynos leynos deleted the codex/refactor-poll_sources-tokio-select-loop branch July 1, 2025 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant