Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Nov 15, 2024

not trigger OnStateChanged callback when set TValue to bool

Summary of the changes (Less than 80 chars)

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

Description

fixes #4666

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

Fix the Checkbox component to prevent the OnStateChanged callback from being triggered when TValue is set to a boolean, and add a corresponding unit test to ensure correct behavior.

Bug Fixes:

  • Fix the issue where the OnStateChanged callback was triggered when setting TValue to a boolean value in the Checkbox component.

Tests:

  • Add a unit test to verify that the OnStateChanged callback is correctly triggered when the TValue is set to a boolean value.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Nov 15, 2024

Reviewer's Guide by Sourcery

This PR fixes a bug in the Checkbox component where the OnStateChanged callback wasn't being triggered correctly when setting TValue to bool. The implementation reorganizes the state change logic in InternalStateChanged method to ensure proper callback execution order and adds a unit test to verify the fix.

Sequence diagram for Checkbox state change process

sequenceDiagram
    participant User
    participant Checkbox
    participant StateChanged
    participant OnStateChanged

    User->>Checkbox: Set TValue to bool
    Checkbox->>Checkbox: InternalStateChanged(state)
    alt IsBoolean
        Checkbox->>Checkbox: Set CurrentValue
    end
    Checkbox->>Checkbox: Update State
    alt StateChanged.HasDelegate
        Checkbox->>StateChanged: InvokeAsync(State)
    end
    alt OnStateChanged != null
        Checkbox->>OnStateChanged: Invoke(State, Value)
    end
Loading

Updated class diagram for Checkbox component

classDiagram
    class Checkbox {
        -CheckboxState State
        -TValue CurrentValue
        +Task<bool> InternalStateChanged(CheckboxState state)
    }
    class CheckboxState {
    }
    Checkbox --> CheckboxState
    note for Checkbox "Reorganized state change logic to ensure proper callback execution order"
Loading

Class diagram for Checkbox unit test additions

classDiagram
    class CheckboxListTest {
        +Task Checkbox_OnTriggerClickAsync()
        +Task Bool_TriggerStateChanged_Ok()
    }
    note for CheckboxListTest "Added unit test to verify OnStateChanged callback when TValue is bool"
Loading

File-Level Changes

Change Details Files
Refactored the InternalStateChanged method to fix callback triggering
  • Moved State assignment before callback invocations
  • Removed conditional check for state change
  • Separated boolean value handling from state change callbacks
  • Added ValueChanged delegate check for boolean values
src/BootstrapBlazor/Components/Checkbox/Checkbox.razor.cs
Added unit test to verify OnStateChanged callback behavior with boolean values
  • Created new test case Bool_TriggerStateChanged_Ok
  • Added verification for state change and value update
test/UnitTest/Components/CheckboxListTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4666 Fix the Checkbox component to trigger OnStateChanged callback when TValue is set to bool

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 bug Something isn't working label Nov 15, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Nov 15, 2024
@ArgoZhang ArgoZhang enabled auto-merge (squash) November 15, 2024 11:42
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: 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 Nov 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (ccd3bdb) to head (05dc08a).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4667   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          620       620           
  Lines        27427     27428    +1     
  Branches      3929      3929           
=========================================
+ Hits         27427     27428    +1     

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

@ArgoZhang ArgoZhang merged commit dc1a76c into main Nov 15, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the fix-checkbox branch November 15, 2024 11:44
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(Checkbox): not trigger OnStateChanged callback when set TValue to bool

2 participants