Merged
Conversation
Contributor
Reviewer's GuideAdds an echo server example with logging middleware and routing, introduces in-memory frame-based test utilities, and provides an async routing test using length-prefixed framing to verify echo behavior. Sequence diagram for echo request handling in the example serversequenceDiagram
actor Client
participant Server as WireframeServer
participant App as WireframeApp
participant Logger
Client->>Server: Connect & send request (route 1)
Server->>App: Pass request
App->>Logger: (Middleware marker, no hooks)
App->>App: Route handler invoked
App-->>Server: Echo response
Server-->>Client: Send echoed response
Class diagram for echo server example and middlewareclassDiagram
class Logger {
<<Middleware>>
}
class WireframeApp {
+new()
+wrap(middleware)
+route(route_id, handler)
}
class WireframeServer {
+new(factory)
+bind(address)
+run()
}
Logger --|> Middleware
WireframeApp o-- Logger : wraps
WireframeServer o-- WireframeApp : uses factory
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
WalkthroughA new example demonstrating a basic Wireframe server with middleware is added. Additionally, asynchronous test utilities and a new test are introduced to verify echo functionality and message handling. Supporting data structures and helper functions are included to facilitate in-memory testing of the server's response behaviour. Changes
Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (3)
⏰ Context from checks skipped due to timeout of 90000ms (1)
🔇 Additional comments (5)
|
![codescene-delta-analysis[bot]](https://avatars.githubusercontent.com/in/53921?s=60&v=4){kind=small}
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey @leynos - I've reviewed your changes - here's some feedback:
- The echo example’s handler is currently a no-op; update it to forward the incoming message back to the client so it actually demonstrates echo functionality.
- The Logger middleware in examples/echo.rs has no implementation; consider adding simple println! hooks in middleware methods to illustrate logging behavior.
- The run_app_with_frame test utility uses a fixed 1024-byte duplex buffer, which may not accommodate larger frames—consider making the buffer size configurable or increasing its default capacity.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The echo example’s handler is currently a no-op; update it to forward the incoming message back to the client so it actually demonstrates echo functionality.
- The Logger middleware in examples/echo.rs has no implementation; consider adding simple println! hooks in middleware methods to illustrate logging behavior.
- The run_app_with_frame test utility uses a fixed 1024-byte duplex buffer, which may not accommodate larger frames—consider making the buffer size configurable or increasing its default capacity.
## Individual Comments
### Comment 1
<location> `examples/echo.rs:9` </location>
<code_context>
+};
+
+struct Logger;
+impl Middleware for Logger {}
+
+#[tokio::main]
</code_context>
<issue_to_address>
Implement the required methods for the Middleware trait or explicitly document why the implementation is empty.
Leaving the Middleware implementation for Logger empty may be intentional, but it is best practice to either implement the required methods or add a comment explaining why the implementation is empty. This helps future maintainers understand the intent.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (3)
examples/echo.rs(1 hunks)tests/routes.rs(1 hunks)tests/util.rs(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: build-test
- GitHub Check: Analyze (actions)
🔇 Additional comments (4)
tests/util.rs (1)
13-27: Well-designed test utility function.The implementation is solid with proper async handling, error propagation, and clear documentation of panic conditions. The use of duplex streams for in-memory testing is appropriate and efficient.
examples/echo.rs (1)
8-9: Empty middleware implementation is acceptable for examples.The minimal Logger middleware implementation is appropriate for demonstrating the middleware pattern in an example.
tests/routes.rs (2)
18-25: Well-defined test data structures.The
TestEnvelopeandEchostructs are properly defined with the necessary bincode traits for serialisation and deserialisation.
44-54: Proper message serialisation and framing.The test correctly demonstrates the serialisation and framing process using the BincodeSerializer and LengthPrefixedProcessor.
Owner
Author
|
@sourcery-ai review |
Owner
Author
|
@coderabbitai review |
Contributor
✅ Actions performedReview triggered.
|
Contributor
There was a problem hiding this comment.
Hey @leynos - I've reviewed your changes - here's some feedback:
- The
run_app_with_framehelper only drives a single request–response; consider extending it to handle multiple frames so tests can simulate streaming or pipelined interactions. - In the
echo.rsexample theLoggermiddleware is a no-op—either implement a simple log hook to show howwrapworks or remove the unused stub for clarity.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The `run_app_with_frame` helper only drives a single request–response; consider extending it to handle multiple frames so tests can simulate streaming or pipelined interactions.
- In the `echo.rs` example the `Logger` middleware is a no-op—either implement a simple log hook to show how `wrap` works or remove the unused stub for clarity.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
This was referenced Jun 20, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
examples/echo.rsshowing basic server setupTesting
make lintmake testhttps://chatgpt.com/codex/tasks/task_e_68555d3a96408322bdbe678fd8da1844
Summary by Sourcery
Add an echo server example, introduce utilities to test the app with wireframe frames, and add a route test verifying request/response echo logic
New Features:
Tests:
Summary by CodeRabbit