Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Feb 18, 2025

add UseCache parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #5384

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

Introduced a UseCache parameter to the DataTableDynamicContext to allow developers to control whether the internal cache is used when retrieving items, providing more flexibility in data handling.

New Features:

  • Added a UseCache parameter to the DataTableDynamicContext class to control whether the internal cache is used when retrieving items.

Enhancements:

  • The GetItems method now checks the UseCache property to determine whether to use the cached items or rebuild them.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 18, 2025

Reviewer's Guide by Sourcery

This pull request introduces a UseCache property to the DataTableDynamicContext class. This property allows developers to control whether the component should use an internal cache for items, providing a mechanism to balance performance and data freshness.

Updated class diagram for DataTableDynamicContext

classDiagram
  class DataTableDynamicContext {
    -Action~DataTableDynamicContext, ITableColumn~? AddAttributesCallback
    +bool UseCache
    -Dictionary~DataRow, IDynamicObject~ RowToItemCache
    +IEnumerable~IDynamicObject~ GetItems()
  }
  note for DataTableDynamicContext "Added UseCache property to control internal caching"
Loading

File-Level Changes

Change Details Files
Added a UseCache property to the DataTableDynamicContext class to control internal caching behavior.
  • Added a UseCache property with a default value of true to enable caching by default.
  • Modified the GetItems method to conditionally use the cached Items or rebuild them based on the UseCache property.
src/BootstrapBlazor/Dynamic/DataTableDynamicContext.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5384 When the DataTable is edited, DataTableDynamicContext.GetItems() should return the updated items.
#5384 When adding new objects with DataTableDynamicContext.AddAsync and OnAddAsync is set, the items should be updated. The PR only addresses the caching of items when the DataTable is edited, but does not address the issue of items not being updated when using DataTableDynamicContext.AddAsync with OnAddAsync.
#5384 DataTableDynamicContext.GetItems() should always return rows from DataTableDynamicContext.DataTable.

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 bug Something isn't working label Feb 18, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Feb 18, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Feb 18, 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:

  • Consider if UseCache should be configurable via a cascading parameter instead of directly on the context.
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.

@codecov
Copy link

codecov bot commented Feb 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (2b1ab85) to head (2412354).

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5389   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          645       645           
  Lines        29254     29261    +7     
  Branches      4131      4132    +1     
=========================================
+ Hits         29254     29261    +7     

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

@ArgoZhang ArgoZhang merged commit ce031e4 into main Feb 18, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the refactor-dy branch February 18, 2025 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bug(DataTableDynamicContext): Items not updated after its DataTable got changed

2 participants