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

feat: Add dynamic property path for sourceData in SelectWidget #34574

Merged

Conversation

rahulbarwal
Copy link
Contributor

@rahulbarwal rahulbarwal commented Jun 28, 2024

Description

Add dynamic property path for sourceData in SelectWidget.

Fixes #34568
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

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

🔍 Cypress test results

Tip

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

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • New Features
    • Enhanced the Select Widget with a new property to support dynamic property paths.
  • Tests
    • Added new tests to validate the dynamic property paths functionality in the Select Widget.

Copy link
Contributor

coderabbitai bot commented Jun 28, 2024

Walkthrough

The recent updates introduce a new dynamicPropertyPathList property to the SelectWidget configuration, enabling dynamic handling of sourceData. Additionally, a Cypress test for toggling the JS mode of sourceData has been added to ensure that the feature works as expected.

Changes

File Path Change Summary
app/client/src/widgets/SelectWidget/widget/index.tsx Added dynamicPropertyPathList: [{ key: "sourceData" }] to the default widget configuration for SelectWidget class.
app/client/cypress/e2e/Regression/ClientSide/Widgets/Select/.../Select_spec.js Added import for propPane and called propPane.ToggleJSMode("sourcedata", false) within a test case to validate the feature.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Cypress_Test
    participant SelectWidget

    User->>+Cypress_Test: Runs `Select_spec.js`
    Cypress_Test->>+SelectWidget: Import `propPane`
    Cypress_Test->>SelectWidget: Call `propPane.ToggleJSMode("sourcedata", false)`
    SelectWidget-->>Cypress_Test: Updates the widget configuration
    Cypress_Test-->>User: Test results
Loading

Assessment against linked issues

