Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: conference simulcast support (WPB-11480) #3150

Merged
merged 9 commits into from
Dec 17, 2024

Conversation

yamilmedina
Copy link
Contributor

@yamilmedina yamilmedina commented Dec 6, 2024

StoryWPB-11480 [Android] Simulcast Support & Automatic Quality Adjustments


PR Submission Checklist for internal contributors

  • The PR Title

    • conforms to the style of semantic commits messages¹ supported in Wire's Github Workflow²
    • contains a reference JIRA issue number like SQPIT-764
    • answers the question: If merged, this PR will: ... ³
  • The PR Description

    • is free of optional paragraphs and you have filled the relevant parts to the best of your ability

What's new in this PR?

Issues

On AVS 10.x.x, we have finally supported for Simulcast (multiple quality for participants video). This is an improvement in the overall experience, and as well in performance, because when the client is with a Tile in FullScreen, we can request only that video stream, saving bandwidth.

Solutions

Add the code to support, this consist in simple words:

  • When requesting the video streams wcall_request_video_streams we send a new parameter call (quality)
  • ANY = 0, LOW = 1, HIGH = 2.

Also took the chance to improve some things in the code:

  • Calling Logging
  • JSON serializer was being created every time we requested streams, now is using a shared instance.

Dependencies (Optional)

Needs releases with:

  • GitHub link to other pull request

Testing

Test Coverage (Optional)

  • I have added automated test to this contribution

How to Test

As of now, it is not possible, but when SFT version 5 is deployed on staging, it will be possible.
For development purposes, was 'hacked' using the SFT test server and local webapp.

Attachments (Optional)

https://drive.google.com/file/d/18N0W4hXT3MDfL_tsD0_rJCzgDz5s4D9D/view?usp=sharing


PR Post Submission Checklist for internal contributors (Optional)

  • Wire's Github Workflow has automatically linked the PR to a JIRA issue

PR Post Merge Checklist for internal contributors

  • If any soft of configuration variable was introduced by this PR, it has been added to the relevant documents and the CI jobs have been updated.

References
  1. https://sparkbox.com/foundry/semantic_commit_messages
  2. https://github.com/wireapp/.github#usage
  3. E.g. feat(conversation-list): Sort conversations by most emojis in the title #SQPIT-764.

@yamilmedina yamilmedina self-assigned this Dec 6, 2024
@echoes-hq echoes-hq bot added the echoes: product-roadmap/feature Work contributing to adding a new feature as part of the product roadmap. label Dec 6, 2024
@yamilmedina yamilmedina marked this pull request as draft December 6, 2024 14:58
Copy link
Contributor

github-actions bot commented Dec 6, 2024

Test Results

3 346 tests  ±0   3 239 ✅ ±0   5m 42s ⏱️ +4s
  573 suites ±0     107 💤 ±0 
  573 files   ±0       0 ❌ ±0 

Results for commit b8eb2f8. ± Comparison against base commit c7723ca.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Dec 6, 2024

🐰 Bencher Report

Branchfeat/cherry-pick-simulcast
Testbedubuntu-latest

⚠️ WARNING: No Threshold found!

Without a Threshold, no Alerts will ever be generated.

Click here to create a new Threshold
For more information, see the Threshold documentation.
To only post results if a Threshold exists, set the --ci-only-thresholds CLI flag.

Click to view all benchmark results
BenchmarkLatencynanoseconds (ns)
com.wire.kalium.benchmarks.logic.CoreLogicBenchmark.createObjectInFiles📈 view plot
⚠️ NO THRESHOLD
659,105.14
com.wire.kalium.benchmarks.logic.CoreLogicBenchmark.createObjectInMemory📈 view plot
⚠️ NO THRESHOLD
367,731,416.80
com.wire.kalium.benchmarks.persistence.MessagesNoPragmaTuneBenchmark.messageInsertionBenchmark📈 view plot
⚠️ NO THRESHOLD
1,318,963,809.79
com.wire.kalium.benchmarks.persistence.MessagesNoPragmaTuneBenchmark.queryMessagesBenchmark📈 view plot
⚠️ NO THRESHOLD
21,516,082.12
🐰 View full continuous benchmarking report in Bencher

@codecov-commenter
Copy link

codecov-commenter commented Dec 6, 2024

Codecov Report

Attention: Patch coverage is 23.80952% with 16 lines in your changes missing coverage. Please review.

Project coverage is 54.13%. Comparing base (c7723ca) to head (b8eb2f8).

Files with missing lines Patch % Lines
...tlin/com/wire/kalium/logic/data/call/CallClient.kt 0.00% 16 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #3150      +/-   ##
===========================================
- Coverage    54.14%   54.13%   -0.01%     
===========================================
  Files         1252     1253       +1     
  Lines        36528    36546      +18     
  Branches      3703     3705       +2     
===========================================
+ Hits         19777    19784       +7     
- Misses       15326    15338      +12     
+ Partials      1425     1424       -1     
Files with missing lines Coverage Δ
...kalium.util/serialization/LenientJsonSerializer.kt 100.00% <100.00%> (ø)
...tlin/com/wire/kalium/logic/data/call/CallClient.kt 0.00% <0.00%> (ø)

... and 2 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c7723ca...b8eb2f8. Read the comment docs.

@datadog-wireapp
Copy link

datadog-wireapp bot commented Dec 6, 2024

Datadog Report

Branch report: feat/cherry-pick-simulcast
Commit report: 13c2c14
Test service: kalium-jvm

✅ 0 Failed, 3239 Passed, 107 Skipped, 1m 2.26s Total Time

@yamilmedina yamilmedina marked this pull request as ready for review December 13, 2024 11:43
@yamilmedina
Copy link
Contributor Author

Bringing back simulcast to 4.11

@yamilmedina yamilmedina changed the title feat: conference simulcast support (WPB-11480) feat: conference simulcast support (WPB-11480) Dec 13, 2024
@yamilmedina yamilmedina requested a review from Garzas December 17, 2024 08:56
@yamilmedina yamilmedina added this pull request to the merge queue Dec 17, 2024
Merged via the queue into develop with commit 1ca6dfc Dec 17, 2024
23 checks passed
@yamilmedina yamilmedina deleted the feat/cherry-pick-simulcast branch December 17, 2024 10:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
echoes: product-roadmap/feature Work contributing to adding a new feature as part of the product roadmap. 👕 size: M type: feature ✨
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants