Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 25, 2025

add prefix cache key

Summary of the changes (Less than 80 chars)

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

Description

fixes #5209

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 a prefix to cache keys.

Bug Fixes:

  • Fix an issue where cached items with no expiration were not being cleared.

Tests:

  • Add tests to verify the fix.

@bb-auto bb-auto bot added the enhancement New feature or request label Jan 25, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 25, 2025

Reviewer's Guide by Sourcery

This pull request introduces a cache key prefix to all cache keys in the CacheManager to avoid potential key collisions. It also adds a default sliding expiration for cache entries that do not have an expiration or priority set.

Sequence diagram for cache entry creation with sliding expiration

sequenceDiagram
    participant Client
    participant CacheManager
    participant Cache
    Client->>CacheManager: GetOrCreateAsync(key, factory)
    CacheManager->>Cache: GetOrCreateAsync(key)
    Cache-->>CacheManager: Create new entry
    CacheManager->>Cache: factory(entry)
    Note over CacheManager: Check expiration settings
    alt No expiration or priority set
        CacheManager->>Cache: SetSlidingExpiration(5 minutes)
    end
    Cache-->>CacheManager: Return cached item
    CacheManager-->>Client: Return result
Loading

Class diagram for CacheManager changes

classDiagram
    class CacheManager {
        -string CacheKeyPrefix
        -static CacheManager Instance
        +GetOrCreate<TItem>(object key, Func factory)
        +GetOrCreateAsync<TItem>(object key, Func factory)
        +ElementCount(object value)
        +GetJsonStringByTypeName(Assembly assembly, string cultureName)
        +GetNullableBoolItems(Type modelType, string fieldName)
        +GetPropertyValue<TModel, TResult>(TModel model, string fieldName)
    }
    note for CacheManager "Added CacheKeyPrefix constant
Modified cache key generation
Added default sliding expiration"
Loading

File-Level Changes

Change Details Files
Added a cache key prefix to all cache keys.
  • Added a constant CacheKeyPrefix with the value BootstrapBlazor.
  • Prepended the CacheKeyPrefix to all cache keys.
src/BootstrapBlazor/Services/CacheManager.cs
Added a default sliding expiration for cache entries.
  • Added a check to see if the cache entry has a sliding or absolute expiration or a priority set.
  • If no expiration or priority is set, a default sliding expiration of 5 minutes is set.
src/BootstrapBlazor/Services/CacheManager.cs
Added a test case for cache entries with NeverRemove priority.
  • Added a test case to verify that cache entries with NeverRemove priority are not removed when the cache is cleared.
test/UnitTest/Services/CacheManagerTest.cs
Added test cases for GetJsonStringByTypeName.
  • Added a test case for an empty culture name.
  • Added a test case for dynamic types.
test/UnitTest/Utils/UtilityTest.cs
Updated the return type of OnModelSearch method.
  • Changed the return type of OnModelSearch method from IEnumerable<string> to IEnumerable<string?>.
src/BootstrapBlazor.Server/Components/Samples/Searches.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5209 Add prefix for cache key

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

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

  • Please add documentation about the cache key format and prefix usage, as this is a potentially breaking change for users who directly interact with the cache
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟢 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 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (692d46c) to head (bdc6317).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5210   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          634       634           
  Lines        28194     28198    +4     
  Branches      4057      4058    +1     
=========================================
+ Hits         28194     28198    +4     

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

@ArgoZhang ArgoZhang merged commit 3a8f822 into main Jan 25, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-cache branch January 25, 2025 16:41
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.

feat(ICacheManager): add prefix for cache key

2 participants