fix: UI segment re render caused by route change

[hetunandu]

Description

On route changes, the UI segment components were re-created (re mounted) causing scrolls to reset. This was happening because of how we were passing the Route Components inside the React Router Route .

By passing these componenets as children of routes instead of a prop function, we avoid recreating the component on route changes and hence avoiding the scroll to reset

Fixes #32995

Automation

/ok-to-test tags="@tag.IDE, @tag.Widget"

🔍 Cypress test results

Caution

🔴 🔴 🔴 Some tests have failed.
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/8972146055
Commit: 05851e3
Cypress dashboard: Click here!
The following are new failures, please fix them before merging the PR:

1. cypress/e2e/Regression/ClientSide/Widgets/Button/ButtonGroup2_spec.ts

To know the list of identified flaky tests - Refer here

Communication

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

• Yes
• No

[coderabbitai]

Walkthrough

The modifications in the EditorPane UI involve reorganizing the routing logic within the UISegment component. This includes adjustments to SentryRoute components for AddWidgets and ListWidgets, ensuring they are correctly nested within the Switch component and modifying their rendering logic.

Changes

File Path	Change Summary
.../EditorPane/UI/index.tsx	Reorganized routing logic within UISegment, adjusted SentryRoute components for AddWidgets and ListWidgets.

Assessment against linked issues

Objective	Addressed	Explanation
#32995: Focus incorrectly returns to top after adding a widget	❓	It's unclear if the reorganized routing logic addresses the focus issue after adding a widget. The provided summary does not specify changes related to focus management or state persistence.

The changes primarily focus on routing logic and do not explicitly address the focus management issue described in the linked bug report. Further review or additional code changes might be necessary to ensure that the focus behavior is corrected as per the issue requirements.

---

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.

[rishabhrathod01]

LGTM