Refactor routes test processor setup

[leynos]

Summary

• derive Clone and Copy for LengthPrefixedProcessor
• add default_processor helper for tests
• reuse a single processor instance in routes test

Testing

• make lint
• make test

---

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

Summary by Sourcery

Refactor routes tests to share a default LengthPrefixedProcessor instance by introducing a default_processor helper and deriving Clone and Copy for LengthPrefixedProcessor.

New Features:

• Add default_processor helper to construct a default length-prefixed processor in tests

Enhancements:

• Derive Clone and Copy for LengthPrefixedProcessor to allow reusing processor instances

Tests:

• Refactor routes test to use a single default_processor instance instead of creating multiple processors

Summary by CodeRabbit

• Refactor

  • Improved code maintainability by introducing a utility function for creating default frame processor instances in tests.
  • Enhanced struct capabilities by enabling cloning, copying, and debugging for internal processor types.

• Tests

  • Updated test setup to use a new utility function for consistent processor instantiation.

[sourcery-ai]

Reviewer's Guide

This PR refactors tests by deriving Clone and Copy for the LengthPrefixedProcessor, introducing a default_processor helper, and updating the routes tests to reuse a single processor instance rather than instantiating it inline.

Class diagram for LengthPrefixedProcessor changes

classDiagram
    class LengthPrefixedProcessor {
        +LengthFormat format
        <<Clone>>
        <<Copy>>
        <<Debug>>
    }

Loading

File-Level Changes

Change	Details	Files
Derive Clone and Copy for LengthPrefixedProcessor	Added #[derive(Clone, Copy, Debug)] to the struct Enabled processor instances to be trivially duplicated	src/frame.rs
Add default_processor helper for tests	Implemented default_processor() returning LengthPrefixedProcessor::default() Marked helper with #[must_use] for clarity	tests/util.rs
Refactor routes tests to use default_processor	Imported default_processor alongside run_app_with_frame Removed inline default instantiation of LengthPrefixedProcessor Reused a single processor instance for encoding	tests/routes.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]

Walkthrough

The changes introduce trait derivations (Clone, Copy, Debug) for the LengthPrefixedProcessor struct, add a utility function to create its default instance, and update test code to use this utility function for consistent processor instantiation.

Changes

File(s)	Change Summary
src/frame.rs	Added #[derive(Clone, Copy, Debug)] to LengthPrefixedProcessor.
tests/util.rs	Introduced pub fn default_processor() returning a default LengthPrefixedProcessor.
tests/routes.rs	Updated to use default_processor() from util instead of direct default() calls; adjusted imports.

Possibly related PRs

• Fix processor usage in routes test #94: Also modifies how LengthPrefixedProcessor is instantiated in tests, focusing on processor instantiation strategies.

Poem

A hop and a skip, a trait or three,
Now the processor clones quite easily!
With a helper function, tests are neat,
Default creation—oh, what a treat!
Debug and Copy, all in line—
This rabbit says, "Your code is fine!" 🐇

---

📜 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 16e2252 and 7263a1c.

📒 Files selected for processing (3)

• src/frame.rs (1 hunks)
• tests/routes.rs (2 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 (5)

src/frame.rs (1)

193-193: LGTM! Appropriate trait derivations for the processor struct.

Adding Clone, Copy, and Debug traits is suitable for LengthPrefixedProcessor since it's a small struct with a single field that already implements these traits. This enables easier duplication and debugging of processor instances, which aligns well with the test setup improvements mentioned in the PR objectives.

tests/util.rs (1)

55-59: LGTM! Clean utility function for test setup consistency.

The default_processor() function provides a centralised way to create default processor instances across the test suite. The #[must_use] attribute ensures the returned processor is utilised, and the implementation aligns with the PR objective of promoting code reuse in tests.

tests/routes.rs (3)

10-10: Good refactoring: Import only what's needed.

Changing the import to only include FrameProcessor trait instead of the concrete LengthPrefixedProcessor type makes the test more focused and leverages the new utility function appropriately.

---

16-16: Excellent use of the new utility function.

Importing default_processor from the util module enables consistent processor creation across tests, aligning with the PR objective of promoting code reuse.

---

31-34: Well-executed refactoring to reuse processor instance.

The change from LengthPrefixedProcessor::default() to default_processor() and reusing the same processor instance for both the app setup and frame encoding/decoding demonstrates excellent code reuse. This leverages the newly added Clone and Copy traits effectively.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch codex/refactor-test-to-reuse-processor-instance

---

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

Prompt for AI Agents

Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `src/frame.rs:193` </location>
<code_context>
 }

 /// Simple length-prefixed framing using a configurable length prefix.
+#[derive(Clone, Copy, Debug)]
 pub struct LengthPrefixedProcessor {
     format: LengthFormat,
</code_context>

<issue_to_address>
Attributes should be placed after the doc comment, not before.

The #[derive(Clone, Copy, Debug)] attribute should be placed after the doc comment for LengthPrefixedProcessor to comply with the style guide.
</issue_to_address>

---

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

[sourcery-ai]

issue (review_instructions): Attributes should be placed after the doc comment, not before.

The #[derive(Clone, Copy, Debug)] attribute should be placed after the doc comment for LengthPrefixedProcessor to comply with the style guide.

Review instructions:

Path patterns: **/*.rs

Instructions:
Ensure that function attributes are placed AFTER the function doc comment