RegionUrlProvider.kt
5.0 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/*
* Copyright 2024-2025 LiveKit, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.livekit.android.room
import android.os.SystemClock
import androidx.annotation.VisibleForTesting
import dagger.assisted.Assisted
import dagger.assisted.AssistedFactory
import dagger.assisted.AssistedInject
import io.livekit.android.util.LKLog
import io.livekit.android.util.executeAsync
import kotlinx.coroutines.ExperimentalCoroutinesApi
import kotlinx.coroutines.coroutineScope
import kotlinx.serialization.Serializable
import kotlinx.serialization.decodeFromString
import kotlinx.serialization.json.Json
import livekit.LivekitRtc
import okhttp3.OkHttpClient
import okhttp3.Request
import java.net.URI
/**
* @suppress
*/
class RegionUrlProvider
@AssistedInject
constructor(
@Assisted val serverUrl: URI,
@Assisted var token: String,
private val okHttpClient: OkHttpClient,
private val json: Json,
) {
private var regionSettings: RegionSettings? = null
private var lastUpdateAt: Long = 0L
private var settingsCacheTimeMs = 30000
private var attemptedRegions = mutableSetOf<RegionInfo>()
fun isLKCloud() = serverUrl.isLKCloud()
@Throws(RoomException.ConnectException::class)
suspend fun getNextBestRegionUrl() = coroutineScope {
if (!isLKCloud()) {
throw IllegalStateException("Region availability is only supported for LiveKit Cloud domains")
}
if (regionSettings == null || SystemClock.elapsedRealtime() - lastUpdateAt > settingsCacheTimeMs) {
fetchRegionSettings()
}
val regions = regionSettings?.regions ?: return@coroutineScope null
val regionsLeft = regions.filter { region ->
!attemptedRegions.any { attempted -> attempted.url == region.url }
}
if (regionsLeft.isEmpty()) {
return@coroutineScope null
}
val nextRegion = regionsLeft.first()
attemptedRegions.add(nextRegion)
LKLog.d { "next region: $nextRegion" }
return@coroutineScope nextRegion.url
}
@Throws(RoomException.ConnectException::class)
@OptIn(ExperimentalCoroutinesApi::class)
suspend fun fetchRegionSettings(): RegionSettings? {
val request = Request.Builder()
.url(serverUrl.getCloudConfigUrl("/regions").toString())
.header("Authorization", "Bearer $token")
.build()
val bodyString = okHttpClient.newCall(request)
.executeAsync()
.use { response ->
if (!response.isSuccessful) {
throw RoomException.ConnectException("Could not fetch region settings: ${response.code} ${response.message}")
}
return@use response.body?.string()
}
if (bodyString == null) {
throw RoomException.ConnectException("Could not fetch region settings: empty response body!")
}
return json.decodeFromString<RegionSettings>(bodyString).also {
regionSettings = it
lastUpdateAt = SystemClock.elapsedRealtime()
}
}
fun clearAttemptedRegions() {
attemptedRegions.clear()
}
fun setServerReportedRegions(regionSettings: RegionSettings) {
this.regionSettings = regionSettings
this.lastUpdateAt = SystemClock.elapsedRealtime()
}
@AssistedFactory
interface Factory {
fun create(serverUrl: URI, token: String): RegionUrlProvider
}
}
internal fun URI.isLKCloud() = regionUrlProviderTesting || host != null && (host.endsWith(".livekit.cloud") || host.endsWith(".livekit.run"))
internal fun URI.getCloudConfigUrl(appendPath: String = ""): URI {
val scheme = if (this.scheme.startsWith("ws")) {
this.scheme.replaceFirst("ws", "http")
} else {
this.scheme
}
return URI(
scheme,
null,
this.host,
this.port,
"/settings$appendPath",
null,
null,
)
}
private var regionUrlProviderTesting = false
@VisibleForTesting
fun setRegionUrlProviderTesting(enable: Boolean) {
regionUrlProviderTesting = enable
}
/**
* @suppress
*/
@Serializable
data class RegionSettings(val regions: List<RegionInfo>) {
companion object {
fun fromProto(proto: LivekitRtc.RegionSettings): RegionSettings {
return RegionSettings(
proto.regionsList.map { region ->
RegionInfo(region.region, region.url, region.distance)
},
)
}
}
}
/**
* @suppress
*/
@Serializable
data class RegionInfo(val region: String, val url: String, val distance: Long)