Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Apr 11, 2025

Link issues

fixes #5809

Summary By Copilot

This pull request includes several changes to improve the handling of delay options in various components and adds a necessary dependency in the unit tests. The most important changes include modifying the delay condition checks in MessageService and SwalService, updating the GetToastOption method in Table.razor.Toolbar.cs, and adding the IOptionsMonitor dependency in TableDialogTest.

Improvements to delay handling:

Unit test improvements:

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

Improve delay handling in Toast, Message, and SweetAlert components by adding more precise delay condition checks

Bug Fixes:

  • Fix Toast delay configuration to only apply when delay is greater than zero
  • Ensure Message and SweetAlert services only set delay when positive value is configured

Enhancements:

  • Refactor delay setting logic in multiple service components to be more explicit about delay conditions

Tests:

  • Update TableDialogTest to support testing zero delay scenarios by injecting BootstrapBlazorOptions

@ArgoZhang ArgoZhang requested a review from Copilot April 11, 2025 03:03
@bb-auto bb-auto bot added the bug Something isn't working label Apr 11, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Apr 11, 2025

Reviewer's Guide by Sourcery

This pull request improves the handling of delay options in various components and adds a necessary dependency in the unit tests. The delay condition checks in MessageService and SwalService were updated, the GetToastOption method in Table.razor.Toolbar.cs was updated, and the IOptionsMonitor dependency was added in TableDialogTest.

Sequence diagram for showing a toast message

sequenceDiagram
    participant Table.razor.Toolbar
    participant BootstrapBlazorOptions
    participant ToastService

    Table.razor.Toolbar->>BootstrapBlazorOptions: Get Options.CurrentValue.ToastDelay
    alt Options.CurrentValue.ToastDelay > 0
        Table.razor.Toolbar->>ToastService: Show Toast with Delay
    else Options.CurrentValue.ToastDelay <= 0
        Table.razor.Toolbar->>ToastService: Show Toast without Delay
    end
Loading

Updated class diagram for ToastOption

classDiagram
    class ToastOption {
        +string Title
        +int Delay
    }

    note for ToastOption "Delay is only set if Options.CurrentValue.ToastDelay > 0"
Loading

File-Level Changes

Change Details Files
Updated delay condition checks in MessageService and SwalService to check if the delay is greater than 0 instead of not equal to 0.
  • Changed the condition to check if Options.MessageDelay is greater than 0 instead of not equal to 0.
  • Modified the condition to check if options.CurrentValue.SwalDelay is greater than 0 instead of not equal to 0.
src/BootstrapBlazor/Components/Message/MessageService.cs
src/BootstrapBlazor/Components/SweetAlert/SwalService.cs
Updated the GetToastOption method in Table.razor.Toolbar.cs to include a check for Options.CurrentValue.ToastDelay being greater than 0 before setting the delay.
  • Updated the GetToastOption method to include a check for Options.CurrentValue.ToastDelay being greater than 0 before setting the delay.
src/BootstrapBlazor/Components/Table/Table.razor.Toolbar.cs
Added IOptionsMonitor dependency in TableDialogTest to set ToastDelay to 0 in the EditAsync_Ok test method.
  • Added Microsoft.Extensions.Options using directive.
  • Injected IOptionsMonitor<BootstrapBlazorOptions> to set ToastDelay to 0 in the EditAsync_Ok test method.
test/UnitTest/Components/TableDialogTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5809 The toast should be displayed even when BootstrapBlazorOption ToastDelay is not explicitly set.
#5809 Fix the bug where the toast result pop-up window is not shown.

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.5.0 milestone Apr 11, 2025
@ArgoZhang ArgoZhang enabled auto-merge (squash) April 11, 2025 03:04
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (1)

test/UnitTest/Components/TableDialogTest.cs:19

  • [nitpick] Directly modifying options.CurrentValue in the test could lead to side effects if the service container is shared. Consider configuring the options through dependency injection or ensuring test isolation to prevent interference with other tests.
var options = Context.Services.GetRequiredService<IOptionsMonitor<BootstrapBlazorOptions>>();

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:

  • The changes to MessageService and SwalService look like they might be needed in other similar components.
  • Consider adding a comment to explain why ToastDelay is being set to 0 in the unit test.
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 Apr 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (bb45f76) to head (a554738).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5810   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          660       660           
  Lines        30117     30123    +6     
  Branches      4250      4251    +1     
=========================================
+ Hits         30117     30123    +6     

☔ 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 b9e9111 into main Apr 11, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-table branch April 11, 2025 03:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bug(Table): should show the Toast when not set BootstrapBlazorOption ToastDelay

2 participants