Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(IErrorLogger): support DetailedErrors config #4579

Merged
merged 6 commits into from
Oct 30, 2024
Merged

feat(IErrorLogger): support DetailedErrors config #4579

merged 6 commits into from
Oct 30, 2024

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Oct 30, 2024

support DetailedErrors config

Summary of the changes (Less than 80 chars)

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

Description

fixes #4578

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

Introduce support for a DetailedErrors configuration option in the error logging system, allowing users to control the level of detail shown in error messages. Refactor error handling to accommodate this new feature and update documentation accordingly. Add a unit test to ensure the correct behavior of the DetailedErrors setting.

New Features:

  • Add support for DetailedErrors configuration in the error logging system, allowing for more granular control over error detail visibility.

Enhancements:

  • Refactor error handling logic to utilize a new method for rendering error content based on the DetailedErrors configuration.

Documentation:

  • Update user-facing documentation to include information about the new DetailedErrors configuration option.

Tests:

  • Add a new unit test to verify the behavior of the DetailedErrors configuration when set to false.

Copy link

sourcery-ai bot commented Oct 30, 2024

Reviewer's Guide by Sourcery

This PR implements support for the DetailedErrors configuration in the error logging system. The implementation adds the ability to control the level of error details shown to users based on a configuration setting, along with improvements to error handling in dialogs and UI components.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added DetailedErrors configuration support to control error detail visibility
  • Added configuration-based toggle for detailed error information
  • Implemented error message fallback to show only Exception.Message when detailed errors are disabled
  • Added caching of DetailedErrors configuration value for performance
src/BootstrapBlazor/Components/ErrorLogger/BootstrapBlazorErrorBoundary.cs
Enhanced error handling test coverage
  • Added test case for DetailedErrors=false scenario
  • Added configuration injection in test setup
  • Implemented division by zero test case
test/UnitTest/Components/ErrorLoggerTest.cs
Improved error handling in dialog components
  • Added new dialog-based error demonstration component
  • Added localization support for dialog error messages
  • Implemented error handling within dialog context
src/BootstrapBlazor.Server/Components/Samples/GlobalException.razor
src/BootstrapBlazor.Server/Components/Samples/GlobalException.razor.cs
src/BootstrapBlazor.Server/Components/Components/MockError.razor
Updated error logger component implementation
  • Simplified HandlerExceptionAsync method
  • Fixed exception handling state management
  • Added standard Blazor error UI component
src/BootstrapBlazor/Components/ErrorLogger/ErrorLogger.cs
src/BootstrapBlazor.Server/Components/Layout/BaseLayout.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#4578 Support DetailedErrors configuration to control error detail display

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

@bb-auto bb-auto bot added the enhancement New feature or request label Oct 30, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Oct 30, 2024
Copy link

@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 - here's some feedback:

Overall Comments:

  • Consider making the DetailedErrors configuration check dynamic rather than caching it in _errorDetails, in case the configuration needs to change at runtime.
Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟡 Testing: 2 issues found
  • 🟢 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 enabled auto-merge (squash) October 30, 2024 13:10
Copy link

codecov bot commented Oct 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (2fb6b5e) to head (8832039).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4579   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          622       622           
  Lines        26856     26858    +2     
  Branches      3919      3920    +1     
=========================================
+ Hits         26856     26858    +2     

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

@ArgoZhang ArgoZhang merged commit 40bea27 into main Oct 30, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the doc-error branch October 30, 2024 13:10
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): support DetailedErrors config
1 participant