Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 17, 2025

reduce cache key count

Summary of the changes (Less than 80 chars)

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

Description

fixes #5139

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

Enhancements:

  • Improve performance of localized string loading by reducing cache key count.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 17, 2025

Reviewer's Guide by Sourcery

This PR reduces the number of cache keys used by the CacheManager by consolidating the cached localized strings into a single key.

Sequence diagram for optimized cache key management in GetJsonStringByTypeName

sequenceDiagram
    participant Client
    participant CacheManager
    participant Cache

    Client->>CacheManager: GetJsonStringByTypeName(assembly, typeName, cultureName, forceLoad)

    Note over CacheManager: Generate single cache key

    alt forceLoad is true
        CacheManager->>Cache: Remove(key)
    end

    critical Lock assembly
        CacheManager->>Cache: GetOrCreate(key)
        Cache-->>CacheManager: cached sections

        Note over CacheManager: Filter items by typeName
    end

    CacheManager-->>Client: filtered localized items
Loading

Class diagram showing CacheManager changes

classDiagram
    class CacheManager {
        -IMemoryCache Cache
        +GetJsonStringByTypeName(Assembly assembly, string typeName, string cultureName, bool forceLoad)
    }

    class LocalizedString {
        +string Key
        +string Value
        +bool ResourceNotFound
        +string SearchedLocation
    }

    CacheManager ..> LocalizedString : creates

    note for CacheManager "Changed to use single cache key
per assembly-culture pair"
Loading

File-Level Changes

Change Details Files
Consolidated cached localized strings into a single cache key.
  • Removed the typeKey variable, which was previously used to store localized strings for each type separately.
  • Added a lock on the assembly to prevent race conditions when accessing the cache.
  • Modified the caching logic to store all localized strings for an assembly under a single key.
  • Added logic to filter localized strings by type name after retrieving them from the cache.
  • Updated the return type of the GetJsonStringByTypeName method to IEnumerable<LocalizedString> to reflect the change in caching logic.
  • Removed the use of ToFrozenSet and ToHashSet methods, as the returned collection is now filtered and no longer needs to be converted to a set.
src/BootstrapBlazor/Services/CacheManager.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5139 Reduce the number of cache keys used in the CacheManager

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 17, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 17, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jan 17, 2025
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:

  • Since this is a performance-focused change, please provide some metrics showing the reduction in cache key count and memory usage in a typical application scenario.
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 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (7f19440) to head (d02bd4c).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5140   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          634       634           
  Lines        28181     28190    +9     
  Branches      4040      4038    -2     
=========================================
+ Hits         28181     28190    +9     

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

@ArgoZhang
Copy link
Member Author

@sourcery-ai review

@ArgoZhang ArgoZhang merged commit 809149f into main Jan 17, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-cache branch January 17, 2025 13:59
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.

perf(CacheManager): reduce cache key count

2 participants