appsmith icon indicating copy to clipboard operation
appsmith copied to clipboard

feat: Add dynamic property path for sourceData in SelectWidget

Open rahulbarwal opened this issue 1 year ago • 7 comments

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"

:mag: Cypress test results

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

Communication

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

  • [ ] Yes
  • [x] 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.

rahulbarwal avatar Jun 28 '24 07:06 rahulbarwal

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

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.

coderabbitai[bot] avatar Jun 28 '24 07:06 coderabbitai[bot]

/build-deploy-preview skip-tests=true

rahulbarwal avatar Jun 28 '24 07:06 rahulbarwal

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

github-actions[bot] avatar Jun 28 '24 07:06 github-actions[bot]

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

github-actions[bot] avatar Jun 28 '24 07:06 github-actions[bot]

/build-deploy-preview skip-tests=true

rahulbarwal avatar Jun 28 '24 10:06 rahulbarwal

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

github-actions[bot] avatar Jun 28 '24 10:06 github-actions[bot]

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

github-actions[bot] avatar Jun 28 '24 10:06 github-actions[bot]