Skip to content

Consolidate polling helper functions#163

Merged
leynos merged 3 commits intomainfrom
codex/consolidate-polling-helper-functions
Jul 4, 2025
Merged

Consolidate polling helper functions#163
leynos merged 3 commits intomainfrom
codex/consolidate-polling-helper-functions

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jul 4, 2025

Summary

  • unify polling logic for optional sources
  • replace poll_receiver and poll_response with poll_if_present

Testing

  • make lint
  • make test

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

Summary by Sourcery

Consolidate polling logic for optional asynchronous sources by replacing specialized helper methods with a generic poll_if_present function.

Enhancements:

  • Replace poll_receiver and poll_response with a unified generic poll_if_present method for optional streams and receivers
  • Update the main connection loop to use poll_if_present for high, low, and response polling

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jul 4, 2025

Reviewer's Guide

This PR consolidates polling logic by replacing the two specialized helpers (poll_receiver and poll_response) with a single generic poll_if_present function, and updates all call sites in the connection loop to use the new helper.

Class diagram for consolidated polling helpers

classDiagram
    class Connection {
        +poll_if_present<'a, T, Fut, R>(opt: Option<&'a mut T>, f: impl FnOnce(&'a mut T) -> Fut + 'a) -> impl Future<Output = Option<R>> + 'a
        +recv_push(rx: &mut mpsc::Receiver<F>) -> Option<F>
    }
    %% Removed helpers
    class poll_receiver {
        -poll_receiver(rx: Option<&mut mpsc::Receiver<F>>) -> impl Future<Output = Option<F>>
    }
    class poll_response {
        -poll_response(stream: Option<&mut FrameStream<F, E>>) -> impl Future<Output = Option<Result<F, WireframeError<E>>>>
    }
    Connection --|> poll_receiver : replaced
    Connection --|> poll_response : replaced
    %% New generic helper
    class poll_if_present {
        +poll_if_present<'a, T, Fut, R>(opt: Option<&'a mut T>, f: impl FnOnce(&'a mut T) -> Fut + 'a) -> impl Future<Output = Option<R>> + 'a
    }
    Connection --> poll_if_present : uses
Loading

File-Level Changes

Change Details Files
Introduce a unified generic helper for polling optional sources
  • Add poll_if_present with generic type parameters and closure
  • Remove legacy poll_receiver definition
  • Remove legacy poll_response definition
src/connection.rs
Refactor all polling invocations to use poll_if_present
  • Replace poll_receiver for high_rx with poll_if_present(self.high_rx.as_mut(), Self::recv_push)
  • Replace poll_receiver for low_rx with poll_if_present(self.low_rx.as_mut(), Self::recv_push)
  • Replace poll_response for response with poll_if_present(self.response.as_mut(),
s

Possibly linked issues


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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 4, 2025

Summary by CodeRabbit

  • Refactor
    • Improved internal polling logic for asynchronous sources to use a more streamlined and reusable approach. No changes to visible behaviour or features for end-users.

Walkthrough

The code refactors the polling logic in the ConnectionActor by replacing two specialised async helper functions with a single generic poll_optional function. This abstraction handles polling of optional asynchronous sources, unifying the approach for both receivers and response streams without altering control flow or error handling.

Changes

File(s) Change Summary
src/connection.rs Removed poll_receiver and poll_response; added generic poll_optional function for async polling; updated imports.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant ConnectionActor
    participant OptionalSource

    Caller->>ConnectionActor: poll_optional(opt, closure)
    alt opt is Some
        ConnectionActor->>OptionalSource: closure(&mut T) (returns Future)
        OptionalSource-->>ConnectionActor: Option<R>
        ConnectionActor-->>Caller: Option<R>
    else opt is None
        ConnectionActor-->>Caller: None
    end
Loading

Possibly related PRs

  • Refactor connection polling #157: Refactored polling logic by consolidating poll_receiver and poll_response into poll_optional, directly building on previous helper functions.
  • Refactor connection actor polling #133: Refactored polling logic by merging multiple specialised async helpers into a single generic function, improving code reuse in ConnectionActor.

Poem

In the warren of code, a rabbit did see,
Two polling functions, now merged into three—
Or rather, just one, so generic and neat,
Awaiting async, abstraction complete.
With poll_optional here,
The code’s crystal clear—
A hop and a skip, refactoring’s treat! 🐇


📜 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 b2bc64c and e00a205.

📒 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 (5)
src/connection.rs (5)

8-8: Import addition is appropriate and necessary.

The std::future::Future import is required for the generic future trait bound in the new poll_optional function.


177-177: Excellent consolidation of polling logic.

The refactoring successfully unifies the polling approach by using poll_optional with Self::recv_push as the closure, maintaining the same functionality whilst reducing code duplication.


181-181: Consistent application of the unified polling pattern.

The low-priority receiver polling correctly uses the same pattern as the high-priority queue, demonstrating the effectiveness of the abstraction.


190-190: Response stream polling elegantly integrated.

The inline closure |s| s.next() appropriately adapts the stream's next() method to the unified polling interface, maintaining the original behavior.


346-366: Well-designed generic abstraction with appropriate bounds.

The poll_optional function provides an elegant solution to the polling consolidation with several strengths:

  • Generic bounds are appropriately restrictive (Send + 'a) for the async context
  • The #[expect] attribute is correctly scoped with a clear reason
  • The async move block properly captures the closure parameter
  • Function documentation clearly explains the purpose

The implementation correctly handles the Option pattern and maintains the expected None propagation behavior.

✨ 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/consolidate-polling-helper-functions

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

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 - here's some feedback:

  • Consider renaming poll_if_present to something more descriptive (for example poll_optional) to make its purpose clearer at call sites.
  • The generic signature of poll_if_present is quite verbose—consider introducing a type alias or helper trait to hide some of the future/bound boilerplate and improve readability.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider renaming `poll_if_present` to something more descriptive (for example `poll_optional`) to make its purpose clearer at call sites.
- The generic signature of `poll_if_present` is quite verbose—consider introducing a type alias or helper trait to hide some of the future/bound boilerplate and improve readability.

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.

@leynos leynos merged commit a07dce1 into main Jul 4, 2025
5 checks passed
@leynos leynos deleted the codex/consolidate-polling-helper-functions branch July 4, 2025 18:47
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