Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cable-guy: fix falling back to default settings #3140

Merged

Conversation

Williangalvani
Copy link
Member

@Williangalvani Williangalvani commented Feb 11, 2025

Summary by Sourcery

Bug Fixes:

  • Ensure default settings are loaded correctly by including the "version" key.

Copy link

sourcery-ai bot commented Feb 11, 2025

Reviewer's Guide by Sourcery

This pull request addresses an issue in the cable_guy service where the application was falling back to default settings without including a version identifier. The changes add a version field to the default configuration, ensuring consistency with expected schema.

Updated class diagram for cable_guy default configuration

classDiagram
    class CableGuyManager {
        +__init__(default_configs: List<NetworkInterface>)
    }
    class Settings {
        +load() : bool
        +root: dict
    }
    class DefaultConfiguration {
        +version: int
        +content: List<NetworkInterface>
    }
    class NetworkInterface {
        +dict() : dict
    }

    CableGuyManager --> Settings : uses
    Settings o-- DefaultConfiguration : holds
    DefaultConfiguration --> "0..*" NetworkInterface : content
Loading

File-Level Changes

Change Details Files
Updated the default configuration to include a version key.
  • Modified the fallback configuration in the cable_guy manager to add a 'version' field with a default value of 0.
  • Ensured that the default configuration now aligns with the upgraded configuration schema.
core/services/cable_guy/api/manager.py

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

@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 @Williangalvani - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a unit test to verify that the default configuration is correctly applied when loading settings fails.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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.

@patrickelectric patrickelectric merged commit c8bac51 into bluerobotics:master Feb 11, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants