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

bug(EditDialog): trigger OnCloseAsync callback twice #4787

Merged
merged 16 commits into from
Dec 5, 2024

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Dec 4, 2024

trigger OnCloseAsync callback twice

Summary of the changes (Less than 80 chars)

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

Description

fixes #4786

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

Fix the bug causing the OnCloseAsync callback to be triggered twice in the EditDialog component and update related unit tests to ensure correct behavior.

Bug Fixes:

  • Fix the issue where the OnCloseAsync callback was triggered twice in the EditDialog component.

Tests:

  • Update unit tests to reflect changes in the EditDialog component, ensuring the OnCloseAsync callback is not triggered twice.

@bb-auto bb-auto bot added the bug Something isn't working label Dec 4, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Dec 4, 2024
Copy link

sourcery-ai bot commented Dec 4, 2024

Reviewer's Guide by Sourcery

This PR fixes an issue where the OnCloseAsync callback was being triggered twice in the EditDialog component. The implementation changes how the OnCloseAsync callback is handled by moving it from the parameter collection to a separate explicit assignment, and updates the related unit tests to use proper button click events instead of direct callback invocations.

Sequence diagram for OnCloseAsync callback handling in EditDialog

sequenceDiagram
    participant User
    participant Button
    participant EditDialog
    participant DrawerService

    User->>Button: Click
    Button->>DrawerService: ShowEditDrawer
    DrawerService->>EditDialog: CreateComponent with OnCloseAsync
    EditDialog->>EditDialog: Handle OnCloseAsync
    EditDialog-->>DrawerService: Return control
    DrawerService-->>User: Display EditDialog
Loading

File-Level Changes

Change Details Files
Changed how OnCloseAsync callback is handled in EditDialog component
  • Removed OnCloseAsync from the default parameter collection
  • Added explicit OnCloseAsync parameter assignment when showing edit drawer
  • Updated parameter handling to prevent double triggering of close callback
src/BootstrapBlazor/Extensions/DrawerExtensions.cs
src/BootstrapBlazor/Extensions/TableEditDialogOptionExtensions.cs
Updated unit tests to use proper button click events
  • Replaced direct DialogCloseButton component access with button element selection
  • Updated button click event handling in tests
  • Removed direct OnClickWithoutRender callback invocations
  • Added assertions to verify OnClickWithoutRender is null where appropriate
test/UnitTest/Components/TableDrawerTest.cs
test/UnitTest/Components/TableTest.cs
test/UnitTest/Components/DialogTest.cs
Minor UI and documentation improvements
  • Updated layout structure in EditDialogs component
  • Enhanced localization text for better clarity
  • Removed unused JSRuntime injection
src/BootstrapBlazor.Shared/Components/Samples/EditDialogs.razor
src/BootstrapBlazor.Shared/Components/Components/CultureChooser.razor.cs
src/BootstrapBlazor.Shared/Locales/en-US.json
src/BootstrapBlazor.Shared/Locales/zh-CN.json

Assessment against linked issues

Issue Objective Addressed Explanation
#4786 Fix the issue where OnCloseAsync callback is triggered twice in EditDialog

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

sourcery-ai[bot]
sourcery-ai bot previously approved these changes Dec 4, 2024
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 and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 2 issues 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.

src/BootstrapBlazor/Components/Dialog/EditDialog.razor.cs Outdated Show resolved Hide resolved
src/BootstrapBlazor.Shared/Locales/en-US.json Show resolved Hide resolved
test/UnitTest/Components/DialogTest.cs Outdated Show resolved Hide resolved
Copy link

codecov bot commented Dec 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (2be3326) to head (7aaf032).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4787   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          620       620           
  Lines        27424     27425    +1     
  Branches      3925      3925           
=========================================
+ Hits         27424     27425    +1     

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

@ArgoZhang
Copy link
Collaborator Author

@sourcery-ai review

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 and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 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.

test/UnitTest/Components/TableTest.cs Show resolved Hide resolved
@ArgoZhang ArgoZhang merged commit 902e266 into main Dec 5, 2024
6 checks passed
@ArgoZhang ArgoZhang deleted the refactor-close-button branch December 5, 2024 00:44
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.

bug(EditDialog): trigger OnCloseAsync callback twice
1 participant