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

fix: Adds a set transformation before returning the dynamicbindingpathlist to ensure that dulplicates don't go through #36613

Conversation

rahulbarwal
Copy link
Contributor

@rahulbarwal rahulbarwal commented Sep 30, 2024

Description

Tip

Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team).

Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR.

Fixes #Issue Number
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.All"

🔍 Cypress test results

Caution

🔴 🔴 🔴 Some tests have failed.
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11105992104
Commit: 9a88d59
Cypress dashboard.
Tags: @tag.All
Spec:
The following are new failures, please fix them before merging the PR:

  1. cypress/e2e/Regression/ClientSide/Widgets/Button/Button_showAlert_multiline_message_spec.ts
  2. cypress/e2e/Regression/ClientSide/Widgets/Chart/ChartDataPoint_Spec.ts
  3. cypress/e2e/Regression/ClientSide/Widgets/Dropdown/Dropdown_onOptionChange_spec.js
  4. cypress/e2e/Regression/ClientSide/Widgets/TableV1/Table_Widget_Add_button_spec.js
  5. cypress/e2e/Regression/ClientSide/Widgets/TableV2/Inline_editing_2_spec.js
  6. cypress/e2e/Regression/ClientSide/Widgets/TableV2/Inline_editing_3_spec.js
  7. cypress/e2e/Regression/ClientSide/Widgets/TableV2/TableV2_Widget_Add_button_spec.js
  8. cypress/e2e/Regression/ClientSide/Widgets/TableV2/inline_editing_validations_spec.js
List of identified flaky tests.
Mon, 30 Sep 2024 13:38:14 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features

    • Enhanced uniqueness of dynamic binding paths to improve data integrity.
  • Bug Fixes

    • Improved safety checks in utility functions to prevent errors when accessing properties on undefined or non-array values.

… to ensure that dulplicates don't go through
@rahulbarwal rahulbarwal added the All Widgets Issues related to all widgets label Sep 30, 2024
@rahulbarwal rahulbarwal self-assigned this Sep 30, 2024
@rahulbarwal rahulbarwal added List Widget V2 Issues related to the list widget v2 Widgets & Accelerators Pod Issues related to widgets & Accelerators labels Sep 30, 2024
Copy link
Contributor

coderabbitai bot commented Sep 30, 2024

Walkthrough

The changes introduce modifications to the DynamicBindingUtils.ts file, focusing on enhancing the uniqueness of dynamic binding paths in the getEntityDynamicBindingPathList function. The return statement is updated to filter out duplicates using Array.from(new Set(...)). Additionally, the isPathADynamicBinding and isPathDynamicTrigger functions are revised to include checks for the existence of relevant properties, ensuring they only operate on defined arrays. These adjustments aim to improve the integrity and robustness of the utility functions.

Changes

File Path Change Summary
app/client/src/utils/DynamicBindingUtils.ts - Updated getEntityDynamicBindingPathList to return unique dynamic binding paths.
- Enhanced isPathADynamicBinding and isPathDynamicTrigger with checks for property existence and array types.
- Method signatures updated for clarity and type safety.

Suggested reviewers

  • ApekshaBhosale
  • sagar-qa007
  • sharat87

In the realm of code, changes unfold,
Unique paths emerge, bright and bold.
Functions now check, with care they tread,
Ensuring no errors, where once they led.
With each little tweak, our code shines anew,
A dance of logic, in harmony too! 🌟


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 141da55 and 9a88d59.

📒 Files selected for processing (1)
  • app/client/src/utils/DynamicBindingUtils.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • app/client/src/utils/DynamicBindingUtils.ts

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.

@rahulbarwal rahulbarwal changed the title Adds a set transformation before returning the dynamicbindingpathlist to ensure that dulplicates don't go through fix: Adds a set transformation before returning the dynamicbindingpathlist to ensure that dulplicates don't go through Sep 30, 2024
@rahulbarwal
Copy link
Contributor Author

/build-deploy-preview skip-tests=true

@github-actions github-actions bot added the Bug Something isn't working label Sep 30, 2024
@rahulbarwal rahulbarwal added ok-to-test Required label for CI and removed Bug Something isn't working labels Sep 30, 2024
Copy link

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

@github-actions github-actions bot added the Bug Something isn't working label Sep 30, 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 (1)
app/client/src/utils/DynamicBindingUtils.ts (1)

196-196: Well done, class! Let's review this change.

The modification to use Array.from(new Set(...)) is a clever way to remove duplicates from the dynamic binding path list. This addresses our lesson objective of ensuring unique entries. However, we can make it even better!

Consider this slight optimization:

-    return [...Array.from(new Set(entity.dynamicBindingPathList))];
+    return Array.from(new Set(entity.dynamicBindingPathList));

By removing the spread operator, we avoid an unnecessary array creation. Remember, Array.from() already returns a new array, so spreading it again is redundant. This small change will make our code more efficient. Who can tell me why efficiency is important in programming?

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 37c2cf5 and 141da55.

📒 Files selected for processing (1)
  • app/client/src/utils/DynamicBindingUtils.ts (1 hunks)

Copy link

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

@@ -193,7 +193,7 @@ export const getEntityDynamicBindingPathList = (
entity.dynamicBindingPathList &&
Array.isArray(entity.dynamicBindingPathList)
) {
return [...entity.dynamicBindingPathList];
return [...Array.from(new Set(entity.dynamicBindingPathList))];
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we skip using Array.from here? A set can be spread directly to an array like [...set]

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

Copy link

github-actions bot commented Oct 7, 2024

This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected.

@github-actions github-actions bot added the Stale label Oct 7, 2024
@rahulbarwal
Copy link
Contributor Author

closing as no longer required.

@rahulbarwal rahulbarwal closed this Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
All Widgets Issues related to all widgets Bug Something isn't working List Widget V2 Issues related to the list widget v2 ok-to-test Required label for CI Stale Widgets & Accelerators Pod Issues related to widgets & Accelerators
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants