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

frontend:DefaultParamLoader: Fix to new parameter #3133

Merged

Conversation

JoaoMario109
Copy link
Collaborator

@JoaoMario109 JoaoMario109 commented Feb 7, 2025

Fix parameter table to show new parameter instead of current one

Fix #3130

Summary by Sourcery

Bug Fixes:

  • Fixed a bug where the parameter table was showing the current parameter instead of the new parameter.

* Fix parameter table to show new parameter instead of current one
Copy link

sourcery-ai bot commented Feb 7, 2025

Reviewer's Guide by Sourcery

This pull request fixes the display issue in the parameter table by ensuring that the new parameter value is shown instead of the current one. The implementation modifies both the frontend Vue template and the logic that maps parameter values, creating a new parameter object with the desired value.

Class diagram for DefaultParamLoader and parameter object structure

classDiagram
    class DefaultParamLoader {
      +mappedParameters(): ParameterItem[]
      +printParamWithUnit(param): String
    }

    class ParameterItem {
      +name: String
      +current: Parameter
      +value: Parameter
    }

    class Parameter {
      +value: Any
      ...
    }

    DefaultParamLoader --> ParameterItem : creates
    ParameterItem --> Parameter : current
    ParameterItem --> Parameter : value

    %% Note: The new change constructs a new Parameter object for value,
    %% so that in the template the access is done via item.value.value
    note for ParameterItem "'value' now holds a Parameter object instead of a primitive value"
Loading

File-Level Changes

Change Details Files
Updated Vue template to properly display the new parameter value.
  • Modified the text interpolation within the template to use the new parameter value from item.value.
  • Updated tooltip content to reflect the new parameter value.
core/frontend/src/components/wizard/DefaultParamLoader.vue
Adjusted the parameter mapping logic to create a new parameter object.
  • Introduced a new parameter object that merges the current parameter configuration with the updated value.
  • Replaced the assignment of the raw parameter value with the new parameter object in the mapping function.
core/frontend/src/components/wizard/DefaultParamLoader.vue

Assessment against linked issues

Issue Objective Addressed Explanation
#3130 Correctly display the AHRS_ORIENTATION parameter value in the wizard parameter table
#3130 Ensure the parameter table shows the new parameter value instead of the current one

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

Overall Comments:

  • Consider renaming or restructuring the new parameter object to avoid the confusing double use of the 'value' key (e.g., item.value.value).
  • Extract the duplicated template logic into a computed property to reduce repetition in handling current versus new parameter display.
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 396f8b0 into bluerobotics:master Feb 10, 2025
6 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.

wizard: parameter table is displaying AHRS_ORIENTATION wrongly
3 participants