Implement multi-frame test helper

[leynos]

Summary

• extend run_app_with_frame to support multiple frames via new utilities
• add sequential frames test exercising streaming behaviour
• clean up echo example by removing placeholder middleware

Testing

• make lint
• make test

---

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

Summary by Sourcery

Introduce support for testing multiple frames, add a corresponding multi-frame test, update frame processor usage, and clean up the example application.

New Features:

• Expose run_app_with_frames and run_app_with_frames_with_capacity helpers for testing multiple input frames
• Add multiple_frames_processed_in_sequence test to validate sequential frame handling

Enhancements:

• Refactor run_app_with_frame to delegate to the multi-frame helper
• Switch to LengthPrefixedProcessor::default() for frame processing consistency
• Remove unused Logger middleware from the echo example

Summary by CodeRabbit

• Bug Fixes

  • Removed unused middleware from the application setup for improved clarity.

• New Features

  • Added a new asynchronous test to verify that multiple frames are processed sequentially.

• Refactor

  • Updated test utilities to support handling multiple frames, allowing for more comprehensive testing scenarios.

• Tests

  • Enhanced test coverage for multi-frame processing to ensure correct behaviour.

[sourcery-ai]

Reviewer's Guide

This PR extends test utilities to support driving applications with multiple frames by introducing new multi-frame runners, updates existing tests to leverage these utilities and default processor instances, and cleans up the echo example by removing a placeholder middleware.

Class diagram for updated test utilities with multi-frame support

classDiagram
    class TestHelper {
        +run_app_with_frame(frame)
        +run_app_with_frames(frames)
    }
    TestHelper : +run_app_with_frame(frame)
    TestHelper : +run_app_with_frames(frames)

    class WireframeApp {
        +new()
        +route()
    }

    TestHelper --> WireframeApp : drives

Loading

Class diagram for cleaned up echo example

classDiagram
    class WireframeApp {
        +new()
        +route()
    }
    class WireframeServer {
    }
    WireframeApp --> WireframeServer : used by

Loading

File-Level Changes

Change	Details	Files
Add multi-frame test helper utilities	Introduce run_app_with_frames and run_app_with_frames_with_capacity functions Refactor run_app_with_frame to delegate to the multi-frame runner Implement frame write loop for multiple inputs Use DEFAULT_CAPACITY in the helper API	tests/util.rs
Update tests to use default processor and multi-frame runner	Import and use run_app_with_frames alongside run_app_with_frame Switch LengthPrefixedProcessor instantiation to ::default() Add multiple_frames_processed_in_sequence async test exercising streaming behavior Decode and deserialize two sequential frames and assert responses	tests/routes.rs
Remove placeholder middleware from echo example	Delete Logger struct and its Middleware implementation Remove wrap(Logger) call and unused imports Simplify example imports to only include WireframeApp and WireframeServer	examples/echo.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]

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 changes remove the Logger middleware from the echo example, simplify imports, and extend test utilities to handle multiple frames. A new asynchronous test verifies sequential processing of multiple frames. Utility functions are refactored to generalise from single-frame to multi-frame support, with new convenience functions added.

Changes

File(s)	Change Summary
examples/echo.rs	Removed Logger middleware, adjusted imports, and eliminated middleware wrapping from app setup.
tests/routes.rs	Updated to use LengthPrefixedProcessor::default(); added async test for sequential multi-frame processing.
tests/util.rs	Refactored utilities to support multiple frames; added multi-frame functions; updated single-frame functions to delegate.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Test Case
    participant Util as Test Utilities
    participant App as WireframeApp
    participant Handler as Route Handler

    Test->>Util: Call run_app_with_frames(frames)
    Util->>App: Start app with handler
    loop For each frame
        Util->>App: Send frame
        App->>Handler: Process frame
        Handler-->>App: Return response
    end
    App-->>Util: Write responses to output buffer
    Util-->>Test: Return output buffer

Loading

Possibly related PRs

• Add echo example and route test utilities #86: Adds the initial Logger middleware and example setup, along with single-frame test utilities. The current changes remove and extend these components, making this PR directly related.

Poem

A hop, a skip, a frame or two,
No more logs to muddle through!
Utilities now dance in line,
Handling frames just fine.
With tests that check them one by one,
This rabbit’s work is never done—
Onward, code, let’s have some fun! 🐇

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch codex/extend-run_app_with_frame-for-multiple-frames

---

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