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

fix(CacheManager): GetJsonStringByTypeName prevent throw ArgumentNull exception #5106

Merged

Conversation

densen2014
Copy link
Member

@densen2014 densen2014 commented Jan 13, 2025

CacheManager GetLocalizedString Key.Value Null

CacheManager GetLocalizedString Key.Value Null

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

Description

fixes #5103

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

Bug Fixes:

  • Fix a bug where CacheManager.GetLocalizedString returned null values when the resource value was not found.

Copy link

bb-auto bot commented Jan 13, 2025

Thanks for your PR, @densen2014. Someone from the team will get assigned to your PR shortly and we'll get it reviewed.

@bb-auto bb-auto bot requested a review from ArgoZhang January 13, 2025 12:45
@bb-auto bb-auto bot added the bug Something isn't working label Jan 13, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 13, 2025
Copy link

sourcery-ai bot commented Jan 13, 2025

Reviewer's Guide by Sourcery

This pull request fixes a bug in the CacheManager.GetLocalizedString method where the Value property of the LocalizedString object could be null. The fix ensures that if the value is null, the key is used instead.

Class diagram showing LocalizedString handling in CacheManager

classDiagram
    class CacheManager {
        -JsonLocalizationOptions GetJsonLocalizationOption()
        +GetLocalizedString(string key)
    }
    class LocalizedString {
        +string Key
        +string Value
        +bool ResourceNotFound
        +string SearchedLocation
    }
    note for LocalizedString "Value now falls back to Key if null"
    CacheManager ..> LocalizedString : creates
Loading

File-Level Changes

Change Details Files
Handle null values in LocalizedString
  • Use the key as the value if the value is null in the LocalizedString constructor.
  • Added a null check for the kv.Value in the SelectMany lambda expression.
  • Updated the logic to fallback to the key if the value is null, ensuring a non-null value for the localized string
src/BootstrapBlazor/Services/CacheManager.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5103 Handle potential JSON parsing errors when loading localization files
#5103 Prevent system crash when a localization file has formatting issues
#5103 Implement a fallback mechanism for invalid or missing localization 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.
  • 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

sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jan 13, 2025
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 @densen2014 - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 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.

Copy link

codecov bot commented Jan 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (6a85589) to head (d942d6d).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5106   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          634       634           
  Lines        28159     28165    +6     
  Branches      4039      4040    +1     
=========================================
+ Hits         28159     28165    +6     

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

@ArgoZhang ArgoZhang changed the title fix CacheManager GetLocalizedString Key.Value Null fix(CacheManager): GetJsonStringByTypeName prevent throw ArgumentNull exception Jan 15, 2025
@ArgoZhang ArgoZhang merged commit 5960d5c into main Jan 15, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the alex/fix#5103CacheManagerGetLocalizedStringKeyValueNull branch January 15, 2025 03:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bug(Locales): 切换多语言,json格式异常,某些条件下会崩溃
2 participants