fix: Refresh breaks open tabs

[hetunandu]

Description

Fixes a focus retention issue where on refresh, the tabs are lost

EE Shadow: https://github.com/appsmithorg/appsmith-ee/pull/6106

Automation

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

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/13151485815
Commit: e7ed2c3
Cypress dashboard.
Tags: @tag.IDE
Spec:

---

Wed, 05 Feb 2025 06:53:31 UTC

Communication

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

• Yes
• No

Summary by CodeRabbit

This update delivers enhanced navigation stability and focus management for a smoother browsing experience.

• Bug Fixes
  • Improved focus handling during navigation transitions by ensuring adjustments occur only when returning from a valid page. This refinement minimizes unintended focus shifts, providing a more consistent and user-friendly interface.

[coderabbitai]

Walkthrough

The change in this pull request updates the handleRouteChange saga by adding a conditional check for previousPath. Now, the focus retention logic via FocusRetention.onRouteChange is only triggered when previousPath is truthy. This adjustment prevents unnecessary invocations when previousPath is undefined or empty while maintaining the rest of the saga's functionality.

Changes

File	Change Summary
app/client/src/…/NavigationSagas.ts	Added a conditional check for previousPath in the handleRouteChange function before calling FocusRetention.onRouteChange.

Sequence Diagram(s)

sequenceDiagram
    participant Action as Redux Action
    participant Saga as handleRouteChange
    participant FR as FocusRetention
    Action->>Saga: dispatch RouteChangeAction
    alt previousPath is valid
        Saga->>FR: Invoke onRouteChange
    else previousPath is not valid
        Saga-->>Saga: Skip onRouteChange
    end

Loading

Possibly related PRs

• fix: Focus retention on inputs #36770: Addresses focus retention issues in input fields and involves similar focus management modifications.

Suggested labels

Bug, IDE Navigation, ok-to-test

Suggested reviewers

• AmanAgarwal041
• ankitakinger

Poem

Lines of code now neatly align,
Focus checks shine like a sign,
Conditions guard the flow so fine,
Our saga steps in perfect time,
Cheers to clarity in each new line!
🚀 Happy coding!

Tip

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1de2408 and e7ed2c3.

📒 Files selected for processing (1)

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

⏰ Context from checks skipped due to timeout of 90000ms (8)

• GitHub Check: perform-test / client-build / client-build
• GitHub Check: perform-test / rts-build / build
• GitHub Check: perform-test / server-build / server-unit-tests
• GitHub Check: client-unit-tests / client-unit-tests
• GitHub Check: client-prettier / prettier-check
• GitHub Check: client-check-cyclic-deps / check-cyclic-dependencies
• GitHub Check: client-lint / client-lint
• GitHub Check: client-build / client-build

🔇 Additional comments (1)

app/client/src/ce/sagas/NavigationSagas.ts (1)

41-48: LGTM! The conditional check prevents unnecessary focus retention calls.

The implementation correctly addresses the tab state loss on refresh by ensuring focus retention logic only runs when there's a valid previous path.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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