Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented May 14, 2025

Link issues

fixes #6012

Summary By Copilot

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

Redesign the table filtering system by replacing the old TableFilter with a new TableColumnFilter component and introducing a unified Filter wrapper and MultipleFilterBase for multi‐condition filters. Update filter base classes, component templates, and CascadingParameters to streamline type‐specific filters (string, number, date, enum, bool, lookup, multi). Update sample usage and SCSS imports accordingly. Migrate and simplify unit tests to target the new filter architecture and close #6012.

New Features:

  • Introduce TableColumnFilter component to replace TableFilter
  • Add a generic Filter wrapper component for rendering custom filters
  • Introduce MultipleFilterBase to support multi‐condition filter logic

Enhancements:

  • Refactor FilterBase to work with TableColumnFilter and remove legacy TableFilter APIs
  • Unify component templates and code‐behind for all filter types (String, Number, DateTime, Enum, Bool, Lookup, Multi)
  • Update sample TablesFilter demo to use new Filter syntax and parameters
  • Import TableColumnFilter styles instead of the old TableFilter SCSS

Tests:

  • Rewrite all unit tests to reference TableColumnFilter and the new filter APIs instead of TableFilter
  • Simplify and extend existing filter tests to cover OnFilterAsync, Reset, and SetFilterConditionsAsync

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 14, 2025

Reviewer's Guide

This PR completely overhauls the table filtering architecture by replacing the old TableFilter with a new TableColumnFilter component, refactoring filter base classes, introducing a generic Filter wrapper, updating all built-in filter components to the new API, adjusting samples, and streamlining the unit tests to align with the simplified OnFilterAsync/Reset model.

File-Level Changes

Change Details Files
Replace TableFilter with TableColumnFilter across codebase
  • Introduce TableColumnFilter component and remove TableFilter
  • Update Table.razor to render TableColumnFilter in headers and cells
  • Provide extension helpers in TableColumnFilterExtensions
src/BootstrapBlazor/Components/Filters/TableColumnFilter.razor
src/BootstrapBlazor/Components/Filters/TableColumnFilter.razor.cs
src/BootstrapBlazor/Extensions/TableColumnFilterExtensions.cs
src/BootstrapBlazor/Components/Table/Table.razor
Introduce generic Filter wrapper
  • Add Filter.razor and Filter.razor.cs to render any filter with header/body and action buttons
  • Update samples to use instead of inline templates
src/BootstrapBlazor/Components/Filters/Filter.razor
src/BootstrapBlazor/Components/Filters/Filter.razor.cs
src/BootstrapBlazor.Server/Components/Samples/Table/TablesFilter.razor
src/BootstrapBlazor.Server/Components/Samples/Table/TablesFilter.razor.cs
Refactor filter base types
  • Simplify FilterBase to cascade TableColumnFilter, expose FieldKey/IsHeaderRow
  • Introduce MultipleFilterBase for filters supporting multiple conditions
src/BootstrapBlazor/Components/Filters/FilterBase.cs
src/BootstrapBlazor/Components/Filters/MultipleFilterBase.cs
Update built-in filter components
  • Adapt StringFilter, NumberFilter, DateTimeFilter, BoolFilter, EnumFilter, LookupFilter, MultiFilter to new base classes
  • Rename internal fields to _value/_action, use OnFilterAsync event
  • Revise .razor markup to support header vs. popover modes
src/BootstrapBlazor/Components/Filters/StringFilter.razor
src/BootstrapBlazor/Components/Filters/StringFilter.razor.cs
src/BootstrapBlazor/Components/Filters/NumberFilter.razor
src/BootstrapBlazor/Components/Filters/NumberFilter.razor.cs
src/BootstrapBlazor/Components/Filters/DateTimeFilter.razor
src/BootstrapBlazor/Components/Filters/DateTimeFilter.razor.cs
src/BootstrapBlazor/Components/Filters/BoolFilter.razor
src/BootstrapBlazor/Components/Filters/BoolFilter.razor.cs
src/BootstrapBlazor/Components/Filters/EnumFilter.razor
src/BootstrapBlazor/Components/Filters/EnumFilter.razor.cs
src/BootstrapBlazor/Components/Filters/LookupFilter.razor
src/BootstrapBlazor/Components/Filters/LookupFilter.razor.cs
src/BootstrapBlazor/Components/Filters/MultiFilter.razor
src/BootstrapBlazor/Components/Filters/MultiFilter.razor.cs
Revise unit tests for new filter API
  • Rename and simplify tests to use TableColumnFilter and OnFilterAsync
  • Remove obsolete multi-step assertions, use MockTable/MockColumn helpers
  • Catch and test core behaviors: FilterAction, Reset, OnFilterAsync
test/UnitTest/Components/TableColumnFilterTest.cs
test/UnitTest/Components/*FilterTest.cs
test/UnitTest/Components/InternalTableColumnTest.cs
test/UnitTest/Extensions/ITableColumnExtensionsTest.cs
Update styling and localization
  • Import TableColumnFilter SCSS instead of TableFilter in components.scss
  • Add or adjust localization entries for new components
src/BootstrapBlazor/wwwroot/scss/components.scss
src/BootstrapBlazor/Components/Filters/Filter.razor.cs
src/BootstrapBlazor/Locales/en.json
src/BootstrapBlazor/Locales/zh.json

Assessment against linked issues

Issue Objective Addressed Explanation
#6012 Enable the reuse of add and subtract buttons when customizing filters through FilterTemplate.

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!

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 May 14, 2025
@bb-auto bb-auto bot added this to the v9.6.0 milestone May 14, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes May 14, 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:

  • There are repeated definitions of MockTable and MockColumn across many test classes—consider extracting these into shared test helpers to reduce duplication and make future updates easier.
  • The Filter component mixes a lot of inline render logic with dynamic parameter injection—factoring out the RenderFilter delegate or moving the template selection into a dedicated helper could improve readability and maintainability.
  • I see many literal SelectedItem lists and hard‐coded filter parameters throughout the code; consider introducing reusable factories or static collections to DRY up these repetitive initializations.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 2 issues found
  • 🟢 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 May 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (051fdba) to head (b4ee5c1).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##              main     #6020    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files          670       701    +31     
  Lines        30657     30871   +214     
  Branches      4364      4370     +6     
==========================================
+ Hits         30657     30871   +214     

☔ 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.

@ArgoZhang ArgoZhang merged commit 124f84b into main May 14, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-filter branch May 14, 2025 06:29
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(Table): 通过列 FilterTemplate 自定义过滤时可重用 加、减 按钮

2 participants