feat(ErrorLogger): check EnableErrorLogger parameter #7483
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR updates the ErrorLogger component so that it conditionally provides the error-logging cascading context only when error logging is enabled, and tightens logging behavior in the BootstrapBlazorErrorBoundary to only log when ILogger is enabled for error level. Sequence diagram for conditional error logging and renderingsequenceDiagram
actor User
participant ErrorLogger
participant CascadingValue_IErrorLogger_ as CascadingValue_IErrorLogger
participant ChildComponent
participant BootstrapBlazorErrorBoundary as ErrorBoundary
participant ILogger as Logger
User->>ErrorLogger: Render
activate ErrorLogger
alt EnableErrorLogger is true
ErrorLogger->>CascadingValue_IErrorLogger: Provide IErrorLogger context
CascadingValue_IErrorLogger->>ErrorBoundary: RenderError (wrap ChildContent)
activate ErrorBoundary
User->>ChildComponent: Interact (may cause exception)
ChildComponent-->>ErrorBoundary: Exception thrown
ErrorBoundary->>ErrorBoundary: OnErrorAsync(exception)
alt EnableILogger and Logger.IsEnabled(Error)
ErrorBoundary->>Logger: LogError(exception, uri)
else logging disabled
ErrorBoundary-->>Logger: No call
end
deactivate ErrorBoundary
else EnableErrorLogger is false
ErrorLogger->>ChildComponent: Render ChildContent directly
User->>ChildComponent: Interact (exceptions not logged here)
end
deactivate ErrorLogger
Class diagram for updated ErrorLogger and BootstrapBlazorErrorBoundary behaviorclassDiagram
class IErrorLogger
class ErrorLogger {
bool EnableErrorLogger
RenderFragment ChildContent
RenderFragment ErrorContent
bool EnableILogger
BootstrapBlazorErrorBoundary _errorBoundary
+BuildRenderTree(RenderTreeBuilder builder) void
-RenderError RenderFragment
}
class CascadingValue_IErrorLogger_ {
IErrorLogger Value
bool IsFixed
RenderFragment ChildContent
}
class BootstrapBlazorErrorBoundary {
bool EnableILogger
ILogger Logger
NavigationManager NavigationManager
RenderFragment ErrorContent
RenderFragment ChildContent
+OnErrorAsync(Exception exception) Task
}
ErrorLogger ..|> IErrorLogger
ErrorLogger --> CascadingValue_IErrorLogger_ : wraps
ErrorLogger --> BootstrapBlazorErrorBoundary : creates
BootstrapBlazorErrorBoundary --> ILogger : uses
BootstrapBlazorErrorBoundary --> NavigationManager : uses
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #7483 +/- ##
===========================================
- Coverage 100.00% 99.98% -0.02%
===========================================
Files 749 749
Lines 32936 32941 +5
Branches 4576 4576
===========================================
+ Hits 32936 32937 +1
- Misses 0 3 +3
- Partials 0 1 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the ErrorLogger component to properly respect the EnableErrorLogger parameter by conditionally rendering the error handling infrastructure only when enabled, and adds a performance optimization to check log level before logging.
- Refactored
BuildRenderTreeto conditionally render error handling based onEnableErrorLogger - Fixed component reference capture index from 5 to 7 (correcting a bug)
- Added
Logger.IsEnabled(LogLevel.Error)check before logging for performance optimization
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/BootstrapBlazor/Components/ErrorLogger/ErrorLogger.cs | Refactored BuildRenderTree to check EnableErrorLogger and conditionally wrap content in CascadingValue with error boundary; removed RenderContent property; fixed component reference capture index |
| src/BootstrapBlazor/Components/ErrorLogger/BootstrapBlazorErrorBoundary.cs | Added Logger.IsEnabled check before logging to avoid unnecessary logging overhead |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+104
to
+115
| if (EnableErrorLogger) | ||
| { | ||
| builder.OpenComponent<CascadingValue<IErrorLogger>>(0); | ||
| builder.AddAttribute(1, nameof(CascadingValue<>.Value), this); | ||
| builder.AddAttribute(2, nameof(CascadingValue<>.IsFixed), true); | ||
| builder.AddAttribute(3, nameof(CascadingValue<>.ChildContent), RenderError); | ||
| builder.CloseComponent(); | ||
| } | ||
| else | ||
| { | ||
| builder.AddContent(10, ChildContent); | ||
| } |
There was a problem hiding this comment.
The refactored BuildRenderTree method introduces new conditional logic where EnableErrorLogger false directly renders ChildContent without the CascadingValue wrapper. However, there are no tests in ErrorLoggerTest.cs that verify this specific behavior. Consider adding a test that verifies when EnableErrorLogger is false, the CascadingValue is not created and ChildContent is rendered directly.
Comment on lines
+104
to
+115
| if (EnableErrorLogger) | ||
| { | ||
| builder.OpenComponent<CascadingValue<IErrorLogger>>(0); | ||
| builder.AddAttribute(1, nameof(CascadingValue<>.Value), this); | ||
| builder.AddAttribute(2, nameof(CascadingValue<>.IsFixed), true); | ||
| builder.AddAttribute(3, nameof(CascadingValue<>.ChildContent), RenderError); | ||
| builder.CloseComponent(); | ||
| } | ||
| else | ||
| { | ||
| builder.AddContent(10, ChildContent); | ||
| } |
There was a problem hiding this comment.
When EnableErrorLogger is false, the _errorBoundary field will not be initialized (remains null). While the current call site in BootstrapComponentBase checks EnableErrorLogger before calling HandlerExceptionAsync (line 136), the method itself is public and part of the IErrorLogger interface. Consider adding a null check or EnableErrorLogger guard within HandlerExceptionAsync to make it safer for direct calls and prevent potential NullReferenceException if the method is called when EnableErrorLogger is false.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Link issues
fixes #7482
Summary By Copilot
Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Gate the ErrorLogger cascading component and error boundary rendering on the EnableErrorLogger flag and tighten error logging conditions.
Bug Fixes:
Enhancements: