Skip to content

perf(PopConfirmButton): remove dismiss event handler to improve performance #5453

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 4 commits into from
Feb 27, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Feb 27, 2025

remove dismiss event handler to improve performance

Summary of the changes (Less than 80 chars)

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

Description

fixes #5444

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

Bug Fixes:

  • Fixes an issue where the dismiss event handler on the PopConfirmButton was causing performance problems.

Copy link
Contributor

sourcery-ai bot commented Feb 27, 2025

Reviewer's Guide by Sourcery

This pull request removes the dismiss event handler from the PopConfirmButton component to improve performance. It also removes redundant methods and directly calls the event callbacks.

Sequence diagram for PopConfirmButton confirmation before and after

sequenceDiagram
    actor User
    participant PopConfirmButton
    participant PopConfirmButtonContent
    participant bootstrap.Popover

    alt Before
        User->PopConfirmButton: Click button
        PopConfirmButton->bootstrap.Popover: Show popover
        User->PopConfirmButtonContent: Click Confirm
        PopConfirmButtonContent->PopConfirmButtonContent: TriggerConfirmAsync()
        PopConfirmButtonContent->PopConfirmButtonContent: InvokeVoidAsync("hide", Id)
        PopConfirmButtonContent->PopConfirmButtonContent: OnConfirmClick()
        PopConfirmButtonContent->PopConfirmButton: await OnConfirm()
        PopConfirmButton->bootstrap.Popover: hide()
    else After
        User->PopConfirmButton: Click button
        PopConfirmButton->bootstrap.Popover: Show popover
        User->PopConfirmButtonContent: Click Confirm
        PopConfirmButtonContent->PopConfirmButtonContent: OnConfirmClick()
        PopConfirmButtonContent->PopConfirmButtonContent: InvokeVoidAsync("hide", Id)
        PopConfirmButtonContent->PopConfirmButton: await OnConfirm()
        PopConfirmButton->bootstrap.Popover: hide()
    end
Loading

Sequence diagram for PopConfirmButton closing before and after

sequenceDiagram
    actor User
    participant PopConfirmButton
    participant PopConfirmButtonContent
    participant bootstrap.Popover

    alt Before
        User->PopConfirmButton: Click button
        PopConfirmButton->bootstrap.Popover: Show popover
        User->PopConfirmButtonContent: Click Close
        PopConfirmButtonContent->PopConfirmButtonContent: TriggerCloseAsync()
        PopConfirmButtonContent->PopConfirmButtonContent: InvokeVoidAsync("hide", Id)
        PopConfirmButtonContent->PopConfirmButtonContent: OnCloseClick()
        PopConfirmButtonContent->PopConfirmButton: await OnClose()
        PopConfirmButton->bootstrap.Popover: hide()
    else After
        User->PopConfirmButton: Click button
        PopConfirmButton->bootstrap.Popover: Show popover
        User->PopConfirmButtonContent: Click Close
        PopConfirmButtonContent->PopConfirmButtonContent: OnCloseClick()
        PopConfirmButtonContent->PopConfirmButtonContent: InvokeVoidAsync("hide", Id)
        PopConfirmButtonContent->PopConfirmButton: await OnClose()
        PopConfirmButton->bootstrap.Popover: hide()
    end
Loading

File-Level Changes

Change Details Files
Removed the dismiss event handler to improve performance.
  • Removed the dismiss property from the config object.
  • Removed the dismissHandler function.
  • Removed the event listener for the click event on the document.
  • Removed the code that disposes of the dismiss event handler.
src/BootstrapBlazor/Components/Button/PopConfirmButton.razor.js
Removed redundant methods and directly call the event callbacks.
  • Removed the TriggerCloseAsync method.
  • Removed the TriggerConfirmAsync method.
  • Directly call OnCloseClick and OnConfirmClick methods in the CascadingValue components.
src/BootstrapBlazor/Components/Button/PopConfirmButtonContent.razor.cs
src/BootstrapBlazor/Components/Button/PopConfirmButtonContent.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#5444 Improve the performance of the PopoverConfirm component when used in tables with many rows, specifically addressing the slow response time (approximately 1 second delay) observed on mouse clicks anywhere on the page.

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 bug Something isn't working label Feb 27, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Feb 27, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Feb 27, 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:

  • The removal of the dismiss handler looks good, but I'm not sure about passing the OnCloseClick and OnConfirmClick methods as cascading values - can these be simplified?
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 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 Feb 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (4a2f5bb) to head (46573fa).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5453   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          646       646           
  Lines        29352     29346    -6     
  Branches      4129      4129           
=========================================
- Hits         29352     29346    -6     

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

@ArgoZhang ArgoZhang added enhancement New feature or request and removed bug Something isn't working labels Feb 27, 2025
@ArgoZhang ArgoZhang merged commit c174ff7 into main Feb 27, 2025
3 checks passed
@ArgoZhang ArgoZhang deleted the fix-pop branch February 27, 2025 00:24
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.

perf(PopoverConfirm): 组件界面元素多的时候 JS 有性能问题
1 participant