Isolate per-track mute RPCs and atomic mute map #1796
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| /* | ||
| * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved. | ||
| * | ||
| * Licensed under the Stream License; | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://github.com/GetStream/stream-video-android/blob/main/LICENSE | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.getstream.video.android.core.call | ||
|
|
||
| import kotlinx.coroutines.CoroutineScope | ||
| import kotlinx.coroutines.CoroutineStart | ||
| import kotlinx.coroutines.Job | ||
| import kotlinx.coroutines.launch | ||
| import stream.video.sfu.models.TrackType | ||
| import java.util.concurrent.ConcurrentHashMap | ||
|
|
||
| /** | ||
| * One job per [TrackType]. Replacing a job cancels only that track's previous work, so an | ||
| * in-flight audio mute RPC is not dropped when video or screen-share sync starts. | ||
| */ | ||
| internal class TrackKeyedJobs { | ||
| private val jobs = ConcurrentHashMap<TrackType, Job>() | ||
|
|
||
| fun launch( | ||
| scope: CoroutineScope, | ||
| trackType: TrackType, | ||
| block: suspend CoroutineScope.() -> Unit, | ||
| ) { | ||
| val job = scope.launch(start = CoroutineStart.LAZY, block = block) | ||
| jobs.put(trackType, job)?.cancel() | ||
| job.start() | ||
| } | ||
|
|
||
| fun cancelAll() { | ||
| jobs.values.forEach { it.cancel() } | ||
| jobs.clear() | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| /* | ||
| * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved. | ||
| * | ||
| * Licensed under the Stream License; | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://github.com/GetStream/stream-video-android/blob/main/LICENSE | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.getstream.video.android.core.call | ||
|
|
||
| import com.google.common.truth.Truth.assertThat | ||
| import kotlinx.coroutines.CompletableDeferred | ||
| import kotlinx.coroutines.CoroutineScope | ||
| import kotlinx.coroutines.Job | ||
| import kotlinx.coroutines.test.UnconfinedTestDispatcher | ||
| import kotlinx.coroutines.test.runTest | ||
| import org.junit.Test | ||
| import stream.video.sfu.models.TrackType | ||
| import java.util.concurrent.atomic.AtomicBoolean | ||
|
|
||
| class TrackKeyedJobsTest { | ||
|
|
||
| @Test | ||
| fun `launching a second track does not cancel the first track's job`() = runTest { | ||
| val scope = CoroutineScope(UnconfinedTestDispatcher(testScheduler) + Job()) | ||
| val jobs = TrackKeyedJobs() | ||
| val release = CompletableDeferred<Unit>() | ||
| val audioDone = AtomicBoolean(false) | ||
| val videoDone = AtomicBoolean(false) | ||
|
|
||
| try { | ||
| jobs.launch(scope, TrackType.TRACK_TYPE_AUDIO) { | ||
| release.await() | ||
| audioDone.set(true) | ||
| } | ||
| jobs.launch(scope, TrackType.TRACK_TYPE_VIDEO) { | ||
| release.await() | ||
| videoDone.set(true) | ||
| } | ||
|
|
||
| release.complete(Unit) | ||
|
|
||
| assertThat(audioDone.get()).isTrue() | ||
| assertThat(videoDone.get()).isTrue() | ||
| } finally { | ||
| scope.coroutineContext[Job]?.cancel() | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun `launching the same track cancels the previous job`() = runTest { | ||
| val scope = CoroutineScope(UnconfinedTestDispatcher(testScheduler) + Job()) | ||
| val jobs = TrackKeyedJobs() | ||
| val firstHold = CompletableDeferred<Unit>() | ||
| val firstDone = AtomicBoolean(false) | ||
| val secondDone = AtomicBoolean(false) | ||
|
|
||
| try { | ||
| jobs.launch(scope, TrackType.TRACK_TYPE_AUDIO) { | ||
| firstHold.await() | ||
| firstDone.set(true) | ||
| } | ||
| jobs.launch(scope, TrackType.TRACK_TYPE_AUDIO) { | ||
| secondDone.set(true) | ||
| } | ||
| firstHold.complete(Unit) | ||
|
|
||
| assertThat(firstDone.get()).isFalse() | ||
| assertThat(secondDone.get()).isTrue() | ||
| } finally { | ||
| scope.coroutineContext[Job]?.cancel() | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun `cancelAll cancels every track job and clears the map`() = runTest { | ||
| val scope = CoroutineScope(UnconfinedTestDispatcher(testScheduler) + Job()) | ||
| val jobs = TrackKeyedJobs() | ||
| val audioHold = CompletableDeferred<Unit>() | ||
| val videoHold = CompletableDeferred<Unit>() | ||
| val audioDone = AtomicBoolean(false) | ||
| val videoDone = AtomicBoolean(false) | ||
|
|
||
| try { | ||
| jobs.launch(scope, TrackType.TRACK_TYPE_AUDIO) { | ||
| audioHold.await() | ||
| audioDone.set(true) | ||
| } | ||
| jobs.launch(scope, TrackType.TRACK_TYPE_VIDEO) { | ||
| videoHold.await() | ||
| videoDone.set(true) | ||
| } | ||
|
|
||
| jobs.cancelAll() | ||
| audioHold.complete(Unit) | ||
| videoHold.complete(Unit) | ||
|
|
||
| assertThat(audioDone.get()).isFalse() | ||
| assertThat(videoDone.get()).isFalse() | ||
| } finally { | ||
| scope.coroutineContext[Job]?.cancel() | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
resumeMuteSync()launches oneUpdateMuteStatesper recorded track, thenlistenToMediaChanges()two lines down re-collects the camera/mic/screenshareStateFlows —collectLatestreplays on re-subscription, so each replay reachessyncMuteStateToSfufor the sameTrackTypeand cancels the flush job launched microseconds earlier.So every reconnect gets a redundant in-flight RPC per track, cancelled mid-flight, logging the
IOException: Canceledquoted in the Goal section. Not a correctness bug — the winning job carries the same value — but it puts the line back in customer logs.Reordering won't help; the collectors launch on
mediaScopeand the interleaving is nondeterministic either way. Recording which tracks were actually deferred while paused and flushing only those avoids it, and also stops the flush posting for tracks that were never published whenpublisher.value == null.