chore: Splitting JS Object body dump vs parsed JS Object update to remove race condition originated bad state #33124

trishaanand · 2024-05-02T07:04:18Z

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

Tip

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

Communication

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

Yes
No

coderabbitai · 2024-05-02T07:04:26Z

Walkthrough

The recent updates focus on enhancing JavaScript collection management and action collection handling. New methods for updating JS collection bodies and unpublished action collections have been introduced, improving specificity and efficiency. Changes also involve refactoring existing functionalities and updating method signatures to streamline processes and integrate new logic, ensuring a more robust and flexible system.

Changes

File Path	Change Summary
`app/client/src/ce/api/JSActionAPI.tsx`	Added `updateJSCollectionBody` method for updating JavaScript collection bodies via PUT requests.
`app/client/src/sagas/JSPaneSagas.ts`	Modified `handleUpdateJSCollectionBody` to use `updateJSCollectionBody`. Changed response type and updated logic for handling collection updates.
`app/server/.../services/ce/LayoutCollectionServiceCEImpl.java`	Added new methods and refactored existing ones for better management of action collections. Updated method signatures and integrated new logic for resource handling.

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between edf5662 and 190f768.

Files selected for processing (1)

app/server/appsmith-server/src/main/java/com/appsmith/server/services/ce/LayoutCollectionServiceCEImpl.java (6 hunks)

Files skipped from review as they are similar to previous changes (1)

app/server/appsmith-server/src/main/java/com/appsmith/server/services/ce/LayoutCollectionServiceCEImpl.java

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 a review. This is useful when automatic reviews are disabled for the repository.
@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

Actionable comments posted: 0

Out of diff range and nitpick comments (1)

app/server/scripts/start-dev-server.sh (1)
Line range hint 4-4: Add error handling for the cd command to prevent script execution in an unintended directory.
- cd "$(cd "$(dirname "$0")" && pwd)/.."
+ cd "$(cd "$(dirname "$0")" && pwd)/.." || exit

github-actions · 2024-05-02T07:29:12Z

Failed server tests

com.appsmith.server.solutions.CreateDBTablePageSolutionTests#createPageWithLessColumnsComparedToTemplateForSql

github-actions · 2024-05-02T07:38:12Z

Failed server tests

com.appsmith.server.solutions.CreateDBTablePageSolutionTests#createPageWithInvalidApplicationIdTest

nidhi-nair · 2024-05-03T03:33:32Z

...th-server/src/main/java/com/appsmith/server/controllers/ce/ActionCollectionControllerCE.java

