Skip to content

doc(IOptions): use IOptions improve performance #6485

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 5 commits into from
Jul 24, 2025
Merged

Conversation

ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jul 24, 2025

Link issues

fixes #6484

Summary By Copilot

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

Switch configuration injection from IOptionsMonitor to IOptions to reduce overhead and improve performance across server components

Bug Fixes:

Enhancements:

  • Replace IOptionsMonitor and IOptionsMonitor with IOptions<> in all razor components, pages, services, and extension methods
  • Update all WebsiteOption.CurrentValue references to use WebsiteOption.Value consistently
  • Simplify request localization setup by removing OnChange callbacks and using IOptions value directly
  • Adjust WebsiteOptions class defaults and nullability: set AssetRootPath and JSModuleRootPath to absolute paths, remove obsolete TotalCount property, make QQGroup links non-nullable, and streamline GetAssetUrl signature

@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Jul 24, 2025
Copy link
Contributor

sourcery-ai bot commented Jul 24, 2025

Reviewer's Guide

This PR migrates configuration usage from IOptionsMonitor to IOptions across the server project to reduce runtime monitoring overhead, refactors the WebsiteOptions class to enforce non-null defaults and simplify path handling, and streamlines the request localization setup by dropping change callbacks and directly using the new IOptions API.

Sequence diagram for configuration value access with IOptions (after PR)

sequenceDiagram
    participant RazorComponent
    participant IOptions as IOptions<WebsiteOptions>
    participant WebsiteOptions
    RazorComponent->>IOptions: Access Value property
    IOptions-->>RazorComponent: WebsiteOptions instance
    RazorComponent->>WebsiteOptions: Call GetAssetUrl(url)
    WebsiteOptions-->>RazorComponent: Asset URL string
Loading

Class diagram for updated WebsiteOptions and related configuration usage

classDiagram
    class WebsiteOptions {
        +string ServerUrl
        +string AdminUrl
        +string AdminProUrl
        +string BootstrapAdminLink
        +string GiteeRepositoryUrl
        +string VideoLibUrl
        +string GithubRepositoryUrl
        +string WikiUrl
        +string QQGroup1Link
        +string QQGroup2Link
        +string? WebRootPath
        +string? ContentRootPath
        +string AssetRootPath = "/"
        +string JSModuleRootPath = "/Components/"
        +string VideoUrl
        +string CurrentTheme
        +string GetAssetUrl(string url)
        +string GetAvatarUrl(string id)
        +IDictionary<string, string> Videos
        +IList<Theme> Themes
        +IDictionary<string, string> Links
    }

    class IOptions~T~ {
        +T Value
    }

    WebsiteOptions <|-- IOptions~WebsiteOptions~ : used by
    class IOptionsMonitor~T~ {
        +T CurrentValue
        +void OnChange(Action<T>)
    }
    %% IOptionsMonitor was replaced by IOptions in the codebase
    note for IOptions~WebsiteOptions~ "Now used for dependency injection instead of IOptionsMonitor"
    note for WebsiteOptions "Refactored: non-nullable properties, default values, simplified path handling"
Loading

File-Level Changes

Change Details Files
Replace IOptionsMonitor with IOptions for configuration injection
  • Changed all Razor and code-behind injections from IOptionsMonitor to IOptions
  • Replaced .CurrentValue accesses with .Value across components, layouts, samples, and controllers
  • Updated service registrations and controllers to consume IOptions rather than IOptionsMonitor
