Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jun 17, 2025

Link issues

fixes #6245

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

Introduce a configurable flag to enable or disable the built-in error logging behavior, expose it through component parameters and global options, and update the layout and tests accordingly

New Features:

  • Add EnableILogger parameter to ErrorLogger and BootstrapBlazorErrorBoundary to toggle ILogger usage
  • Add EnableErrorLoggerILogger option and corresponding Layout parameter to control error logging at the application level

Bug Fixes:

  • Correct ILogger injection generic type in BootstrapBlazorErrorBoundary

Tests:

  • Extend Layout unit test to cover the new EnableErrorLoggerILogger parameter

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

sourcery-ai bot commented Jun 17, 2025

Reviewer's Guide

Adds a configurable ILogger toggle to the error-logging components and exposes it through layout and global options, updating the render trees, dependency injection, and tests accordingly.

Class diagram for updated error logging components

classDiagram
    class IErrorLogger {
        +bool ShowToast
        +bool EnableILogger
        +string ToastTitle
        +RenderFragment ErrorContent
        +RenderFragment ChildContent
        +Func<Exception, Task> OnErrorHandleAsync
        +Func<Task> OnInitializedCallback
    }
    class ErrorLogger {
        +bool ShowToast
        +bool EnableILogger
        +string ToastTitle
        +RenderFragment ErrorContent
        +RenderFragment ChildContent
        +Func<Exception, Task> OnErrorHandleAsync
        +Func<Task> OnInitializedCallback
    }
    class BootstrapBlazorErrorBoundary {
        +bool ShowToast
        +bool EnableILogger
        +string ToastTitle
        +RenderFragment ErrorContent
        +RenderFragment ChildContent
        +Task OnErrorAsync(Exception)
    }
    class Layout {
        +bool? ShowErrorLoggerToast
        +bool? EnableErrorLoggerILogger
        -bool _showToast
        -bool _enableILogger
    }
    class BootstrapBlazorOptions {
        +bool ShowErrorLoggerToast
        +bool EnableErrorLoggerILogger
    }
    ErrorLogger --|> IErrorLogger
    ErrorLogger o-- BootstrapBlazorErrorBoundary : uses
    Layout o-- ErrorLogger : uses
    Layout o-- BootstrapBlazorOptions : uses
    BootstrapBlazorErrorBoundary o-- ILogger : injects
Loading

File-Level Changes

Change Details Files
Support EnableILogger toggle in BootstrapBlazorErrorBoundary
  • Changed ILogger generic type to BootstrapBlazorErrorBoundary
  • Added EnableILogger parameter with default true
  • Wrapped Logger.LogError call in an EnableILogger conditional
src/BootstrapBlazor/Components/ErrorLogger/BootstrapBlazorErrorBoundary.cs
Propagate EnableILogger through ErrorLogger component
  • Added EnableILogger parameter
  • Passed EnableILogger into BootstrapBlazorErrorBoundary in BuildRenderTree
src/BootstrapBlazor/Components/ErrorLogger/ErrorLogger.cs
Update IErrorLogger interface with EnableILogger
  • Added EnableILogger property to interface
src/BootstrapBlazor/Components/ErrorLogger/IErrorLogger.cs
Expose global EnableErrorLoggerILogger setting and wire in Layout
  • Added EnableErrorLoggerILogger parameter to Layout
  • Derived internal _enableILogger from parameter or options
  • Updated Layout.razor to pass _enableILogger to ErrorLogger
  • Introduced EnableErrorLoggerILogger in BootstrapBlazorOptions with default true
src/BootstrapBlazor/Components/Layout/Layout.razor.cs
src/BootstrapBlazor/Components/Layout/Layout.razor
src/BootstrapBlazor/Options/BootstrapBlazorOptions.cs
Extend layout unit tests for ILogger toggle
  • Added test case disabling EnableErrorLoggerILogger
test/UnitTest/Components/LayoutTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6245 Allow users to disable the Logger.LogError call within the OnErrorAsync method of the ErrorLogger component to prevent specific exceptions from being logged.
#6245 Provide a configuration option to control the ILogger behavior from outside the ErrorLogger component, such as at the application level.

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 17, 2025
@ArgoZhang ArgoZhang merged commit b7e67a8 into main Jun 17, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the feat-errorlogger branch June 17, 2025 06:22
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!

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `src/BootstrapBlazor/Components/Layout/Layout.razor:129` </location>
<code_context>
         else
         {
             <ErrorLogger EnableErrorLogger="@_enableErrorLogger" ShowToast="@_showToast" ToastTitle="@ErrorLoggerToastTitle" 
-                         OnErrorHandleAsync="OnErrorHandleAsync" OnInitializedCallback="OnErrorLoggerInitialized">
+                         EnableILogger="@_enableILogger" OnErrorHandleAsync="OnErrorHandleAsync" OnInitializedCallback="OnErrorLoggerInitialized">
</code_context>

<issue_to_address>
Unrecognized ‘EnableErrorLogger’ attribute on ErrorLogger component

Remove the EnableErrorLogger attribute or replace it with EnableILogger to match the component's parameters.
</issue_to_address>

### Comment 2
<location> `src/BootstrapBlazor/Components/ErrorLogger/ErrorLogger.cs:121` </location>
<code_context>
         builder.AddAttribute(3, nameof(BootstrapBlazorErrorBoundary.ToastTitle), ToastTitle);
         builder.AddAttribute(4, nameof(BootstrapBlazorErrorBoundary.ErrorContent), ErrorContent);
         builder.AddAttribute(5, nameof(BootstrapBlazorErrorBoundary.ChildContent), ChildContent);
+        builder.AddAttribute(6, nameof(BootstrapBlazorErrorBoundary.EnableILogger), EnableILogger);
         builder.AddComponentReferenceCapture(5, obj => _errorBoundary = (BootstrapBlazorErrorBoundary)obj);
         builder.CloseComponent();
</code_context>

<issue_to_address>
RenderTreeBuilder sequence numbers are non-monotonic and duplicated

The AddComponentReferenceCapture should use a unique, higher sequence number (e.g., 7) to avoid conflicts with previous attributes.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
        builder.AddComponentReferenceCapture(5, obj => _errorBoundary = (BootstrapBlazorErrorBoundary)obj);
=======
        builder.AddComponentReferenceCapture(7, obj => _errorBoundary = (BootstrapBlazorErrorBoundary)obj);
>>>>>>> REPLACE

</suggested_fix>

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 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d97672f) to head (deaa04f).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6246   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          704       704           
  Lines        31121     31130    +9     
  Branches      4400      4402    +2     
=========================================
+ Hits         31121     31130    +9     
Flag Coverage Δ
BB 100.00% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

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(ErrorLogger): add EnableILogger parameter

2 participants