Skip to content

frontend: InlineParameterEditor: populate parameter value when mounting#3129

Merged
patrickelectric merged 1 commit intobluerobotics:masterfrom
Williangalvani:fix_inline_parameter
Feb 6, 2025
Merged

frontend: InlineParameterEditor: populate parameter value when mounting#3129
patrickelectric merged 1 commit intobluerobotics:masterfrom
Williangalvani:fix_inline_parameter

Conversation

@Williangalvani
Copy link
Member

@Williangalvani Williangalvani commented Feb 6, 2025

Summary by Sourcery

Bug Fixes:

  • Fix an issue where the parameter value was not populated when the component was mounted.

@sourcery-ai
Copy link

sourcery-ai bot commented Feb 6, 2025

Reviewer's Guide by Sourcery

The pull request populates the parameter value when the component is mounted. This ensures that the parameter value is always displayed in the editor, even if it is not explicitly set.

Sequence diagram for parameter value population on mount

sequenceDiagram
    participant Component as InlineParameterEditor
    participant Internal as Internal State

    Note over Component: Component Mounts
    alt Parameter value exists
        Component->>Internal: Get parameter value
        Component->>Internal: Convert value to string
        Component->>Internal: Set internal_new_value_as_string
    end
    Component->>Internal: Save edited parameter
Loading

State diagram for InlineParameterEditor value handling

stateDiagram-v2
    [*] --> Mounted
    Mounted --> HasValue: param.value exists
    Mounted --> NoValue: param.value undefined
    HasValue --> StringConverted: Convert to string
    StringConverted --> SavedState: Save parameter
    NoValue --> SavedState: Save parameter
    SavedState --> [*]
Loading

File-Level Changes

Change Details Files
Populate parameter value when mounting
  • Added a condition to check if the parameter has a value.
  • If the parameter has a value, set the internal_new_value_as_string to the string representation of the parameter value.
core/frontend/src/components/parameter-editor/InlineParameterEditor.vue

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:

  • Review the 'if (this.param?.value)' check because falsy values like 0 won't trigger the initialization; consider an explicit null/undefined check.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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 4920df5 into bluerobotics:master Feb 6, 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.

2 participants

Comments