Introduce FrameContainer for middleware frames

[leynos]

Summary

• share request and response behaviour via FrameContainer
• keep ServiceRequest and ServiceResponse wrappers

Testing

• make lint
• make test
• cargo check --examples
• cargo build --examples

---

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

Summary by Sourcery

Introduce a generic FrameContainer to encapsulate middleware frame data and refactor ServiceRequest and ServiceResponse to use it, consolidating shared frame handling logic.

Enhancements:

• Add FrameContainer to encapsulate request and response frame data.
• Refactor ServiceRequest and ServiceResponse to delegate frame storage and access to FrameContainer.

[sourcery-ai]

Reviewer's Guide

Introduces a generic FrameContainer to encapsulate frame data and refactors ServiceRequest and ServiceResponse to delegate their internal Vec handling to this new container.

Class diagram for FrameContainer introduction and ServiceRequest/ServiceResponse refactor

classDiagram
    class FrameContainer~F~ {
        +frame: F
        +new(frame: F) FrameContainer<F>
        +frame() &F
        +frame_mut() &mut F
        +into_inner() F
    }

    class ServiceRequest {
        +inner: FrameContainer<Vec<u8>>
        +new(frame: Vec<u8>) ServiceRequest
        +frame() &[u8]
        +frame_mut() &mut Vec<u8>
        +into_inner() Vec<u8>
    }

    class ServiceResponse {
        +inner: FrameContainer<Vec<u8>>
        +new(frame: Vec<u8>) ServiceResponse
        +frame() &[u8]
        +frame_mut() &mut Vec<u8>
        +into_inner() Vec<u8>
    }

    ServiceRequest --> FrameContainer : uses
    ServiceResponse --> FrameContainer : uses

Loading

File-Level Changes

Change	Details	Files
Add generic FrameContainer abstraction	Define FrameContainer struct with generic parameter Derive Debug and Default Implement new, frame, frame_mut, and into_inner methods	src/middleware.rs
Refactor ServiceRequest to use FrameContainer	Replace raw frame field with inner FrameContainer<Vec> Update constructor to wrap Vec in FrameContainer Redirect frame, frame_mut, and into_inner to container methods	src/middleware.rs
Refactor ServiceResponse to use FrameContainer	Replace raw frame field with inner FrameContainer<Vec> Update constructor to wrap Vec in FrameContainer Redirect frame, frame_mut, and into_inner to container methods	src/middleware.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]

Summary by CodeRabbit

• Refactor
  • Improved the internal handling of frame data for requests and responses, ensuring better encapsulation and maintainability. No changes to the external interface or user-facing behaviour.

Walkthrough

A new generic struct, FrameContainer<F>, was introduced to encapsulate frame data and provide accessor and mutator methods. The ServiceRequest and ServiceResponse structs were refactored to use FrameContainer<Vec<u8>> instead of directly storing a Vec<u8>, with their methods updated to delegate to the new container.

Changes

File(s)	Change Summary
src/middleware.rs	Added generic FrameContainer<F> struct with methods; refactored ServiceRequest and ServiceResponse to use FrameContainer<Vec<u8>> for internal frame storage and updated all relevant methods accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ServiceRequest
    participant FrameContainer
    participant ServiceResponse

    Client->>ServiceRequest: Create ServiceRequest with frame data
    ServiceRequest->>FrameContainer: Store Vec<u8> in FrameContainer
    ServiceRequest->>FrameContainer: Access/mutate/consume frame via methods

    ServiceRequest->>ServiceResponse: Pass frame (via FrameContainer)
    ServiceResponse->>FrameContainer: Store Vec<u8> in FrameContainer
    ServiceResponse->>FrameContainer: Access/mutate/consume frame via methods

Loading

Possibly related PRs

• Implement basic middleware wrappers #80: Refactored ServiceRequest and ServiceResponse to encapsulate frame data within a new generic FrameContainer, building on the initial introduction of these structs and their frame handling methods.

Poem

In a frame, a change took root,
Wrapped in a container, snug and cute.
Requests and responses, now neat and clear,
With methods to borrow, mutate, and steer.
The rabbit hops, with code anew—
Encapsulated frames, just for you!
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Clippy (1.86.0)

Updating crates.io index

warning: failed to write cache, path: /usr/local/registry/index/index.crates.io-1949cf8c6b5b557f/.cache/bi/nc/bincode, error: Permission denied (os error 13)
Downloading crates ...
Downloaded async-trait v0.1.88
error: failed to create directory /usr/local/registry/cache/index.crates.io-1949cf8c6b5b557f

Caused by:
Permission denied (os error 13)

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b2bc64c and 3a11e3c.

📒 Files selected for processing (1)

• src/middleware.rs (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`**/*.rs`: * Seek to keep the cyclomatic complexity of functions no more than 12...

**/*.rs: * Seek to keep the cyclomatic complexity of functions no more than 12.

• Adhere to single responsibility and CQRS

• Place function attributes after doc comments.

• Do not use return in single-line functions.

• Move conditionals with >2 branches into a predicate function.

• Avoid unsafe unless absolutely necessary.

• Every module must begin with a //! doc comment that explains the module's purpose and utility.

• Comments must use en-GB-oxendict spelling and grammar.

• Lints must not be silenced except as a last resort.

  • #[allow] is forbidden.
  • Only narrowly scoped #[expect(lint, reason = "...")] is allowed.
  • No lint groups, no blanket or file-wide suppression.
  • Include FIXME: with link if a fix is expected.

• Use rstest fixtures for shared setup and to avoid repetition between tests.

• Replace duplicated tests with #[rstest(...)] parameterised cases.

• Prefer mockall for mocks/stubs.

• Prefer .expect() over .unwrap()

• Ensure that any API or behavioural changes are reflected in the documentation in docs/

• Ensure that any completed roadmap steps are recorded in the appropriate roadmap in docs/

⚙️ Source: CodeRabbit Configuration File

List of files the instruction was applied to:

• src/middleware.rs

🔇 Additional comments (3)

src/middleware.rs (3)

11-33: Well-designed generic container implementation.

The FrameContainer<F> struct provides a clean abstraction for frame data with appropriate accessor methods. The implementation follows Rust conventions and coding guidelines correctly.

---

38-61: Clean refactoring with proper delegation pattern.

The ServiceRequest refactoring successfully delegates frame handling to FrameContainer whilst maintaining the existing API. The delegation is implemented correctly and preserves all expected behaviour.

---

65-89: Consistent refactoring maintains API compatibility.

The ServiceResponse refactoring correctly mirrors the ServiceRequest changes and maintains the external API through proper delegation. The implementation is consistent and well-executed.

Please verify that any documentation in docs/ reflects this internal restructuring if it affects the described architecture or examples.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in a Comment
• Commit Unit Tests in branch codex/create-framecontainer-struct-and-update-api

---

🪧 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 found some issues that need to be addressed.

---

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

[leynos]

@coderabbitai resume

[coderabbitai]

✅ Actions performed

Reviews resumed.