Skip to content

Add helper test for connection state#116

Merged
leynos merged 5 commits intomainfrom
codex/update-tests-to-cover-new-generic-parameters
Jun 23, 2025
Merged

Add helper test for connection state#116
leynos merged 5 commits intomainfrom
codex/update-tests-to-cover-new-generic-parameters

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 23, 2025

Summary

  • exercise helper generics with custom connection state
  • use run_app_with_frame in lifecycle tests

Testing

  • make lint
  • make test

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

Summary by Sourcery

Add utilities and a new integration test to verify custom connection state propagation in WireframeApp

Enhancements:

  • Extract frame-processing and runtime helpers (processor, run_app_with_frame) into a util module
  • Introduce a StateEnvelope packet type with Bincode serialization and length-prefixed framing for testing

Tests:

  • Add helpers_propagate_connection_state test to exercise connection setup and teardown callbacks with custom state

Summary by CodeRabbit

  • Tests
    • Refactored lifecycle tests for improved modularity and clarity.
    • Added a new helper for setting up lifecycle callbacks with generic packet support.
    • Introduced a new test to verify correct propagation of connection state through the app lifecycle and routing.
    • Enhanced test coverage with additional packet types and state handling.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 23, 2025

Reviewer's Guide

This PR enhances the lifecycle tests by refactoring the imports to use shared test utilities (including run_app_with_frame and framing/serialization helpers), introduces a custom StateEnvelope type with Bincode-based serialization that implements the Packet trait, and adds a new integration test that verifies generic connection-state propagation via the on_connection_setup/on_connection_teardown hooks.

File-Level Changes

Change Details Files
Refactor imports to leverage shared test utilities and framing/serialization support
  • Added bytes::BytesMut import
  • Expanded wireframe import to include frame and serializer modules
  • Added mod util and imported processor & run_app_with_frame
tests/lifecycle.rs
Define StateEnvelope with Bincode serialization and Packet implementation
  • Derived bincode::Encode/BorrowDecode for StateEnvelope
  • Implemented the Packet trait methods (id, into_parts, from_parts)
tests/lifecycle.rs
Add helpers_propagate_connection_state integration test
  • Instantiate WireframeApp with custom envelope and frame processor
  • Set up connection-state hooks with on_connection_setup/on_connection_teardown
  • Serialize a StateEnvelope via BincodeSerializer and LengthPrefixedProcessor
  • Drive the app using run_app_with_frame and assert state propagation
tests/lifecycle.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 Jun 23, 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

The test file lifecycle.rs was refactored to introduce a generic helper for setting up a WireframeApp with lifecycle callbacks. A new packet struct was added, and a new test verifies that connection state propagates correctly using these helpers and custom packet types.

Changes

File(s) Change Summary
tests/lifecycle.rs Refactored tests: added a generic helper for lifecycle callbacks, introduced a new packet struct, and added a test for state propagation through lifecycle and routing.

Sequence Diagram(s)

sequenceDiagram
    participant Test
    participant WireframeApp
    participant SetupCallback
    participant TeardownCallback
    participant RouteHandler

    Test->>WireframeApp: Create with lifecycle callbacks (setup, teardown)
    WireframeApp->>SetupCallback: On connection setup
    SetupCallback-->>WireframeApp: Return connection state
    Test->>WireframeApp: Send frame (StateEnvelope)
    WireframeApp->>RouteHandler: Route packet based on id
    RouteHandler-->>WireframeApp: Processed output
    WireframeApp->>TeardownCallback: On connection teardown
    TeardownCallback-->>WireframeApp: Confirm state match
Loading

Possibly related PRs

Poem

In the warren where packets hop and play,
New helpers guide the lifecycle way.
State envelopes bounce, counters rise—
Each connection tracked with rabbit eyes.
With setup and teardown, all is neat,
The tests now thump with a rhythmic beat!
🐇✨

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch codex/update-tests-to-cover-new-generic-parameters

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

Copy link
Copy Markdown

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gates Failed
Enforce advisory code health rules (1 file with Code Duplication)

Gates Passed
5 Quality Gates Passed

See analysis details in CodeScene

Reason for failure
Enforce advisory code health rules Violations Code Health Impact
lifecycle.rs 1 advisory rule 10.00 → 9.39 Suppress

Quality Gate Profile: Pay Down Tech Debt
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

Copy link
Copy Markdown

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gates Failed
Enforce advisory code health rules (1 file with Code Duplication)

Gates Passed
5 Quality Gates Passed

See analysis details in CodeScene

Reason for failure
Enforce advisory code health rules Violations Code Health Impact
lifecycle.rs 1 advisory rule 10.00 → 9.39 Suppress

Quality Gate Profile: Pay Down Tech Debt
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

Copy link
Copy Markdown

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gates Failed
Enforce advisory code health rules (1 file with Code Duplication)

Gates Passed
5 Quality Gates Passed

See analysis details in CodeScene

Reason for failure
Enforce advisory code health rules Violations Code Health Impact
lifecycle.rs 1 advisory rule 10.00 → 9.39 Suppress

Quality Gate Profile: Pay Down Tech Debt
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

Copy link
Copy Markdown

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gates Failed
Enforce advisory code health rules (1 file with Code Duplication)

Gates Passed
5 Quality Gates Passed

See analysis details in CodeScene

Reason for failure
Enforce advisory code health rules Violations Code Health Impact
lifecycle.rs 1 advisory rule 10.00 → 9.39 Suppress

Absence of Expected Change Pattern

  • wireframe/tests/util.rs is usually changed with: wireframe/tests/routes.rs

Quality Gate Profile: Pay Down Tech Debt
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

Copy link
Copy Markdown

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

Absence of Expected Change Pattern

  • wireframe/tests/util.rs is usually changed with: wireframe/tests/routes.rs

Quality Gate Profile: Pay Down Tech Debt
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

@leynos leynos force-pushed the codex/update-tests-to-cover-new-generic-parameters branch from 12ff486 to 69c5f41 Compare June 23, 2025 02:46
@leynos leynos merged commit 1e3d687 into main Jun 23, 2025
5 checks passed
@leynos leynos deleted the codex/update-tests-to-cover-new-generic-parameters branch June 23, 2025 02:50
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