Skip to content

refactor(Table): throw exception when set IsTree to true in virtualize mode #5723

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

Merged
merged 2 commits into from
Mar 26, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Mar 26, 2025

Link issues

fixes #5722
fixes #5685

Summary By Copilot

This pull request introduces a check to prevent the use of virtual scrolling in tree mode in the Table component and updates the corresponding unit tests to validate this behavior.

Changes to Table component:

  • Added a check in OnParametersSet method to throw an InvalidOperationException if ScrollMode is set to Virtual and IsTree is true. (src/BootstrapBlazor/Components/Table/Table.razor.cs)

Changes to unit tests:

  • Disabled error logging in the ScrollMode_Ok test to prevent unnecessary logs during test execution. (test/UnitTest/Components/TableTest.cs)
  • Added a unit test to ensure an InvalidOperationException is thrown when IsTree is set to true while ScrollMode is Virtual. (test/UnitTest/Components/TableTest.cs)

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

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

Prevent using virtual scrolling with tree mode in Table component by adding a validation check that throws an exception when incompatible settings are configured

Bug Fixes:

  • Prevent invalid configuration of Table component by adding a check to disallow virtual scrolling when tree mode is enabled

Tests:

  • Added a unit test to verify that an InvalidOperationException is thrown when attempting to enable tree mode with virtual scrolling
  • Updated ScrollMode_Ok test to disable error logging during test execution

Copy link
Contributor

sourcery-ai bot commented Mar 26, 2025

Reviewer's Guide by Sourcery

This pull request introduces a check to prevent the use of virtual scrolling in tree mode in the Table component and updates the corresponding unit tests to validate this behavior. An InvalidOperationException is thrown when IsTree is set to true while ScrollMode is Virtual.

Updated class diagram for the Table component

classDiagram
  class Table {
    ScrollMode ScrollMode
    bool IsTree
    OnParametersSet()
  }
  note for Table "Throws InvalidOperationException if ScrollMode is Virtual and IsTree is true"
Loading

File-Level Changes

Change Details Files
Added a check to prevent the use of virtual scrolling in tree mode.
  • Added a check in OnParametersSet to throw an InvalidOperationException if ScrollMode is set to Virtual and IsTree is true.
src/BootstrapBlazor/Components/Table/Table.razor.cs
Added a unit test to ensure an InvalidOperationException is thrown when IsTree is set to true while ScrollMode is Virtual.
  • Disabled error logging in the ScrollMode_Ok test to prevent unnecessary logs during test execution.
  • Added a unit test to ensure an InvalidOperationException is thrown when IsTree is set to true while ScrollMode is Virtual.
test/UnitTest/Components/TableTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5722 Throw an exception when the IsTree property is set to true while the ScrollMode is set to Virtual.

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 Mar 26, 2025
@bb-auto bb-auto bot added this to the v9.4.0 milestone Mar 26, 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 extracting the exception throwing logic into a separate method for better readability.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

@ArgoZhang ArgoZhang merged commit e8be200 into main Mar 26, 2025
3 checks passed
@ArgoZhang ArgoZhang deleted the refactor-table branch March 26, 2025 10:55
Copy link

codecov bot commented Mar 26, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5723   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          657       657           
  Lines        29829     29832    +3     
  Branches      4229      4230    +1     
=========================================
+ Hits         29829     29832    +3     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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
1 participant