refactor(IVideoDevice): add Apply method #5949
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Reviewer's GuideThis pull request adds an Sequence Diagram for Applying Video ConstraintssequenceDiagram
actor User
participant RazorComponent as VideoDevices.razor
participant VideoService as VideoDeviceService
participant MediaJs as media.js
User->>RazorComponent: Click 'Apply Resolution' button (e.g., VGA)
RazorComponent->>VideoService: OnApply(640, 480)
VideoService->>VideoService: Apply(new MediaTrackConstraints { Width = 640, Height = 480 })
Note over VideoService, MediaJs: Service calls JS via Interop
VideoService->>MediaJs: apply({ width: 640, height: 480 })
MediaJs->>MediaJs: Get video track
MediaJs->>MediaJs: Get current settings
MediaJs->>MediaJs: Calculate exact height based on aspect ratio
MediaJs->>MediaJs: Prepare new constraints object
MediaJs->>MediaJs: track.applyConstraints(newSettings)
MediaJs-->>VideoService: return success/failure
VideoService-->>RazorComponent: Task<bool>
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey @ArgoZhang - I've reviewed your changes - here's some feedback:
- The JavaScript
applyfunction appears to always returnfalse; consider returningtrueupon successful application of constraints. - Using
exactconstraints inapplyConstraintsmight cause errors on some devices; consider usingidealfor better compatibility.
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 Security: all looks good
- 🟡 Testing: 1 issue found
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| return ret; | ||
| } | ||
|
|
||
| export async function apply(options) { |
Contributor
There was a problem hiding this comment.
suggestion (bug_risk): Return value is never updated on success.
ret remains false even on success; update it (or return true) when constraints apply successfully.
Suggested implementation:
ret = true;
}
} catch (ex) {Please verify that inserting ret = true at this position fits the overall logic, meaning that the constraints have been applied by this point. You might need to adjust the placement if additional logic should occur before returning a successful value.
Comment on lines
+91
to
+98
| if (options.width) { | ||
| settings.width = { | ||
| exact: options.width, | ||
| }; | ||
| settings.height = { | ||
| exact: Math.floor(options.width / aspectRatio) | ||
| }; | ||
| } |
Contributor
There was a problem hiding this comment.
suggestion: Inconsistency between JS applied constraints and provided parameters.
The function ignores options.height even when passed; either apply options.height to the constraints or update the interface to explicitly reflect that only width is used.
Suggested change
| if (options.width) { | |
| settings.width = { | |
| exact: options.width, | |
| }; | |
| settings.height = { | |
| exact: Math.floor(options.width / aspectRatio) | |
| }; | |
| } | |
| if (options.width) { | |
| settings.width = { | |
| exact: options.width, | |
| }; | |
| if (options.height) { | |
| settings.height = { | |
| exact: options.height, | |
| }; | |
| } else { | |
| settings.height = { | |
| exact: Math.floor(options.width / aspectRatio) | |
| }; | |
| } | |
| } |
Comment on lines
45
to
+49
| var close = await service.Close(".bb-video"); | ||
| Assert.True(close); | ||
|
|
||
| var apply = await service.Apply(new MediaTrackConstraints() { Width = 640, Height = 480, VideoSelector = ".bb-video" }); | ||
| Assert.True(apply); |
Contributor
There was a problem hiding this comment.
suggestion (testing): Consider testing failure scenarios for the Apply method.
Add tests for when the JS interop call for apply returns false and when it throws an exception.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5949 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 669 669
Lines 30548 30555 +7
Branches 4348 4348
=========================================
+ Hits 30548 30555 +7 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Link issues
fixes #5948
Summary By Copilot
Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Add support for applying media track constraints to video devices, allowing dynamic adjustment of video stream properties like width and resolution
New Features:
Enhancements:
Tests: