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

test if only when adding a new widget do we compute the entire widget… #36293

Closed
wants to merge 3 commits into from

Conversation

vsvamsi1
Copy link
Contributor

@vsvamsi1 vsvamsi1 commented Sep 13, 2024

… graph

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/10848494131
Commit: c8eb9f6
Cypress dashboard.
Tags: @tag.All
Spec:
The following are new failures, please fix them before merging the PR:

  1. cypress/e2e/Regression/ClientSide/OneClickBinding/TableWidget/OneClickBindingMysql_spec.ts
  2. cypress/e2e/Regression/ClientSide/OneClickBinding/TableWidget/Table_MongoDB_spec.ts
  3. cypress/e2e/Regression/ClientSide/OneClickBinding/TableWidget/Table_postgres_spec.ts
  4. cypress/e2e/Regression/ClientSide/Widgets/Filepicker/FilePickerV2_CSV_spec.js
  5. cypress/e2e/Regression/ClientSide/Widgets/ListV2/Event_Bindings_spec.ts
  6. cypress/e2e/Regression/ClientSide/Widgets/ListV2/ListV2_NestedList_spec.ts
  7. cypress/e2e/Regression/ClientSide/Widgets/ListV2/Listv2_Nested_EventBindings_spec.js
  8. cypress/e2e/Regression/ClientSide/Widgets/ListV2/Listv2_autocomplete_spec.js
  9. cypress/e2e/Regression/ClientSide/Widgets/TableV2/Inline_editing_3_spec.js
  10. cypress/e2e/Regression/ClientSide/Widgets/TableV2/TableV2_PropertyPane_2_spec.js
  11. cypress/e2e/Regression/ClientSide/Widgets/TableV2/TableV2_spec.js
  12. cypress/e2e/Regression/ClientSide/Widgets/TableV2/columnTypes/currency_spec.ts
  13. cypress/e2e/Regression/ClientSide/Widgets/TableV2/inline_editing_validations_spec.js
  14. cypress/e2e/Regression/ServerSide/ApiTests/API_MultiPart_Spec.ts
List of identified flaky tests.
Fri, 13 Sep 2024 12:54:44 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features
    • Introduced a mechanism to exclude specific nodes from dependency processing, enhancing efficiency.
    • Improved handling of widget actions and entity dependencies for better control and clarity.
    • Simplified logic for processing entity dependencies, focusing on direct comparisons for improved clarity.
  • Bug Fixes
    • Enhanced error handling and streamlined dependency setting logic for improved functionality.

@vsvamsi1 vsvamsi1 added the ok-to-test Required label for CI label Sep 13, 2024
@vsvamsi1 vsvamsi1 self-assigned this Sep 13, 2024
Copy link
Contributor

coderabbitai bot commented Sep 13, 2024

Walkthrough

The changes enhance the updateDependencyMap function by introducing a new mechanism for excluding specific nodes from dependency processing. A constant array, excludeNodes, is added to prevent processing of entities with certain identifiers. Additionally, a boolean variable, isAddingNewWidget, is introduced to clarify the distinction between new widgets and existing entities. The logic for processing dependencies has been simplified, focusing on direct comparisons rather than complex evaluations. The overall structure of the function remains intact, but these modifications improve the control flow and efficiency of dependency mapping.

Changes

File Path Change Summary
app/client/src/workers/common/DependencyMap/index.ts Introduced excludeNodes array to streamline dependency processing by excluding specific nodes. Added isAddingNewWidget for clearer control flow in handling widget actions and dependencies. Removed the isDynamicLeaf check to simplify conditions for processing dependencies. Enhanced error handling and dependency logic for improved readability.

Possibly related PRs

Suggested labels

Test, Task, Enhancement

In the code where widgets play,
A new path has found its way.
With clearer flows and logic bright,
Dependencies now align just right.
So here's to changes, fresh and new,
In the map of dependencies, we bid adieu! 🎉

Tip

OpenAI O1 model for chat
  • We have deployed OpenAI's latest O1 model for chat.
  • OpenAI claims that this model has superior reasoning capabilities than their GPT-4o model.
  • Please share any feedback with us in the discussions post.

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e572a11 and c8eb9f6.

Files selected for processing (1)
  • app/client/src/workers/common/DependencyMap/index.ts (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • app/client/src/workers/common/DependencyMap/index.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>.
    • 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 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.

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/workers/common/DependencyMap/index.ts (1)

151-151: Remove the unnecessary comment.

The comment "// If a new entity is added, add setter functions to all nodes" doesn't add any value to the code. It's better to remove such comments to improve code readability.

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 71b44a1 and fcde7d1.

Files selected for processing (1)
  • app/client/src/workers/common/DependencyMap/index.ts (3 hunks)
Additional comments not posted (3)
app/client/src/workers/common/DependencyMap/index.ts (3)

Line range hint 167-209: Great job on refining the control flow and improving code clarity! 👍

The introduction of the isAddingNewWidget boolean variable simplifies the logic by allowing the function to directly check for new widgets. This change, along with the modifications to the widget action processing logic, enhances the clarity and maintainability of the code.

The distinction between handling new widgets and existing entities ensures that the dependency map is updated appropriately based on the entity's status. The streamlined error handling and dependency setting logic further improve readability while maintaining the same functionality.

Overall, these changes enhance the code structure and make it easier to understand and maintain. Well done!


193-209: The handling of existing dynamic leaf entities looks good!

This code segment correctly handles the case when the entity is not a new widget but is still a dynamic leaf. Retrieving the entity path dependencies and extracting binding information ensures that the dependency map is updated accurately for existing entities.

Additionally, collecting any errors encountered during the extraction process helps in identifying and fixing issues related to the dependencies.

The changes in this code segment contribute to the overall improvement of the dependency map update process. Keep up the good work!


194-199: The retrieval of entity path dependencies is implemented correctly.

This code segment properly retrieves the entity path dependencies by calling the getEntityPathDependencies function with the necessary arguments: entity, entityConfig, fullPropertyPath, and allKeys.

These arguments provide the required information for the function to determine the dependencies accurately. The usage of the getEntityPathDependencies function is appropriate in this context.

Good job on implementing the retrieval of entity path dependencies correctly!

@vsvamsi1 vsvamsi1 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Sep 13, 2024
@@ -164,7 +164,7 @@ export const updateDependencyMap = ({
didUpdateDependencyMap;

if (isWidgetActionOrJsObject(entity)) {
if (!isDynamicLeaf(unEvalDataTree, fullPropertyPath, configTree)) {
if (entityName === fullPropertyPath) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Please check the failures and also kindly add/update unit test related to this file.

Copy link

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 Sep 20, 2024
Copy link

This PR has been closed because of inactivity.

@github-actions github-actions bot closed this Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ok-to-test Required label for CI Stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants