Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 20, 2025

add DisableGetLocalizerFromService parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #5163

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

Add a DisableGetLocalizerFromService parameter to JsonLocalizationOptions to control whether to get localized strings from the injected service.

New Features:

  • Added a DisableGetLocalizerFromService parameter to JsonLocalizationOptions.
  • Added a DisableGetLocalizerFromResourceManager parameter to JsonLocalizationOptions.

Tests:

  • Added unit tests for the new parameters.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 20, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new DisableGetLocalizerFromService parameter to JsonLocalizationOptions, allowing users to disable the retrieval of localized strings from services. It also adds a DisableGetLocalizerFromResourceManager parameter to disable the retrieval of localized strings from resource managers.

Sequence diagram for string localization with new control options

sequenceDiagram
    participant C as Client
    participant JSL as JsonStringLocalizer
    participant S as Service
    participant RM as ResourceManager
    participant J as JSON Files

    C->>JSL: GetStringSafely(name)
    alt DisableGetLocalizerFromService is false
        JSL->>S: GetStringFromService(name)
        S-->>JSL: localized string
    end
    alt DisableGetLocalizerFromResourceManager is false
        JSL->>RM: GetStringFromResourceManager(name)
        RM-->>JSL: localized string
    end
    JSL->>J: GetStringFromJson(name)
    J-->>JSL: localized string
    JSL-->>C: final localized string
Loading

Class diagram showing changes to JsonLocalizationOptions and BootstrapBlazorOptions

classDiagram
    class JsonLocalizationOptions {
        +bool DisableGetLocalizerFromService
        +bool DisableGetLocalizerFromResourceManager
        +bool UseKeyWhenValueIsNull
        +bool IgnoreLocalizerMissing
    }

    class BootstrapBlazorOptions {
        +bool? DisableGetLocalizerFromService
        +bool? DisableGetLocalizerFromResourceManager
        +bool? IgnoreLocalizerMissing
    }

    JsonLocalizationOptions --|> LocalizationOptions
    note for JsonLocalizationOptions "Added new options for controlling
localizer behavior"
Loading

Flow diagram for string localization process

flowchart TD
    A[Get String Request] --> B{DisableGetLocalizerFromService?}
    B -->|No| C[Try Service]
    B -->|Yes| D{DisableGetLocalizerFromResourceManager?}
    C -->|Not Found| D
    D -->|No| E[Try Resource Manager]
    D -->|Yes| F[Try JSON Files]
    E -->|Not Found| F
    F -->|Not Found| G[Return null]
    F -->|Found| H[Return String]
    E -->|Found| H
    C -->|Found| H
Loading

File-Level Changes

Change Details Files
Added DisableGetLocalizerFromService and DisableGetLocalizerFromResourceManager parameters to JsonLocalizationOptions.
  • Added DisableGetLocalizerFromService property to JsonLocalizationOptions.
  • Added DisableGetLocalizerFromResourceManager property to JsonLocalizationOptions.
  • Added DisableGetLocalizerFromService property to BootstrapBlazorOptions.
  • Added DisableGetLocalizerFromResourceManager property to BootstrapBlazorOptions.
src/BootstrapBlazor/Localization/Json/JsonLocalizationOptions.cs
src/BootstrapBlazor/Options/BootstrapBlazorOptions.cs
Modified JsonStringLocalizer to use the new JsonLocalizationOptions parameters.
  • Modified the constructor to accept JsonLocalizationOptions instead of ignoreLocalizerMissing.
  • Updated GetStringFromService to check DisableGetLocalizerFromService before attempting to get a string from a service.
  • Updated GetStringFromResourceManager to check DisableGetLocalizerFromResourceManager before attempting to get a string from a resource manager.
  • Updated GetStringSafely to use GetStringFromResourceManager instead of GetStringSafely(name, null).
  • Updated HandleMissingResourceItem to check IgnoreLocalizerMissing from JsonLocalizationOptions.
  • Updated GetAllStringsFromService to check DisableGetLocalizerFromService before attempting to get all strings from a service.
  • Updated GetAllStringsFromBase to check DisableGetLocalizerFromResourceManager before attempting to get all strings from a resource manager.
src/BootstrapBlazor/Localization/Json/JsonStringLocalizer.cs
Modified JsonStringLocalizerFactory to use the new JsonLocalizationOptions parameters.
  • Modified the constructor to accept IOptions<BootstrapBlazorOptions> instead of IOptionsMonitor<BootstrapBlazorOptions>.
  • Modified the constructor to store JsonLocalizationOptions and ILocalizationMissingItemHandler as readonly fields.
  • Modified the constructor to get IgnoreLocalizerMissing, DisableGetLocalizerFromService, and DisableGetLocalizerFromResourceManager from BootstrapBlazorOptions.
  • Modified CreateResourceManagerStringLocalizer to pass JsonLocalizationOptions to JsonStringLocalizer.
src/BootstrapBlazor/Localization/Json/JsonStringLocalizerFactory.cs
Added a new unit test to verify the DisableGetLocalizerFromResourceManager functionality.
  • Added DisableGetLocalizerFromResourceManager_Ok test method to verify the DisableGetLocalizerFromResourceManager functionality.
test/UnitTest/Localization/JsonStringLocalizerTest.cs
Updated the default configuration in appsettings.json.
  • Set DisableGetLocalizerFromService to true.
  • Set DisableGetLocalizerFromResourceManager to true.
src/BootstrapBlazor.Server/appsettings.json

Assessment against linked issues

Issue Objective Addressed Explanation
#5163 Add DisableGetLocalizerFromService parameter to JsonLocalizationOptions

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 20, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 20, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jan 20, 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: 1 issue found
  • 🟡 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 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (e0f6516) to head (60afbb4).
Report is 1 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main     #5164      +/-   ##
===========================================
+ Coverage   99.98%   100.00%   +0.01%     
===========================================
  Files         634       634              
  Lines       28122     28145      +23     
  Branches     4043      4049       +6     
===========================================
+ Hits        28118     28145      +27     
+ Misses          4         0       -4     

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

@ArgoZhang ArgoZhang merged commit de1b5b1 into main Jan 20, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-opitons branch January 20, 2025 12:27
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(JsonLocalizationOptions): add DisableGetLocalizerFromService parameter

2 participants