+            @PathVariable String id,
+            @Valid @RequestBody String body,
+            @RequestHeader(name = FieldName.BRANCH_NAME, required = false) String branchName) {
+        log.debug("Going to update action collection body with id: {}, branch: {}", id, branchName);


Nit: Do we need these kinda log lines? I think we should start getting rid of them.

…ing entities

subrata71 · 2024-05-09T12:07:52Z

QQ: Doesn't this PR need the client-side changes w.r.t. modules and workflows? @trishaanand Asking this because there is JS object in both workflows and modules.

trishaanand · 2024-05-09T12:12:09Z

QQ: Doesn't this PR need the client-side changes w.r.t. modules and workflows? @trishaanand Asking this because there is JS object in both workflows and modules.

@ApekshaBhosale : Is this correct? Do we need changes in modules and workflows code flow as well?

ApekshaBhosale · 2024-05-09T12:14:05Z

@trishaanand i don't think so because underline uses same JS objects.it will be fine! @ayushpahwa can you confirm once?

ApekshaBhosale · 2024-05-09T12:28:29Z

@trishaanand checked code for workflow as well. looks like it uses same underline js object so it will be fine!

dvj1988 · 2024-05-09T13:52:50Z

/build-deploy-preview skip-tests=true

github-actions · 2024-05-09T13:53:10Z

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

github-actions · 2024-05-09T14:06:18Z

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

ApekshaBhosale · 2024-05-09T15:01:31Z

@dvj1988 @trishaanand format of JS object body is different so regex is failing on client side. extra "/" i see

…pdate-race

coderabbitai

Actionable comments posted: 1

coderabbitai · 2024-05-10T04:53:17Z

app/client/src/sagas/JSPaneSagas.ts

+      const response: ApiResponse<any> =
+        yield JSActionAPI.updateJSCollectionBody(
+          jsCollection.id,
+          jsCollection.body,
+        );
      const isValidResponse: boolean = yield validateResponse(response);
      if (isValidResponse) {
        // since server is not sending the info about whether the js collection is main or not
        // we are retaining it manually
        const updatedJSCollection: JSCollection = {
-          ...response.data,
+          ...jsCollection,


Avoid direct modification of the JS collection object before confirming the update success.

- jsCollection["body"] = actionPayload.payload.body; + const updatedBody = actionPayload.payload.body;

Use updatedBody for the API call, and only update jsCollection after confirming the response is valid.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

const response: ApiResponse<any> =

yield JSActionAPI.updateJSCollectionBody(

jsCollection.id,

jsCollection.body,

);

const isValidResponse: boolean = yield validateResponse(response);

if (isValidResponse) {

// since server is not sending the info about whether the js collection is main or not

// we are retaining it manually

const updatedJSCollection: JSCollection = {

...response.data,

...jsCollection,

const updatedBody = actionPayload.payload.body;

const response: ApiResponse<any> =

yield JSActionAPI.updateJSCollectionBody(

jsCollection.id,

updatedBody,

);

const isValidResponse: boolean = yield validateResponse(response);

if (isValidResponse) {

// since server is not sending the info about whether the js collection is main or not

// we are retaining it manually

const updatedJSCollection: JSCollection = {

...jsCollection,

…-race

…org/appsmith into chore/split-js-body-update-race

dvj1988 · 2024-05-10T07:16:24Z

/build-deploy-preview skip-tests=true

github-actions · 2024-05-10T07:16:45Z

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

github-actions · 2024-05-10T07:29:46Z

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

…e is a separate end point for this

…org/appsmith into chore/split-js-body-update-race

Adding client side code changes from PR appsmithorg/appsmith-ee#3938

7408a6f

github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label May 2, 2024

coderabbitai bot reviewed May 2, 2024

View reviewed changes

Adding server side code changes from PR appsmithorg/appsmith-ee#3938

3c1bf1d

trishaanand requested review from nidhi-nair and sondermanish as code owners May 2, 2024 07:10

Undo local setup changes from PR.

0ea0217

trishaanand added the ok-to-test Required label for CI label May 2, 2024

nidhi-nair reviewed May 3, 2024

View reviewed changes

nidhi-nair previously approved these changes May 3, 2024

View reviewed changes

fix: Use branched entity for operations to do with updating and creat…

57b3311

…ing entities

trishaanand added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 9, 2024

Merge branch 'fix/default-entity-accesses' into chore/split-js-body-u…

957745e

…pdate-race

trishaanand dismissed nidhi-nair’s stale review via 957745e May 10, 2024 04:47

coderabbitai bot reviewed May 10, 2024

View reviewed changes

dvj1988 and others added 3 commits May 10, 2024 12:26

Change the payload of updateJSCollectionBody

885866c

to ensure body is not json stringified, expecting js object itself

62d4480

Merge remote-tracking branch 'origin' into chore/split-js-body-update…

5e1acd9

…-race

Merge branch 'chore/split-js-body-update-race' of github.com:appsmith…

edf5662

…org/appsmith into chore/split-js-body-update-race

trishaanand added 2 commits May 10, 2024 13:19

Ignoring body field in the update action collection call because ther…

ef3f35b

…e is a separate end point for this

Merge branch 'chore/split-js-body-update-race' of github.com:appsmith…

190f768

…org/appsmith into chore/split-js-body-update-race

dvj1988 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels May 10, 2024

dvj1988 approved these changes May 10, 2024

View reviewed changes

trishaanand merged commit 7250422 into release May 13, 2024
84 checks passed

trishaanand deleted the chore/split-js-body-update-race branch May 13, 2024 04:08

This was referenced Oct 21, 2024

fix: resolve redundant JSObject action saving #36958

Merged

fix: avoiding unnecessary update page layouts in js action update #37062

Merged

coderabbitai bot mentioned this pull request Oct 30, 2024

fix: skipped unnecessary code for js object updates #37125

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Splitting JS Object body dump vs parsed JS Object update to remove race condition originated bad state #33124

chore: Splitting JS Object body dump vs parsed JS Object update to remove race condition originated bad state #33124

trishaanand commented May 2, 2024 •

edited by github-actions bot

Loading

coderabbitai bot commented May 2, 2024 •

edited

Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

github-actions bot commented May 2, 2024

github-actions bot commented May 2, 2024

nidhi-nair May 3, 2024

subrata71 commented May 9, 2024

trishaanand commented May 9, 2024

ApekshaBhosale commented May 9, 2024 •

edited

Loading

ApekshaBhosale commented May 9, 2024

dvj1988 commented May 9, 2024

github-actions bot commented May 9, 2024

github-actions bot commented May 9, 2024

ApekshaBhosale commented May 9, 2024

coderabbitai bot left a comment

coderabbitai bot May 10, 2024

dvj1988 commented May 10, 2024

github-actions bot commented May 10, 2024

github-actions bot commented May 10, 2024

chore: Splitting JS Object body dump vs parsed JS Object update to remove race condition originated bad state #33124

chore: Splitting JS Object body dump vs parsed JS Object update to remove race condition originated bad state #33124

Conversation

trishaanand commented May 2, 2024 • edited by github-actions bot Loading

Description

Automation

🔍 Cypress test results

Communication

coderabbitai bot commented May 2, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

github-actions bot commented May 2, 2024

Failed server tests

github-actions bot commented May 2, 2024

Failed server tests

nidhi-nair May 3, 2024

Choose a reason for hiding this comment

subrata71 commented May 9, 2024

trishaanand commented May 9, 2024

ApekshaBhosale commented May 9, 2024 • edited Loading

ApekshaBhosale commented May 9, 2024

dvj1988 commented May 9, 2024

github-actions bot commented May 9, 2024

github-actions bot commented May 9, 2024

ApekshaBhosale commented May 9, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot May 10, 2024

Choose a reason for hiding this comment

dvj1988 commented May 10, 2024

github-actions bot commented May 10, 2024

github-actions bot commented May 10, 2024

trishaanand commented May 2, 2024 •

edited by github-actions bot

Loading

coderabbitai bot commented May 2, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

ApekshaBhosale commented May 9, 2024 •

edited

Loading