Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Wrong pageId used for segment navigation #38247

Merged
merged 1 commit into from
Dec 19, 2024

Conversation

hetunandu
Copy link
Member

@hetunandu hetunandu commented Dec 19, 2024

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 #38216

Automation

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

🔍 Cypress test results

Tip

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


Thu, 19 Dec 2024 06:19:57 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features

    • Enhanced navigation management in the editor for improved user experience.
    • Streamlined retrieval of the base entity ID for navigation purposes.
  • Bug Fixes

    • Improved consistency in widget selection behavior based on current focus entity and keyboard events.

Copy link
Contributor

coderabbitai bot commented Dec 19, 2024

Walkthrough

The pull request modifies the hooks.ts file in the editor, focusing on streamlining navigation state management. The primary change involves replacing multiple hooks with a direct selector call to getCurrentBasePageId. This simplifies how the base entity ID is retrieved for navigation purposes, particularly in the useSegmentNavigation hook. The modifications aim to consolidate state management for editor navigation and focus handling, using a single source of truth for the base page ID.

Changes

File Change Summary
app/client/src/pages/Editor/IDE/hooks.ts - Replaced useEditorType and useParentEntityInfo hooks with direct getCurrentBasePageId selector
- Modified onSegmentChange to use basePageId for URL construction
- Maintained useWidgetSelectionBlockListener core logic

Sequence Diagram

sequenceDiagram
    participant Hook as useSegmentNavigation
    participant Selector as getCurrentBasePageId
    participant History as history.push
    
    Hook->>Selector: Get base page ID
    Selector-->>Hook: Return basePageId
    Hook->>History: Construct URL with basePageId
    History-->>Hook: Navigate to segment
Loading

Possibly related PRs

Suggested Labels

Bug, ok-to-test, Javascript Product, Query & JS Pod

Suggested Reviewers

  • ankitakinger
  • albinAppsmith

Poem

🖥️ In hooks of code, a change takes flight,
Selectors dance with navigation's might
Base page ID, now crystal clear
Simplifying paths without a fear
Code refactored, smooth and bright! 🚀


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

@hetunandu hetunandu added the ok-to-test Required label for CI label Dec 19, 2024
@github-actions github-actions bot added the Bug Something isn't working label Dec 19, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
app/client/src/pages/Editor/IDE/hooks.ts (1)

Line range hint 92-115: Good architectural pattern: Consistent pageId source across hooks.

The consistent usage of getCurrentBasePageId selector across hooks (useGetPageFocusUrl and useIDETabClickHandlers) maintains a single source of truth for page identification.

Consider documenting this pattern in the codebase to ensure future modifications follow the same approach.

Also applies to: 166-209

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7d87c55 and 194f2ec.

📒 Files selected for processing (1)
  • app/client/src/pages/Editor/IDE/hooks.ts (2 hunks)
🔇 Additional comments (1)
app/client/src/pages/Editor/IDE/hooks.ts (1)

61-61: LGTM: Consistent usage of basePageId across segment navigation.

The changes correctly implement consistent pageId usage across all segment navigation paths.

Let's verify that all navigation paths are using the correct pageId:

Also applies to: 73-85

✅ Verification successful

Verified: getCurrentBasePageId is consistently used across the codebase

The changes in the IDE hooks align with the codebase-wide pattern of using getCurrentBasePageId for page navigation. All relevant components and sagas are using the same selector for base page ID retrieval, ensuring consistent behavior.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any remaining instances of potentially incorrect page ID usage in navigation
rg -g '*.{ts,tsx}' 'history\.push.*pageId(?!.*getCurrentBasePageId)' 

Length of output: 342


Script:

#!/bin/bash
# Search for history.push calls with pageId in the URL construction
rg -g '*.{ts,tsx}' 'history\.push.*pageId'

# Also search for getCurrentBasePageId usage to cross-reference
rg -g '*.{ts,tsx}' 'getCurrentBasePageId'

Length of output: 10620

@github-actions github-actions bot added Community Reported issues reported by community members IDE Navigation Issues/feature requests related to IDE navigation, and context switching IDE Pod Issues that new developers face while exploring the IDE IDE Product Issues related to the IDE Product Medium Issues that frustrate users due to poor UX Needs Triaging Needs attention from maintainers to triage Production labels Dec 19, 2024
@ankitakinger ankitakinger merged commit 8ec314f into release Dec 19, 2024
50 checks passed
@ankitakinger ankitakinger deleted the fix/segment-navigation branch December 19, 2024 06:48
NandanAnantharamu pushed a commit that referenced this pull request Dec 27, 2024
## 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 #38216

## Automation

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

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/12406790663>
> Commit: 194f2ec
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=12406790663&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Git, @tag.IDE`
> Spec:
> <hr>Thu, 19 Dec 2024 06:19:57 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [ ] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Enhanced navigation management in the editor for improved user
experience.
	- Streamlined retrieval of the base entity ID for navigation purposes.

- **Bug Fixes**
- Improved consistency in widget selection behavior based on current
focus entity and keyboard events.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working Community Reported issues reported by community members IDE Navigation Issues/feature requests related to IDE navigation, and context switching IDE Pod Issues that new developers face while exploring the IDE IDE Product Issues related to the IDE Product Medium Issues that frustrate users due to poor UX Needs Triaging Needs attention from maintainers to triage ok-to-test Required label for CI Production
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Navigation between Jsobjects not working properly
2 participants