Refactor connection callback types

[leynos]

Summary

• alias setup and teardown callbacks for clarity
• add doc examples for connection callbacks

Testing

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

---

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

Summary by Sourcery

Introduce ConnectionSetup and ConnectionTeardown type aliases for connection callbacks with documentation examples, and update WireframeApp to use them

Enhancements:

• Add ConnectionSetup and ConnectionTeardown aliases for connection setup and teardown callbacks
• Refactor WireframeApp to use the new callback type aliases for on_connect and on_disconnect

Documentation:

• Include doc examples illustrating how to use ConnectionSetup and ConnectionTeardown callbacks

Summary by CodeRabbit

• Documentation

  • Improved documentation and added usage examples for connection setup and teardown callbacks.
  • Enhanced readability of method comments.

• Refactor

  • Simplified and clarified the definition of connection setup and teardown callbacks for improved maintainability.

[sourcery-ai]

Reviewer's Guide

Introduces named type aliases for connection setup and teardown callbacks with documentation examples, and refactors existing fields in WireframeApp to use these aliases.

Class diagram for refactored connection callback types in WireframeApp

classDiagram
    class WireframeApp {
        +HashMap<u32, Service> routes
        +Vec<Service> services
        +Vec<Box<dyn Middleware>> middleware
        +BoxedFrameProcessor frame_processor
        +S serializer
        +Option<ConnectionSetup<C>> on_connect
        +Option<ConnectionTeardown<C>> on_disconnect
    }

    class ConnectionSetup {
        <<type alias>>
        +Fn() -> Future<Output = C>
    }
    class ConnectionTeardown {
        <<type alias>>
        +Fn(C) -> Future<Output = ()>
    }

    WireframeApp --> "1" ConnectionSetup : uses as on_connect
    WireframeApp --> "1" ConnectionTeardown : uses as on_disconnect

Loading

File-Level Changes

Change	Details	Files
Introduced ConnectionSetup type alias with documentation examples	Defined ConnectionSetup as Arc<Fn() -> Pin<Box<dyn Future<Output=C> + Send>> + Send + Sync> Added doc comment and no_run example showing async connection initialization	src/app.rs
Introduced ConnectionTeardown type alias with documentation examples	Defined ConnectionTeardown as Arc<Fn(C) -> Pin<Box<dyn Future<Output=()>> + Send> + Send + Sync> Added doc comment and no_run example showing async connection cleanup	src/app.rs
Refactored WireframeApp fields to use callback aliases	Replaced on_connect field type with Option<ConnectionSetup> Replaced on_disconnect field type with Option<ConnectionTeardown>	src/app.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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

Walkthrough

This update introduces two type aliases, ConnectionSetup<C> and ConnectionTeardown<C>, to represent asynchronous connection lifecycle callbacks. The WireframeApp struct is refactored to use these aliases for its on_connect and on_disconnect fields. Documentation and formatting improvements are also included.

Changes

File(s)	Change Summary
src/app.rs	Added ConnectionSetup<C> and ConnectionTeardown<C> type aliases; refactored WireframeApp to use them; improved documentation and formatting.

Poem

In fields of code where futures grow,
Two new aliases now bestow—
Setup and teardown, clear and neat,
Making app connections sweet.
With types refined and docs anew,
The rabbit hops—this code feels new!
🐇✨

---

📜 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 5863c26 and 2f624c2.

📒 Files selected for processing (1)

• src/app.rs (2 hunks)

🔇 Additional comments (4)

src/app.rs (4)

21-37: Excellent type alias with comprehensive documentation.

The ConnectionSetup<C> type alias significantly improves code readability by replacing the complex inline function pointer type. The documentation is exemplary, providing a complete usage example that demonstrates proper Arc wrapping and realistic use case (authentication).

---

39-55: Well-designed teardown type alias with clear documentation.

The ConnectionTeardown<C> type alias perfectly complements ConnectionSetup<C> and maintains the same high documentation standard. The example correctly demonstrates state consumption using async move, which is essential for proper ownership transfer.

---

68-69: Perfect application of the new type aliases.

The struct field updates correctly replace the complex inline types with the new ConnectionSetup<C> and ConnectionTeardown<C> aliases. This dramatically improves readability whilst maintaining identical semantics and avoiding any breaking changes.

---

209-210: Good formatting improvement.

Splitting the long comment line enhances readability whilst preserving the documentation content. This aligns well with the PR's goal of improving code clarity.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch codex/refactor-callback-signatures-with-type-aliases

---

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

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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[leynos]

@coderabbitai review

[coderabbitai]

✅ 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]

@coderabbitai review

[coderabbitai]

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