Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jun 2, 2025

Link issues

fixes #6131

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

Redesign error-logging parameters to support nullable values and fallback to global configuration settings

Enhancements:

  • Change EnableErrorLogger and ShowToast properties to nullable bool and update IErrorLogger accordingly
  • Inject and use IOptionsMonitor in ErrorLogger to derive actual behavior when parameters are null
  • Update RenderContent and RenderError builder logic to use computed fallback values
  • Refactor Layout component to pass parameters directly to ErrorLogger without computing defaults
  • Adjust unit tests to set EnableErrorLogger on nested Layout component

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jun 2, 2025

Reviewer's Guide

This PR refactors the ErrorLogger feature to use nullable parameters with fallback to global configuration, simplifies the Layout component by removing duplicate option injections, and updates related interface definitions and tests accordingly.

Sequence Diagram: ErrorLogger Option Resolution Logic

sequenceDiagram
    participant EL as ErrorLogger
    participant OptsMon as "IOptionsMonitor<BootstrapBlazorOptions>"
    participant OptsVal as "BootstrapBlazorOptions.CurrentValue"

    EL->>EL: Read local EnableErrorLogger (bool?)
    alt local EnableErrorLogger is not null
        EL->>EL: Set _enableErrorLogger = local value
    else local EnableErrorLogger is null
        EL->>OptsMon: Get CurrentValue
        OptsMon-->>OptsVal: options instance
        EL->>OptsVal: Read EnableErrorLogger property
        OptsVal-->>EL: globalEnableErrorLogger (bool)
        EL->>EL: Set _enableErrorLogger = global value
    end

    EL->>EL: Read local ShowToast (bool?)
    alt local ShowToast is not null
        EL->>EL: Set _showToast = local value
    else local ShowToast is null
        EL->>OptsMon: Get CurrentValue
        OptsMon-->>OptsVal: options instance
        EL->>OptsVal: Read ShowErrorLoggerToast property
        OptsVal-->>EL: globalShowToast (bool)
        EL->>EL: Set _showToast = global value
    end
Loading

File-Level Changes

Change Details Files
IErrorLogger interface updated to use nullable parameters
  • Changed EnableErrorLogger from bool to bool?
  • Changed ShowToast from bool to bool?
  • Updated XML comments to reference global BootstrapBlazorOptions
src/BootstrapBlazor/Components/ErrorLogger/IErrorLogger.cs
ErrorLogger component now falls back to global options
  • Converted EnableErrorLogger and ShowToast parameters to nullable bool
  • Injected IOptionsMonitor
  • Added private _enableErrorLogger and _showToast properties for fallback
  • Updated RenderContent and RenderError to use fallback values
src/BootstrapBlazor/Components/ErrorLogger/ErrorLogger.cs
Layout component cleanup and parameter forwarding
  • Removed IOptionsMonitor injection and local fallback properties
  • Updated Layout.razor to pass EnableErrorLogger and ShowErrorLoggerToast directly to ErrorLogger
src/BootstrapBlazor/Components/Layout/Layout.razor.cs
src/BootstrapBlazor/Components/Layout/Layout.razor
Unit tests adjusted for new parameter behavior
  • Added explicit EnableErrorLogger override in LayoutTest
test/UnitTest/Components/LayoutTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6131 Redesign the data type of the EnableErrorLogger parameter in the IErrorLogger interface to allow for nullable boolean values.
#6131 Redesign the data type of the ShowToast parameter in the IErrorLogger interface to allow for nullable boolean values.

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 the enhancement New feature or request label Jun 2, 2025
@bb-auto bb-auto bot added this to the 9.7.0 milestone Jun 2, 2025
@ArgoZhang ArgoZhang merged commit f81d400 into main Jun 2, 2025
3 checks passed
@ArgoZhang ArgoZhang deleted the feat-errorlogger branch June 2, 2025 08:58
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: 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.

Comment on lines +65 to +67
[Inject]
[NotNull]
private IOptionsMonitor<BootstrapBlazorOptions>? Options { get; set; }
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion: Consider making the injected Options property non-nullable

You can remove the '?' from IOptionsMonitor since [NotNull] ensures it won't be null.

Suggested change
[Inject]
[NotNull]
private IOptionsMonitor<BootstrapBlazorOptions>? Options { get; set; }
[Inject]
[NotNull]
private IOptionsMonitor<BootstrapBlazorOptions> Options { get; set; }

@codecov
Copy link

codecov bot commented Jun 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (6f83053) to head (eab8ef5).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6132   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          703       703           
  Lines        31073     31073           
  Branches      4397      4397           
=========================================
  Hits         31073     31073           

☔ 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(IErrorLogger): redesign parameter data type

2 participants