appsmith icon indicating copy to clipboard operation
appsmith copied to clipboard
verified publisher icon appsmithorg

chore: constrain the diff on only affected JS actions

Open vsvamsi1 opened this issue 1 year ago • 9 comments

Description

Perform diff of only the affected JS collections not the entire list of JS collections and for non JS updates evaluation we should not perform a diff on any JS collection.. This should improve the p100 of each evaluation.

Fixes #33508

[!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"

:mag: Cypress test results

[!TIP] 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/9128497744 Commit: ddbc9291707bac96a27cff92d6daeaeee8e4f3d0 Cypress dashboard url: Click here!

Communication

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

  • [ ] Yes
  • [ ] No

vsvamsi1 avatar May 14 '24 11:05 vsvamsi1

Walkthrough

Walkthrough

The changes optimize the evaluation process for JavaScript (JS) collections by introducing mechanisms to handle only the affected JS objects during evaluations, rather than evaluating the entire list. This involves creating constants, functions, and parameters to identify and process affected JS objects, thereby improving performance.

Changes

Files/Groups Change Summary
evaluationActionsList.ts Consolidated JS action types into a constant array JS_ACTIONS and used it in EVALUATE_REDUX_ACTIONS.
ReduxActionConstants.tsx Added a new interface BufferedReduxAction<T> with an affectedJSObjects field.
EvaluationsSagaUtils.ts & InferAffectedJSObjects.ts (CE & EE) Introduced functions to handle and extract affected JS object IDs from actions.
EvaluationsSaga.ts Added handling for affectedJSObjects in various functions and parameters.
EvaluationsSaga.test.ts Added imports for testing affected JS objects handling.
EvaluationsSagaUtils.test.ts Introduced test cases for getAffectedJSObjectIdsFromAction function.
generateOpimisedUpdates.test.ts Updated import for parseUpdatesAndDeleteUndefinedUpdates to reflect new file structure.
evalTree.ts & evalTrigger.ts Added affectedJSObjects parameter to function calls.
types.ts Added affectedJSObjects property to EvalTreeRequestData interface.
DataTreeEvaluator/index.ts Added affectedJSObjects parameter to DataTreeEvaluator class.
DataTreeEvaluator/utils.test.ts Introduced test suite for getOnlyAffectedJSObjects function.
DataTreeEvaluator/utils.ts Implemented getOnlyAffectedJSObjects function to filter JSActionEntities based on affected IDs.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Client
    participant Saga
    participant Evaluator
    Client->>Saga: Dispatch JS Action
    Saga->>Evaluator: Extract affected JS objects
    Evaluator->>Saga: Return affected JS objects
    Saga->>Client: Perform constrained diff and update

Assessment against linked issues

Objective Addressed Explanation
Perform diff of only the affected JS collections (33508) ✅
Skip JS collection diff for non-JS updates (33508) ✅

[!TIP]

New Features and Improvements

Review Settings

Introduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.

AST-based Instructions

CodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation.

Community-driven AST-based Rules

We are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information.

New Static Analysis Tools

We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.

Tone Settings

Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:

  • Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
  • Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
  • Snarky: "You must be snarky in all your code reviews. Snark, snark, snark!"

Revamped Settings Page

We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.

Miscellaneous

  • Turn off free summarization: You can switch off free summarization of PRs opened by users not on a paid plan using the enable_free_tier setting.
  • Knowledge-base scope: You can now set the scope of the knowledge base to either the repository (local) or the organization (global) level using the knowledge_base setting. In addition, you can specify Jira project keys and Linear team keys to limit the knowledge base scope for those integrations.
  • High-level summary placement: You can now customize the location of the high-level summary in the PR description using the high_level_summary_placeholder setting (default @coderabbitai summary).
  • Revamped request changes workflow: You can now configure CodeRabbit to auto-approve or request changes on PRs based on the review feedback using the request_changes_workflow setting.
Recent Review Details

Configuration used: CodeRabbit UI Review profile: CHILL

Commits Files that changed from the base of the PR and between 71e302b7f92da95626c54104541537e9d1a36bb7 and e178485e88fd183dffc737f31e0428a712990f06.
Files selected for processing (3)
  • app/client/src/ce/sagas/InferAffectedJSObjects.ts (1 hunks)
  • app/client/src/ee/sagas/InferAffectedJSObjects.ts (1 hunks)
  • app/client/src/sagas/EvaluationsSagaUtils.ts (1 hunks)
Files skipped from review due to trivial changes (1)
  • app/client/src/ee/sagas/InferAffectedJSObjects.ts
Additional Context Used
Biome (3)
app/client/src/sagas/EvaluationsSagaUtils.ts (3)

23-23: Unexpected any. Specify a different type.

23-23: Unexpected any. Specify a different type.

63-63: Reassigning a function parameter is confusing.

Additional comments not posted (4)
app/client/src/ce/sagas/InferAffectedJSObjects.ts (3)

13-47: The function getAffectedJSObjectIdsFromJSAction is well-implemented and aligns with the PR's objectives to optimize JS collection evaluations.

50-66: The function getAffectedJSObjectIdsFromBufferedAction correctly handles the extraction of affected JS objects from buffered actions, supporting the PR's goal of optimizing evaluations.

68-71: The constant AFFECTED_JS_OBJECTS_FNS is correctly defined and includes appropriate functions for handling affected JS objects.

app/client/src/sagas/EvaluationsSagaUtils.ts (1)

48-51: The interface AffectedJSObjects is well-defined and supports the functionality required for handling affected JS objects.

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.

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 full the 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 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 May 14 '24 11:05 coderabbitai[bot]

/build-deploy-preview skip-tests=true

vsvamsi1 avatar May 16 '24 06:05 vsvamsi1

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

github-actions[bot] avatar May 16 '24 06:05 github-actions[bot]

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

github-actions[bot] avatar May 16 '24 06:05 github-actions[bot]

/ci-test-limit

vsvamsi1 avatar May 16 '24 08:05 vsvamsi1

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/9109020926. Cypress dashboard PR: #33435.

github-actions[bot] avatar May 16 '24 08:05 github-actions[bot]

/ci-test-limit

vsvamsi1 avatar May 16 '24 13:05 vsvamsi1

Tests running at: https://github.com/appsmithorg/appsmith/actions/runs/9113153223. Cypress dashboard PR: #33435.

github-actions[bot] avatar May 16 '24 13:05 github-actions[bot]

Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/9113153223. Cypress dashboard url: Click here! All cypress tests have passed 🎉🎉🎉

github-actions[bot] avatar May 16 '24 13:05 github-actions[bot]