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

Buffered both trigger and Buffered #38215

Draft
wants to merge 3 commits into
base: release
Choose a base branch
from
Draft

Buffered both trigger and Buffered #38215

wants to merge 3 commits into from

Conversation

vsvamsi1
Copy link
Contributor

@vsvamsi1 vsvamsi1 commented Dec 17, 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/12379248898
Commit: 0bcb2a6
Cypress dashboard.
Tags: @tag.All
Spec:
The following are new failures, please fix them before merging the PR:

  1. cypress/e2e/Regression/ClientSide/ActionExecution/NavigateTo_spec.ts
  2. cypress/e2e/Regression/ClientSide/Debugger/Widget_property_navigation_spec.ts
  3. cypress/e2e/Regression/ClientSide/OneClickBinding/TableWidget/OneClickBindingMysql_spec.ts
  4. cypress/e2e/Regression/ClientSide/OneClickBinding/TableWidget/Table_MongoDB_spec.ts
  5. cypress/e2e/Regression/ClientSide/OneClickBinding/TableWidget/Table_postgres_spec.ts
  6. cypress/e2e/Regression/ClientSide/Widgets/ListV2/Childwigets/List_FilePicker_spec.js
  7. cypress/e2e/Regression/ClientSide/Widgets/ListV2/Listv2_BasicChildWidgetInteraction_spec.js
  8. cypress/e2e/Regression/ClientSide/Widgets/ListV2/Listv2_WithButtonGroupIconWidget_spec.ts
List of identified flaky tests.
Wed, 18 Dec 2024 06:16:43 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features

    • Enhanced action handling and evaluation processes for improved responsiveness.
    • Introduced a new constant for managing buffered actions during evaluations.
  • Bug Fixes

    • Optimized control flow to differentiate between regular and trigger actions, reducing unnecessary evaluations.

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

coderabbitai bot commented Dec 17, 2024

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request modifies the EvaluationsSaga.ts file to enhance action handling and evaluation processes. By introducing a race effect from redux-saga/effects, the saga now supports more sophisticated concurrent action management. The changes improve the control flow for processing evaluation-related actions, particularly focusing on handling trigger actions with a more nuanced approach that includes timeout mechanisms and buffered action processing.

Changes

File Change Summary
app/client/src/sagas/EvaluationsSaga.ts - Added race import from redux-saga/effects
- Introduced bufferedAction constant
- Updated evaluationChangeListenerSaga with more complex action handling logic
- Implemented timeout and trigger action detection mechanism

Sequence Diagram

sequenceDiagram
    participant Saga as EvaluationsSaga
    participant Channel as evtActionChannel
    participant Timeout as Timeout Mechanism

    loop Action Processing
        Saga->>Channel: Listen for actions
        Saga->>Timeout: Set 1000ms timeout
        alt Trigger Action Detected
            Saga-->>Saga: Buffer Action
            Saga-->>Saga: Continue Listening
        else Timeout Occurs
            Saga-->>Saga: Process Buffered Action
        end
    end
Loading

Possibly Related PRs

Poem

🚀 Saga of Actions, Swift and Bright
Racing through channels with timeout's might
Buffering triggers, a dance so keen
Evaluations flow, now more serene!
Code's rhythm finds its perfect beat 🎵


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@vsvamsi1 vsvamsi1 marked this pull request as draft December 17, 2024 18:35
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: 1

🧹 Nitpick comments (1)
app/client/src/sagas/EvaluationsSaga.ts (1)

776-776: Avoid reassigning 'action' variable to prevent confusion

Reassigning the action variable shadows the outer scope variable and can lead to confusion. Use a different variable name.

Apply this diff to rename the variable:

- const action = bufferedAction as any;
+ const bufferedEvalAction = bufferedAction as any;
  const affectedJSObjects = getAffectedJSObjectIdsFromAction(
-   action,
+   bufferedEvalAction,
  );

  yield call(evalAndLintingHandler, true,
-   action,
+   bufferedEvalAction,
    {
      shouldReplay: get(action, "payload.shouldReplay"),
      forceEvaluation: shouldForceEval(action),
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 35a5d83 and 0bcb2a6.

📒 Files selected for processing (1)
  • app/client/src/sagas/EvaluationsSaga.ts (3 hunks)

Comment on lines 760 to 799
const { action, timeout } = yield race({
action: take(evtActionChannel),
timeout: delay(1000),
});

// We are dequing actions from the buffer and inferring the JS actions affected by each
// action. Through this we know ahead the nodes we need to specifically diff, thereby improving performance.
const affectedJSObjects = getAffectedJSObjectIdsFromAction(action);
if (
action?.type === ReduxActionTypes.TRIGGER_EVAL ||
isEqual(action, bufferedAction)
) {
hasTriggerAction = true;
continue;
}

yield call(evalAndLintingHandler, true, action, {
shouldReplay: get(action, "payload.shouldReplay"),
forceEvaluation: shouldForceEval(action),
requiresLogging: shouldLog(action),
affectedJSObjects,
});
if (timeout) {
if (hasTriggerAction) {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const action = bufferedAction as any;
const affectedJSObjects = getAffectedJSObjectIdsFromAction(action);

yield call(evalAndLintingHandler, true, action, {
shouldReplay: get(action, "payload.shouldReplay"),
forceEvaluation: shouldForceEval(action),
requiresLogging: shouldLog(action),
affectedJSObjects,
});
}
} else {
// We are dequing actions from the buffer and inferring the JS actions affected by each
// action. Through this we know ahead the nodes we need to specifically diff, thereby improving performance.
const affectedJSObjects = getAffectedJSObjectIdsFromAction(action);

yield call(evalAndLintingHandler, true, action, {
shouldReplay: get(action, "payload.shouldReplay"),
forceEvaluation: shouldForceEval(action),
requiresLogging: shouldLog(action),
affectedJSObjects,
});
}

hasTriggerAction = false;
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix usage of 'bufferedAction' before its declaration

The variable bufferedAction is used before its declaration at line 803, which will cause a ReferenceError. Move the declaration of bufferedAction before its usage.

Apply this diff to fix the issue:

+ const bufferedAction = {
+   postEvalActions: [],
+   affectedJSObjects: {
+     isAllAffected: false,
+     ids: [],
+   },
+   type: "BUFFERED_ACTION",
+ };

 while (true) {
   const { action, timeout } = yield race({
     action: take(evtActionChannel),
     timeout: delay(1000),
   });

Committable suggestion skipped: line range outside the PR's diff.

@vsvamsi1
Copy link
Contributor Author

/build-deploy-preview skip-tests=true

Copy link

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

@vsvamsi1 vsvamsi1 changed the title Buffered actions Buffered both trigger and Buffered Dec 17, 2024
Copy link

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

@vsvamsi1
Copy link
Contributor Author

/build-deploy-preview skip-tests=true

@vsvamsi1 vsvamsi1 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Dec 17, 2024
Copy link

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

@vsvamsi1 vsvamsi1 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Dec 17, 2024
Copy link

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

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 Dec 25, 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.

1 participant