Objective Addressed Explanation
Change the top input type to an open field (Select) (#34568)
Addition of dynamic property handling for sourceData in SelectWidget (#34568)
Validation of new functionality through automated testing in Cypress (#34568)

Poem

In a codebase far and wide,
SelectWidget now takes stride.
With dynamic paths and Cypress tests,
Ensuring new features at their best.
A change to source, a small delight,
Making the dev's world a bit more bright. ☀️


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

@github-actions github-actions bot added Widgets Product This label groups issues related to widgets Select Widget Select or dropdown widget Task A simple Todo Widgets & Blocks Pod labels Jun 28, 2024
@rahulbarwal rahulbarwal removed Select Widget Select or dropdown widget Widgets Product This label groups issues related to widgets Task A simple Todo Widgets & Blocks Pod labels Jun 28, 2024
@github-actions github-actions bot added Widgets Product This label groups issues related to widgets Select Widget Select or dropdown widget Task A simple Todo Widgets & Blocks Pod labels Jun 28, 2024
@rahulbarwal rahulbarwal removed Select Widget Select or dropdown widget Widgets Product This label groups issues related to widgets Task A simple Todo labels Jun 28, 2024
@github-actions github-actions bot added Enhancement New feature or request Widgets Product This label groups issues related to widgets Select Widget Select or dropdown widget Task A simple Todo labels Jun 28, 2024
@rahulbarwal
Copy link
Contributor Author

/build-deploy-preview skip-tests=true

Copy link

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9709265919.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 34574.
recreate: .

@rahulbarwal rahulbarwal added the ok-to-test Required label for CI label Jun 28, 2024
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 (3)
app/client/src/widgets/SelectWidget/widget/index.tsx (3)

Line range hint 61-63: Remove unnecessary constructor.

The constructor in this class is redundant since it only calls super(props) and does nothing else. Removing it will clean up the code without affecting functionality.

-  constructor(props: SelectWidgetProps) {
-    super(props);
-  }

Line range hint 161-163: Remove redundant double-negation.

The use of double-negation (!!) is unnecessary here as the values will be coerced to boolean naturally in JavaScript. Simplifying this will make the code cleaner and more readable.

-    const isInvalid =
-      "isValid" in this.props && !this.props.isValid && !!this.props.isDirty;
+    const isInvalid =
+      "isValid" in this.props && !this.props.isValid && this.props.isDirty;

Line range hint 593-593: Replace super with class name in static context.

Using super in a static context can lead to confusion. It's clearer and more correct to use the class name directly.

-              return !super.getFeatureFlag(
+              return !SelectWidget.getFeatureFlag(
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b856dbd and f41d386.

Files selected for processing (1)
  • app/client/src/widgets/SelectWidget/widget/index.tsx (1 hunks)
Additional context used
Biome
app/client/src/widgets/SelectWidget/widget/index.tsx

[error] 61-63: This constructor is unnecessary.

Unsafe fix: Remove the unnecessary constructor.

(lint/complexity/noUselessConstructor)


[error] 161-163: Avoid redundant double-negation.

It is not necessary to use double-negation when a value will already be coerced to a boolean.
Unsafe fix: Remove redundant double-negation

(lint/complexity/noExtraBooleanCast)


[error] 593-593: Using super in a static context can be confusing.

super refers to a parent class.
Unsafe fix: Use the class name instead.

(lint/complexity/noThisInStatic)

Additional comments not posted (1)
app/client/src/widgets/SelectWidget/widget/index.tsx (1)

114-114: Approved addition of dynamic property path.

The addition of dynamicPropertyPathList with { key: "sourceData" } aligns with the PR's goal to enhance dynamic data handling in the SelectWidget. This change should facilitate easier integration and management of dynamic data sources.

Copy link

Deploy-Preview-URL: https://ce-34574.dp.appsmith.com

…tion

This is required because if source data does not match with sample data passed for the widget configuration, it disallows switching back JS toggle button
@rahulbarwal
Copy link
Contributor Author

/build-deploy-preview skip-tests=true

Copy link

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/9711128924.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 34574.
recreate: .

Copy link

Deploy-Preview-URL: https://ce-34574.dp.appsmith.com

@rahulbarwal rahulbarwal added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Jun 28, 2024
@rahulbarwal rahulbarwal added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Jun 28, 2024
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2ec7d53 and ce948f0.

Files selected for processing (1)
  • app/client/cypress/e2e/Regression/ClientSide/Widgets/Select/Select_spec.js (2 hunks)
Additional comments not posted (2)
app/client/cypress/e2e/Regression/ClientSide/Widgets/Select/Select_spec.js (2)

12-12: Review of new import statement for propPane.

The import of propPane is appropriate for enabling dynamic toggling of JavaScript modes in the properties panel, which aligns with the test case modifications.


106-106: Ensure correct usage and integration of propPane.ToggleJSMode.

The addition of propPane.ToggleJSMode("sourcedata", false) is intended to toggle JavaScript mode for the sourcedata property of the Select widget. This change is crucial for the test scenario that follows, ensuring that the widget behaves as expected in non-JS mode. It is important to verify that this function call correctly toggles the mode as intended and that it doesn't affect other properties unintentionally.

@rahulbarwal rahulbarwal added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Jun 28, 2024
AmanAgarwal041
AmanAgarwal041 previously approved these changes Jun 28, 2024
Copy link
Contributor

@AmanAgarwal041 AmanAgarwal041 left a comment

Choose a reason for hiding this comment

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

Looks good to me

@rahulbarwal rahulbarwal added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Jun 28, 2024
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ce948f0 and c5521e4.

Files selected for processing (1)
  • app/client/cypress/e2e/Regression/ClientSide/Widgets/Select/Select_spec.js (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • app/client/cypress/e2e/Regression/ClientSide/Widgets/Select/Select_spec.js

@rahulbarwal rahulbarwal merged commit 938e7b4 into release Jul 1, 2024
44 checks passed
@rahulbarwal rahulbarwal deleted the fix-34568/enable-js-mode-for-sourcedata-in-select-widget branch July 1, 2024 06:32
sharat87 added a commit that referenced this pull request Jul 2, 2024
sharat87 added a commit that referenced this pull request Jul 2, 2024
…et (#34574)" (#34618)

**/test binding**



<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/9754334718>
> Commit: 2c67d23
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9754334718&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Binding`

<!-- end of auto-generated comment: Cypress test results  -->



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

## Summary by CodeRabbit

- **Refactor**
- Improved the internal handling of `sourceData` within the Select
widget for better performance and maintainability.

- **Tests**
- Updated test cases for the Select widget to reflect the new handling
of `sourceData`.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Shivam-z pushed a commit to Shivam-z/appsmith that referenced this pull request Jul 10, 2024
…ithorg#34574)

## Description
Add dynamic property path for sourceData in SelectWidget.

Fixes appsmithorg#34568
_or_  
Fixes `Issue URL`
> [!WARNING]  
> _If no issue exists, please create an issue first, and check with the
maintainers if the issue is valid._

## Automation

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

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/9712372976>
> Commit: c5521e4
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9712372976&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Widget`

<!-- end of auto-generated comment: Cypress test results  -->









## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [x] No


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

- **New Features**
- Enhanced the Select Widget with a new property to support dynamic
property paths.
- **Tests**
- Added new tests to validate the dynamic property paths functionality
in the Select Widget.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Shivam-z pushed a commit to Shivam-z/appsmith that referenced this pull request Jul 10, 2024
…et (appsmithorg#34574)" (appsmithorg#34618)

**/test binding**



<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/9754334718>
> Commit: 2c67d23
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=9754334718&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Binding`

<!-- end of auto-generated comment: Cypress test results  -->



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

## Summary by CodeRabbit

- **Refactor**
- Improved the internal handling of `sourceData` within the Select
widget for better performance and maintainability.

- **Tests**
- Updated test cases for the Select widget to reflect the new handling
of `sourceData`.

<!-- 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
Labels
Enhancement New feature or request ok-to-test Required label for CI Select Widget Select or dropdown widget Task A simple Todo Widgets Product This label groups issues related to widgets
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change the top input type to an open field (Select)
2 participants