Skip to content
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

refactor(LoadModule): add logger information for load module failed #5148

Merged
merged 3 commits into from
Jan 18, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Jan 18, 2025

add logger information for load module failed

Summary of the changes (Less than 80 chars)

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

Description

fixes #5147

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

Bug Fixes:

  • Fixed an issue where module load failures were not logged.

Copy link

sourcery-ai bot commented Jan 18, 2025

Reviewer's Guide by Sourcery

This pull request adds logging for when loading a JS module fails, which helps with debugging. It also adds a version parameter to the LoadUtility method.

Sequence diagram for JS module loading with error handling

sequenceDiagram
    participant App
    participant JSRuntime
    participant JSModule
    participant Console

    App->>JSRuntime: LoadModule(fileName, version)
    JSRuntime->>JSModule: Import JS Module
    alt Module Load Failed
        JSModule-->>Console: Log error message
        Note right of Console: New: Added logging for<br/>module load failures
        JSModule-->>App: Throw JSException
    else Module Load Success
        JSModule-->>App: Return JSModule instance
    end
Loading

Class diagram for JSModule and extensions

classDiagram
    class JSModule {
        -IJSObjectReference jSObjectReference
        +InvokeVoidAsync(string identifier, CancellationToken cancellationToken, params object?[]? args)
        +InvokeAsync<TValue>(string identifier, CancellationToken cancellationToken, params object?[]? args)
    }

    class JSModuleExtensions {
        +LoadUtility(IJSRuntime jsRuntime, string? version)*
        +LoadModule(IJSRuntime jsRuntime, string fileName, string? version)*
    }
    note for JSModuleExtensions "Modified: Added version parameter
and enhanced error logging"
Loading

File-Level Changes

Change Details Files
Added logging for JS module loading failures.
  • Added try-catch blocks to the InvokeVoidAsync and InvokeAsync methods to catch JSExceptions.
  • Added a console log message when a JSException is caught in debug mode.
  • Added a console log message when a JSException is caught in the LoadModule method in debug mode.
src/BootstrapBlazor/Utils/JSModule.cs
src/BootstrapBlazor/Extensions/JSModuleExtensions.cs
Added a version parameter to the LoadUtility method.
  • Added an optional string parameter named version to the LoadUtility method.
  • The LoadUtility method now calls the LoadModule method with the provided version.
src/BootstrapBlazor/Extensions/JSModuleExtensions.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5147 Add logger information for load module failed scenarios

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 18, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 18, 2025
Copy link

@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: 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 enabled auto-merge (squash) January 18, 2025 04:23
Copy link

codecov bot commented Jan 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (3279623) to head (7c62987).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5148   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          634       634           
  Lines        28196     28191    -5     
  Branches      4038      4038           
=========================================
- Hits         28196     28191    -5     

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

@ArgoZhang ArgoZhang merged commit 84ace2e into main Jan 18, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-js branch January 18, 2025 04:24
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.

refactor(LoadModule): add logger information for load module failed
1 participant