Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 21, 2025

add default cache policy

Summary of the changes (Less than 80 chars)

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

Description

fixes #5175

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 default cache policy to ICacheManager to set a sliding expiration of 5 minutes if no expiration is specified.

New Features:

  • Add default cache policy to ICacheManager.

Enhancements:

  • Set a sliding expiration of 5 minutes for cache entries if no expiration is set.
  • Set cache entry for BootstrapBlazor_StartTime with NeverRemove priority.
  • Set a 10-second absolute expiration for dynamic types when getting or setting property values using lambda expressions.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 21, 2025

Reviewer's Guide by Sourcery

This pull request introduces a default cache policy to the ICacheManager implementation. It also refactors the CodeSnippetService to use the new cache policy and improve code readability.

Sequence diagram for GetOrCreate cache operation with default policy

sequenceDiagram
    participant Client
    participant CacheManager
    participant Cache
    Client->>CacheManager: GetOrCreate(key, factory)
    CacheManager->>Cache: GetOrCreate(key)
    alt Item not in cache
        Cache-->>CacheManager: Create new entry
        CacheManager->>CacheManager: Execute factory
        alt No expiration policy set
            CacheManager->>Cache: Set sliding expiration (5 min)
        end
        CacheManager->>Cache: Store item
    end
    Cache-->>CacheManager: Return cached item
    CacheManager-->>Client: Return item
Loading

Class diagram showing changes to CacheManager and CodeSnippetService

classDiagram
    class ICacheManager {
        +GetOrCreate<TItem>(key: object, factory: Func<ICacheEntry, TItem>): TItem
        +Clear(key: object?): void
    }
    class CacheManager {
        -IServiceProvider Provider
        -IMemoryCache Cache
        +GetOrCreate<TItem>(key: object, factory: Func<ICacheEntry, TItem>): TItem
        +Clear(key: object?): void
    }
    class CodeSnippetService {
        +GetCodeAsync(codeFile: string): Task<string>
        +GetFileContentAsync(fileName: string): Task<string>
        -ReadFileAsync(fileName: string): Task<string>
    }
    ICacheManager <|.. CacheManager
    CodeSnippetService --> ICacheManager
    note for CacheManager "Added default cache policy:
- 5 min sliding expiration if no policy set
- Special handling for dynamic assemblies"
Loading

File-Level Changes

Change Details Files
Refactor CodeSnippetService to use IOptionsMonitor for configuration and ICacheManager for caching.
  • The service now uses IOptions and IOptions instead of IOptionsMonitor.
  • The service now uses IHttpClientFactory and ICacheManager directly in the constructor.
  • The service now uses the ICacheManager to cache the file content.
  • The service now uses the ICacheManager to cache the localized strings.
  • The service now uses the options.Value to get the configuration values.
src/BootstrapBlazor.Server/Services/CodeSnippetService.cs
Implement a default cache policy for ICacheManager.
  • The GetOrCreate method now sets a default sliding expiration of 5 minutes if no expiration is set.
  • The SetStartTime method now sets the cache priority to NeverRemove.
src/BootstrapBlazor/Services/CacheManager.cs
Remove CacheManagerExtensions.
  • The CacheManagerExtensions file was removed.
src/BootstrapBlazor.Server/Extensions/CacheManagerExtensions.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5175 Add a default cache policy to the ICacheManager implementation

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 21, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 21, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jan 21, 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 provide documentation explaining the rationale for removing FrozenDictionary and CacheManagerExtensions.cs. These are significant changes that should be justified in the PR description.
  • Consider keeping FrozenDictionary for SourceCodes as it provides better performance for read-only scenarios. If there's a specific reason for removing it, please explain.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

@codecov
Copy link

codecov bot commented Jan 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (9e809f0) to head (a09264f).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5176   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          634       634           
  Lines        28139     28158   +19     
  Branches      4049      4052    +3     
=========================================
+ Hits         28139     28158   +19     

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

@ArgoZhang ArgoZhang enabled auto-merge (squash) January 21, 2025 07:32
@ArgoZhang ArgoZhang disabled auto-merge January 21, 2025 07:34
@ArgoZhang ArgoZhang enabled auto-merge (squash) January 21, 2025 07:34
@ArgoZhang ArgoZhang disabled auto-merge January 21, 2025 07:34
@ArgoZhang ArgoZhang merged commit d52dda0 into main Jan 21, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-cache branch January 21, 2025 07:34
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 default cache policy

2 participants