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: fixing issue with persisting branch name #32914

Merged
merged 3 commits into from
Apr 24, 2024

Conversation

brayn003
Copy link
Contributor

@brayn003 brayn003 commented Apr 24, 2024

Description

Fixes issue with persisting branch if the more dropdown in inline nav is used

Fixes #32050

Automation

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

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/8816010061
Commit: 697a171
Cypress dashboard url: Click here!

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • New Features
    • Enhanced app navigation to retain branch parameters when using the navigation dropdown.
  • Tests
    • Added tests to ensure consistent navigation behavior with Git integration.

@brayn003 brayn003 self-assigned this Apr 24, 2024
@github-actions github-actions bot added Bug Something isn't working Community Reported issues reported by community members Git Platform Pod Issues related to the git & the app platform Git Product Issues related to version control product Low effort Takes 1-2 days Medium Issues that frustrate users due to poor UX Production labels Apr 24, 2024
@brayn003 brayn003 added the ok-to-test Required label for CI label Apr 24, 2024
@brayn003 brayn003 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Apr 24, 2024
@brayn003 brayn003 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Apr 24, 2024
Copy link
Contributor

@ankitakinger ankitakinger left a comment

Choose a reason for hiding this comment

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

LGTM

@brayn003 brayn003 added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Apr 24, 2024
@brayn003 brayn003 marked this pull request as ready for review April 24, 2024 12:02
Copy link
Contributor

coderabbitai bot commented Apr 24, 2024

Walkthrough

Walkthrough

The changes introduced involve adding a query prop to both the TopInline and MoreDropdownButton components to maintain URL parameters, like the branch parameter, during app navigation. This update ensures that navigation through different parts of the app interface does not remove essential query parameters, thereby improving user experience in version-controlled environments.

Changes

File Path Change Summary
.../AppNavigation/AppNavigationWithGit_spec.ts Adds tests for ensuring the branch parameter is retained when navigating via the more dropdown.
.../TopInline.tsx
.../MoreDropdownButton.tsx
Added a query prop to maintain URL parameters during navigation.

Possibly related issues


Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 4b9dddc and 697a171.
Files selected for processing (3)
  • app/client/cypress/e2e/Regression/ClientSide/AppNavigation/AppNavigationWithGit_spec.ts (1 hunks)
  • app/client/src/pages/AppViewer/Navigation/TopInline.tsx (1 hunks)
  • app/client/src/pages/AppViewer/Navigation/components/MoreDropdownButton.tsx (2 hunks)
Additional comments not posted (3)
app/client/cypress/e2e/Regression/ClientSide/AppNavigation/AppNavigationWithGit_spec.ts (1)

13-40: Ensure the test scenario accurately reflects the intended functionality.

This test scenario is crucial for verifying the persistence of the branch parameter during navigation. Please ensure it aligns with the expected behavior and covers all necessary edge cases.

app/client/src/pages/AppViewer/Navigation/TopInline.tsx (1)

137-137: Ensure the query prop is correctly utilized in the MoreDropdownButton.

The addition of the query prop to the MoreDropdownButton component is intended to maintain the branch name during navigation. Please verify that this prop is being used correctly throughout the component to ensure consistent behavior.

app/client/src/pages/AppViewer/Navigation/components/MoreDropdownButton.tsx (1)

123-124: Ensure the query prop and state object are correctly utilized in navigation links.

The addition of the query prop and the state object with the invokedBy key set to NavigationMethod.AppNavigation is crucial for maintaining the branch name during navigation. Please verify that these properties are being used correctly to ensure consistent navigation behavior.


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

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

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

@brayn003 brayn003 merged commit b867f9c into release Apr 24, 2024
75 of 76 checks passed
@brayn003 brayn003 deleted the fix/queryparams-inline-nav branch April 24, 2024 12:23
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 Git Platform Pod Issues related to the git & the app platform Git Product Issues related to version control product Low effort Takes 1-2 days Medium Issues that frustrate users due to poor UX ok-to-test Required label for CI Production
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Git Branch Parameter Removed When Navigating to a Page Under the More Dropdown
2 participants