Skip to content

Improve RtcSession Creation Logic: Handle Errors Gracefully #1576

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.

Sign up for GitHub

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
aleksandar-apostolov merged 4 commits into from
Nov 28, 2025
Merged

Improve RtcSession Creation Logic: Handle Errors Gracefully #1576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1f94285
Replace throwing IllegalStateException with Result.Error or handle it…
rahul-lohra Nov 26, 2025
c13f9fe
Merge branch 'develop' into bugfix/rahullohra/call-cleanup-crash
aleksandar-apostolov Nov 27, 2025
94284d0
Merge branch 'develop' into bugfix/rahullohra/call-cleanup-crash
aleksandar-apostolov Nov 27, 2025
9d137a3
Merge branch 'develop' into bugfix/rahullohra/call-cleanup-crash
aleksandar-apostolov Nov 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 74 additions & 60 deletions stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/Call.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -631,29 +631,28 @@ public class Call(
val sfuUrl = result.value.credentials.server.url
val sfuWsUrl = result.value.credentials.server.wsEndpoint
val iceServers = result.value.credentials.iceServers.map { it.toIceServer() }
try {
session = if (testInstanceProvider.rtcSessionCreator != null) {
testInstanceProvider.rtcSessionCreator!!.invoke()
} else {
RtcSession(
sessionId = this.sessionId,
apiKey = clientImpl.apiKey,
lifecycle = clientImpl.coordinatorConnectionModule.lifecycle,
client = client,
call = this,
sfuUrl = sfuUrl,
sfuWsUrl = sfuWsUrl,
sfuToken = sfuToken,
remoteIceServers = iceServers,
powerManager = powerManager,
)
}

session = if (testInstanceProvider.rtcSessionCreator != null) {
testInstanceProvider.rtcSessionCreator!!.invoke()
} else {
RtcSession(
sessionId = this.sessionId,
apiKey = clientImpl.apiKey,
lifecycle = clientImpl.coordinatorConnectionModule.lifecycle,
client = client,
call = this,
sfuUrl = sfuUrl,
sfuWsUrl = sfuWsUrl,
sfuToken = sfuToken,
remoteIceServers = iceServers,
powerManager = powerManager,
)
}

session?.let {
state._connection.value = RealtimeConnection.Joined(it)
}
session?.let {
state._connection.value = RealtimeConnection.Joined(it)
}

try {
session?.connect()
} catch (e: Exception) {
return Failure(Error.GenericError(e.message ?: "RtcSession error occurred."))
Expand Down Expand Up @@ -791,24 +790,31 @@ public class Call(
)
this.state.removeParticipant(prevSessionId)
session.prepareRejoin()
this.session = RtcSession(
clientImpl,
reconnectAttepmts,
powerManager,
this,
sessionId,
clientImpl.apiKey,
clientImpl.coordinatorConnectionModule.lifecycle,
cred.server.url,
cred.server.wsEndpoint,
cred.token,
cred.iceServers.map { ice ->
ice.toIceServer()
},
)
this.session?.connect(reconnectDetails, currentOptions)
session.cleanup()
monitorSession(joinResponse.value)
try {
this.session = RtcSession(
clientImpl,
reconnectAttepmts,
powerManager,
this,
sessionId,
clientImpl.apiKey,
clientImpl.coordinatorConnectionModule.lifecycle,
cred.server.url,
cred.server.wsEndpoint,
cred.token,
cred.iceServers.map { ice ->
ice.toIceServer()
},
)
this.session?.connect(reconnectDetails, currentOptions)
session.cleanup()
monitorSession(joinResponse.value)
} catch (ex: Exception) {
logger.e(ex) {
"[rejoin] Failed to join response with ex: ${ex.message}"
}
state._connection.value = RealtimeConnection.Failed(ex)
}
} else {
logger.e {
"[rejoin] Failed to get a join response ${joinResponse.errorOrNull()}"
Expand Down Expand Up @@ -847,27 +853,35 @@ public class Call(
reconnect_attempt = reconnectAttepmts,
)
session.prepareRejoin()
val newSession = RtcSession(
clientImpl,
reconnectAttepmts,
powerManager,
this,
sessionId,
clientImpl.apiKey,
clientImpl.coordinatorConnectionModule.lifecycle,
cred.server.url,
cred.server.wsEndpoint,
cred.token,
cred.iceServers.map { ice ->
ice.toIceServer()
},
)
val oldSession = this.session
this.session = newSession
this.session?.connect(reconnectDetails, currentOptions)
monitorSession(joinResponse.value)
oldSession?.leaveWithReason("migrating")
oldSession?.cleanup()
try {
val newSession = RtcSession(
clientImpl,
reconnectAttepmts,
powerManager,
this,
sessionId,
clientImpl.apiKey,
clientImpl.coordinatorConnectionModule.lifecycle,
cred.server.url,
cred.server.wsEndpoint,
cred.token,
cred.iceServers.map { ice ->
ice.toIceServer()
},
)
val oldSession = this.session
this.session = newSession
this.session?.connect(reconnectDetails, currentOptions)
monitorSession(joinResponse.value)
oldSession?.leaveWithReason("migrating")
oldSession?.cleanup()
} catch (ex: Exception) {
logger.e(ex) {
"[switchSfu] Failed to join during " +
"migration - Error ${ex.message}"
}
state._connection.value = RealtimeConnection.Failed(ex)
}
} else {
logger.e {
"[switchSfu] Failed to get a join response during " +
Expand Down
1 change: 1 addition & 0 deletions stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/RtcSession.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,7 @@ data class TrackDimensions(
* * Or when the UI layout changes
* * The SFU tells us what resolution to publish using the ChangePublishQualityEvent event
*
* For developers: RtcSession throws [IllegalStateException] because its [coroutineScope] & [rtcSessionScope] throws it
*/
public class RtcSession internal constructor(
client: StreamVideo,
Expand Down
5 changes: 5 additions & 0 deletions ...roid-core/src/main/kotlin/io/getstream/video/android/core/call/scope/ScopeProviderImpl.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.asCoroutineDispatcher
import java.util.concurrent.ExecutorService
import java.util.concurrent.Executors
import kotlin.jvm.Throws

/**
* Implementation of [ScopeProvider] that manages coroutine scopes for RTC sessions.
Expand All @@ -41,7 +42,9 @@ internal class ScopeProviderImpl(
private var executor: ExecutorService? = null
private var isCleanedUp = false

@Throws(IllegalStateException::class)
override fun getCoroutineScope(supervisorJob: CompletableJob): CoroutineScope {
// Future: We should not throw exception. Instead return Result.Fail
check(!isCleanedUp) { "ScopeProvider has been cleaned up" }
logger.d { "Creating coroutine scope for RTC session main" }
return CoroutineScope(
Expand All @@ -51,7 +54,9 @@ internal class ScopeProviderImpl(
)
}

@Throws(IllegalStateException::class)
override fun getRtcSessionScope(supervisorJob: CompletableJob, callId: String): CoroutineScope {
// Future: We should not throw exception. Instead return Result.Fail
check(!isCleanedUp) { "ScopeProvider has been cleaned up" }
logger.d { "Creating RTC session scope for callId: $callId" }

Expand Down