src/BootstrapBlazor.Server/Components/Samples/Carousels.razor
src/BootstrapBlazor.Server/Components/Samples/Avatars.razor
src/BootstrapBlazor.Server/Components/Samples/ImageViewers.razor
src/BootstrapBlazor.Server/Components/Samples/AutoFills.razor
src/BootstrapBlazor.Server/Components/Samples/Logouts.razor
src/BootstrapBlazor.Server/Components/Samples/LinkButtons.razor
src/BootstrapBlazor.Server/Components/Samples/Menus.razor
src/BootstrapBlazor.Server/Components/Samples/MouseFollowers.razor
src/BootstrapBlazor.Server/Components/Samples/Tutorials/Admin.razor
src/BootstrapBlazor.Server/Components/Samples/Tutorials/MFA/TwoFactor.razor
src/BootstrapBlazor.Server/Components/Samples/UploadButtons.razor
src/BootstrapBlazor.Server/Components/Components/ThemeChooser.razor
src/BootstrapBlazor.Server/Components/Layout/HomeLayout.razor
src/BootstrapBlazor.Server/Components/Layout/PageLayout.razor
src/BootstrapBlazor.Server/Components/Pages/Localization.razor
src/BootstrapBlazor.Server/Components/Pages/Install.razor
src/BootstrapBlazor.Server/Components/Pages/Introduction.razor.cs
src/BootstrapBlazor.Server/Controllers/Api/CodeController.cs
Refactor WebsiteOptions defaults and types
  • Removed nullable annotations and the obsolete TotalCount property
  • Changed default AssetRootPath and JSModuleRootPath from './' to '/'
  • Updated GetAssetUrl method to return a non-nullable string and removed inline expression
src/BootstrapBlazor.Server/Data/WebsiteOptions.cs
Simplify request localization configuration
  • Switched AddRequestLocalization to use IOptions instead of the monitor
  • Removed OnChange callbacks and directly set SupportedCultures using options.Value
  • Updated both startup extension and inline page setup to the new pattern
src/BootstrapBlazor.Server/Extensions/ServiceCollectionExtensions.cs
src/BootstrapBlazor.Server/Components/Pages/Localization.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#6484 Update documentation and sample code to use IOptions instead of IOptionsMonitor for dependency injection of WebsiteOptions and BootstrapBlazorOptions.
#6484 Ensure all code samples and related documentation reflect the use of IOptions (including constructor and method signatures, property accesses, and usage patterns) instead of IOptionsMonitor.

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!

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 9.8.0 milestone Jul 24, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jul 24, 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 and they look great!

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `src/BootstrapBlazor.Server/Components/Samples/Table/TablesColumnResizing.razor.cs:37` </location>
<code_context>
         IEnumerable<Foo> items = Items;
         // 过滤
         var isFiltered = false;
-        if (options.Filters.Any())
+        if (options.Filters.Count != 0)
         {
             items = items.Where(options.Filters.GetFilterFunc<Foo>());
</code_context>

<issue_to_address>
Changed filter check from Any() to Count != 0, which may affect performance or semantics.

Count != 0 may be less efficient and less clear than Any() for some collections. Prefer Any() unless there's a specific need for Count.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
        if (options.Filters.Count != 0)
=======
        if (options.Filters.Any())
>>>>>>> REPLACE

</suggested_fix>

### Comment 2
<location> `src/BootstrapBlazor.Server/Components/Samples/Carousels.razor:33` </location>
<code_context>
-            <img src="@WebsiteOption.CurrentValue.GetAssetUrl("images/Pic1.jpg")" alt="demo-image" />
+            <img src="@WebsiteOption.Value.GetAssetUrl("images/Pic1.jpg")" alt="demo-image" />
         </CarouselItem>
         <CarouselItem Caption="Thrid slide label">
-            <img src="@WebsiteOption.CurrentValue.GetAssetUrl("images/Pic2.jpg")" alt="demo-image" />
+            <img src="@WebsiteOption.Value.GetAssetUrl("images/Pic2.jpg")" alt="demo-image" />
</code_context>

<issue_to_address>
Typo in 'Thrid slide label' should be 'Third slide label'.

Please correct the typo in the caption from 'Thrid' to 'Third'.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
        <CarouselItem Caption="Thrid slide label">
            <img src="@WebsiteOption.Value.GetAssetUrl("images/Pic2.jpg")" alt="demo-image" />
        </CarouselItem>
=======
        <CarouselItem Caption="Third slide label">
            <img src="@WebsiteOption.Value.GetAssetUrl("images/Pic2.jpg")" alt="demo-image" />
        </CarouselItem>
>>>>>>> REPLACE

</suggested_fix>

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 Jul 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (981fd03) to head (0272bf8).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6485   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          714       714           
  Lines        31383     31383           
  Branches      4431      4431           
=========================================
  Hits         31383     31383           
Flag Coverage Δ
BB 100.00% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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 ArgoZhang merged commit 967b5ca into main Jul 24, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the refactor-options branch July 24, 2025 04:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc(IOptions): use IOptions instead of IOptionsMonitor
1 participant