Document connection lifecycle hooks

[leynos]

Summary

• mention connection lifecycle hooks in README feature list
• describe on_connection_setup and on_connection_teardown
• give example storing state in setup and using it in teardown

Testing

• mdformat-all
• markdownlint README.md docs/*.md
• nixie docs/preamble-validator.md
• nixie docs/roadmap.md
• cargo fmt -- --check
• cargo clippy -- -D warnings
• RUSTFLAGS="-D warnings" cargo test

---

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

Summary by Sourcery

Document the new connection lifecycle hooks by updating the feature list and adding explanatory documentation with a setup/teardown example

Documentation:

• Mention connection lifecycle hooks in the README feature list
• Add a new “Connection Lifecycle” section describing on_connection_setup and on_connection_teardown with an example

Summary by CodeRabbit

• Documentation
  • Updated the README with details on new connection lifecycle hooks for asynchronous setup and teardown in the WireframeApp API.
  • Added an example demonstrating how to use connection lifecycle callbacks to manage per-connection state.

[sourcery-ai]

Reviewer's Guide

This PR enhances the README by adding and documenting per-connection lifecycle hooks: a new feature list item and a detailed “Connection Lifecycle” section with descriptions and an example.

Sequence diagram for connection setup and teardown hooks

sequenceDiagram
    actor User
    participant App
    User->>App: Open connection
    App->>App: on_connection_setup()
    Note right of App: Setup state created
    User->>App: Interact (send/receive data)
    User->>App: Close connection
    App->>App: on_connection_teardown(state)
    Note right of App: Teardown uses setup state

Loading

File-Level Changes

Change	Details	Files
Introduce connection lifecycle hooks in feature list	Add “Connection lifecycle hooks” bullet Escape link brackets in preamble item	README.md
Add Connection Lifecycle section with callbacks description and example	Describe on_connection_setup and on_connection_teardown state flow Provide Rust code example illustrating setup and teardown	README.md

---

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]

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

The README was updated to document new connection lifecycle hooks in the WireframeApp API. This includes a feature list addition, a detailed explanation of the setup and teardown hooks, and a Rust code example demonstrating their usage. No source code or architectural changes were made.

Changes

File(s)	Change Summary
README.md	Added documentation for connection lifecycle hooks, feature list entry, explanatory section, and example code.
src/app.rs	Reformatted documentation comment for on_connection_setup method for improved readability without changing logic.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant WireframeApp
    participant SetupCallback
    participant TeardownCallback

    Client->>WireframeApp: Open connection
    WireframeApp->>SetupCallback: Run on_connection_setup()
    SetupCallback-->>WireframeApp: Return state
    Note over WireframeApp: Connection active
    Client->>WireframeApp: Close connection
    WireframeApp->>TeardownCallback: Run on_connection_teardown(state)
    TeardownCallback-->>WireframeApp: Complete teardown

Loading

Possibly related PRs

• Update roadmap with connection features #26: Adds connection lifecycle hooks as a planned feature in the roadmap, conceptually linked to the documentation added here.

Poem

In README fields where docs now grow,
Connection hooks are on show!
Setup and teardown, side by side,
With Rusty code as a guide.
WireframeApp’s lifecycle’s clear—
Hopping forward, year by year!
🐇

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch codex/update-readme-with-connection-setup/teardown-example

---

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

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3f43136 and 40f895f.

📒 Files selected for processing (1)

• README.md (2 hunks)

🔇 Additional comments (2)

README.md (2)

16-16: Approve connection preamble bullet.
The added “Connection preamble” feature bullet correctly extends the feature list and points to the relevant docs.

---

22-22: Approve connection lifecycle hooks bullet.
This succinctly surfaces the new per-connection setup/teardown hooks in the feature list.

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

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 40f895f and 15adc38.

📒 Files selected for processing (2)

• README.md (2 hunks)
• src/app.rs (1 hunks)

🔇 Additional comments (4)

src/app.rs (1)

174-175: Docs formatting improvement approved. The reflowed lines enhance readability without impacting semantics.

README.md (3)

22-23: Approve feature list addition. The new hook entry is clear, and the anchor link correctly references the section.

---

92-96: Section content approved. The "Connection Lifecycle" heading and description clearly explain the setup/teardown flow.

---

99-103: Verify example compiles. As on_connection_setup and on_connection_teardown return Result, consider adding .unwrap() or propagating errors (?) in the example for correctness.