Skip to content

Simplify preamble callback handling#73

Merged
leynos merged 4 commits intomainfrom
codex/define-and-apply-type-aliases-in-server.rs
Jun 18, 2025
Merged

Simplify preamble callback handling#73
leynos merged 4 commits intomainfrom
codex/define-and-apply-type-aliases-in-server.rs

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 18, 2025

Summary

  • introduce PreambleCallback and PreambleErrorCallback aliases
  • use the aliases in WireframeServer, worker_task and process_stream
  • drop clippy type_complexity allowances

Testing

  • cargo clippy -- -D warnings
  • RUSTFLAGS="-D warnings" cargo test

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

Summary by Sourcery

Simplify preamble callback types by introducing aliases and remove unnecessary lint allowances

Enhancements:

  • Introduce PreambleCallback and PreambleErrorCallback type aliases
  • Replace inline Arc callback signatures in WireframeServer, worker_task, and process_stream with the new aliases
  • Remove clippy::type_complexity allowances now rendered obsolete

Summary by CodeRabbit

  • Refactor
    • Improved code clarity and maintainability by simplifying internal callback type definitions. No changes to user-facing features or behaviour.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 18, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

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.

Walkthrough

This change introduces two new public type aliases for callback functions related to preamble decoding in the server module. These aliases replace explicit Arc<dyn Fn...> types in struct fields and function parameters, simplifying type declarations and removing the need for Clippy complexity allowances. No control flow or semantic behaviour is altered.

Changes

File(s) Change Summary
src/server.rs Added PreambleCallback<T> and PreambleErrorCallback type aliases; updated struct fields and function parameters to use these aliases instead of explicit Arc<dyn Fn...> types; removed #[allow(clippy::type_complexity)] attributes.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant WireframeServer
    participant PreambleCallback
    participant PreambleErrorCallback

    Client->>WireframeServer: Sends connection/preamble
    WireframeServer->>WireframeServer: Decodes preamble
    alt Decode success
        WireframeServer->>PreambleCallback: Call with decoded preamble
    else Decode failure
        WireframeServer->>PreambleErrorCallback: Call with decode error
    end
Loading

Possibly related PRs

  • Add WireframeServer skeleton #6: Refactors callback type declarations in the same WireframeServer implementation, modifying struct and function signatures in src/server.rs.
  • Implement preamble callback tests #28: Introduced and tested the callback fields and function parameters now refactored with type aliases in this PR, indicating a direct code-level relationship.

Poem

A hop and a skip, a type alias appears,
Simplifying callbacks, reducing our fears.
No more complex types to clutter our den,
Just clear, crisp aliases—much easier than!
The server now smiles, its burden made light,
Thanks to a rabbit who codes through the night. 🐇

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch codex/define-and-apply-type-aliases-in-server.rs

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

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 18, 2025

Reviewer's Guide

Introduces type aliases for preamble success and error callbacks, refactors WireframeServer and related async functions to use these aliases, and removes clippy::type_complexity allowances.

File-Level Changes

Change Details Files
Define PreambleCallback and PreambleErrorCallback aliases
  • Add alias for success callback signature
  • Add alias for failure callback signature
src/server.rs
Refactor callback parameters to use aliases
  • Update WireframeServer fields to use PreambleCallback and PreambleErrorCallback
  • Change worker_task parameters to use the new aliases
  • Adjust process_stream parameters to reference the aliases
src/server.rs
Remove clippy::type_complexity allowances
  • Drop allow annotation on WireframeServer
  • Remove clippy allowance on worker_task
  • Eliminate allow on process_stream
src/server.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

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 18, 2025

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 18, 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.

@leynos leynos merged commit 25bc8a0 into main Jun 18, 2025
5 checks passed
@leynos leynos deleted the codex/define-and-apply-type-aliases-in-server.rs branch June 18, 2025 22:26
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