Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 24, 2025

add TriggerByPagination parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #5192

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 a TriggerByPagination parameter to QueryPageOptions to indicate whether a query was triggered by pagination. Update the QueryAsync method in Table.razor.Edit.cs to accept this parameter and pass it to the QueryData method. Update the OnPageLinkClick method in Table.razor.Pagination.cs to pass triggerByPagination: true when calling QueryAsync. Add tests to verify the behavior of the IsAutoQueryFirstQuery method.

New Features:

  • Added a TriggerByPagination parameter to QueryPageOptions to indicate whether a query was triggered by pagination.

Tests:

  • Added tests to verify the behavior of the IsAutoQueryFirstQuery method.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 24, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new TriggerByPagination parameter to the QueryPageOptions class and modifies the Table component to use this parameter when querying data. This allows the component to differentiate between queries triggered by pagination and other queries.

Sequence diagram for Table pagination query flow

sequenceDiagram
    participant User
    participant Table
    participant QueryPageOptions

    User->>Table: Click page link
    activate Table
    Table->>Table: OnPageLinkClick(pageIndex)
    Table->>Table: QueryAsync(false, triggerByPagination: true)
    Table->>Table: QueryData(triggerByPagination)
    Table->>QueryPageOptions: BuildQueryPageOptions()
    Note right of QueryPageOptions: Sets TriggerByPagination=true
    Table->>Table: OnQueryAsync with updated options
    Table->>Table: OnSelectedRowsChanged()
    deactivate Table
Loading

Class diagram showing QueryPageOptions changes

classDiagram
    class QueryPageOptions {
        +int PageIndex
        +int PageItems
        +string? SearchText
        +List~IFilterAction~ Filters
        +List~ISortAction~ SortList
        +bool IsFirstQuery
        +bool TriggerByPagination
    }
    note for QueryPageOptions "Added TriggerByPagination property"

    class Table {
        -Task QueryAsync(bool shouldRender, int? pageIndex, bool triggerByPagination)
        #Task QueryData(bool triggerByPagination)
        #Task OnPageLinkClick(int pageIndex)
    }
    Table ..> QueryPageOptions : uses
Loading

File-Level Changes

Change Details Files
Added TriggerByPagination property to QueryPageOptions.
  • Added a new boolean property TriggerByPagination to the QueryPageOptions class.
  • Added a summary comment for the new property.
src/BootstrapBlazor/Options/QueryPageOptions.cs
Modified QueryAsync method in Table component to accept triggerByPagination parameter.
  • Modified the QueryAsync method to accept an optional triggerByPagination boolean parameter.
  • Modified the QueryData method call to pass the triggerByPagination parameter.
  • Modified the QueryData method to set the TriggerByPagination property of the queryOption.
src/BootstrapBlazor/Components/Table/Table.razor.Edit.cs
Modified OnPageLinkClick method in Table component to pass triggerByPagination as true.
  • Modified the QueryAsync method call to pass triggerByPagination as true when a page link is clicked.
src/BootstrapBlazor/Components/Table/Table.razor.Pagination.cs
Added a unit test to verify the TriggerByPagination property.
  • Added a new unit test IsAutoQueryFirstQuery_Ok to verify the TriggerByPagination property is set correctly.
test/UnitTest/Components/TableTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5192 Add TriggerByPagination parameter to QueryPageOptions

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 24, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 24, 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:

  • Please provide more context in the PR description about why this TriggerByPagination flag is needed and what problem it solves. This will help reviewers better understand the motivation for these changes.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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 Jan 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (8526429) to head (922bde0).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5193   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          634       634           
  Lines        28167     28169    +2     
  Branches      4053      4053           
=========================================
+ Hits         28167     28169    +2     

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

@ArgoZhang ArgoZhang merged commit c607323 into main Jan 24, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-table branch January 24, 2025 05:20
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(QueryPageOptions): add TriggerByPagination parameter

2 participants