Skip to content

Refactor connection actor event polling#232

Merged
leynos merged 3 commits intomainfrom
codex/refactor-next_event-and-poll_sources-into-functions
Aug 3, 2025
Merged

Refactor connection actor event polling#232
leynos merged 3 commits intomainfrom
codex/refactor-next_event-and-poll_sources-into-functions

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jul 31, 2025

Summary

  • simplify next_event by moving shutdown and queue polling to helpers
  • dispatch events via a new handle_event function

Testing

  • make fmt
  • make lint
  • make test

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

Summary by Sourcery

Refactor connection actor event polling to simplify next_event logic and centralize event dispatch

Enhancements:

  • Extract shutdown waiting and queue polling into dedicated async helper methods (await_shutdown, poll_high_priority, poll_low_priority, poll_response)
  • Replace inline tokio::select arms in next_event with calls to the new helper methods
  • Introduce handle_event method to centralize event dispatching and delegate to existing process_* handlers

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jul 31, 2025

Reviewer's Guide

This PR refactors the connection actor’s event loop by moving polling and shutdown logic into dedicated async helper methods and consolidating event dispatch into a new handle_event function.

File-Level Changes

Change Details Files
Extract polling and shutdown logic into helper methods
  • Added await_shutdown wrapper for shutdown cancellation
  • Extracted poll_high_priority, poll_low_priority, and poll_response async helpers
  • Replaced inline shutdown and queue polling in next_event select with helper calls
src/connection.rs
Introduce unified handle_event method for dispatch
  • Added handle_event to match on Event and delegate to process_* methods
  • Refactored run logic to call next_event then handle_event
  • Removed direct inline match in run to centralize event handling
src/connection.rs

Possibly linked issues

  • #0: PR refactors tokio::select! loop by extracting branches into helper functions as suggested by 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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 31, 2025

Summary by CodeRabbit

  • Refactor
    • Improved clarity and separation of concerns in event handling logic, resulting in more readable and maintainable code.
    • Simplified the process for retrieving and dispatching events, with more direct and descriptive control flow.
    • No changes to user-facing features or behaviour.

Walkthrough

Refactor the ConnectionActor in src/connection.rs by introducing new async helper methods for shutdown, priority polling, and response polling. Split the poll_sources logic, delegating event handling to a new synchronous method. Update method signatures to use these helpers, focusing on clearer separation of event retrieval and handling.

Changes

Cohort / File(s) Change Summary
ConnectionActor Refactor
src/connection.rs
Refactor next_event and poll_sources to use new async helpers: await_shutdown, poll_priority, poll_response. Add synchronous dispatch_event for event processing. Remove old helper functions. Update method signatures accordingly. No logic changes to event processing or error handling.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ConnectionActor
    participant ShutdownToken
    participant PriorityQueue
    participant ResponseStream

    Client->>ConnectionActor: poll_sources()
    ConnectionActor->>ConnectionActor: next_event(state)
    alt Await shutdown
        ConnectionActor->>ShutdownToken: await_shutdown()
        ShutdownToken-->>ConnectionActor: Shutdown event
    else Poll priority
        ConnectionActor->>PriorityQueue: poll_priority()
        PriorityQueue-->>ConnectionActor: Priority event
    else Poll response
        ConnectionActor->>ResponseStream: poll_response()
        ResponseStream-->>ConnectionActor: Response event
    end
    ConnectionActor->>ConnectionActor: dispatch_event(event, state, out)
    ConnectionActor-->>Client: Result
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Poem

In code's quiet halls, helpers arise,
Splitting tasks with clearer guise.
Events fetched, then sent with grace,
Each function finds its proper place.
Refactor done, the flow now sings,
Smooth and bright, like well-tuned strings! 🎶✨


📜 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 760f612 and 93d1a1f.

