refactor(BootstrapBlazorRoot): support nested usage #5552

ArgoZhang · 2025-03-06T11:18:20Z

Link issues

fixes #5551
fixes #5526
[Please fill in the relevant Issue number after the # above, such as #42]
[请在上方 # 后面填写相关 Issue 编号，如 #42]

Summary By Copilot

This pull request includes several changes to the BootstrapBlazor project, focusing on version updates, code comments, and the BootstrapBlazorRootRegisterService class. The most important changes include updating the project version, modifying method comments for consistency, and altering the behavior of the Subscribe and Unsubscribe methods in the BootstrapBlazorRootRegisterService class.

Version update:

src/BootstrapBlazor/BootstrapBlazor.csproj: Updated the project version from 9.4.7-beta04 to 9.4.7.

Code comments:

src/BootstrapBlazor/Services/BootstrapBlazorRootRegisterService.cs: Standardized the comments for methods such as AddProvider, RemoveProvider, GetProviders, Subscribe, and Unsubscribe to start with an uppercase letter. [1] [2] [3] [4]

Behavior changes in BootstrapBlazorRootRegisterService:

src/BootstrapBlazor/Services/BootstrapBlazorRootRegisterService.cs: Modified the Subscribe method to return early instead of throwing an InvalidOperationException if a subscriber already exists.
src/BootstrapBlazor/Services/BootstrapBlazorRootRegisterService.cs: Simplified the Unsubscribe method by removing the check and exception throw for already unsubscribed identifiers.

Test updates:

test/UnitTest/Services/BootstrapBlazorRootRegisterServiceTest.cs: Removed the tests that checked for exceptions in the Subscribe and Unsubscribe methods, as these methods no longer throw exceptions.

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

Updates the BootstrapBlazorRootRegisterService to support nested usage by modifying the Subscribe and Unsubscribe methods to prevent exceptions when a subscriber already exists or is already unsubscribed.

Enhancements:

Updates the Subscribe method to return early instead of throwing an InvalidOperationException if a subscriber already exists.
Simplifies the Unsubscribe method by removing the check and exception throw for already unsubscribed identifiers.
Standardizes the comments for methods such as AddProvider, RemoveProvider, GetProviders, Subscribe, and Unsubscribe to start with an uppercase letter.
Updates the project version to 9.4.7.
Removes the tests that checked for exceptions in the Subscribe and Unsubscribe methods, as these methods no longer throw exceptions.
Fixes issue where nested components were not working correctly.

sourcery-ai · 2025-03-06T11:18:41Z

Reviewer's Guide by Sourcery

This pull request refactors the BootstrapBlazorRootRegisterService to support nested usage by preventing exceptions when subscribing or unsubscribing. It also updates the project version and standardizes method comments.

Sequence diagram for Subscribe method

sequenceDiagram
  participant Service as BootstrapBlazorRootRegisterService
  participant Subscriber as BootstrapBlazorRootOutlet

  Subscriber->>Service: Subscribe(identifier, subscriber)
  Service->>Service: Check if subscriber exists for identifier
  alt Subscriber already exists
    Service-->>Subscriber: Return early
  else Subscriber does not exist
    Service->>Service: Add subscriber to _subscribersByIdentifier
    Service-->>Subscriber: Return
  end

Sequence diagram for Unsubscribe method

sequenceDiagram
  participant Service as BootstrapBlazorRootRegisterService
  participant Subscriber as BootstrapBlazorRootOutlet

  Subscriber->>Service: Unsubscribe(identifier)
  Service->>Service: Remove subscriber from _subscribersByIdentifier
  Service-->>Subscriber: Return

File-Level Changes

Change	Details	Files
Updated the project version to the release version.	Updated the project version from `9.4.7-beta04` to `9.4.7`.	`src/BootstrapBlazor/BootstrapBlazor.csproj`
Standardized method comments to start with an uppercase letter.	Updated the comments for `AddProvider` to start with an uppercase letter. Updated the comments for `RemoveProvider` to start with an uppercase letter. Updated the comments for `GetProviders` to start with an uppercase letter. Updated the comments for `Subscribe` to start with an uppercase letter. Updated the comments for `Unsubscribe` to start with an uppercase letter.	`src/BootstrapBlazor/Services/BootstrapBlazorRootRegisterService.cs`
Modified the behavior of the `Subscribe` and `Unsubscribe` methods in `BootstrapBlazorRootRegisterService` to prevent exceptions.	Modified the `Subscribe` method to return early if a subscriber already exists, instead of throwing an exception. Simplified the `Unsubscribe` method by removing the check and exception throw for already unsubscribed identifiers.	`src/BootstrapBlazor/Services/BootstrapBlazorRootRegisterService.cs`
Removed exception checks from the unit tests for the `Subscribe` and `Unsubscribe` methods.	Removed the tests that checked for exceptions in the `Subscribe` method, as it no longer throws exceptions. Removed the tests that checked for exceptions in the `Unsubscribe` method, as it no longer throws exceptions.	`test/UnitTest/Services/BootstrapBlazorRootRegisterServiceTest.cs`

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#5551	Support nested usage of BootstrapBlazorRoot components.	✅

Possibly linked issues

refactor(BootstrapBlazorRoot): support nested usage #5551: The PR fixes the issue by updating the Subscribe method to prevent multiple event handler registrations.

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 logging to the Subscribe and Unsubscribe methods to help diagnose issues in production.
The changes to Subscribe and Unsubscribe methods simplify the code, but make sure this doesn't hide potential issues.

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/Services/BootstrapBlazorRootRegisterServiceTest.cs

codecov · 2025-03-06T11:21:40Z

Codecov Report

Attention: Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.

Please upload report for BASE (main@d7e68cd). Learn more about missing BASE report.
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
...zor/Services/BootstrapBlazorRootRegisterService.cs	50.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5552   +/-   ##
=======================================
  Coverage        ?   99.98%           
=======================================
  Files           ?      649           
  Lines           ?    29605           
  Branches        ?     4172           
=======================================
  Hits            ?    29602           
  Misses          ?        2           
  Partials        ?        1

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

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

ArgoZhang added 4 commits March 6, 2025 19:14

refactor: 兼容 Root 多层嵌套

1c0080d

test: 更新单元测试

541b692

doc: 更新注释

ca6eef7

chore: bump version 9.4.7

a718324

bb-auto bot assigned ArgoZhang Mar 6, 2025

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

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

sourcery-ai bot approved these changes Mar 6, 2025

View reviewed changes

test/UnitTest/Services/BootstrapBlazorRootRegisterServiceTest.cs Show resolved Hide resolved

ArgoZhang merged commit 8c86ed9 into main Mar 6, 2025
5 checks passed

ArgoZhang deleted the refactor-root branch March 6, 2025 11:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

refactor(BootstrapBlazorRoot): support nested usage #5552

refactor(BootstrapBlazorRoot): support nested usage #5552

ArgoZhang commented Mar 6, 2025 •

edited

Loading

Uh oh!

sourcery-ai bot commented Mar 6, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

Uh oh!

codecov bot commented Mar 6, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

refactor(BootstrapBlazorRoot): support nested usage #5552

refactor(BootstrapBlazorRoot): support nested usage #5552

Conversation

ArgoZhang commented Mar 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Link issues

Summary By Copilot

Regression?

Risk

Verification

Packaging changes reviewed?

☑️ Self Check before Merge

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Mar 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

Sequence diagram for Subscribe method

Sequence diagram for Unsubscribe method

File-Level Changes

Assessment against linked issues

Possibly linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov bot commented Mar 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ArgoZhang commented Mar 6, 2025 •

edited

Loading

sourcery-ai bot commented Mar 6, 2025 •

edited

Loading

codecov bot commented Mar 6, 2025 •

edited

Loading