Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jun 3, 2025

Link issues

fixes #6138

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Delegate exception handling in Tab items to the ErrorLogger component and provide a new extension to display exceptions in dialogs.

New Features:

  • Add DialogService.ShowExceptionDialog extension to display exception messages in a dialog
  • Enable TabItemContent to automatically catch and display child content exceptions via the ErrorLogger component

Enhancements:

  • Wrap TabItemContent in ErrorLogger according to Layout.EnableErrorLogger and Layout.ShowErrorLoggerToast settings
  • Refactor ErrorLogger to initialize default settings from Options and streamline its render logic
  • Remove obsolete IHandlerException implementation and related error handling methods from the Tab component

Tests:

  • Add unit tests for ShowExceptionDialog extension
  • Add tests to verify error display inside TabItemContent via ErrorLogger

@bb-auto bb-auto bot added the enhancement New feature or request label Jun 3, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jun 3, 2025

Reviewer's Guide

This PR enhances TabItem error handling by wrapping its content in ErrorLogger configured via the parent Layout, removes obsolete exception-handling code from the Tab component, refactors ErrorLogger for parameter-driven configuration, adds a new ShowExceptionDialog extension to DialogService, and updates unit tests to cover these exception scenarios.

Sequence Diagram for TabItem Error Handling with ErrorLogger

sequenceDiagram
    actor User
    participant TabItemContent
    participant ErrorLogger
    participant "BootstrapBlazorErrorBoundary" as BBEB

    User->>TabItemContent: Interact with Tab Content (causes error)
    TabItemContent->>ErrorLogger: Render Content (wrapped in ErrorLogger)
    activate ErrorLogger
    ErrorLogger->>BBEB: Render ChildContent (via BBEB)
    activate BBEB
    %% Exception occurs in ChildContent, BBEB catches it
    BBEB->>ErrorLogger: OnErrorHandleAsync(Exception)  // BBEB calls ErrorLogger's handler
    activate ErrorLogger
    %% ErrorLogger performs internal logic (e.g., logging)
    ErrorLogger-->>BBEB: Processing complete
    deactivate ErrorLogger

    alt if BBEB.ShowToast is true (configured by Layout via ErrorLogger)
        BBEB-->>User: Show Toast Notification
    end
    BBEB-->>User: Show Error UI (ErrorContent)
    deactivate BBEB
    ErrorLogger-->>TabItemContent: Return
    deactivate ErrorLogger
Loading

File-Level Changes

Change Details Files
Wrap TabItem content in ErrorLogger and pass layout-driven error logging settings
  • Introduce CascadingParameter Layout to TabItemContent
  • Wrap child content in ErrorLogger component
  • Bind EnableErrorLogger and ShowToast from Layout to ErrorLogger
src/BootstrapBlazor/Components/Tab/TabItemContent.cs
Remove IHandlerException implementation and related DialogService injection from Tab
  • Drop IHandlerException interface from Tab
  • Remove OnInitialized registration and Dispose unregistration for ErrorLogger
  • Eliminate DialogService injection and HandlerException method
src/BootstrapBlazor/Components/Tab/Tab.razor.cs
Refactor ErrorLogger to initialize parameters and use them in rendering
  • Initialize EnableErrorLogger and ShowToast from Options in OnInitialized
  • Update RenderContent logic to rely on EnableErrorLogger parameter
  • Forward ShowToast parameter to BootstrapBlazorErrorBoundary
src/BootstrapBlazor/Components/ErrorLogger/ErrorLogger.cs
Add ShowExceptionDialog extension to DialogService
  • Implement ShowExceptionDialog that wraps exception message in error dialog
  • Reuse ShowErrorHandlerDialog for consistent dialog behavior
src/BootstrapBlazor/Extensions/DialogServiceExtensions.cs
Extend unit tests to cover exception dialog and error logging behavior
  • Add tests for ShowExceptionDialog in DialogTest
  • Enhance ErrorLoggerTest to validate error-stack rendering
  • Adjust LayoutTest configuration for error logger settings
test/UnitTest/Components/DialogTest.cs
test/UnitTest/Components/ErrorLoggerTest.cs
test/UnitTest/Components/LayoutTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6138 Implement ErrorLogger to catch exceptions within TabItem.
#6138 Allow configuration of error logging and toast notifications via the parent Layout component.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added this to the 9.7.0 milestone Jun 3, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jun 3, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ArgoZhang - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented Jun 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (1f5e494) to head (9c08e4d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6139   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          703       703           
  Lines        31069     31084   +15     
  Branches      4397      4397           
=========================================
+ Hits         31069     31084   +15     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ArgoZhang
Copy link
Member Author

@sourcery-ai review

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ArgoZhang - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

  • Avoid using MarkupString with untrusted content (link)
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ArgoZhang ArgoZhang merged commit b63ed8a into main Jun 3, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-id branch June 3, 2025 06:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(TabItem): support ErrorLogger catch exception

2 participants