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

feat(ICacheEntry): add GetLastAccessed extension method #5219

Merged
merged 11 commits into from
Jan 26, 2025
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Jan 26, 2025

add GetLastAccessed extension method

Summary of the changes (Less than 80 chars)

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

Description

fixes #5218

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 an extension method GetLastAccessed to ICacheEntry to retrieve the last accessed time of a cache entry. Update the CacheList page to display cache expiration information using the new extension method.

New Features:

  • Added GetLastAccessed extension method to ICacheEntry.

Tests:

  • Added unit tests for the ICacheEntryExtensions class.

Copy link

sourcery-ai bot commented Jan 26, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new extension method GetLastAccessed for ICacheEntry and modifies the cache list and cache expiration components to display more detailed cache information.

Sequence diagram for cache list and expiration display

sequenceDiagram
    participant UI as Cache List UI
    participant CL as CacheList Component
    participant CE as CacheExpiration Component
    participant CM as CacheManager
    participant Ext as ICacheEntryExtensions

    UI->>CL: View cache list
    CL->>CM: Get cache keys
    CM-->>CL: Return cache entries
    loop For each entry
        CL->>CE: Display expiration
        CE->>Ext: GetExpiration()
        Ext->>Ext: GetLastAccessed()
        Ext-->>CE: Return formatted expiration
        CE-->>CL: Show expiration info
    end
    CL-->>UI: Display updated cache list
Loading

Class diagram for ICacheEntry extensions

classDiagram
    class ICacheEntry {
        <<interface>>
    }
    class ICacheEntryExtensions {
        +GetLastAccessed(ICacheEntry entry, bool force) DateTime?
        -PropertyInfo? _lastAccessedProperty
    }
    class ICacheEntryServerExtensions {
        +GetExpiration(ICacheEntry entry) string
        +GetSlidingLeftTime(ICacheEntry entry) TimeSpan
    }
    ICacheEntry <-- ICacheEntryExtensions : extends
    ICacheEntry <-- ICacheEntryServerExtensions : extends
    note for ICacheEntryExtensions "New extension method to get
the last accessed time"
    note for ICacheEntryServerExtensions "Additional extensions for
cache expiration info"
Loading

File-Level Changes

Change Details Files
Added GetLastAccessed extension method to ICacheEntry
  • Added a new extension method GetLastAccessed to the ICacheEntry interface.
  • Added unit tests for the new extension method.
test/UnitTest/Extensions/ICacheEntryExtensionsTest.cs
src/BootstrapBlazor/Extensions/ICacheEntryExtensions.cs
Modified CacheList component to display cache entry details
  • Modified the OnParametersSetAsync method to use Task.Yield().
  • Modified the UpdateCacheList method to store ICacheEntry objects instead of keys.
  • Added GetKey and GetValue methods to extract data from ICacheEntry objects.
  • Modified the razor file to use the new GetKey and GetValue methods.
src/BootstrapBlazor.Server/Components/Pages/CacheList.razor.cs
src/BootstrapBlazor.Server/Components/Pages/CacheList.razor
Modified CacaheExpiration component to display cache entry expiration details
  • Modified the component to accept an ICacheEntry object as a parameter instead of a key.
  • Modified the component to use the GetExpiration extension method to display expiration information.
src/BootstrapBlazor.Server/Components/Pages/CacaheExpiration.razor.cs
Modified CacheManager to use reflection to get all cache values
  • Modified the GetAllValues method to use reflection to get the _coherentState field and GetAllValues method from the MemoryCache class.
src/BootstrapBlazor/Services/CacheManager.cs
Added GetExpiration extension method to ICacheEntry
  • Added a new extension method GetExpiration to the ICacheEntry interface.
  • This method is used to get the expiration information of a cache entry.
src/BootstrapBlazor.Server/Extensions/ICacheEntryExtensions.cs
Fixed a typo in the AutoFill component
  • Fixed a typo in the OnGetDisplayText method of the AutoFill component.
  • Modified the OnGetDisplayText method to handle null values.
  • Modified the AutoFill component to handle null values in the OnGetDisplayText method.
src/BootstrapBlazor.Server/Components/Samples/AutoFills.razor.cs
src/BootstrapBlazor.Server/Components/Samples/InputGroups.razor
src/BootstrapBlazor/Components/AutoFill/AutoFill.razor.cs
Modified InputGroups sample to use new SelectedItem constructor
  • Modified the SelectedItem constructor to use the new constructor.
src/BootstrapBlazor.Server/Components/Samples/InputGroups.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5218 Add GetLastAccessed extension method to ICacheEntry

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 Jan 26, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 26, 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 and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 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.

Copy link

codecov bot commented Jan 26, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (f0fd5dc) to head (6eb8e8c).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5219   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          634       635    +1     
  Lines        28229     28243   +14     
  Branches      4063      4066    +3     
=========================================
+ Hits         28229     28243   +14     

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

@ArgoZhang ArgoZhang merged commit 0d04f6f into main Jan 26, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the doc-fill branch January 26, 2025 11: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(ICacheEntry): add GetLastAccessed extension method
1 participant