Fix sign-in button's return-url issue in Boilerplate (#10022)

[yasmoradi]

closes #10022

Summary by CodeRabbit

• New Features
  • The header component now automatically updates its display as you navigate through pages, ensuring real-time consistency.
• Refactor
  • Streamlined navigation handling by removing redundant logic in the main layout, resulting in improved performance and simplified interaction management.

[coderabbitai]

Walkthrough

This pull request modifies two layout components in the client core project. In the IdentityHeader component, routing event handling is added to update the component state dynamically upon navigation changes. A new private method subscribes to the NavigationManager.LocationChanged event and triggers a UI update using StateHasChanged(), with proper unsubscription during disposal. In the MainLayout component, the redundant navigation event handling code and its associated method have been removed.

Changes

File	Change Summary
src/Templates/Boilerplate/…/IdentityHeader.razor.cs	- Added using Microsoft.AspNetCore.Components.Routing - Subscribed to NavigationManager.LocationChanged in OnInitAsync - Added NavigationManager_LocationChanged method - Updated DisposeAsync to unsubscribe from the event
src/Templates/Boilerplate/…/MainLayout.razor.cs	- Removed subscription to NavigationManager.LocationChanged - Deleted the associated NavigationManagerLocationChanged method and its unsubscription in DisposeAsync

Sequence Diagram(s)

sequenceDiagram
    participant NM as NavigationManager
    participant IH as IdentityHeader
    participant UI as UI Renderer

    Note over IH: Component initializes and subscribes to NM.LocationChanged
    NM->>IH: LocationChanged event triggered
    IH->>IH: NavigationManager_LocationChanged()
    IH->>UI: StateHasChanged() renders updated UI

Loading

Poem

I hop through lines of code with cheer,
Navigation shifts and the path is clear.
With events anew, the state refines,
In IdentityHeader, magic intertwines.
Safe and sound, the code does play,
A rabbit’s smile lights up the day!
🐰✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1029987 and 6f4a639.

📒 Files selected for processing (2)

• src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/IdentityHeader.razor.cs (4 hunks)
• src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/MainLayout.razor.cs (0 hunks)

💤 Files with no reviewable changes (1)

• src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/MainLayout.razor.cs

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

• GitHub Check: build and test

🔇 Additional comments (4)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/IdentityHeader.razor.cs (4)

1-1: LGTM!

The added using directive is necessary for the new routing functionality.

---

30-30: LGTM!

The event subscription is properly placed in OnInitAsync and aligns with fixing the return-url issue.

---

42-47: LGTM! Well-documented solution.

The event handler correctly updates the component state when routes change, ensuring sign-in/sign-up button hrefs remain current. The comments effectively explain the purpose of this change.

---

67-67: LGTM! Proper cleanup.

The event unsubscription is correctly implemented in DisposeAsync to prevent memory leaks.

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

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.