Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented May 30, 2025

Link issues

fixes #6118

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

Integrate a global ErrorLogger component into the Layout and root components to capture unhandled exceptions, display configurable toasts, and allow custom handling callbacks.

New Features:

  • Add EnableErrorLogger, ShowErrorLoggerToast, ErrorLoggerToastTitle, and OnErrorHandleAsync parameters to Layout for configuring global exception handling
  • Wrap Layout and BootstrapBlazorRoot content in an ErrorLogger component to automatically catch and report errors

Enhancements:

  • Inject IOptionsMonitor to use configuration defaults for error logging settings

@bb-auto bb-auto bot added the enhancement New feature or request label May 30, 2025
@bb-auto bb-auto bot added this to the 9.7.0 milestone May 30, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 30, 2025

Reviewer's Guide

Integrates a global ErrorLogger into the main layout and root components by adding configuration parameters, injecting options, and wrapping content in an ErrorLogger component to capture and display exceptions.

Sequence Diagram for Global Exception Handling

sequenceDiagram
    participant C as Component
    participant EL as ErrorLogger
    participant OHEA as OnErrorHandleAsync (optional)
    participant TS as ToastService (optional)

    Note over C, EL: Content rendering within Layout/BootstrapBlazorRoot
    C ->> C: Operation leads to exception
    activate C
    C --x EL: Exception Occurs
    deactivate C
    activate EL
    EL ->> EL: Catches Exception
    alt Custom Error Handling
        EL ->> OHEA: OnErrorHandleAsync(logger, exception)
        activate OHEA
        OHEA -->> EL: Returns
        deactivate OHEA
    end
    alt Show Toast (if _showToast is true)
        EL ->> TS: DisplayErrorToast(ErrorLoggerToastTitle)
        activate TS
        TS -->> EL: Toast Displayed
        deactivate TS
    end
    deactivate EL
Loading

File-Level Changes

Change Details Files
Add error logging parameters and option injection to Layout code-behind
  • Introduce nullable EnableErrorLogger, ShowErrorLoggerToast, ErrorLoggerToastTitle and OnErrorHandleAsync parameters
  • Inject IOptionsMonitor to read default settings
  • Compute private flags (_enableErrorLoggerValue, _showToast) from parameters or options
  • Import Microsoft.Extensions.Logging for ILogger support
src/BootstrapBlazor/Components/Layout/Layout.razor.cs
Wrap layout content in ErrorLogger component in Layout.razor
  • Replace direct @HandlerMain() call with wrapper
  • Bind EnableErrorLogger, ShowToast, ToastTitle and OnErrorHandleAsync to the ErrorLogger component
src/BootstrapBlazor/Components/Layout/Layout.razor
Wrap root component content in ErrorLogger in BootstrapBlazorRoot.razor
  • Enclose @ChildContent and Dialog elements within wrapper
  • Pass the same error logger parameters and callback to the ErrorLogger component
src/BootstrapBlazor/Components/BaseComponents/BootstrapBlazorRoot.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#6118 Integrate an ErrorLogger handler for global exception handling.

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

@codecov
Copy link

codecov bot commented May 30, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (c06050c) to head (53bc77f).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6119   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          703       703           
  Lines        31024     31048   +24     
  Branches      4387      4391    +4     
=========================================
+ Hits         31024     31048   +24     

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

sourcery-ai[bot]
sourcery-ai bot previously approved these changes May 30, 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.

@ArgoZhang ArgoZhang merged commit b80e875 into main May 30, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-layout branch May 30, 2025 04:27
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(Layout): integrated ErrorLogger handler global exception

2 participants