refactor(BootstrapBlazorModule): use registerBootstrapBlazorModule refactor component #5497

ArgoZhang · 2025-03-03T02:04:54Z

Link issues

Summary By Copilot

This pull request includes several changes to the BootstrapBlazor components to improve the handling of popup close events and module registration. The most important changes include the introduction of the registerBootstrapBlazorModule utility function, refactoring of the event handling logic, and enhancements to the dispose functions for various components.

Improvements to module registration and event handling:

src/BootstrapBlazor/Components/Button/DialButton.razor.js: Introduced the registerBootstrapBlazorModule utility function to manage module registration and event handling for the DialButton component. [1] [2]
src/BootstrapBlazor/Components/Button/PopConfirmButton.razor.js: Refactored the init and dispose functions to use the registerBootstrapBlazorModule utility function for the PopConfirmButton component. [1] [2] [3]
src/BootstrapBlazor/Components/Button/SlideButton.razor.js: Updated the init and dispose functions to utilize the registerBootstrapBlazorModule utility function for the SlideButton component. [1] [2] [3]
src/BootstrapBlazor/wwwroot/modules/base-popover.js: Modified the Popover module to integrate the registerBootstrapBlazorModule utility function and improve event handling logic. [1] [2] [3] [4]

Enhancements to component disposal:

src/BootstrapBlazor/Components/Select/Select.razor.js: Enhanced the dispose function to properly dispose of the popover instance if it exists.

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

Refactors BootstrapBlazor components to use the registerBootstrapBlazorModule utility function for managing module registration and event handling, specifically for popup close events. This change improves the disposal of popover instances and ensures proper event handling across multiple components.

Enhancements:

Refactor components to use the registerBootstrapBlazorModule utility function for managing module registration and event handling.
Improve the disposal of popover instances to prevent memory leaks.
Enhance event handling logic for popup close events to ensure proper functionality across multiple components.

sourcery-ai · 2025-03-03T02:04:59Z

Reviewer's Guide by Sourcery

This pull request introduces the registerBootstrapBlazorModule utility function to streamline module registration and event handling across multiple BootstrapBlazor components. It refactors the event handling logic in DialButton, PopConfirmButton, SlideButton, and Popover components to use the new utility function. Additionally, it enhances the dispose functions for various components to properly dispose of resources and event listeners.

Updated class diagram for BootstrapBlazor module registration

classDiagram
  class BootstrapBlazor {
    <<static>> object register(string name, object module)
  }

  class Module {
    <<abstract>>
  }

  BootstrapBlazor -- Module : registers

File-Level Changes

Change	Details	Files
Introduces a utility function for managing module registration and disposal.	Adds a new function `registerBootstrapBlazorModule` to manage module registration and disposal. The utility function stores module initialization and disposal callbacks. The utility function ensures that callbacks are executed only once during initialization and disposal.	`src/BootstrapBlazor/wwwroot/modules/utility.js`
Refactors components to use the new module registration utility.	Updates the `DialButton` component to use the `registerBootstrapBlazorModule` utility function. Updates the `PopConfirmButton` component to use the `registerBootstrapBlazorModule` utility function. Updates the `SlideButton` component to use the `registerBootstrapBlazorModule` utility function. Updates the `Popover` module to use the `registerBootstrapBlazorModule` utility function. Removes the global `bb_confirm` and `bb_slide_button` variables. Removes the `hooked` property from the `AutoComplete` component.	`src/BootstrapBlazor/Components/AutoComplete/AutoComplete.razor.js` `src/BootstrapBlazor/Components/Button/PopConfirmButton.razor.js` `src/BootstrapBlazor/wwwroot/modules/base-popover.js` `src/BootstrapBlazor/Components/Button/DialButton.razor.js` `src/BootstrapBlazor/Components/Button/SlideButton.razor.js`
Enhances component disposal to properly dispose of resources.	The `dispose` function in `Select.razor.js` now disposes of the popover instance if it exists. The `Tooltip` component is updated to use the new utility function.	`src/BootstrapBlazor/Components/Select/Select.razor.js` `src/BootstrapBlazor/wwwroot/modules/utility.js`

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#5496	Refactor BootstrapBlazor components to use the `registerBootstrapBlazorModule` utility function.	✅

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

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

Consider adding a comment block to the registerBootstrapBlazorModule function explaining its purpose and usage.
It looks like you're manually managing a list of IDs, consider using a WeakSet instead.

Here's what I looked at during the review

🟡 General issues: 3 issues found
🟢 Security: all looks good
🟢 Testing: all looks good
🟡 Complexity: 1 issue 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.}

src/BootstrapBlazor/Components/Button/PopConfirmButton.razor.js

src/BootstrapBlazor/Components/Button/SlideButton.razor.js

src/BootstrapBlazor/Components/Button/DialButton.razor.js

src/BootstrapBlazor/Components/Button/SlideButton.razor.js

codecov · 2025-03-03T02:07:24Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d3f3b37) to head (6c0e762).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main     #5497   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          649       649           
  Lines        29563     29563           
  Branches      4165      4165           
=========================================
  Hits         29563     29563

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

ArgoZhang · 2025-03-03T03:22:32Z

@sourcery-ai review

sourcery-ai

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

