Skip to content

Handle low queue TryRecvError and fix test message#252

Merged
leynos merged 2 commits intocodex/replace-.unwrap-with-.expectfrom
codex/fix-non-exhaustive-patterns-in-match-statement
Aug 3, 2025
Merged

Handle low queue TryRecvError and fix test message#252
leynos merged 2 commits intocodex/replace-.unwrap-with-.expectfrom
codex/fix-non-exhaustive-patterns-in-match-statement

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Aug 3, 2025

Summary

  • handle disconnected low-priority channel during fairness drain
  • clarify test failure message when creating app

Testing

  • make lint
  • make test

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

Summary by Sourcery

Handle low-priority channel disconnections during fairness draining, unify code formatting conventions, simplify conditional logic, and update test and example annotations and messages

Bug Fixes:

  • Handle TryRecvError::Disconnected on the low-priority channel during fairness drain

Enhancements:

  • Expand single-line function bodies to multiline braces for consistent styling
  • Simplify compound if-let in stream preamble callback into nested conditionals

Documentation:

  • Replace expect attribute annotations on unused doctest structs with inline comments

Tests:

  • Update expect panic message in send_response_propagates_write_error test to "app creation failed"

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Aug 3, 2025

Reviewer's Guide

This PR enhances fairness drain logic by handling disconnected low-priority channels, streamlines callback and pattern matching, enforces consistent multi-line formatting for methods, replaces dead-code expect attributes with comments, and updates a test’s failure message.

Sequence diagram for fairness drain handling of disconnected low-priority channel

sequenceDiagram
    participant Connection
    participant FairnessConfig
    participant LowPriorityQueue as mpsc::Receiver
    participant ActorState
    participant Hooks
    participant OutVec as Vec<F>

    Connection->>FairnessConfig: should_yield()
    alt should_yield is true
        Connection->>LowPriorityQueue: try_recv()
        alt Ok(frame)
            Connection->>Hooks: before_send(frame, ctx)
            Connection->>OutVec: push(frame)
            Connection->>FairnessConfig: after_low()
        else TryRecvError::Empty
            Note right of Connection: Do nothing
        else TryRecvError::Disconnected
            Connection->>Connection: handle_closed_receiver(&mut low_rx, state)
        end
    end
Loading

File-Level Changes

Change Details Files
Handle disconnected low-priority channel during fairness drain
  • Map try_recv over the optional receiver
  • Add match arms for Empty and Disconnected cases
  • Invoke handle_closed_receiver on Disconnected
src/connection.rs
Normalize single-line method definitions into multi-line for readability
  • Expanded definitions of set_fairness, set_response, shutdown_token, after_low, wait_shutdown, recv_push, is_active, is_shutting_down, is_done
  • Applied same formatting to worker_count
src/connection.rs
src/server.rs
Refactor preamble callback error handling in process_stream
  • Replace combined if let guard with nested ifs
  • Log callback errors inside the nested block
src/server.rs
Replace #[expect(dead_code)] attributes with inline comments
  • Removed expect attributes in doctest and example structs
  • Added single-line comments to explain unused placeholders
src/server.rs
examples/metadata_routing.rs
Clarify test failure message in response tests
  • Updated panic message from “route registration failed” to “app creation failed”
tests/response.rs

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 Aug 3, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/fix-non-exhaustive-patterns-in-match-statement

🪧 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 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:404` </location>
<code_context>
     fn after_high(&mut self, out: &mut Vec<F>, state: &mut ActorState) {
         self.fairness.after_high();

</code_context>

<issue_to_address>
Consider restructuring after_high to use early returns and an if-let for clarity instead of mapping over Option.

You can simplify after_high by reverting the `.as_mut().map(…)` into an `if let Some(…)` and pulling your `should_yield` check up front. That way the reader sees “we only try_recv if there’s a queue and we should yield,” and you don’t construct an intermediate `Option<Result<…>>`. For example:

```rust
fn after_high(&mut self, out: &mut Vec<F>, state: &mut ActorState) {
    self.fairness.after_high();

    // only drain when fairness wants us to yield, and only if we have a receiver
    if !self.fairness.should_yield() {
        return;
    }
    if let Some(rx) = &mut self.low_rx {
        match rx.try_recv() {
            Ok(mut frame) => {
                self.hooks.before_send(&mut frame, &mut self.ctx);
                out.push(frame);
                self.after_low();
            }
            Err(TryRecvError::Disconnected) => {
                // handle the closed queue
                Self::handle_closed_receiver(&mut self.low_rx, state);
            }
            Err(TryRecvError::Empty) => {
                // nothing to do
            }
        }
    }
}
```

This preserves exactly the same behavior but removes the extra `map` + inner `if let`, so the control-flow reads straight down.
</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
@@ -393,21 +404,28 @@ where
fn after_high(&mut self, out: &mut Vec<F>, state: &mut ActorState) {
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 (complexity): Consider restructuring after_high to use early returns and an if-let for clarity instead of mapping over Option.

You can simplify after_high by reverting the .as_mut().map(…) into an if let Some(…) and pulling your should_yield check up front. That way the reader sees “we only try_recv if there’s a queue and we should yield,” and you don’t construct an intermediate Option<Result<…>>. For example:

fn after_high(&mut self, out: &mut Vec<F>, state: &mut ActorState) {
    self.fairness.after_high();

    // only drain when fairness wants us to yield, and only if we have a receiver
    if !self.fairness.should_yield() {
        return;
    }
    if let Some(rx) = &mut self.low_rx {
        match rx.try_recv() {
            Ok(mut frame) => {
                self.hooks.before_send(&mut frame, &mut self.ctx);
                out.push(frame);
                self.after_low();
            }
            Err(TryRecvError::Disconnected) => {
                // handle the closed queue
                Self::handle_closed_receiver(&mut self.low_rx, state);
            }
            Err(TryRecvError::Empty) => {
                // nothing to do
            }
        }
    }
}

This preserves exactly the same behavior but removes the extra map + inner if let, so the control-flow reads straight down.

@leynos leynos merged commit cbb7f90 into codex/replace-.unwrap-with-.expect Aug 3, 2025
2 checks passed
@leynos leynos deleted the codex/fix-non-exhaustive-patterns-in-match-statement branch August 3, 2025 14:14
leynos added a commit that referenced this pull request Aug 3, 2025
* Replace unwraps with expect

* Add expect macros and document infallible call

* Use push_expect macros in connection actor tests

Replace verbose await/expect pairs with the push_expect! helper to
standardise low- and high-priority push failure messages. Rewriting
let-chain expressions to nested conditionals keeps the build on stable
Rust, and lint expectations were relaxed accordingly.

* Apply formatting

* Handle low queue TryRecvError and fix test message (#252)

* Handle missing TryRecvError and fix test message

* Apply formatting

* Collapse nested conditionals (#253)

* Remove unneedeed carriage returns

* Remove unneedeed carriage returns

* Remove unused struct

* Remove unused struct
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