fix: issue with opening custom widget source editor

[brayn003]

Description

Custom widget source editor crashes when open from an application connected to packages

Fixes #35462

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/10271875888
Commit: f36faa4
Cypress dashboard.
Tags: @tag.All
Spec:

---

Tue, 06 Aug 2024 19:15:42 UTC

Communication

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

• Yes
• No

Summary by CodeRabbit

• New Features
  • Enhanced navigation entity logic in the Code Editor for improved performance.
  • Conditional loading of navigation entities based on the current page context.

[coderabbitai]

Walkthrough

This update refines the mapStateToProps function in the CodeEditor component, enhancing how navigation entities are derived based on the current page ID. By introducing a conditional assignment for entitiesForNavigation, the code optimizes performance, ensuring that it only computes navigation entities when a valid currentPageId is present. This change addresses a critical bug related to navigating custom widgets in a production environment.

Changes

Files	Change Summary
app/client/src/components/editorComponents/CodeEditor/index.tsx	Modified mapStateToProps to include currentPageId, optimizing the assignment of entitiesForNavigation based on its validity.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CodeEditor
    participant ReduxStore

    User->>CodeEditor: Click "Edit Source"
    CodeEditor->>ReduxStore: Request currentPageId
    ReduxStore-->>CodeEditor: Provide currentPageId
    alt if currentPageId is valid
        CodeEditor->>ReduxStore: Get entitiesForNavigation
        ReduxStore-->>CodeEditor: Return entities
    else if currentPageId is not valid
        CodeEditor->>CodeEditor: Set entitiesForNavigation to {}
    end
    CodeEditor->>User: Render editor with entities

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Ensure currentPageId is retrieved to prevent crashes (#[35462])	✅
Optimize performance by computing entities only when required (#[35462])	✅

Poem

In the realm of code, a change took flight,
With currentPageId, the path feels right.
No more crashes, just smooth navigation,
Entities flow, a sweet optimization!
Bugs now at bay, our apps sing with cheer,
Thanks to these changes, let's give a great cheer! 🎉

---

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 57a8e83 and f36faa4.

Files selected for processing (1)

• app/client/src/components/editorComponents/CodeEditor/index.tsx (2 hunks)

Additional comments not posted (3)

app/client/src/components/editorComponents/CodeEditor/index.tsx (3)

1776-1776: Great job introducing the currentPageId variable!

This ensures the code is more readable and maintainable by clearly defining what currentPageId represents.

---

1778-1783: Excellent use of conditional logic!

By checking if currentPageId is truthy before assigning entitiesForNavigation, you avoid unnecessary computations, which can improve performance.

---

1784-1784: Good structure in returning the state properties!

The return statement is well-organized and ensures all necessary properties are included in the state.