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

refactor(Select): auto load data on virtual mode #4852

Merged
merged 3 commits into from
Dec 15, 2024
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Dec 15, 2024

auto load data on virtual mode

Summary of the changes (Less than 80 chars)

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

Description

fixes #4851

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

Refactor the Select component to automatically load data when in virtual mode by introducing a new method to refresh the virtualized element. Update the unit test to ensure the correct value binding in virtual mode.

Enhancements:

  • Implement auto-loading of data in virtual mode for Select component.

Tests:

  • Update unit test to verify the correct binding of value in virtual mode.

Copy link

sourcery-ai bot commented Dec 15, 2024

Reviewer's Guide by Sourcery

This PR implements auto-loading of data in virtual mode for Select components. The changes introduce a new RefreshVirtualizeElement method and add OnAfterRenderAsync lifecycle hook to automatically load data on first render. The implementation is consistent across both Select and SelectGeneric components.

Sequence diagram for auto-loading data in virtual mode

sequenceDiagram
    actor User
    participant SelectComponent
    participant VirtualizeElement

    User->>SelectComponent: Render component
    SelectComponent->>SelectComponent: OnAfterRenderAsync(firstRender)
    alt firstRender is true
        SelectComponent->>SelectComponent: RefreshVirtualizeElement()
        SelectComponent->>VirtualizeElement: RefreshDataAsync()
        VirtualizeElement-->>SelectComponent: Data loaded
        SelectComponent->>SelectComponent: StateHasChanged()
    end
Loading

Updated class diagram for Select component

classDiagram
    class Select {
        +Task OnAfterRenderAsync(bool firstRender)
        +Task RefreshVirtualizeElement()
        -Task SearchTextChanged(string val)
        -bool IsVirtualize
        -Func OnQueryAsync
        -VirtualizeElement VirtualizeElement
    }

    class SelectGeneric {
        +Task OnAfterRenderAsync(bool firstRender)
        +Task RefreshVirtualizeElement()
        -Task SearchTextChanged(string val)
        -bool IsVirtualize
        -Func OnQueryAsync
        -VirtualizeElement VirtualizeElement
    }

    Select <|-- SelectGeneric
Loading

File-Level Changes

Change Details Files
Added automatic data loading for virtual mode in Select components
  • Introduced new RefreshVirtualizeElement method to handle data loading logic
  • Added OnAfterRenderAsync lifecycle hook to load data on first render
  • Modified SearchTextChanged to use the new RefreshVirtualizeElement method
  • Added IsVirtualize check before attempting to load data
src/BootstrapBlazor/Components/Select/Select.razor.cs
src/BootstrapBlazor/Components/SelectGeneric/SelectGeneric.razor.cs
Updated unit test expectation for virtual mode binding
  • Changed assertion to expect value '3' instead of null for input element
test/UnitTest/Components/SelectTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4851 Implement auto loading of data when in virtual mode for Select 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 the enhancement New feature or request label Dec 15, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Dec 15, 2024
@ArgoZhang ArgoZhang enabled auto-merge (squash) December 15, 2024 03:09
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 - here's some feedback:

Overall Comments:

  • Please complete the PR template with proper documentation - including risk assessment, verification details, and a clear description of the behavior changes (particularly around the test modification).
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 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (8b246b8) to head (bec5622).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4852   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          623       623           
  Lines        27809     27831   +22     
  Branches      3980      3982    +2     
=========================================
+ Hits         27809     27831   +22     

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

@ArgoZhang ArgoZhang merged commit a759930 into main Dec 15, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-select branch December 15, 2024 03:14
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.

refactor(Select): auto load data on virtual mode
1 participant