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(Table): add OnAfterCancelSaveAsync parameter #4757

Merged
merged 5 commits into from
Nov 29, 2024
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Nov 29, 2024

add OnAfterCancelSaveAsync parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #4749

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 the OnAfterCancelSaveAsync parameter to the Table component to enable custom actions after a cancel save operation, and implement corresponding unit tests to verify its functionality.

New Features:

  • Introduce the OnAfterCancelSaveAsync parameter to the Table component, allowing for custom actions to be executed after a cancel save operation.

Tests:

  • Add unit tests for the OnAfterCancelSaveAsync parameter to ensure it triggers correctly in both Popup and Drawer edit modes.

Copy link

sourcery-ai bot commented Nov 29, 2024

Reviewer's Guide by Sourcery

This PR adds a new OnAfterCancelSaveAsync callback parameter to the Table component, which is triggered when a user cancels saving changes in either Popup or Drawer edit modes. The implementation includes unit tests to verify the callback behavior in both modes.

Class diagram for the updated Table component

classDiagram
    class Table {
        +Func<Task> OnAfterCancelSaveAsync
    }
    note for Table "New parameter OnAfterCancelSaveAsync added to handle post-cancel save actions."
Loading

File-Level Changes

Change Details Files
Added new OnAfterCancelSaveAsync callback parameter to Table component
  • Added OnAfterCancelSaveAsync parameter property with Func type
  • Added XML documentation for the new parameter
src/BootstrapBlazor/Components/Table/Table.razor.Edit.cs
Implemented callback logic in dialog and drawer edit modes
  • Added triggerFromSave flag to prevent callback on save operation
  • Implemented callback in dialog close handler when not triggered by save
  • Added callback execution in drawer close handler
src/BootstrapBlazor/Components/Table/Table.razor.Toolbar.cs
Added comprehensive unit tests for the new callback
  • Added test case for Popup edit mode
  • Added test case for Drawer edit mode
  • Verified callback is not triggered on save operation
  • Verified callback is triggered on cancel operation
test/UnitTest/Components/TableTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4749 Add ability to detect when table editing is cancelled

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 bug Something isn't working label Nov 29, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Nov 29, 2024
@ArgoZhang ArgoZhang enabled auto-merge (squash) November 29, 2024 05:38
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:

  • The OnAfterCancelSaveAsync callback behavior is inconsistent between popup and drawer modes. In popup mode it won't trigger after a successful save, but in drawer mode it will. Consider adding the same triggerFromSave check in the drawer implementation to match the popup behavior.
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.

Copy link

codecov bot commented Nov 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (44da935) to head (891acca).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4757   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          620       620           
  Lines        27390     27407   +17     
  Branches      3921      3923    +2     
=========================================
+ Hits         27390     27407   +17     

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

@ArgoZhang ArgoZhang merged commit 40a1418 into main Nov 29, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-table branch November 29, 2024 05:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

How to check if Table is in Edit Mode / OnCancelSave callback?
1 participant