Skip to content

Conversation

leynos
Copy link
Owner

@leynos leynos commented Jun 20, 2025

Summary

  • use an instance of LengthPrefixedProcessor instead of the struct type

Testing

  • make fmt
  • make lint
  • make test

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

Summary by Sourcery

Use a default-initialized LengthPrefixedProcessor instance for route configuration and test framing instead of referring to the struct type directly

Tests:

  • Update route tests to instantiate LengthPrefixedProcessor with default() for encode/decode operations
  • Pass a LengthPrefixedProcessor::default() instance to frame_processor in app setup instead of the struct type

Summary by CodeRabbit

  • Tests
    • Improved the way a processor is instantiated in tests to ensure consistent usage. No changes to test outcomes or logic.

Copy link
Contributor

sourcery-ai bot commented Jun 20, 2025

Reviewer's Guide

Refactors the routes test to instantiate and reuse a LengthPrefixedProcessor via its default() constructor rather than invoking methods on the type itself, improving consistency in processor usage.

File-Level Changes

Change Details Files
Use a default instance of LengthPrefixedProcessor instead of the type in tests
  • Updated .frame_processor call to use LengthPrefixedProcessor::default()
  • Introduced a local processor variable for encoding frames
  • Replaced static encode and decode calls with instance method calls on processor
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

Copy link
Contributor

coderabbitai bot commented Jun 20, 2025

Walkthrough

The test function in tests/routes.rs was updated to instantiate LengthPrefixedProcessor using its default() method, ensuring an explicit processor instance is used for encoding and decoding operations. No other logic, assertions, or control flow in the test was changed.

Changes

File(s) Change Summary
tests/routes.rs Updated to use LengthPrefixedProcessor::default() for processor instantiation in three places.

Poem

A processor now with a default face,
Encodes and decodes in the proper place.
No longer just a type, but an instance to see,
In tests it works, as neat as can be!
🐇✨


📜 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 31a220e and b5319ae.

📒 Files selected for processing (1)
  • tests/routes.rs (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build-test
  • GitHub Check: Analyze (actions)
🔇 Additional comments (3)
tests/routes.rs (3)

33-33: Correct fix for processor instantiation.

The change from using the bare type to creating an instance via LengthPrefixedProcessor::default() is the proper way to configure the frame processor. This ensures the WireframeApp receives an actual processor instance rather than a type.


52-53: Good practice: reusable processor instance.

Creating a single processor instance for both encoding and decoding operations is efficient and ensures consistency. The explicit instantiation resolves the previous incorrect usage pattern.


58-58: Consistent processor usage maintained.

Using the same processor instance for both encoding and decoding ensures state consistency and completes the fix for proper processor instantiation throughout the test.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch codex/fix-lint-errors-in-tests/routes.rs

🪧 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
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 - here's some feedback:

  • Extract the LengthPrefixedProcessor::default() call into a single local variable and clone or reference it when configuring the app, encoding, and decoding to avoid repeating default instantiation.
  • Consider moving the processor initialization into a small helper or fixture to reduce boilerplate and keep the test focused on routing logic rather than setup.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Extract the LengthPrefixedProcessor::default() call into a single local variable and clone or reference it when configuring the app, encoding, and decoding to avoid repeating default instantiation.
- Consider moving the processor initialization into a small helper or fixture to reduce boilerplate and keep the test focused on routing logic rather than setup.

## Individual Comments

### Comment 1
<location> `tests/routes.rs:52` </location>
<code_context>
-    LengthPrefixedProcessor
-        .encode(&env_bytes, &mut framed)
-        .unwrap();
+    let processor = LengthPrefixedProcessor::default();
+    processor.encode(&env_bytes, &mut framed).unwrap();

</code_context>

<issue_to_address>
Consider reusing the processor instance throughout the test for consistency.

Reusing the same processor instance in all test steps, including .frame_processor, helps ensure consistency and can reveal state-related issues if the processor becomes stateful in the future.

Suggested implementation:

```rust
    let processor = LengthPrefixedProcessor::default();
    let app = app
        .frame_processor(processor.clone())
        .route(
            1,
            Box::new(move |_| {
    };
    let env_bytes = BincodeSerializer.serialize(&env).unwrap();
    let mut framed = BytesMut::new();
    processor.encode(&env_bytes, &mut framed).unwrap();

    let out = run_app_with_frame(app, framed.to_vec()).await.unwrap();

    let mut buf = BytesMut::from(&out[..]);
    let frame = processor.decode(&mut buf).unwrap().unwrap();
    let (resp_env, _) = BincodeSerializer
        .deserialize::<TestEnvelope>(&frame)
        .unwrap();

```

- Ensure that `LengthPrefixedProcessor` implements `Clone` if it does not already, as `.frame_processor(processor.clone())` requires it.
- If the `app` variable is not defined in this snippet, you may need to adjust the placement of the `processor` instantiation and the `.frame_processor()` call to fit the actual test structure.
</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.

LengthPrefixedProcessor
.encode(&env_bytes, &mut framed)
.unwrap();
let processor = LengthPrefixedProcessor::default();
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion: Consider reusing the processor instance throughout the test for consistency.

Reusing the same processor instance in all test steps, including .frame_processor, helps ensure consistency and can reveal state-related issues if the processor becomes stateful in the future.

Suggested implementation:

    let processor = LengthPrefixedProcessor::default();
    let app = app
        .frame_processor(processor.clone())
        .route(
            1,
            Box::new(move |_| {
    };
    let env_bytes = BincodeSerializer.serialize(&env).unwrap();
    let mut framed = BytesMut::new();
    processor.encode(&env_bytes, &mut framed).unwrap();

    let out = run_app_with_frame(app, framed.to_vec()).await.unwrap();

    let mut buf = BytesMut::from(&out[..]);
    let frame = processor.decode(&mut buf).unwrap().unwrap();
    let (resp_env, _) = BincodeSerializer
        .deserialize::<TestEnvelope>(&frame)
        .unwrap();
  • Ensure that LengthPrefixedProcessor implements Clone if it does not already, as .frame_processor(processor.clone()) requires it.
  • If the app variable is not defined in this snippet, you may need to adjust the placement of the processor instantiation and the .frame_processor() call to fit the actual test structure.

@leynos leynos merged commit 16e2252 into main Jun 20, 2025
5 checks passed
@leynos leynos deleted the codex/fix-lint-errors-in-tests/routes.rs branch June 20, 2025 17:05
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