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

perf(CacheManager): remove lock improve performance #5154

Merged
merged 2 commits into from
Jan 19, 2025
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Jan 19, 2025

remove lock improve performance

Summary of the changes (Less than 80 chars)

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

Description

fixes #5153

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

Remove the lock from the CacheManager to improve performance.

Bug Fixes:

  • Fix an issue where the cache was not being updated correctly.

Enhancements:

  • Improve the performance of the CacheManager by removing the lock.

Copy link

sourcery-ai bot commented Jan 19, 2025

Reviewer's Guide by Sourcery

This pull request removes a lock from the CacheManager to improve performance. The lock was previously used to protect the cache from concurrent access, but it was determined that the cache is thread-safe and the lock is not necessary.

Sequence diagram showing simplified cache access flow after lock removal

sequenceDiagram
    participant Client
    participant CacheManager
    participant Cache

    Client->>CacheManager: GetAllStringsByTypeName(assembly, typeName)
    CacheManager->>Cache: GetOrCreate(key, valueFactory)
    Note right of Cache: No lock needed anymore
    Cache-->>CacheManager: Return localized items
    CacheManager-->>Client: Return filtered items
Loading

Class diagram showing CacheManager changes

classDiagram
    class CacheManager {
        -Cache Instance
        +GetAllStringsByTypeName(Assembly, string) IEnumerable~LocalizedString~
        +GetJsonStringByTypeName(JsonLocalizationOptions, Assembly, string, string) IEnumerable~LocalizedString~
    }
    note for CacheManager "Removed _locker field
Cache operations are now lockless"
Loading

File-Level Changes

Change Details Files
Removed the lock from the CacheManager.
  • Removed the _locker field.
  • Removed the lock statement when creating or getting items from the cache.
src/BootstrapBlazor/Services/CacheManager.cs
Removed unnecessary exception.
  • Removed the InvalidOperationException from the GetResourcePrefix method.
src/BootstrapBlazor/Localization/Json/JsonStringLocalizerFactory.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5153 Remove locking mechanism to improve performance of CacheManager
#5153 Optimize localization string retrieval process

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 19, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 19, 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:

  • Please provide performance benchmarks demonstrating the improvement from removing the lock. This will help validate that the change achieves its intended goal without introducing any issues.
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 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d0dd670) to head (f420e2f).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5154   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          635       635           
  Lines        28187     28184    -3     
  Branches      4039      4039           
=========================================
- Hits         28187     28184    -3     

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

@ArgoZhang ArgoZhang merged commit 951c1c6 into main Jan 19, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the perf-cache branch January 19, 2025 02: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.

perf(CacheManager): remove lock improve performance
1 participant