Skip to content

feat(IThemeProvider): add TriggerThemeChanged method #5707

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 3 commits into from
Mar 25, 2025
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Mar 25, 2025

Link issues

fixes #5706

Summary By Copilot

This pull request focuses on refactoring the theme management logic in the BootstrapBlazor services. The most important changes include removing the asynchronous callback invocation from the SetThemeAsync method and introducing a new method to trigger the theme changed event.

Refactoring theme management:

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

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

Enhancements:

  • Remove the asynchronous callback invocation from the SetThemeAsync method and introduce a new method to trigger the theme changed event.

Copy link
Contributor

sourcery-ai bot commented Mar 25, 2025

Reviewer's Guide by Sourcery

This pull request refactors the theme management logic by decoupling the SetThemeAsync method from directly invoking the ThemeChangedAsync event. A new TriggerThemeChanged method was introduced to explicitly trigger the theme change event.

Sequence diagram for setting and triggering theme change

sequenceDiagram
    participant Client
    participant DefaultThemeProvider
    participant jsRuntime

    Client->>DefaultThemeProvider: SetThemeAsync(themeName)
    DefaultThemeProvider->>jsRuntime: LoadUtility()
    jsRuntime-->>DefaultThemeProvider: module
    DefaultThemeProvider->>module: SetThemeAsync(themeName)
    module-->>DefaultThemeProvider: 
    DefaultThemeProvider->>DefaultThemeProvider: TriggerThemeChanged(themeName)
    DefaultThemeProvider->>Client: ThemeChangedAsync(themeName)
Loading

File-Level Changes

Change Details Files
Decoupled the SetThemeAsync method from directly invoking the ThemeChangedAsync event and introduced a TriggerThemeChanged method to explicitly trigger the theme change event.
  • Removed the asynchronous callback invocation from the SetThemeAsync method.
  • Added a TriggerThemeChanged method to handle the theme change event.
  • Added the TriggerThemeChanged method to the IThemeProvider interface.
src/BootstrapBlazor/Services/DefaultThemeProvider.cs
src/BootstrapBlazor/Services/IThemeProvider.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5706 Add a TriggerThemeChanged method to the IThemeProvider interface.
#5706 Implement the TriggerThemeChanged method in the DefaultThemeProvider class.

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 enhancement New feature or request label Mar 25, 2025
@bb-auto bb-auto bot added this to the v9.4.0 milestone Mar 25, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Mar 25, 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:

  • Consider making TriggerThemeChanged async to avoid potential deadlocks if a callback attempts to synchronously acquire a lock.
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.

@ArgoZhang ArgoZhang merged commit 2713111 into main Mar 25, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the refactor-theme branch March 25, 2025 03:50
Copy link

codecov bot commented Mar 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (8860c4b) to head (0fe8fd0).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5707   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          657       657           
  Lines        29825     29824    -1     
  Branches      4226      4226           
=========================================
- Hits         29825     29824    -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.

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.

feat(IThemeProvider): add TriggerThemeChanged method
1 participant