Skip to content

Fix formatting for short functions#247

Merged
leynos merged 1 commit intocodex/replace-eprintln-with-tracing-macrosfrom
codex/fix-lint-errors-in-connection-and-push-modules
Aug 1, 2025
Merged

Fix formatting for short functions#247
leynos merged 1 commit intocodex/replace-eprintln-with-tracing-macrosfrom
codex/fix-lint-errors-in-connection-and-push-modules

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Aug 1, 2025

Summary

  • collapse simple if/let chains flagged by clippy
  • inline short functions per project style guidelines

Testing

  • CARGO="cargo +nightly-2025-07-22" make lint
  • CARGO="cargo +nightly-2025-07-22" make test

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

Summary by Sourcery

Inline trivial getter and setter functions and collapse simple conditional chains using new let-else syntax across connection, push, and server modules to satisfy Clippy style guidelines.

Enhancements:

  • Inline short methods into single-line function bodies in connection.rs, push.rs, and server.rs
  • Collapse nested if/let constructs into combined conditions using Rust’s let-else syntax to simplify branch logic

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Aug 1, 2025

Reviewer's Guide

Inline trivial functions into single-line bodies and leverage Rust let-chains to simplify nested conditionals for more concise, consistent formatting.

Class diagram for updated function signatures and inlined methods

classDiagram
    class Connection {
        +set_fairness(fairness: FairnessConfig)
        +set_response(stream: Option<FrameStream<F, E>>)
        +shutdown_token() CancellationToken
        -after_low()
        -reset_high_counter()
        -wait_shutdown(token: CancellationToken)
        -recv_push(rx: &mut mpsc::Receiver<F>) Option<F>
    }
    class ActorState {
        -is_active() bool
        -is_shutting_down() bool
        -is_done() bool
    }
    class PushHandle {
        +from_arc(arc: Arc<PushHandleInner<F>>) Self
        +downgrade() Weak<PushHandleInner<F>>
    }
    class Server {
        +worker_count() usize
    }
Loading

File-Level Changes

Change Details Files
Inline short functions into single-line definitions
  • Collapsed trivial getters and setters into one-liners
  • Inlined utility methods such as after_low, wait_shutdown, recv_push, and worker_count
  • Converted state-check methods (is_active, is_shutting_down, is_done) to single-line forms
src/connection.rs
src/push.rs
src/server.rs
Simplify nested if/let chains using Rust let-chains
  • Combined conditional checks in the low-priority yield block
  • Flattened nested preamble handler if let chains in process_stream
  • Applied && let patterns in push queue rate validation
src/connection.rs
src/push.rs
src/server.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 Aug 1, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/fix-lint-errors-in-connection-and-push-modules

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

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Choose a reason for hiding this comment

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

Gates Failed
Enforce advisory code health rules (1 file with Complex Conditional)

Gates Passed
5 Quality Gates Passed

See analysis details in CodeScene

Reason for failure
Enforce advisory code health rules Violations Code Health Impact
push.rs 1 advisory rule 10.00 → 9.69 Suppress

Quality Gate Profile: Pay Down Tech Debt
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

Comment thread src/push.rs
Comment on lines +385 to +386
if let Some(r) = rate
&& (r == 0 || r > MAX_PUSH_RATE)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

❌ New issue: Complex Conditional
PushQueues.bounded_with_rate_dlq has 1 complex conditionals with 2 branches, threshold = 2

Suppress

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

@coderabbitai Please suggest a fix for this issue and supply a prompt for an AI coding agent to enable it to apply the fix.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@leynos I'll suggest a fix for the complex conditional issue by extracting the rate validation logic into a predicate function, following your coding guidelines.

Suggested Fix

Extract the rate validation logic into a predicate function:

/// Check if a rate value is invalid (zero or exceeds maximum).
fn is_invalid_rate(rate: usize) -> bool {
    rate == 0 || rate > MAX_PUSH_RATE
}

Then replace the complex conditional with:

if let Some(r) = rate
    && is_invalid_rate(r)
{
    return Err(PushConfigError::InvalidRate(r));
}

AI Coding Agent Prompt

In the file src/push.rs, refactor the rate validation logic in the `bounded_with_rate_dlq` method to comply with the complexity guidelines:

1. Add a new private function `is_invalid_rate` that takes a `usize` parameter and returns `bool`
2. The function should return `true` if the rate is 0 or greater than `MAX_PUSH_RATE`
3. Add a doc comment explaining the function's purpose
4. Place the function before the `PushQueues` impl block
5. Replace the complex conditional `r == 0 || r > MAX_PUSH_RATE` with a call to `is_invalid_rate(r)`
6. Keep the existing let-guard pattern structure intact

This refactoring will reduce the cyclomatic complexity while maintaining the same validation behavior.

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!


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.

@leynos leynos merged commit 2a3c599 into codex/replace-eprintln-with-tracing-macros Aug 1, 2025
1 of 2 checks passed
@leynos leynos deleted the codex/fix-lint-errors-in-connection-and-push-modules branch August 1, 2025 23:27
leynos added a commit that referenced this pull request Aug 1, 2025
* Replace eprintln with tracing macros

* Add structured tracing and context

* Format short functions (#247)
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