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(Display): support LookupService method GetItemsByKeyAsync #4924

Merged
merged 3 commits into from
Dec 23, 2024

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Dec 23, 2024

support LookupService method GetItemsByKeyAsync

Summary of the changes (Less than 80 chars)

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

Description

fixes #4923

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 the GetItemsByKeyAsync method in the LookupService for the Display component.

New Features:

  • The Display component now supports asynchronous lookup of items using the GetItemsByKeyAsync method from the LookupService.

Tests:

  • Added unit tests to verify the correct behavior of the asynchronous lookup functionality.

ArgoZhang and others added 3 commits December 23, 2024 11:43
Co-Authored-By: chengKun <49547008+zhaijunlei955@users.noreply.github.com>
更新 Lookup 逻辑

Co-Authored-By: chengKun <49547008+zhaijunlei955@users.noreply.github.com>
@bb-auto bb-auto bot added the enhancement New feature or request label Dec 23, 2024
Copy link

sourcery-ai bot commented Dec 23, 2024

Reviewer's Guide by Sourcery

This pull request introduces support for asynchronous lookups in the Display component using the GetItemsByKeyAsync method. It refactors the existing lookup logic to use the new asynchronous method and updates the UI to reflect the changes. Additionally, the code removes unnecessary dependencies and simplifies the formatting logic.

Sequence diagram for Display component async lookup flow

sequenceDiagram
    participant Display as Display Component
    participant LS as LookupService
    Display->>Display: OnParametersSetAsync
    Display->>Display: FormatDisplayText
    Display->>Display: FormatText
    alt Has Lookup Key
        Display->>Display: GetLookup
        Display->>LS: GetItemsAsync(key, data)
        LS-->>Display: Return lookup items
        Display->>Display: Format with lookup data
    else No Lookup Key
        Display->>Display: Direct format
    end
    Display->>Display: Update display text
Loading

File-Level Changes

Change Details Files
Support asynchronous lookups using GetItemsByKeyAsync
  • Added LookupService parameter to the Display component.
  • Refactored lookup logic to use GetItemsByKeyAsync.
  • Updated UI to handle asynchronous results.
src/BootstrapBlazor/Components/Display/Display.razor.cs
Refactor and simplify formatting logic
  • Removed unnecessary using statements.
  • Simplified formatting logic for different data types.
  • Improved handling of null values.
src/BootstrapBlazor/Components/Display/Display.razor.cs
Update Display component UI
  • Updated the UI to display the formatted text asynchronously.
src/BootstrapBlazor/Components/Display/Display.razor
Refactor LookupFilter to use a common lookup service method
  • Introduced a common GetLookupService method to retrieve the lookup service instance.
src/BootstrapBlazor/Components/Filters/LookupFilter.razor.cs
Add unit test for LookupService
  • Added a unit test to verify the LookupService functionality.
test/UnitTest/Components/DisplayTest.cs
Move array and enumerable conversion logic to LambdaExtensions
  • Moved the array and enumerable conversion logic to the LambdaExtensions class.
  • Added new methods EnumerableConvertToStringLambda, ConvertToStringEnumerableLambda, and ArrayConvertToStringLambda to LambdaExtensions.
src/BootstrapBlazor/Extensions/LambdaExtensions.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4923 Add support for GetItemsByKeyAsync method in LookupService for Display component

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 this to the v9.0.0 milestone Dec 23, 2024
@ArgoZhang ArgoZhang enabled auto-merge (squash) December 23, 2024 03:50
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: 1 issue 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 Dec 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (ece2207) to head (bc69889).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4924   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          628       628           
  Lines        28073     28082    +9     
  Branches      4038      4042    +4     
=========================================
+ Hits         28073     28082    +9     

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

@ArgoZhang ArgoZhang merged commit 4350928 into main Dec 23, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-display branch December 23, 2024 03:59
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(Display): support LookupService method GetItemsByKeyAsync
1 participant