Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 28, 2025

reduce exception records

Summary of the changes (Less than 80 chars)

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

Description

fixes #5234

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

Update exception display and fix download error handling.

New Features:

  • Display SDK and BB versions in the footer.

Bug Fixes:

  • Handle generic exceptions during downloads to provide more informative error messages.

Enhancements:

  • Improve cache list value display by adding a scrollbar and limiting the maximum height.

@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Jan 28, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Jan 28, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 28, 2025

Reviewer's Guide by Sourcery

This pull request reduces the amount of exception information displayed to the user and improves the display of cached values.

Class diagram for exception handling changes

classDiagram
    class Downloads {
        -Task DownloadFolderAsync()
    }
    class DownloadService {
        +Task DownloadFolderAsync(string, string)
    }
    class ToastService {
        +Task Error(string, string)
    }
    Downloads --> DownloadService : uses
    Downloads --> ToastService : uses
    note for Downloads "Changed to catch all exceptions
instead of just FileNotFoundException"
Loading

File-Level Changes

Change Details Files
Updated the display of cached values in the CacheList component.
  • Added a max-height and overflow style to the table-cache-value class.
  • Added the table-cache-value CSS class to the TableTemplateColumn.
src/BootstrapBlazor.Server/Components/Pages/CacheList.razor.css
src/BootstrapBlazor.Server/Components/Pages/CacheList.razor
Reduced the amount of exception information displayed to the user.
  • Changed the catch block in DownloadFolderAsync to catch all exceptions instead of just FileNotFoundException.
  • Updated the .NET framework version in the GlobalException sample.
src/BootstrapBlazor.Server/Components/Samples/Downloads.razor.cs
src/BootstrapBlazor.Server/Components/Samples/GlobalException.razor
Removed redundant calls to GetDisplayName.
  • Removed the fallback to GetDisplayName when a display name is already present in CreateDisplayByFieldType.
  • Removed the fallback to GetDisplayName when a display name is already present in CreateComponentByFieldType.
src/BootstrapBlazor/Utils/Utility.cs
Updated the footer text in the HomeLayout component.
  • Changed 'Powered by .NET' to 'SDK .NET' in the footer.
src/BootstrapBlazor.Server/Components/Layout/HomeLayout.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#5234 Reduce exception records documentation

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

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

Overall Comments:

  • Consider keeping the specific FileNotFoundException catch block instead of using a general Exception catch. This helps with proper error handling and makes debugging easier by not masking specific exceptions.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟡 Security: 1 issue found
  • 🟢 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.

@codecov
Copy link

codecov bot commented Jan 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (cfcd597) to head (3e273d5).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5235   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          635       635           
  Lines        28248     28248           
  Branches      4068      4066    -2     
=========================================
  Hits         28248     28248           

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

@ArgoZhang ArgoZhang merged commit b6f47f0 into main Jan 28, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the refactor-code branch January 28, 2025 11:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc(Exception): reduce exception records

2 participants