Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Feb 6, 2025

add CacheManagerOptions support configue cache expiration

Summary of the changes (Less than 80 chars)

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

Description

fixes #5309

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 support for configuring cache expiration using CacheManagerOptions.

New Features:

  • Added CacheManagerOptions to control cache expiration settings, including sliding and absolute expiration times.

Tests:

  • Added unit tests for the new CacheManagerOptions.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 6, 2025

Reviewer's Guide by Sourcery

This pull request introduces CacheManagerOptions to configure cache expiration times, allowing for more flexible control over cache behavior.

Sequence diagram for cache entry creation with new expiration settings

sequenceDiagram
    participant Client
    participant CacheManager
    participant Cache
    participant Options

    Client->>CacheManager: GetOrCreate(key, factory)
    activate CacheManager
    CacheManager->>Cache: Create cache entry
    activate Cache
    Cache-->>CacheManager: Return entry
    deactivate Cache

    CacheManager->>Options: Get CacheManagerOptions
    activate Options
    Options-->>CacheManager: Return options
    deactivate Options

    alt No expiration set
        CacheManager->>Cache: Set sliding expiration from options
    end

    CacheManager-->>Client: Return cached item
    deactivate CacheManager
Loading

Class diagram showing CacheManagerOptions integration

classDiagram
    class BootstrapBlazorOptions {
      +TableSettings TableSettings
      +StepSettings StepSettings
      +ConnectionHubOptions ConnectionHubOptions
      +WebClientOptions WebClientOptions
      +IpLocatorOptions IpLocatorOptions
      +ScrollOptions ScrollOptions
      +ContextMenuOptions ContextMenuOptions
      +CacheManagerOptions CacheManagerOptions
    }

    class CacheManagerOptions {
      +bool Enable
      +TimeSpan SlidingExpiration
      +TimeSpan AbsoluteExpiration
    }

    class CacheManager {
      -IServiceProvider Provider
      -IMemoryCache Cache
      -static CacheManager Instance
      -static BootstrapBlazorOptions Options
      +GetOrCreate<TItem>(object key, Func factory)
      +GetOrCreateAsync<TItem>(object key, Func factory)
    }

    BootstrapBlazorOptions *-- CacheManagerOptions
    CacheManager --> BootstrapBlazorOptions : uses
Loading

File-Level Changes

Change Details Files
Added CacheManagerOptions class to encapsulate cache expiration settings.
  • Introduced Enable property to control CacheManager functionality.
  • Added SlidingExpiration property to configure sliding expiration time.
  • Added AbsoluteExpiration property to configure absolute expiration time.
src/BootstrapBlazor/Options/CacheManagerOptions.cs
Integrated CacheManagerOptions into BootstrapBlazorOptions.
  • Added CacheManagerOptions property to BootstrapBlazorOptions to expose cache settings.
src/BootstrapBlazor/Options/BootstrapBlazorOptions.cs
Modified CacheManager to use CacheManagerOptions for setting cache expiration.
  • Injected IOptions to access CacheManagerOptions.
  • Replaced hardcoded sliding expiration with value from CacheManagerOptions.
  • Replaced hardcoded absolute expiration with value from CacheManagerOptions.
src/BootstrapBlazor/Services/CacheManager.cs
Added unit tests for CacheManagerOptions.
  • Created CacheManagerOptions_Ok test method to verify CacheManagerOptions properties.
test/UnitTest/Options/BootstrapBlazorOptionsTest.cs
Improved ICacheEntryExtensions to display expiration information.
  • Added GetAbsoluteLeftTime method to calculate the remaining time until absolute expiration.
  • Modified GetExpiration method to display 'Expirated' when the cache entry has expired.
  • Modified GetExpiration method to display absolute expiration time in seconds.
src/BootstrapBlazor.Server/Extensions/ICacheEntryExtensions.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5309 Add CacheManagerOptions support to configure cache expiration

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. 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 the enhancement New feature or request label Feb 6, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Feb 6, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Feb 6, 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:

  • In ICacheEntryExtensions, consider revising the 'Expirated' string to 'Expired' for clarity in expiration messages.
  • Before applying cache expiration settings in GetOrCreate methods, consider checking if CacheManagerOptions.Enable is true to ensure that the expiration configuration is applied only when intended.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟡 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 Feb 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d4adda1) to head (2ca04a6).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5310   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          643       644    +1     
  Lines        28906     28918   +12     
  Branches      4109      4110    +1     
=========================================
+ Hits         28906     28918   +12     

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

@ArgoZhang ArgoZhang merged commit 93817bc into main Feb 6, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-cachemanager branch February 6, 2025 03:15
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(CacheManagerOptions): add CacheManagerOptions support configue cache expiration

2 participants