Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 1, 2025

use FrozenDictionary improve performance

Summary of the changes (Less than 80 chars)

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

Description

fixes #5007

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

Improve performance by using FrozenDictionary for icon themes in .NET 8 and later.

New Features:

  • Introduce FontAwesomeIcons class to store icon theme mapping.

Enhancements:

  • Use FrozenDictionary to store icon themes for improved performance.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 1, 2025

Reviewer's Guide by Sourcery

This pull request improves performance by using FrozenDictionary to store icon themes when running on .NET 8 or higher.

Class diagram showing IconTheme changes for .NET 8

classDiagram
    class IIconTheme {
        <<interface>>
        +GetIcons() Dictionary~ComponentIcons, string~
        +GetIcons() FrozenDictionary~ComponentIcons, string~
    }
    class DefaultIconTheme {
        -IOptions~IconThemeOptions~ _options
        +GetIcons() Dictionary~ComponentIcons, string~
        +GetIcons() FrozenDictionary~ComponentIcons, string~
    }
    class IconThemeOptions {
        +Icons Dictionary~string, Dictionary~ComponentIcons, string~~
        +Icons FrozenDictionary~string, FrozenDictionary~ComponentIcons, string~~
        +ThemeKey string
    }
    class FontAwesomeIcons {
        +Icons Dictionary~ComponentIcons, string~
        +ToFrozenDictionary() FrozenDictionary~ComponentIcons, string~
    }
    IIconTheme <|.. DefaultIconTheme
    DefaultIconTheme --> IconThemeOptions
    IconThemeOptions --> FontAwesomeIcons
    note for IconThemeOptions "Uses FrozenDictionary in .NET 8+"
    note for DefaultIconTheme "Implements both Dictionary and FrozenDictionary versions"
Loading

State diagram showing IconTheme initialization flow

stateDiagram-v2
    [*] --> InitializeIconTheme
    InitializeIconTheme --> CheckDotNetVersion
    CheckDotNetVersion --> NET8: if .NET 8+
    CheckDotNetVersion --> OlderVersion: if < .NET 8
    NET8 --> CreateFrozenDictionary
    OlderVersion --> CreateRegularDictionary
    CreateFrozenDictionary --> [*]
    CreateRegularDictionary --> [*]
    note right of NET8: Uses FrozenDictionary for better performance
    note right of OlderVersion: Uses regular Dictionary
Loading

File-Level Changes

Change Details Files
Replaced the usage of Dictionary with FrozenDictionary for storing icon themes.
  • Introduced preprocessor directives to conditionally use FrozenDictionary based on the .NET version.
  • Updated the Icons property and related methods to use FrozenDictionary when available.
  • Added a new FontAwesomeIcons class to store the default FontAwesome icons and provide a method to convert them to a FrozenDictionary.
src/BootstrapBlazor/Options/IconThemeOptions.cs
src/BootstrapBlazor/Services/DefaultIconTheme.cs
src/BootstrapBlazor/Services/IIconTheme.cs
Refactored the icon theme initialization logic.
  • Moved the FontAwesome icons definitions to a separate FontAwesomeIcons class.
  • Simplified the IconThemeOptions constructor by using the FontAwesomeIcons class.
  • Removed the explicit setting of the ThemeKey in the AddBootstrapBlazorServices method, relying on the default value set in the IconThemeOptions constructor.
src/BootstrapBlazor/Options/IconThemeOptions.cs
src/BootstrapBlazor/Extensions/BootstrapBlazorServiceCollectionExtensions.cs
src/BootstrapBlazor/Server/Extensions/ServiceCollectionSharedExtensions.cs
Added a new file for FontAwesome icons.
  • Created a new class FontAwesomeIcons to store the FontAwesome icon mappings.
  • Provided a method ToFrozenDictionary to convert the icon dictionary to a FrozenDictionary when running on .NET 8 or higher.
src/BootstrapBlazor/Options/FontAwesomeIcons.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5007 Use FrozenDictionary to improve performance

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

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.

@codecov
Copy link

codecov bot commented Jan 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (9a215d2) to head (ba8899c).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5008   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          630       631    +1     
  Lines        27928     27938   +10     
  Branches      3996      3998    +2     
=========================================
+ Hits         27928     27938   +10     

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

@ArgoZhang ArgoZhang merged commit ffe9689 into main Jan 1, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-icon branch January 1, 2025 04:11
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(IIconTheme): use FrozenDictionary improve performance

2 participants