Merged
Conversation
Contributor
Reviewer's GuideThis PR updates documentation and code examples to use serde::Serialize instead of bincode::Encode, and reflows markdown lines for consistent formatting across the docs. Class diagram for updated trait usage in helper functionsclassDiagram
class WireframeApp
class drive_with_bincode {
+drive_with_bincode(app: WireframeApp, msg: M) IoResult<Vec<u8>>
M: Serialize
}
WireframeApp <.. drive_with_bincode : uses
class Ping {
+u8
<<Serialize>>
}
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
Summary by CodeRabbit
WalkthroughUpdate all documentation references and function signatures from Changes
Possibly related PRs
Poem
✨ Finishing Touches
🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![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 and found some issues that need to be addressed.
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 (2)
docs/wireframe-testing-crate.md(6 hunks)wireframe_testing/src/lib.rs(1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
**/*.rs
Instructions used from:
Sources:
📄 CodeRabbit Inference Engine
- AGENTS.md
⚙️ CodeRabbit Configuration File
docs/**/*.md
Instructions used from:
Sources:
📄 CodeRabbit Inference Engine
- AGENTS.md
- docs/asynchronous-outbound-messaging-roadmap.md
- docs/contents.md
- docs/documentation-style-guide.md
- docs/wireframe-1-0-detailed-development-roadmap.md
**/*.md
Instructions used from:
Sources:
📄 CodeRabbit Inference Engine
- AGENTS.md
⚙️ CodeRabbit Configuration File
🧠 Learnings (1)
docs/wireframe-testing-crate.md (2)
Learnt from: CR
PR: leynos/wireframe#0
File: docs/roadmap.md:0-0
Timestamp: 2025-06-30T23:07:15.902Z
Learning: Applies to docs/tests/server.rs : Provide testing utilities for handlers, offering simple ways to drive handlers with raw frames for unit tests; future helpers may reside in a `wireframe-testing` crate
Learnt from: CR
PR: leynos/wireframe#0
File: docs/wireframe-testing-crate.md:0-0
Timestamp: 2025-06-24T16:43:59.363Z
Learning: Convenience wrappers that accept serializable types (e.g., any type implementing bincode::Encode) and handle encoding and framing internally simplify test code and reduce boilerplate, especially when most tests require encoding structured data into frames.
🔇 Additional comments (2)
docs/wireframe-testing-crate.md (2)
53-65: Avoid a silent contract change.Exposing
drive_with_bincodeasfn<M: Serialize>broadens the accepted types, yet the name still hard-codes the chosen codec. Either rename the function (e.g.,drive_with_serialised) or reinforce in the docs thatbincoderemains the implementation detail. This prevents future surprises when callers try to decode with a different format.
115-116: Show import for the derive macro.Add
use serde::Serialize;above the example to make the#[derive(serde::Serialize)]compile standalone.#[derive(serde::Serialize)] struct Ping(u8); + +use serde::Serialize;Likely an incorrect or invalid review comment.
Comment on lines
+6
to
7
| //! message implementing [`serde::Serialize`] – the example uses a simple `u8` | ||
| //! value so no generics are required. |
Contributor
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Clarify the serializer expectation.
State explicitly that the helpers still use bincode under the hood. “Any message implementing serde::Serialize” is correct, but without mentioning the concrete encoder the reader might assume a generic serialisation mechanism.
Example wording:
“…work with any message implementing
serde::Serialize; the payload is currently encoded withbincodebefore framing.”
🤖 Prompt for AI Agents
In wireframe_testing/src/lib.rs around lines 6 to 7, clarify the documentation
comment to explicitly state that the serialization uses the bincode encoder.
Update the comment to mention that while the helpers accept any message
implementing serde::Serialize, the payload is currently encoded with bincode
before framing, to avoid confusion about the serialization mechanism.
Comment on lines
108
to
113
| For most tests the input frame is preassembled from raw bytes. A small wrapper | ||
| can accept any `bincode::Encode` value and perform the encoding and framing | ||
| before delegating to `drive_with_frame`. This mirrors the patterns in | ||
| `tests/routes.rs` where structs are converted to bytes with `BincodeSerializer` | ||
| and then wrapped in a length‑prefixed frame. | ||
| can accept any `serde::Serialize` value and perform the encoding and framing | ||
| before delegating to `drive_with_frame`. This mirrors the patterns in `tests/ | ||
| routes.rs` where structs are converted to bytes with `BincodeSerializer` and | ||
| then wrapped in a length‑prefixed frame. | ||
|
|
Contributor
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Wrap long sentence at 80 columns.
The two changed lines exceed the documentation style-guide limit. Wrap them to maintain consistency with the rest of the file and silence markdownlint MD013.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~108-~108: Possible missing comma found.
Context: ...# Bincode Convenience Wrapper For most tests the input frame is preassembled from ra...
(AI_HYDRA_LEO_MISSING_COMMA)
🤖 Prompt for AI Agents
In docs/wireframe-testing-crate.md around lines 108 to 113, the two sentences
exceed the 80-column limit set by the documentation style guide. Break these
long lines into shorter lines, each not exceeding 80 characters, to maintain
consistency and comply with markdownlint MD013 rules.
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
serde::SerializeTesting
make lintmake testmdformat-all(fails: MD052 in docs)nixie *.md **/*.mdhttps://chatgpt.com/codex/tasks/task_e_6873bfa294a483228fbbaae3e5321f02
Summary by Sourcery
Fix missing trait references by replacing bincode::Encode with serde::Serialize in documentation and helper code
Bug Fixes:
Enhancements:
Documentation: