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

yamilmedina · 2024-11-14T14:58:36Z

WPB-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)

feat: conference simulcast support (WPB-11480) wire-android#3638

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

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

github-actions · 2024-11-14T15:16:55Z

Test Results

3 284 tests ±0 3 177 ✅ ±0 4m 42s ⏱️ -25s
559 suites ±0 107 💤 ±0
559 files ±0 0 ❌ ±0

Results for commit ba29203. ± Comparison against base commit eb66288.

♻️ This comment has been updated with latest results.

github-actions · 2024-11-14T15:22:41Z

Bencher Report

Branch	feat/conference-simulcast-support
Testbed	ubuntu-latest

⚠️ WARNING: No Threshold found!
Without a Threshold, no Alerts will ever be generated.
Latency (nanoseconds (ns))
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

Benchmark	Latency	nanoseconds (ns)
com.wire.kalium.benchmarks.logic.CoreLogicBenchmark.createObjectInFiles	📈 view plot ⚠️ NO THRESHOLD	652,416.46
com.wire.kalium.benchmarks.logic.CoreLogicBenchmark.createObjectInMemory	📈 view plot ⚠️ NO THRESHOLD	394,679,888.17
com.wire.kalium.benchmarks.persistence.MessagesNoPragmaTuneBenchmark.messageInsertionBenchmark	📈 view plot ⚠️ NO THRESHOLD	1,311,587,860.68
com.wire.kalium.benchmarks.persistence.MessagesNoPragmaTuneBenchmark.queryMessagesBenchmark	📈 view plot ⚠️ NO THRESHOLD	21,571,433.20

🐰 View full continuous benchmarking report in Bencher

codecov-commenter · 2024-11-14T15:38:11Z

Codecov Report

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

Project coverage is 54.20%. Comparing base (eb66288) to head (ba29203).

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    #3107      +/-   ##
===========================================
- Coverage    54.20%   54.20%   -0.01%     
===========================================
  Files         1205     1206       +1     
  Lines        35806    35824      +18     
  Branches      3641     3643       +2     
===========================================
+ Hits         19410    19418       +8     
- Misses       14993    15004      +11     
+ Partials      1403     1402       -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 3 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 eb66288...ba29203. Read the comment docs.

---- 🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests
JS Bundle Analysis - Avoid shipping oversized bundles

datadog-wireapp · 2024-11-14T15:39:39Z

Datadog Report

Branch report: feat/conference-simulcast-support
Commit report: ee13eea
Test service: kalium-jvm

✅ 0 Failed, 3177 Passed, 107 Skipped, 32.89s Total Time

MohamadJaara

question about logging clientsJson

MohamadJaara · 2024-11-18T14:49:55Z

logic/src/commonJvmAndroid/kotlin/com/wire/kalium/logic/feature/call/CallManagerImpl.kt

                )
            }
            val clientsJson = CallClientList(clients).toJsonString()
+            callingLogger.d(
+                "$TAG - wcall_request_video_streams() called -> Requesting video streams for conversation = " +
+                        "${conversationId.toLogString()} with clients = $clientsJson"


what clientsJson include in this case? and is it safe to log ?

Removed, thanks for the catch

sonarqubecloud · 2024-11-18T16:41:12Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Comment addressed

This reverts commit 9273703.

* Revert "feat: conference simulcast support (WPB-11480) (#3107)" This reverts commit 9273703. * chore: empty commit bump

…)" This reverts commit d8b69f1.

* chore: empty commit bump * Revert "revert: conference simulcast support (WPB-11480) (#3107) (#3149)" This reverts commit d8b69f1. * chore: empty commit bump

yamilmedina added 5 commits November 11, 2024 18:18

bump avs to v10 with simulcast support and extract Json serializer

b45ab23

feat: adjustment and logs

d5922ed

Merge branch 'develop' into feat/conference-simulcast-support

712d20c

feat: adjustment for calling simulcast new params

e89b077

feat: adjustment for calling simulcast new params

1012d1a

github-actions bot assigned yamilmedina Nov 14, 2024

github-actions bot added type: feature ✨ 👕 size: M labels Nov 14, 2024

chore: detekt

65634b9

yamilmedina requested review from ohassine, Garzas, MohamadJaara and saleniuk November 15, 2024 12:56

yamilmedina mentioned this pull request Nov 15, 2024

feat: conference simulcast support (WPB-11480) wireapp/wire-android#3638

Merged

8 tasks

Merge branch 'develop' into feat/conference-simulcast-support

f6ec15b

yamilmedina enabled auto-merge November 18, 2024 10:06

MohamadJaara previously requested changes Nov 18, 2024

View reviewed changes

feat: comments

ba29203

yamilmedina requested a review from MohamadJaara November 18, 2024 16:41

Garzas approved these changes Nov 20, 2024

View reviewed changes

ohassine approved these changes Nov 20, 2024

View reviewed changes

yamilmedina added this pull request to the merge queue Nov 20, 2024

github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Nov 20, 2024

yamilmedina added this pull request to the merge queue Nov 20, 2024

Merged via the queue into develop with commit 9273703 Nov 20, 2024
22 checks passed

yamilmedina deleted the feat/conference-simulcast-support branch November 20, 2024 11:25

echoes-hq bot added the echoes: product-roadmap/feature Work contributing to adding a new feature as part of the product roadmap. label Nov 20, 2024

yamilmedina added a commit that referenced this pull request Dec 6, 2024

Revert "feat: conference simulcast support (WPB-11480) (#3107)"

bf97e22

This reverts commit 9273703.

github-merge-queue bot pushed a commit that referenced this pull request Dec 6, 2024

revert: conference simulcast support (WPB-11480) (#3107) (#3149)

d8b69f1

* Revert "feat: conference simulcast support (WPB-11480) (#3107)" This reverts commit 9273703. * chore: empty commit bump

yamilmedina added a commit that referenced this pull request Dec 13, 2024

Revert "revert: conference simulcast support (WPB-11480) (#3107) (#3149…

9f9a1cd

…)" This reverts commit d8b69f1.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

yamilmedina commented Nov 14, 2024 •

edited by github-actions bot

Loading

github-actions bot commented Nov 14, 2024 •

edited

Loading

github-actions bot commented Nov 14, 2024 •

edited

Loading

⚠️ WARNING: No Threshold found!

codecov-commenter commented Nov 14, 2024 •

edited

Loading

datadog-wireapp bot commented Nov 14, 2024 •

edited

Loading

MohamadJaara left a comment

MohamadJaara Nov 18, 2024

yamilmedina Nov 18, 2024

sonarqubecloud bot commented Nov 18, 2024

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

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

Conversation

yamilmedina commented Nov 14, 2024 • edited by github-actions bot Loading

PR Submission Checklist for internal contributors

What's new in this PR?

Issues

Solutions

Dependencies (Optional)

Testing

Test Coverage (Optional)

How to Test

Attachments (Optional)

PR Post Submission Checklist for internal contributors (Optional)

PR Post Merge Checklist for internal contributors

References

github-actions bot commented Nov 14, 2024 • edited Loading

Test Results

github-actions bot commented Nov 14, 2024 • edited Loading

Bencher Report

⚠️ WARNING: No Threshold found!

codecov-commenter commented Nov 14, 2024 • edited Loading

Codecov Report

datadog-wireapp bot commented Nov 14, 2024 • edited Loading

Datadog Report

MohamadJaara left a comment

Choose a reason for hiding this comment

MohamadJaara Nov 18, 2024

Choose a reason for hiding this comment

yamilmedina Nov 18, 2024

Choose a reason for hiding this comment

sonarqubecloud bot commented Nov 18, 2024

Quality Gate passed

yamilmedina commented Nov 14, 2024 •

edited by github-actions bot

Loading

github-actions bot commented Nov 14, 2024 •

edited

Loading

github-actions bot commented Nov 14, 2024 •

edited

Loading

codecov-commenter commented Nov 14, 2024 •

edited

Loading

datadog-wireapp bot commented Nov 14, 2024 •

edited

Loading