feat(ErrorLogger): redesign ErrorLogger component

[ArgoZhang]

redesign ErrorLogger component

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符；如果有关联 Issue 请在下方填写相关编号

Description

fixes #4575

Regression?

• Yes
• No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

• High
• Medium
• Low

[Justify the selection above]

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

Redesign the ErrorLogger component to enhance its functionality and introduce the BootstrapBlazorErrorBoundary component for improved exception handling.

New Features:

• Introduce a new BootstrapBlazorErrorBoundary component for handling exceptions with customizable error handling and toast notifications.

Enhancements:

• Redesign the ErrorLogger component to improve its structure and functionality, including the addition of a parameter to enable or disable global exception logging.

Tests:

• Add new tests for the ErrorLogger component to verify the handling of error content and exception rendering.

[sourcery-ai]

Reviewer's Guide by Sourcery

The PR redesigns the ErrorLogger component by introducing a new parameter to control global exception capturing and refactoring the error handling logic. The changes simplify the component's inheritance structure and improve its exception handling capabilities by delegating the core functionality to a new BootstrapBlazorErrorBoundary component.

Sequence diagram for error handling in ErrorLogger

sequenceDiagram
    participant User
    participant ErrorLogger
    participant BootstrapBlazorErrorBoundary
    participant Logger
    participant ToastService
    User->>ErrorLogger: Trigger error
    ErrorLogger->>BootstrapBlazorErrorBoundary: RenderException(exception)
    BootstrapBlazorErrorBoundary->>Logger: LogError(exception)
    alt ShowToast is true
        BootstrapBlazorErrorBoundary->>ToastService: Show error toast
    end
    BootstrapBlazorErrorBoundary->>ErrorLogger: Update state
    ErrorLogger->>User: Display error content

Loading

Class diagram for redesigned ErrorLogger component

classDiagram
    class ErrorLogger {
        +bool EnableErrorLogger
        +Func<ILogger, Exception, Task> OnErrorHandleAsync
        +RenderFragment ChildContent
        +RenderFragment<Exception> ErrorContent
        +Task HandlerExceptionAsync(Exception exception)
        +void Register(IHandlerException component)
        +void UnRegister(IHandlerException component)
    }
    class BootstrapBlazorErrorBoundary {
        +Func<ILogger, Exception, Task> OnErrorHandleAsync
        +bool ShowToast
        +string ToastTitle
        +Task RenderException(Exception exception, IHandlerException? handler)
    }
    ErrorLogger --> BootstrapBlazorErrorBoundary : uses
    IErrorLogger <|.. ErrorLogger
    IHandlerException <|.. BootstrapBlazorErrorBoundary

Loading

File-Level Changes

Change	Details	Files
Introduced a new parameter to control global exception capturing	Added EnableErrorLogger parameter with default value of true Updated IErrorLogger interface to include the new EnableErrorLogger property Modified error handling logic to respect the EnableErrorLogger setting	src/BootstrapBlazor/Components/ErrorLogger/ErrorLogger.cs src/BootstrapBlazor/Components/ErrorLogger/IErrorLogger.cs
Created a new error boundary component to handle core exception functionality	Implemented new BootstrapBlazorErrorBoundary class inheriting from ErrorBoundaryBase Added exception rendering and toast notification capabilities Implemented custom error content template support	src/BootstrapBlazor/Components/ErrorLogger/BootstrapBlazorErrorBoundary.cs
Simplified ErrorLogger component structure	Removed direct inheritance from ErrorBoundaryBase Delegated error handling to BootstrapBlazorErrorBoundary Updated component registration to use IHandlerException interface	src/BootstrapBlazor/Components/ErrorLogger/ErrorLogger.cs
Restructured BootstrapBlazorRoot component	Simplified component rendering logic Moved component initialization into the template Improved component organization and hierarchy	src/BootstrapBlazor/Components/BaseComponents/BootstrapBlazorRoot.razor src/BootstrapBlazor/Components/BaseComponents/BootstrapBlazorRoot.razor.cs

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#4575	Redesign the ErrorLogger component to improve its architecture and functionality	✅

Possibly linked issues

• feat(ErrorLogger): redesign ErrorLogger component #4575: The PR implements the redesign of the ErrorLogger component as described in the issue.

---

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.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a 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. You can also use
  this command to specify where the summary should be inserted.

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[ArgoZhang]

@sourcery-ai review

[sourcery-ai]

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

Here's what I looked at during the review

• 🟡 General issues: 2 issues found
• 🟢 Security: all looks good
• 🟡 Testing: 1 issue found
• 🟡 Complexity: 1 issue found
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (99090e3) to head (e6e2407).
Report is 3 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main     #4576   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          622       622           
  Lines        26933     26856   -77     
  Branches      3923      3919    -4     
=========================================
- Hits         26933     26856   -77     

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