fix: JSObject function is not defined error

[rishabhrathod01]

Description

• Add the initial fetch all entity completion to the affectedJSObject logic to make sure the JSObjects are defined on page change

Fixes #34681
Fixed #34933

Automation

/test js

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/9998917287
Commit: 88f6c63
Cypress dashboard.
Tags: @tag.JS
Spec:

---

Thu, 18 Jul 2024 22:05:02 UTC

Communication

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

• Yes
• No

Summary by CodeRabbit

• Bug Fixes
  • Improved handling of specific action types to ensure correct identification of affected objects.
  • Enhanced logic to address cases where action types are not included in the predefined set, providing more accurate results.

[coderabbitai]

Walkthrough

The update to getAffectedJSObjectIdsFromJSAction in InferAffectedJSObjects.ts enhances the function by handling ReduxActionTypes.FETCH_ALL_PAGE_ENTITY_COMPLETION actions distinctly. When such an action is detected, it now returns an empty array of IDs with a flag indicating that all objects are affected. Additionally, it ensures proper handling of actions not included in JS_ACTIONS, returning empty IDs and a false flag. This change aims to rectify issues where JSObject functions may not be recognized under specific navigation circumstances.

Changes

File	Change Summary
.../InferAffectedJSObjects.ts	Enhanced getAffectedJSObjectIdsFromJSAction to handle FETCH_ALL_PAGE_ENTITY_COMPLETION and improved action type checking.

Sequence Diagram(s)

For these changes, generating a sequence diagram isn't necessary because the modifications primarily involve conditional checks and return statements without altering the overall flow or introducing new features.

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Handle ReduxActionTypes.FETCH_ALL_PAGE_ENTITY_COMPLETION correctly (#34681, #34933)	✅
Ensure proper handling of JSObject functions during navigation (#34681)	✅
Fix error <function_name> is not a function in deployed apps (#34933)	✅

Poem

In code's maze, new logic's thread,
Fetched all pages, errors fled.
Functions lost, now found again,
Navigation smooth, without the strain.
Oh, the joy in JS we see,
As bugs are squashed, our code runs free. 🚀

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 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 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration 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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d044155 and 88f6c63.

Files selected for processing (1)

• app/client/src/ce/sagas/InferAffectedJSObjects.ts (1 hunks)

Additional comments not posted (3)

app/client/src/ce/sagas/InferAffectedJSObjects.ts (3)

16-21: Good job handling FETCH_ALL_PAGE_ENTITY_COMPLETION!

The new conditional block correctly handles the ReduxActionTypes.FETCH_ALL_PAGE_ENTITY_COMPLETION action by returning an object with empty IDs and a flag set to true. This ensures that all JSObjects are considered affected when this action occurs.

---

22-29: Great check for action types!

The logic to check if the action type is included in JS_ACTIONS is well-implemented. It ensures that only relevant actions are processed, returning an empty array of IDs and a false flag for other actions.

---

Line range hint 41-52:
Function getAffectedJSObjectIdsFromBufferedAction looks good!

The function correctly handles buffered actions and returns the affected JSObjects or an empty array with a false flag when the action type is not ReduxActionTypes.BUFFERED_ACTION.

[rishabhrathod01]

/build-deploy-preview skip-tests=true

[github-actions]

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

[github-actions]

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