Skip to content

Refactor routes test processor setup#96

Merged
leynos merged 1 commit intomainfrom
4axeff-codex/refactor-test-to-reuse-processor-instance
Jun 20, 2025
Merged

Refactor routes test processor setup#96
leynos merged 1 commit intomainfrom
4axeff-codex/refactor-test-to-reuse-processor-instance

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 20, 2025

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 the framing setup in routes tests by deriving Clone and Copy for the length-prefixed processor and adding a reusable default_processor helper

Enhancements:

  • Derive Clone and Copy on LengthPrefixedProcessor
  • Introduce default_processor helper in tests to instantiate a default length-prefixed processor
  • Refactor routes tests to reuse a single LengthPrefixedProcessor instance

Summary by CodeRabbit

  • Refactor
    • Improved test code by introducing a utility function for creating default processor instances, simplifying test setup.
  • Tests
    • Updated tests to use the new utility function for processor creation.
  • Chores
    • Enhanced a struct with additional traits to support easier copying, cloning, and debugging.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 20, 2025

Reviewer's Guide

Derived Copy and Clone for LengthPrefixedProcessor, introduced a default_processor helper for tests, and refactored the routes tests to reuse a single processor instance via this helper.

Class diagram for LengthPrefixedProcessor trait derivation

classDiagram
    class FrameProcessor {
        <<trait>>
        +process_frame()
    }
    class LengthPrefixedProcessor {
        +format: LengthFormat
        +clone()
        +copy()
    }
    LengthPrefixedProcessor --|> FrameProcessor
Loading

Class diagram for test utilities refactor

classDiagram
    class TestUtil {
        +default_processor(): LengthPrefixedProcessor
    }
    class LengthPrefixedProcessor {
        +format: LengthFormat
        +clone()
        +copy()
    }
    TestUtil ..> LengthPrefixedProcessor : uses
Loading

File-Level Changes

Change Details Files
Derived Clone, Copy, and Debug for LengthPrefixedProcessor
  • Added Clone and Copy traits to the derive attribute
  • Included Debug derive for consistency
src/frame.rs
Added default_processor test helper
  • Created default_processor() returning LengthPrefixedProcessor::default()
  • Annotated it with #[must_use] for clarity
tests/util.rs
Refactored routes tests to reuse a single processor
  • Imported default_processor in tests/routes.rs
  • Replaced two LengthPrefixedProcessor::default() calls with a single processor instance
  • Removed redundant instantiation before 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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 20, 2025

Walkthrough

The changes add Clone, Copy, and Debug trait derivations to the LengthPrefixedProcessor struct. Test code now uses a new default_processor utility function for constructing processor instances, replacing direct calls to LengthPrefixedProcessor::default(). The utility function is introduced in the test utilities module.

Changes

File(s) Change Summary
src/frame.rs Added #[derive(Clone, Copy, Debug)] to LengthPrefixedProcessor struct.
tests/util.rs Added public function default_processor() returning a default LengthPrefixedProcessor instance.
tests/routes.rs Replaced direct use of LengthPrefixedProcessor::default() with default_processor() utility; updated imports.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Test Code
    participant Util as util::default_processor
    participant Frame as LengthPrefixedProcessor

    Test->>Util: Call default_processor()
    Util->>Frame: Return LengthPrefixedProcessor::default()
    Util-->>Test: Return default processor instance
    Test->>Frame: Use processor for encoding/decoding
Loading

Possibly related PRs

Poem

In the meadow of code where processors grow,
Now they can copy, debug, and clone as they go!
Tests hop to the utility, neat and precise,
With a single new function—oh, isn't that nice?
🐇✨

The frames are prefixed, the rabbits are proud,
Hopping through tests with their heads in the cloud!


📜 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 8fe45c3.

📒 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 (3)
src/frame.rs (1)

193-193: LGTM! Trait derivations enable easier testing and debugging.

Adding Clone, Copy, and Debug to LengthPrefixedProcessor is appropriate since LengthFormat already implements these traits. This change facilitates easier duplication of processor instances in tests, aligning perfectly with the PR's objective to improve test setup efficiency.

tests/util.rs (1)

55-59: LGTM! Well-designed utility function with good practices.

The default_processor() function is well-implemented with the #[must_use] attribute to ensure the returned processor is utilised. This centralises processor creation for tests and aligns with the PR objective of improving test code efficiency and clarity.

tests/routes.rs (1)

10-10: LGTM! Clean refactoring improves test organisation.

The changes successfully replace direct processor instantiation with the utility function whilst maintaining the same test logic. The updated imports properly reflect the new dependency structure, and using default_processor() makes the test code cleaner and more maintainable.

Also applies to: 16-16, 31-31, 34-34

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch 4axeff-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.

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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, per style guide.

The #[derive(Clone, Copy, Debug)] attribute should be placed after the doc comment for LengthPrefixedProcessor, not before. Please move the attribute below the doc comment to comply with the instruction.
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread src/frame.rs
@leynos
Copy link
Copy Markdown
Owner Author

leynos commented Jun 20, 2025

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 20, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@leynos leynos merged commit 506b4de into main Jun 20, 2025
5 checks passed
@leynos leynos deleted the 4axeff-codex/refactor-test-to-reuse-processor-instance branch June 20, 2025 22:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant