Skip to content

Refactor connection actor polling#133

Merged
leynos merged 3 commits intomainfrom
codex/add-private-helper-functions-and-refactor-poll_sources
Jun 26, 2025
Merged

Refactor connection actor polling#133
leynos merged 3 commits intomainfrom
codex/add-private-helper-functions-and-refactor-poll_sources

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 25, 2025

Summary

  • add small async helpers for the connection actor
  • refactor poll_sources to use helpers while preserving biased order

Testing

  • make fmt
  • make lint
  • make test

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

Summary by Sourcery

Extract common async operations into helper functions and refactor the connection actor's polling loop to use these helpers while preserving biased selection order.

Enhancements:

  • Introduce async helpers wait_shutdown, recv_push, and next_response to encapsulate shutdown, push receiving, and response streaming logic.
  • Refactor poll_sources’ select! arms to invoke the new helper methods instead of inline async blocks.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 25, 2025

Reviewer's Guide

This PR refactors the connection actor’s polling loop by extracting common async operations into helpers and updating the select branches to call those helpers while maintaining the original biased evaluation order.

File-Level Changes

Change Details Files
Extract common async operations into standalone helper functions
  • Added async fn wait_shutdown(token) to await shutdown cancellation
  • Added async fn recv_push(rx) to wrap queue.recv()
  • Added async fn next_response(stream) to abstract FrameStream.next()
  • Grouped these helpers at the end of the file for clarity
src/connection.rs
Refactor poll_sources select branches to use the new helpers
  • Replaced direct token.cancelled() await with wait_shutdown
  • Swapped high_priority_rx.recv() calls for recv_push
  • Swapped low_priority_rx.recv() calls for recv_push
  • Replaced inline response.next() block with next_response
src/connection.rs

Possibly linked issues

  • #0: The PR refactors the ConnectionActor::poll_sources select loop by extracting branches into helper async functions, directly 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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 25, 2025

Warning

Rate limit exceeded

@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 46 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 4225cc0 and 211faf3.

📒 Files selected for processing (1)
  • src/connection.rs (3 hunks)

Summary by CodeRabbit

  • Refactor
    • Improved internal handling of asynchronous operations for better maintainability and clarity. No changes to user-facing behaviour.

Summary by CodeRabbit

  • Refactor
    • Improved internal handling of asynchronous polling for connections, leading to cleaner and more maintainable code. No changes to user-facing features or behaviour.

Walkthrough

The asynchronous polling logic within the poll_sources method of ConnectionActor has been refactored by extracting inline async operations into private helper functions. These helpers encapsulate shutdown waiting, push queue receiving, and response stream polling, without altering the original control flow or error handling.

Changes

File(s) Change Summary
src/connection.rs Refactored poll_sources by moving inline async logic into private helper functions: wait_shutdown, recv_push, and next_response. No public API or behaviour changes.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ConnectionActor
    participant ShutdownToken
    participant PushQueue
    participant ResponseStream

    Client->>ConnectionActor: poll_sources()
    alt Wait for shutdown
        ConnectionActor->>ShutdownToken: wait_shutdown()
    end
    alt Receive high-priority push
        ConnectionActor->>PushQueue: recv_push(high_priority_rx)
    end
    alt Receive low-priority push
        ConnectionActor->>PushQueue: recv_push(low_priority_rx)
    end
    alt Poll next response
        ConnectionActor->>ResponseStream: next_response(response)
    end
Loading

Possibly related issues

Possibly related PRs

Poem

A hop and a skip, some code to refine,
Async awaits now neatly align.
Helpers extracted, the flow stays the same,
ConnectionActor’s logic—tidy, not tame!
With queues and responses now clear in their role,
This rabbit approves: refactoring’s goal! 🐇

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch codex/add-private-helper-functions-and-refactor-poll_sources

🪧 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 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
Copy link
Copy Markdown
Owner Author

leynos commented Jun 26, 2025

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 26, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Repository owner deleted a comment from coderabbitai Bot Jun 26, 2025
Repository owner deleted a comment from coderabbitai Bot Jun 26, 2025
Repository owner deleted a comment from coderabbitai Bot Jun 26, 2025
Repository owner deleted a comment from coderabbitai Bot Jun 26, 2025
Repository owner deleted a comment from coderabbitai Bot Jun 26, 2025
@leynos
Copy link
Copy Markdown
Owner Author

leynos commented Jun 26, 2025

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 26, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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 d9e5bdf and e2c271e.

📒 Files selected for processing (1)
  • src/connection.rs (3 hunks)
🔇 Additional comments (1)
src/connection.rs (1)

93-99: Helper improves readability – good extraction

Replacing the inline recv().await calls with Self::recv_push(..) keeps the select! arm concise while
preserving the bias order. Nice improvement.

Comment thread src/connection.rs
Comment thread src/connection.rs Outdated
Comment thread src/connection.rs
@leynos leynos force-pushed the codex/add-private-helper-functions-and-refactor-poll_sources branch from 11157a0 to 4225cc0 Compare June 26, 2025 18:45
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 e2c271e and 4225cc0.

📒 Files selected for processing (1)
  • src/connection.rs (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.rs`: Every Rust module must begin with a module level (`//!`) comment expl...

**/*.rs: Every Rust module must begin with a module level (//!) comment explaining the module's purpose and utility.
Document public Rust APIs using Rustdoc comments (///) so documentation can be generated with cargo doc.
Place function attributes after doc comments.

📄 Source: CodeRabbit Inference Engine (AGENTS.md)

List of files the instruction was applied to:

  • src/connection.rs
🪛 GitHub Check: build-test
src/connection.rs

[failure] 116-116:
this function takes 4 arguments but 3 arguments were supplied


[failure] 112-112:
this function takes 4 arguments but 3 arguments were supplied


[failure] 108-108:
this function takes 4 arguments but 3 arguments were supplied

🪛 GitHub Actions: CI
src/connection.rs

[error] 108-108: Rust compiler error E0061: this function takes 4 arguments but 3 arguments were supplied.

Comment thread src/connection.rs
Comment thread src/connection.rs
Comment thread src/connection.rs
@leynos leynos merged commit 9995c1d into main Jun 26, 2025
5 checks passed
@leynos leynos deleted the codex/add-private-helper-functions-and-refactor-poll_sources branch June 26, 2025 19:40
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