Skip to content

Conversation

leynos
Copy link
Owner

@leynos leynos commented Jul 4, 2025

Summary

  • document why Event only derives Debug
  • clarify comments around biased event priority and reference tests

Testing

  • make fmt
  • cargo clippy --all-targets --all-features -- -D warnings
  • make test

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

Summary by Sourcery

Simplify the polling flow in ConnectionActor by extracting a unified event selection method, consolidating shutdown/high/low/response handling into an Event enum, and streamlining poll_sources matching on those events.

Enhancements:

  • Extract the async polling branch into a new next_event method.
  • Introduce an Event enum to represent shutdown, high, low, response, and idle events.
  • Simplify poll_sources by matching on the Event enum instead of direct tokio::select! branches.
  • Enhance documentation on the Debug-only derive for Event and clarify biased priority ordering with test references.

Copy link
Contributor

sourcery-ai bot commented Jul 4, 2025

Reviewer's Guide

Refactors polling in ConnectionActor by extracting a centralized next_event method using a biased tokio::select into an Event enum and updating poll_sources to dispatch based on Event, while improving documentation around event derivation and priority ordering.

Sequence diagram for next_event and poll_sources interaction

sequenceDiagram
    participant CA as ConnectionActor
    participant State as ActorState
    participant Out as Vec<F>
    participant Event
    actor Tokio as tokio::select!

    CA->>Tokio: next_event(state)
    Tokio-->>CA: Event (Shutdown | High | Low | Response | Idle)
    CA->>CA: match Event
    alt Shutdown
        CA->>CA: process_shutdown(state)
    else High
        CA->>CA: process_high(res, state, out)
    else Low
        CA->>CA: process_low(res, state, out)
    else Response
        CA->>CA: process_response(res, state, out)
    else Idle
        CA->>CA: (do nothing)
    end
    CA-->>Out: (frames appended as needed)
Loading

Class diagram for Event enum and ConnectionActor polling refactor

classDiagram
    class Event {
        <<enum>>
        +Shutdown
        +High(Option<F>)
        +Low(Option<F>)
        +Response(Option<Result<F, WireframeError<E>>>)
        +Idle
    }
    class ConnectionActor {
        +next_event(state: &ActorState) Event<F, E>
        +poll_sources(state: &mut ActorState, out: &mut Vec<F>) Result<(), WireframeError<E>>
        -high_rx
        -low_rx
        -response
        -shutdown
        +process_shutdown(state: &ActorState)
        +process_high(res, state, out)
        +process_low(res, state, out)
        +process_response(res, state, out)
    }
    ConnectionActor --> Event : uses
    ConnectionActor --> WireframeError : uses
    ConnectionActor --> ActorState : uses
    ConnectionActor --> F : generic
    ConnectionActor --> E : generic
    Event --> WireframeError : uses
Loading

File-Level Changes

Change Details Files
Introduce Event enum to represent polling outcomes and limit trait derivations
  • Added Debug-only Event enum variants for Shutdown, High, Low, Response, Idle
  • Documented why Clone/PartialEq are omitted due to WireframeError constraints
src/connection.rs
Extract next_event method with biased tokio::select for prioritized event polling
  • Moved shutdown, high, low, and response guards into next_event
  • Enforced ordering and added Idle fallback to prevent select panics
  • Referenced strict_priority_order and shutdown_signal_precedence tests in comments
src/connection.rs
Simplify poll_sources by matching on Event instead of inline select
  • Replaced inline tokio::select in poll_sources with a match on next_event
  • Delegated to process_shutdown, process_high, process_low, process_response via Event
src/connection.rs

Possibly linked issues

  • #0: PR extracts select! loop from poll_sources to next_event, improving readability and addressing issue suggestion.

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
Contributor

coderabbitai bot commented Jul 4, 2025

Summary by CodeRabbit

  • Refactor
    • Improved internal event handling for connection management, resulting in clearer separation between event detection and processing. No changes to user-facing behaviour or features.

📜 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 a9a483d and c04a9f9.

📒 Files selected for processing (1)
  • src/connection.rs (2 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)

23-35: Documentation clearly explains the Debug-only derivation.

The comment effectively addresses why Event only derives Debug, directly fulfilling one of the PR's main objectives. The explanation about WireframeError<E> not implementing Clone or PartialEq provides valuable context for future maintainers.


168-178: Excellent documentation of biased priority ordering with test references.

The documentation clearly explains the priority hierarchy (shutdown → high → low → response) and the rationale for the else branch. The explicit references to strict_priority_order and shutdown_signal_precedence tests provide valuable assurance that this critical behaviour is tested and maintained across refactors.


206-226: Clean separation of event polling and processing logic.

The refactoring successfully simplifies the polling logic by:

  • Extracting event detection into next_event
  • Using pattern matching for clear dispatch to handler methods
  • Maintaining the original error propagation semantics

This improves code readability and maintainability whilst preserving the original behaviour.

✨ 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-polling-logic-and-improve-select-handling

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


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 a56a82b into main Jul 4, 2025
5 checks passed
@leynos leynos deleted the codex/refactor-polling-logic-and-improve-select-handling branch July 4, 2025 20:38
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