Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Feb 3, 2025

add LoadModuleByName extension method

Summary of the changes (Less than 80 chars)

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

Description

fixes #5285

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

Introduce the LoadModuleByName extension method to simplify loading JS modules.

New Features:

  • Add a LoadModuleByName extension method to the IJSRuntime that simplifies loading JavaScript modules by automatically constructing the module path.

Tests:

  • Update calls to LoadModule with LoadModuleByName across the project.

@bb-auto bb-auto bot added the enhancement New feature or request label Feb 3, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 3, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new extension method LoadModuleByName to simplify loading JavaScript modules by name. It also updates existing code to use this new method, reducing code duplication and improving maintainability.

Sequence diagram showing the simplified module loading process

sequenceDiagram
    participant Service as Service Class
    participant Extensions as JSModuleExtensions
    participant Runtime as IJSRuntime
    participant Module as JSModule
    Service->>Extensions: LoadModuleByName('moduleName')
    Extensions->>Extensions: Construct module path
    Note right of Extensions: ./_content/BootstrapBlazor/modules/{name}.js
    Extensions->>Runtime: LoadModule(fileName)
    Runtime-->>Service: JSModule instance
Loading

Class diagram showing the new LoadModuleByName extension method

classDiagram
    class JSModuleExtensions {
        +LoadUtility(IJSRuntime jsRuntime, string? version) Task~JSModule~
        +LoadModuleByName(IJSRuntime jsRuntime, string moduleName, string? version) Task~JSModule~
        +LoadModule(IJSRuntime jsRuntime, string fileName, string? version) Task~JSModule~
    }
    class IJSRuntime {
        <<interface>>
    }
    class JSModule {
        <<class>>
    }
    JSModuleExtensions ..> IJSRuntime : extends
    JSModuleExtensions ..> JSModule : returns
    note for JSModuleExtensions "New LoadModuleByName method
Simplifies module loading by name"
Loading

File-Level Changes

Change Details Files
Added LoadModuleByName extension method to IJSRuntime.
  • Created a new LoadModuleByName extension method that takes a module name and an optional version.
  • The method constructs the module file path and calls the existing LoadModule method.
src/BootstrapBlazor/Extensions/JSModuleExtensions.cs
Refactored WebSpeechService to use LoadModuleByName.
  • Replaced hardcoded module paths with calls to LoadModuleByName for synthesis and recognition modules.
  • Removed the logger from the constructor.
src/BootstrapBlazor/Components/WebSpeech/WebSpeechService.cs
Refactored DefaultBrowserFingerService to use LoadUtility.
  • Replaced the direct call to LoadModule with LoadUtility.
src/BootstrapBlazor/Services/DefaultBrowserFingerService.cs
Refactored ValidateBase to use LoadModuleByName.
  • Replaced the hardcoded module path with a call to LoadModuleByName for the validate module.
src/BootstrapBlazor/Components/Validate/ValidateBase.cs
Refactored AjaxService to use LoadModuleByName.
  • Replaced the hardcoded module path with a call to LoadModuleByName for the ajax module.
src/BootstrapBlazor/Services/AjaxService.cs
Refactored DefaultBluetooth to use LoadModuleByName.
  • Replaced the hardcoded module path with a call to LoadModuleByName for the bt module.
src/BootstrapBlazor/Services/Bluetooth/DefaultBluetooth.cs
Refactored ClipboardService to use LoadUtility.
  • Replaced the direct call to LoadModule with LoadUtility.
src/BootstrapBlazor/Services/ClipboardService.cs
Refactored DefaultGeoLocationService to use LoadModuleByName.
  • Replaced the hardcoded module path with a call to LoadModuleByName for the geo module.
src/BootstrapBlazor/Services/DefaultGeoLocationService.cs
Refactored EyeDropperService to use LoadModuleByName.
  • Replaced the hardcoded module path with a call to LoadModuleByName for the eye-dropper module.
src/BootstrapBlazor/Services/EyeDropperService.cs
Refactored FullScreenService to use LoadModuleByName.
  • Replaced the hardcoded module path with a call to LoadModuleByName for the fullscreen module.
src/BootstrapBlazor/Services/FullScreenService.cs
Refactored NotificationService to use LoadModuleByName.
  • Replaced the hardcoded module path with a call to LoadModuleByName for the noti module.
src/BootstrapBlazor/Services/NotificationService.cs
Refactored DefaultSerialService to use LoadModuleByName.
  • Replaced the hardcoded module path with a call to LoadModuleByName for the serial module.
src/BootstrapBlazor/Services/Serial/DefaultSerialService.cs
Refactored TitleService to use LoadUtility.
  • Replaced the direct call to LoadModule with LoadUtility.
src/BootstrapBlazor/Services/TitleService.cs
Refactored WebClientService to use LoadModuleByName.
  • Replaced the hardcoded module path with a call to LoadModuleByName for the client module.
src/BootstrapBlazor/Services/WebClientService.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5285 Add LoadModuleByName extension method

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 this to the v9.3.0 milestone Feb 3, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Feb 3, 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 adding logging capability to LoadModuleByName method to maintain visibility into module loading operations, rather than removing it entirely
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.

@codecov
Copy link

codecov bot commented Feb 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (c001d4f) to head (91f5efa).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5286   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          640       640           
  Lines        28782     28781    -1     
  Branches      4090      4090           
=========================================
- Hits         28782     28781    -1     

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

@ArgoZhang ArgoZhang merged commit 350b0e3 into main Feb 3, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-module branch February 3, 2025 03: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(LoadModeByName): add LoadModuleByName extension method

2 participants