perf(ErrorLog): improving the error handling logic

[ArgoZhang]

Link issues

fixes #5599

Summary By Copilot

This pull request includes several changes to the error handling and logging functionality in the BootstrapBlazor components. The key changes involve improving the error handling logic, adding nullability annotations, and enhancing unit tests.

Error Handling Improvements:

• src/BootstrapBlazor/Components/ErrorLogger/BootstrapBlazorErrorBoundary.cs: Modified OnErrorAsync and RenderException methods to include early returns after handling exceptions, simplifying the control flow. [1] [2]

Code Quality Enhancements:

• src/BootstrapBlazor/Components/ErrorLogger/ErrorLogger.cs: Added [NotNull] annotation to _errorBoundary to ensure it is not null, improving code safety and readability.

Unit Test Enhancements:

• test/UnitTest/Components/ErrorHandlerTest.cs: Added a new test case ShowToast_Ok to verify the toast notification functionality for error logging, enhancing test coverage.

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

Improves error handling and logging within the BootstrapBlazor components by simplifying control flow, enhancing code safety with nullability annotations, and increasing test coverage.

Tests:

• Adds a new test case to verify the toast notification functionality for error logging, enhancing test coverage.
• Adds a test to verify that the toast is not shown when ShowToast is false in ErrorHandlerTest.cs

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request improves error handling and logging within the BootstrapBlazor components. It introduces early returns in error handling methods, enhances code quality with nullability annotations, and improves test coverage for toast notifications.

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

File-Level Changes

Change	Details	Files
Modified OnErrorAsync and RenderException methods to include early returns after handling exceptions, simplifying the control flow.	Added return statements after handling exceptions in OnErrorAsync to prevent further execution. Added return statements after handling exceptions in RenderException to prevent further execution.	src/BootstrapBlazor/Components/ErrorLogger/BootstrapBlazorErrorBoundary.cs
Added [NotNull] annotation to _errorBoundary to ensure it is not null, improving code safety and readability.	Added the [NotNull] attribute to the _errorBoundary field.	src/BootstrapBlazor/Components/ErrorLogger/ErrorLogger.cs
Added a new test case ShowToast_Ok to verify the toast notification functionality for error logging, enhancing test coverage.	Created a new test method ShowToast_Ok. Verified that a toast notification is displayed when an error is logged. Verified that the toast notification is closed correctly. Added a test case to verify that no toast notification is displayed when ShowToast is set to false.	test/UnitTest/Components/ErrorHandlerTest.cs

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#5599	Improve the performance of the ErrorLogger component.	✅

Possibly linked issues

• perf(ErrorLogger): improving the error handling logic #5599: The PR fixes the issue by improving error handling, preventing crashes caused by invalid JSON.

---

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!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

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

Overall Comments:

• Consider extracting the common logic in OnErrorAsync to a separate method to reduce duplication.
• The early returns in OnErrorAsync and RenderException improve readability.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟡 Testing: 3 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 ✨

• 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 (58f8ea8) to head (ce3009d).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main     #5600   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          649       649           
  Lines        29629     29625    -4     
  Branches      4165      4165           
=========================================
- Hits         29629     29625    -4     

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