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

fix(Widget): throw exception when dispose #4665

Merged
merged 2 commits into from
Nov 15, 2024
Merged

fix(Widget): throw exception when dispose #4665

merged 2 commits into from
Nov 15, 2024

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Nov 15, 2024

throw exception when dispose

Summary of the changes (Less than 80 chars)

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

Description

fixes #4664

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:

  • Fix the dispose function in DropdownWidget to properly remove event listeners by checking if the element exists before attempting to remove events.

@bb-auto bb-auto bot added the bug Something isn't working label Nov 15, 2024
Copy link

sourcery-ai bot commented Nov 15, 2024

Reviewer's Guide by Sourcery

The PR improves the dispose functionality in the DropdownWidget component by adding proper event handler cleanup and null checks. The changes ensure that both 'shown' and 'hidden' dropdown events are properly unsubscribed when the component is disposed.

Sequence diagram for DropdownWidget dispose process

sequenceDiagram
    participant User
    participant DropdownWidget
    participant EventHandler

    User->>DropdownWidget: Call dispose(id)
    DropdownWidget->>DropdownWidget: Get element by id
    alt Element exists
        DropdownWidget->>EventHandler: off(el, 'shown.bs.dropdown')
        DropdownWidget->>EventHandler: off(el, 'hidden.bs.dropdown')
    end
Loading

File-Level Changes

Change Details Files
Enhanced event handler cleanup in dispose function
  • Added null check for element before cleanup
  • Added cleanup for 'shown.bs.dropdown' event
  • Maintained cleanup for 'hidden.bs.dropdown' event
  • Added element retrieval by ID
src/BootstrapBlazor/Components/DropdownWidget/DropdownWidget.razor.js
src/BootstrapBlazor/BootstrapBlazor.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#4664 Fix exception thrown when disposing DropdownWidget component

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 this to the v9.0.0 milestone Nov 15, 2024
@ArgoZhang ArgoZhang enabled auto-merge (squash) November 15, 2024 07:41
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 PR title is misleading - the changes prevent exceptions rather than throwing them. Please update it to something like 'fix(Widget): prevent exceptions during disposal' or similar.
  • Please complete the PR template fully in English to help with project tracking and maintenance. Several sections are currently incomplete or in Chinese.
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 Nov 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (525eaac) to head (a4a439a).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4665   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          620       620           
  Lines        27427     27427           
  Branches      3929      3929           
=========================================
  Hits         27427     27427           

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

@ArgoZhang ArgoZhang merged commit ccd3bdb into main Nov 15, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the fix-widget branch November 15, 2024 07:43
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(Widget): throw exception when dispose
1 participant