The new module registration function looks good, but consider adding a check to prevent duplicate registrations for the same identifier.
It seems like the closePopup function is used in multiple components; consider creating a shared utility function for it.

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟢 Testing: all looks good
🟡 Complexity: 1 issue 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.}

src/BootstrapBlazor/wwwroot/modules/utility.js

ArgoZhang · 2025-03-03T03:35:52Z

@sourcery-ai review

sourcery-ai

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

The new module registration function looks good, but it's not clear how it handles multiple instances of the same component on a single page.
Consider adding a mechanism to automatically remove event listeners when a component is disposed to prevent memory leaks.

Here's what I looked at during the review

🟡 General issues: 3 issues 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.}

src/BootstrapBlazor/Components/AutoComplete/AutoComplete.razor.js

src/BootstrapBlazor/wwwroot/modules/utility.js

ArgoZhang · 2025-03-03T03:39:51Z

@sourcery-ai review

sourcery-ai

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

The new module registration function looks good, but consider adding a check to prevent duplicate registrations for the same identifier.
It seems like the registerBootstrapBlazorModule function could be improved by accepting a dispose callback to avoid having to call BootstrapBlazor.ComponentName.dispose in the dispose functions.

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟢 Testing: all looks good
🟡 Complexity: 1 issue 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.}

src/BootstrapBlazor/wwwroot/modules/base-popover.js

ArgoZhang added 4 commits March 2, 2025 18:15

refactor: 重构全局脚本

4182454

refactor: 增加销毁逻辑

f55e358

refactor: 重构脚本精简代码

2706b13

refactor: base-popover 重构代码

7dc648a

bb-auto bot assigned ArgoZhang Mar 3, 2025

bb-auto bot added the enhancement New feature or request label Mar 3, 2025

bb-auto bot added this to the v9.4.0 milestone Mar 3, 2025

sourcery-ai bot previously approved these changes Mar 3, 2025

View reviewed changes

ArgoZhang added 8 commits March 3, 2025 11:08

refactor: registerBootstrapBlazorModule 重构精简外面代码

744b516

refactor: 精简代码

1c17f9c

refactor: 精简代码

7174bda

refactor: 精简代码

a42af4c

refactor: 精简代码

27d62b6

refactor: 精简代码

301c65b

refactor: 精简代码

678ee72

refactor: 增加参数检查

8d9c2df

ArgoZhang dismissed sourcery-ai[bot]’s stale review via 8d9c2df March 3, 2025 03:20

sourcery-ai bot previously approved these changes Mar 3, 2025

View reviewed changes

src/BootstrapBlazor/wwwroot/modules/utility.js Show resolved Hide resolved

refactor: 精简代码

6c0e762

ArgoZhang dismissed sourcery-ai[bot]’s stale review via 6c0e762 March 3, 2025 03:35

sourcery-ai bot approved these changes Mar 3, 2025

View reviewed changes

src/BootstrapBlazor/Components/AutoComplete/AutoComplete.razor.js Show resolved Hide resolved

src/BootstrapBlazor/Components/AutoComplete/AutoComplete.razor.js Show resolved Hide resolved

src/BootstrapBlazor/wwwroot/modules/utility.js Show resolved Hide resolved

sourcery-ai bot approved these changes Mar 3, 2025

View reviewed changes

src/BootstrapBlazor/wwwroot/modules/base-popover.js Show resolved Hide resolved

ArgoZhang merged commit 98115a9 into main Mar 3, 2025
4 checks passed

ArgoZhang deleted the refactor-bb branch March 3, 2025 04:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(BootstrapBlazorModule): use registerBootstrapBlazorModule refactor component #5497

refactor(BootstrapBlazorModule): use registerBootstrapBlazorModule refactor component #5497

ArgoZhang commented Mar 3, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Mar 3, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

codecov bot commented Mar 3, 2025 •

edited

Loading

ArgoZhang commented Mar 3, 2025

sourcery-ai bot left a comment

ArgoZhang commented Mar 3, 2025

sourcery-ai bot left a comment

ArgoZhang commented Mar 3, 2025

sourcery-ai bot left a comment

refactor(BootstrapBlazorModule): use registerBootstrapBlazorModule refactor component #5497

refactor(BootstrapBlazorModule): use registerBootstrapBlazorModule refactor component #5497

Conversation

ArgoZhang commented Mar 3, 2025 • edited by sourcery-ai bot Loading

Link issues

Summary By Copilot

Improvements to module registration and event handling:

Enhancements to component disposal:

Regression?

Risk

Verification

Packaging changes reviewed?

☑️ Self Check before Merge

Summary by Sourcery

sourcery-ai bot commented Mar 3, 2025 • edited Loading

Reviewer's Guide by Sourcery

Updated class diagram for BootstrapBlazor module registration

File-Level Changes

Assessment against linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

Choose a reason for hiding this comment

codecov bot commented Mar 3, 2025 • edited Loading

Codecov Report

ArgoZhang commented Mar 3, 2025

sourcery-ai bot left a comment

Choose a reason for hiding this comment

ArgoZhang commented Mar 3, 2025

sourcery-ai bot left a comment

Choose a reason for hiding this comment

ArgoZhang commented Mar 3, 2025

sourcery-ai bot left a comment

Choose a reason for hiding this comment

ArgoZhang commented Mar 3, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Mar 3, 2025 •

edited

Loading

codecov bot commented Mar 3, 2025 •

edited

Loading