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.

Sign up for GitHub

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

Jump to bottom

chore: fix prop name in options control #37130

Merged
merged 1 commit into from
Oct 30, 2024
Merged

chore: fix prop name in options control #37130

merged 1 commit into from
Oct 30, 2024

Conversation

jsartisan
Copy link
Contributor

@jsartisan jsartisan commented Oct 30, 2024 •
edited by github-actions bot
Loading

/ok-to-test tags="@tag.Widget"

The options control was using options as the property name for the options array even when thee prop name was not options. This was causing issues when the property name was different.

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11590623056
Commit: 1e16edb
Cypress dashboard.
Tags: @tag.Widget
Spec:

Wed, 30 Oct 2024 11:11:49 UTC

Summary by CodeRabbit

  • New Features

    • Enhanced the OptionControl component to support dynamic property updates based on component props.

  • Bug Fixes

    • Improved the handling of property updates, allowing for more flexible and accurate updates.

@jsartisan jsartisan requested a review from a team as a code owner October 30, 2024 08:03
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 30, 2024 •
edited
Loading

Walkthrough

The OptionControl class in OptionControl.tsx has been updated to enhance the updateOptions method. The primary change involves replacing a hardcoded string "options" with this.props.propertyName as the first argument in the this.updateProperty call. This modification allows for dynamic property updates based on the component's props, while the overall structure of the class remains intact.

Changes

File Path Change Summary
app/client/src/components/propertyControls/OptionControl.tsx Updated updateOptions method to use this.props.propertyName instead of a hardcoded string "options".

Poem

In the land of code so bright,
Options dance with pure delight.
No more strings that bind so tight,
Props now lead, oh what a sight!
Dynamic flows, a coder's cheer,
With each change, the path is clear! 🎉

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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

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.

@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Oct 30, 2024
@jsartisan jsartisan added ok-to-test Required label for CI and removed skip-changelog Adding this label to a PR prevents it from being listed in the changelog labels Oct 30, 2024
@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Oct 30, 2024
coderabbitai[bot]
coderabbitai bot reviewed Oct 30, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
app/client/src/components/propertyControls/OptionControl.tsx (1)

Line range hint 31-32: TODO comment needs attention

There's a TODO comment about fixing the eslint-disable directive. This should be addressed to maintain code quality.

Would you like me to help create a GitHub issue to track the TODO and propose a fix for the eslint configuration?

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between e7e3d5e and 1e16edb.

📒 Files selected for processing (1)
  • app/client/src/components/propertyControls/OptionControl.tsx (1 hunks)
🔇 Additional comments (1)
app/client/src/components/propertyControls/OptionControl.tsx (1)

23-23: LGTM! The fix correctly uses the dynamic property name.

The change from hardcoded "options" to this.props.propertyName resolves the property name mismatch issue.

Let's verify that propertyName is always provided:

coderabbitai[bot]
coderabbitai bot reviewed Oct 30, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
app/client/src/components/propertyControls/OptionControl.tsx (1)

Line range hint 28-29: Consider addressing the TODO comment.

There's a TODO comment about fixing the eslint-disable. This technical debt should be addressed in a future PR.

Would you like me to help create a GitHub issue to track this technical debt?

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between e7e3d5e and 1e16edb.

📒 Files selected for processing (1)
  • app/client/src/components/propertyControls/OptionControl.tsx (1 hunks)
🔇 Additional comments (1)
app/client/src/components/propertyControls/OptionControl.tsx (1)

23-23: LGTM! This fixes the property name inconsistency.

The change correctly uses the dynamic property name from props instead of the hardcoded "options" string.

@jsartisan jsartisan added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Oct 30, 2024
@jsartisan jsartisan merged commit 764d8f3 into release Oct 30, 2024
81 of 83 checks passed
@jsartisan jsartisan deleted the fix/options-control-bug branch October 30, 2024 11:13
@coderabbitai coderabbitai bot mentioned this pull request Nov 14, 2024
Draft
github-actions bot pushed a commit to Zeral-Zhang/appsmith that referenced this pull request Nov 20, 2024
@jsartisan
chore: fix prop name in options control (appsmithorg#37130)
6e31579 
/ok-to-test tags="@tag.Widget"

The options control was using `options` as the property name for the
options array even when thee prop name was not `options`. This was
causing issues when the property name was different.

<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/11590623056>
> Commit: 1e16edb
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=11590623056&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Widget`
> Spec:
> <hr>Wed, 30 Oct 2024 11:11:49 UTC
<!-- end of auto-generated comment: Cypress test results  -->


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Enhanced the `OptionControl` component to support dynamic property
updates based on component props.

- **Bug Fixes**
- Improved the handling of property updates, allowing for more flexible
and accurate updates.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@KelvinOm KelvinOm KelvinOm approved these changes

@znamenskii-ilia znamenskii-ilia znamenskii-ilia approved these changes

Assignees
No one assigned
Labels
ok-to-test Required label for CI skip-changelog Adding this label to a PR prevents it from being listed in the changelog
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jsartisan @znamenskii-ilia @KelvinOm