-
Notifications
You must be signed in to change notification settings - Fork 58
Outgoing ring timeout no longer restarts on every call state update #1777
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
Merged
PratimMallick
merged 4 commits into
develop
from
fix/and-1412-outgoing-ring-structural-equality
Sep 3, 2026
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
80f88c8
fix(core): give RingingState.Outgoing structural equality
aleksandar-apostolov 2c06f6b
test(core): assert the outgoing acceptance stops the ringtone
aleksandar-apostolov fe305e9
Merge branch 'develop' into fix/and-1412-outgoing-ring-structural-equ…
PratimMallick 6ad06b8
Merge branch 'develop' into fix/and-1412-outgoing-ring-structural-equ…
PratimMallick File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
126 changes: 126 additions & 0 deletions
126
...am-video-android-core/src/test/kotlin/io/getstream/video/android/core/RingingStateTest.kt
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,126 @@ | ||
| /* | ||
| * 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 | ||
|
|
||
| import kotlinx.coroutines.ExperimentalCoroutinesApi | ||
| import kotlinx.coroutines.flow.MutableStateFlow | ||
| import kotlinx.coroutines.launch | ||
| import kotlinx.coroutines.test.UnconfinedTestDispatcher | ||
| import kotlinx.coroutines.test.runTest | ||
| import java.util.concurrent.ConcurrentHashMap | ||
| import kotlin.test.Test | ||
| import kotlin.test.assertEquals | ||
| import kotlin.test.assertNotEquals | ||
|
|
||
| /** | ||
| * Structural equality of [RingingState] is load-bearing: the ringing state is published through a | ||
| * [MutableStateFlow], and every consumer relies on the flow conflating unchanged values. Without | ||
| * it, each recomputation publishes a fresh value and restarts side effects that are meant to run | ||
| * once per transition — the auto-cancel ring timer, the outgoing ringtone, and the ongoing-call | ||
| * notification. | ||
| */ | ||
| @OptIn(ExperimentalCoroutinesApi::class) | ||
| class RingingStateTest { | ||
|
|
||
| @Test | ||
| fun `outgoing states with the same acceptance are equal`() { | ||
| assertEquals( | ||
| RingingState.Outgoing(acceptedByCallee = false), | ||
| RingingState.Outgoing(acceptedByCallee = false), | ||
| ) | ||
| assertEquals( | ||
| RingingState.Outgoing(acceptedByCallee = false).hashCode(), | ||
| RingingState.Outgoing(acceptedByCallee = false).hashCode(), | ||
| ) | ||
| } | ||
|
|
||
| @Test | ||
| fun `outgoing states with different acceptance are not equal`() { | ||
| assertNotEquals( | ||
| RingingState.Outgoing(acceptedByCallee = false), | ||
| RingingState.Outgoing(acceptedByCallee = true), | ||
| ) | ||
| } | ||
|
|
||
| @Test | ||
| fun `incoming states with the same acceptance are equal`() { | ||
| assertEquals( | ||
| RingingState.Incoming(acceptedByMe = false), | ||
| RingingState.Incoming(acceptedByMe = false), | ||
| ) | ||
| assertNotEquals( | ||
| RingingState.Incoming(acceptedByMe = false), | ||
| RingingState.Incoming(acceptedByMe = true), | ||
| ) | ||
| } | ||
|
|
||
| @Test | ||
| fun `outgoing and incoming with the same acceptance are not equal`() { | ||
| assertNotEquals<RingingState>( | ||
| RingingState.Outgoing(acceptedByCallee = true), | ||
| RingingState.Incoming(acceptedByMe = true), | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * `CallState.previousRingingStates` is a hash set. Without structural equality every | ||
| * recomputation adds a new member and the set grows for the lifetime of the ring. | ||
| */ | ||
| @Test | ||
| fun `identical outgoing states collapse in a hash set`() { | ||
| val states = ConcurrentHashMap.newKeySet<RingingState>() | ||
|
|
||
| repeat(50) { states.add(RingingState.Outgoing(acceptedByCallee = false)) } | ||
| states.add(RingingState.Outgoing(acceptedByCallee = true)) | ||
|
|
||
| assertEquals(2, states.size) | ||
| } | ||
|
|
||
| /** | ||
| * The mechanism every side effect depends on: repeated identical outgoing states must not be | ||
| * republished. `CallState.updateRingingState` allocates a new instance on every run, so | ||
| * identity equality here would re-emit on each recomputation. | ||
| */ | ||
| @Test | ||
| fun `state flow does not republish identical outgoing states`() = runTest { | ||
| val ringingState = MutableStateFlow<RingingState>(RingingState.Idle) | ||
| val emissions = mutableListOf<RingingState>() | ||
|
|
||
| // The collector has to observe every published value, so it runs eagerly on assignment. | ||
| // A queued collector would only ever see the latest value and the assertion below would | ||
| // hold even without structural equality. | ||
| val collectJob = launch(UnconfinedTestDispatcher(testScheduler)) { | ||
| ringingState.collect { emissions.add(it) } | ||
| } | ||
|
|
||
| // Three recomputations that all resolve to "outgoing, not yet accepted". | ||
| repeat(3) { ringingState.value = RingingState.Outgoing(acceptedByCallee = false) } | ||
| // A genuine transition must still be published. | ||
| ringingState.value = RingingState.Outgoing(acceptedByCallee = true) | ||
|
|
||
| collectJob.cancel() | ||
|
|
||
| assertEquals( | ||
| listOf( | ||
| RingingState.Idle, | ||
| RingingState.Outgoing(acceptedByCallee = false), | ||
| RingingState.Outgoing(acceptedByCallee = true), | ||
| ), | ||
| emissions, | ||
| ) | ||
| } | ||
| } | ||
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
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.
Uh oh!
There was an error while loading. Please reload this page.