Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Dec 10, 2024

add GetItemsByKeyAsync method

Summary of the changes (Less than 80 chars)

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

Description

fixes #4814

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 asynchronous support for retrieving lookup items in the ILookupService interface with the new GetItemsByKeyAsync method. Refactor components to utilize this asynchronous method, improving performance and functionality. Update and add tests to ensure the new asynchronous features work as expected.

New Features:

  • Introduce the GetItemsByKeyAsync method in the ILookupService interface to support asynchronous retrieval of lookup items.

Enhancements:

  • Refactor the EditorForm component to use a cached list of render items, improving performance by avoiding repeated calculations.
  • Update the LookupFilter component to support asynchronous lookup item retrieval using the new GetItemsByKeyAsync method.

Tests:

  • Add new unit tests for the asynchronous GetItemsByKeyAsync method in the ILookupService interface.
  • Enhance existing tests to cover the new asynchronous lookup functionality in components like EditorForm and LookupFilter.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 10, 2024

Reviewer's Guide by Sourcery

This PR adds a new asynchronous method GetItemsByKeyAsync to the ILookupService interface and refactors the lookup data loading mechanism to support both synchronous and asynchronous data fetching. The changes improve the handling of lookup data throughout the component system by making it more flexible and consistent.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added asynchronous lookup data loading support to ILookupService
  • Added GetItemsByKeyAsync method to ILookupService interface
  • Added default implementation in LookupServiceBase that calls synchronous method
  • Added extension method GetItemsAsync that tries sync then async methods
  • Marked GetItemsByKey(string) as obsolete
src/BootstrapBlazor/Services/ILookupService.cs
src/BootstrapBlazor/Services/LookupServiceBase.cs
src/BootstrapBlazor/Extensions/ILookupServiceExtensions.cs
Refactored lookup service integration in components
  • Added LookupService property to IEditorItem interface and implementations
  • Modified components to support component-specific lookup services
  • Changed lookup data loading to use async methods where appropriate
  • Removed direct lookup service dependency from component builders
src/BootstrapBlazor/Components/EditorForm/IEditorItem.cs
src/BootstrapBlazor/Components/EditorForm/EditorItem.cs
src/BootstrapBlazor/Components/Table/TableColumn.cs
src/BootstrapBlazor/Utils/Utility.cs
Improved lookup data initialization in forms and tables
  • Modified EditorForm to load lookup data on first render
  • Updated Table component to preload lookup data before rendering
  • Refactored LookupFilter to support both sync and async data loading
  • Removed redundant lookup data caching
src/BootstrapBlazor/Components/EditorForm/EditorForm.razor.cs
src/BootstrapBlazor/Components/Table/Table.razor.cs
src/BootstrapBlazor/Components/Filters/LookupFilter.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4814 Add GetItemsByKeyAsync method to ILookupService interface

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.
  • 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 Dec 10, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Dec 10, 2024
@ArgoZhang ArgoZhang linked an issue Dec 10, 2024 that may be closed by this pull request
1 task
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Dec 10, 2024
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 and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Testing: 2 issues 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 Dec 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (a85cd0c) to head (84cf034).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4816   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          620       621    +1     
  Lines        27333     27406   +73     
  Branches      3921      3929    +8     
=========================================
+ Hits         27333     27406   +73     

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

@ArgoZhang ArgoZhang merged commit dc943bb into main Dec 10, 2024
3 checks passed
@ArgoZhang ArgoZhang deleted the feat-lookup branch December 10, 2024 11:03
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(ILookupService): add GetItemsByKeyAsync method Lookup服务:使用 .Result 异步方法获取值,会导致死锁问题。

2 participants