📒 Files selected for processing (1)
  • src/connection.rs (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rs

📄 CodeRabbit Inference Engine (AGENTS.md)

**/*.rs: Function documentation must include clear examples demonstrating the usage and outcome of the function. Test documentation should omit examples where the example serves only to reiterate the test logic.
No single code file may be longer than 400 lines. Long switch statements or dispatch tables should be broken up by feature and constituents colocated with targets. Large blocks of test data should be moved to external data files.
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.
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.
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.
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().
Use concat!() to combine long string literals rather than escaping newlines with a backslash.
Prefer semantic error enums. Derive std::error::Error (via the thiserror crate) for any condition the caller might inspect, retry, or map to an HTTP status....

Files:

  • src/connection.rs

⚙️ CodeRabbit Configuration File

**/*.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 and docs must follow en-GB-oxendict (-ize / -our) 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/

  • Files must not exceed 400 lines in length

    • Large modules must be decomposed
    • Long match statements or dispatch tables should be decomposed by domain and collocated with targets
    • Large blocks of inline data (e.g., test fixtures, constants or templates) must be moved to external files and inlined at compile-time or loaded at run-time.

Files:

  • src/connection.rs
🔇 Additional comments (9)
src/connection.rs (9)

252-252: LGTM: Clean refactoring to use dedicated helper method.

The replacement of inline shutdown handling with Self::await_shutdown(self.shutdown.clone()) improves readability and maintains the same functionality.


254-254: LGTM: Unified priority queue polling.

The use of Self::poll_priority(self.high_rx.as_mut()) for high-priority polling is clean and eliminates the previous duplication issue mentioned in past reviews.


256-256: LGTM: Consistent priority queue handling.

The low-priority queue now uses the same Self::poll_priority helper as the high-priority queue, providing consistency and eliminating code duplication.


258-258: LGTM: Clear response polling abstraction.

The Self::poll_response(self.response.as_mut()) call provides a clear, dedicated method for handling streaming responses.


275-277: LGTM: Improved separation of concerns.

The refactored poll_sources method now cleanly separates event retrieval (next_event) from event handling (dispatch_event), improving maintainability and adhering to single responsibility principle.


279-295: LGTM: Clean event dispatching centralisation.

The new dispatch_event method provides a clear, centralised approach to handling different event types. The match expression is straightforward and maintains all existing functionality whilst improving code organisation.


458-459: LGTM: Simple shutdown wrapper.

The await_shutdown helper provides a clear, named abstraction for shutdown waiting functionality.


462-464: LGTM: Unified priority queue polling implementation.

The poll_priority method successfully consolidates the previously duplicated high and low priority polling logic into a single, reusable helper method.


467-471: LGTM: Clean response polling abstraction.

The poll_response method provides a clear wrapper around the streaming response polling logic, maintaining consistency with the other 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-next_event-and-poll_sources-into-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 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 and they look great!

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

### Comment 1
<location> `src/connection.rs:486` </location>
<code_context>
+    async fn await_shutdown(token: CancellationToken) { Self::wait_shutdown(token).await; }
+
+    /// Poll the high-priority queue.
+    async fn poll_high_priority(rx: Option<&mut mpsc::Receiver<F>>) -> Option<F> {
+        Self::poll_optional(rx, Self::recv_push).await
+    }
+
</code_context>

<issue_to_address>
poll_high_priority and poll_low_priority are nearly identical; consider deduplication.

Since both functions wrap poll_optional with identical arguments, consider merging them into one with a priority parameter, unless there's a specific reason to keep them separate.

Suggested implementation:

```rust
    /// Poll the priority queue.
    async fn poll_priority(
        rx_high: Option<&mut mpsc::Receiver<F>>,
        rx_low: Option<&mut mpsc::Receiver<F>>,
        high: bool,
    ) -> Option<F> {
        if high {
            Self::poll_optional(rx_high, Self::recv_push).await
        } else {
            Self::poll_optional(rx_low, Self::recv_push).await
        }
    }

```

```rust
            res = Self::poll_priority(self.high_rx.as_mut(), self.low_rx.as_mut(), true), if high_available => Event::High(res),

```

1. If there is a `poll_low_priority` function, remove it and update any of its call sites to use `poll_priority(..., false)`.
2. If the function signatures or receiver types differ, adjust the parameters to match your actual codebase.
3. If you want to further generalize, you could use an enum for priority instead of a bool.
</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
leynos and others added 3 commits August 3, 2025 23:17
Extract polling helpers for shutdown and push queues to reduce complexity.
@leynos leynos force-pushed the codex/refactor-next_event-and-poll_sources-into-functions branch from 760f612 to 93d1a1f Compare August 3, 2025 22:21
@leynos leynos merged commit 29a9fd2 into main Aug 3, 2025
5 checks passed
@leynos leynos deleted the codex/refactor-next_event-and-poll_sources-into-functions branch August 3, 2025 22:44
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