Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Apr 26, 2025

Link issues

fixes #5893

Summary By Copilot

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

Remove Task.Run from the SpeechWave component.

Enhancements:

  • Refactor SpeechWave component to run its timer logic asynchronously without Task.Run.
  • Optimize rendering by calling StateHasChanged conditionally within the timer loop.
  • Convert OnParametersSet to OnParametersSetAsync.

Tests:

  • Update SpeechWave tests to align with asynchronous changes.
  • Use UnsafeAccessor instead of reflection for accessing private members in tests.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Apr 26, 2025

Reviewer's Guide by Sourcery

This pull request refactors the SpeechWave component to remove the explicit use of Task.Run, which is often problematic in UI contexts like WPF. It updates the internal timing mechanism and state management, and revises the associated unit tests to reflect these changes and use UnsafeAccessor for accessing private members for testing purposes.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Modified the timing mechanism in the SpeechWave component to remove the explicit use of Task.Run.
  • Converted the Run method to an async Task.
  • Updated the parameter setting logic to correctly await the timing start.
src/BootstrapBlazor/Components/Speech/SpeechWave.razor.cs
Encapsulated internal state and refactored control flow methods in SpeechWave.
  • Changed public state properties to private fields.
  • Renamed the cancellation method.
  • Updated internal references and cleanup logic.
  • Optimized UI update calls within the timing loop.
src/BootstrapBlazor/Components/Speech/SpeechWave.razor.cs
Revised unit tests to align with the SpeechWave component changes.
  • Adjusted parameters and timing in the timeout test.
  • Reimplemented the test for the component's running state.
  • Introduced the use of UnsafeAccessor for accessing private state in tests.
test/UnitTest/Components/RecognizerTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5893 Remove Task.Run support from the SpeechWave component in the WPF project.

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!

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 Apr 26, 2025
@bb-auto bb-auto bot added this to the v9.5.0 milestone Apr 26, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Apr 26, 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:

  • The title mentions 'wpf', but the changes appear to be within a Blazor component; consider updating the title for clarity.
  • The condition if (ShowUsedTime || Show == false) for calling StateHasChanged within the loop might need review; consider if the timer UI should update periodically even if ShowUsedTime is false.
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 26, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (6b39b6a) to head (295eb91).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5894   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          661       661           
  Lines        30421     30418    -3     
  Branches      4321      4327    +6     
=========================================
- Hits         30421     30418    -3     

☔ 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 075a1c3 into main Apr 26, 2025
3 checks passed
@ArgoZhang ArgoZhang deleted the refactor-wave branch April 26, 2025 03:32
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(SpeechWave): remove Task.Run support wpf

2 participants