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

refactor(CacheManager): add cache by type #5152

Merged
merged 3 commits into from
Jan 18, 2025
Merged

refactor(CacheManager): add cache by type #5152

merged 3 commits into from
Jan 18, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Jan 18, 2025

add cache by type

Summary of the changes (Less than 80 chars)

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

Description

fixes #5151

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

Add caching for localized strings by type.

Bug Fixes:

  • Fixes an issue where localized strings were not being cached correctly.

Enhancements:

  • Improved performance of string localization by implementing caching by type.

Copy link

sourcery-ai bot commented Jan 18, 2025

Reviewer's Guide by Sourcery

This pull request refactors the JsonStringLocalizer to add a cache by type to improve performance. It also fixes a bug where missing resources were not being cached correctly.

Sequence diagram for string localization process

sequenceDiagram
    participant Client
    participant JsonStringLocalizer
    participant Service
    participant Cache
    participant Json

    Client->>JsonStringLocalizer: Get localized string
    JsonStringLocalizer->>Service: GetStringFromService(name)
    Service->>Cache: Check _missingManifestCache
    alt Not in cache
        Service->>Service: Get localized value
        Service-->>JsonStringLocalizer: Return value if found
        Service->>Cache: Cache missing resource
    end
    alt String not found in service
        JsonStringLocalizer->>Json: GetStringSafelyFromJson(name)
        Json->>Cache: Check _missingManifestCache
        alt Not in cache
            Json->>Json: Find in localizerStrings
            Json-->>JsonStringLocalizer: Return value if found
            Json->>Cache: Cache missing resource
        end
    end
    JsonStringLocalizer-->>Client: Return localized string
Loading

Class diagram for JsonStringLocalizer changes

classDiagram
    class JsonStringLocalizer {
        -ConcurrentDictionary~string,object~ _missingManifestCache
        -List~LocalizedString~ _allLocalizerdStrings
        +LocalizedString this[string name]
        -string GetStringSafely(string name)
        -string GetStringFromService(string name)
        -string GetStringSafelyFromJson(string name)
        -List~LocalizedString~ MegerResolveLocalizers(IEnumerable~LocalizedString~ localizerStrings)
        -string GetValueFromCache(List~LocalizedString~ localizerStrings, string name)
        -void HandleMissingResourceItem(string name)
    }
    note for JsonStringLocalizer "Changed from HashSet to ConcurrentDictionary
for thread-safe caching"
Loading

File-Level Changes

Change Details Files
Refactor GetStringSafely method to improve readability and performance.
  • The GetStringSafely method was refactored to improve readability.
  • The logic for getting strings from the service and JSON files was separated into different methods.
  • The GetStringFromService method was added to get strings from the injected service.
  • The GetStringSafelyFromJson method was added to get strings from the JSON localization file.
src/BootstrapBlazor/Localization/Json/JsonStringLocalizer.cs
Implement a cache for missing resources to avoid repeated lookups.
  • A ConcurrentDictionary named _missingManifestCache was added to cache missing resources.
  • The HandleMissingResourceItem method was updated to add missing resources to the _missingManifestCache.
  • The GetStringFromService and GetValueFromCache methods were updated to check the _missingManifestCache before attempting to get a resource.
src/BootstrapBlazor/Localization/Json/JsonStringLocalizer.cs
Remove unused _missingLocalizerCache field.
  • The _missingLocalizerCache field was removed as it is no longer used.
src/BootstrapBlazor/Localization/Json/JsonStringLocalizer.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5151 Add cache by type for localization

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 Jan 18, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 18, 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 @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider using a struct or tuple as cache key instead of string concatenation to improve performance. The current approach of $"name={name}&culture={CultureInfo.CurrentUICulture.Name}" creates unnecessary string allocations.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟢 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 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (554b715) to head (7302993).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5152   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          635       635           
  Lines        28195     28187    -8     
  Branches      4039      4039           
=========================================
- Hits         28195     28187    -8     

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

@ArgoZhang ArgoZhang merged commit d0dd670 into main Jan 18, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the test-web branch January 18, 2025 06:57
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.

refactor(CacheManager): add cache by type
1 participant