Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented May 2, 2025

Link issues

fixes #5944

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

Refactor the video device open method to return a boolean result indicating success or failure of opening the media device

Bug Fixes:

  • Prevent multiple attempts to open the same video device

Enhancements:

  • Modify the Open method to return a boolean indicating device access status
  • Add error handling for media device access
  • Update UI to disable/enable buttons based on device open state

Chores:

  • Remove unused Flip method from video device interfaces and implementations

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

sourcery-ai bot commented May 2, 2025

Reviewer's Guide

This pull request modifies the Open method for video devices across C# interfaces, implementations, and JavaScript interop to return a boolean indicating success or failure, incorporating error handling in the JavaScript layer. The sample component UI is updated to utilize this result for managing button states, and the unused Flip functionality is removed.

File-Level Changes

Change Details Files
Modified Open method to return boolean success status and removed Flip method.
  • Changed Open method signature in C# interfaces/classes to return Task<bool>.
  • Updated JavaScript open function with try...catch to return true on success or false on failure.
  • Modified C# JS interop calls for open to expect and handle the boolean return value.
  • Removed the Flip method from C# interfaces/classes and the flip function from JavaScript.
src/BootstrapBlazor/wwwroot/modules/media.js
src/BootstrapBlazor/Services/MediaDevices/DefaultMediaDevices.cs
src/BootstrapBlazor/Services/MediaDevices/IMediaDevices.cs
src/BootstrapBlazor/Services/MediaDevices/IVideoDevice.cs
src/BootstrapBlazor/Services/MediaDevices/DefaultVideoDevice.cs
Updated VideoDevices sample component UI/logic for Open result and Flip removal.
  • Stored the boolean result from Open to track device state.
  • Used device state to manage the IsDisabled property of Open/Close/Capture buttons.
  • Removed the 'Flip' button and its associated event handler.
  • Cleared the device list before adding newly fetched devices during request.
src/BootstrapBlazor.Server/Components/Samples/VideoDevices.razor.cs
src/BootstrapBlazor.Server/Components/Samples/VideoDevices.razor
Updated unit tests for Open return value and Flip removal.
  • Adjusted mock setup for the open JS interop call to return a boolean.
  • Added assertion for the boolean return value of the Open service method.
  • Removed test code related to the deleted Flip functionality.
test/UnitTest/Services/VideoDeviceTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5944 Modify the open method in the IVideoDevice interface to return a boolean value indicating success or failure.

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 this to the v9.6.0 milestone May 2, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes May 2, 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:

  • The flip camera functionality was removed; consider mentioning this significant change in the PR description.
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.

await service.Flip();
var url = await service.GetPreviewUrl();
Assert.Equal("blob:https://test-preview", url);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (testing): Add test case for open method failure

Add a test for when JS navigator.mediaDevices.getUserMedia fails, verifying that the C# Open method returns false on interop failure.

Suggested implementation:

        Assert.Equal("blob:https://test-preview", url);
    }

    [Fact]
    public async Task Open_ReturnsFalse_WhenUserMediaFails()
    {
        // Arrange
        var jsRuntime = new FailingMockJSRuntime();
        var service = new VideoDeviceService(jsRuntime);

        // Act
        bool result = await service.Open(".bb-video");

        // Assert
        Assert.False(result);
    }

    // Failing mock that simulates navigator.mediaDevices.getUserMedia failure.
    private class FailingMockJSRuntime : IJSRuntime
    {
        public Task<TValue> InvokeAsync<TValue>(string identifier, object[] args)
        {
            return Task.FromException<TValue>(new Exception("navigator.mediaDevices.getUserMedia error"));
        }

        public Task<TValue> InvokeAsync<TValue>(string identifier, CancellationToken cancellationToken, object[] args)
        {
            return Task.FromException<TValue>(new Exception("navigator.mediaDevices.getUserMedia error"));
        }
    }

Make sure that:

  1. The test framework (xUnit) and required namespaces (e.g., using System.Threading, using System.Threading.Tasks, using Microsoft.JSInterop, and using Xunit) are referenced at the top of the file.
  2. The VideoDeviceService class has a constructor that accepts an IJSRuntime, and its Open method internally catches the JS interop failure and returns false.
  3. Adjust the details if your codebase implements JS interop differently.

@codecov
Copy link

codecov bot commented May 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (fde404c) to head (8d03c86).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5945   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          669       669           
  Lines        30551     30544    -7     
  Branches      4347      4347           
=========================================
- Hits         30551     30544    -7     

☔ 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 a6e14bd into main May 2, 2025
3 checks passed
@ArgoZhang ArgoZhang deleted the dev-test branch May 2, 2025 10:41
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(IVideoDevice): add bool result from open method

2 participants