diff --git a/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/utils/DefaultCallWidgetProvider.kt b/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/utils/DefaultCallWidgetProvider.kt index f36269abc6..df7a031753 100644 --- a/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/utils/DefaultCallWidgetProvider.kt +++ b/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/utils/DefaultCallWidgetProvider.kt @@ -20,6 +20,7 @@ import com.squareup.anvil.annotations.ContributesBinding import io.element.android.appconfig.ElementCallConfig import io.element.android.libraries.di.AppScope import io.element.android.libraries.matrix.api.MatrixClientProvider +import io.element.android.libraries.matrix.api.call.ElementCallBaseUrlProvider import io.element.android.libraries.matrix.api.core.RoomId import io.element.android.libraries.matrix.api.core.SessionId import io.element.android.libraries.matrix.api.widget.CallWidgetSettingsProvider @@ -41,9 +42,10 @@ class DefaultCallWidgetProvider @Inject constructor( languageTag: String?, theme: String?, ): Result = runCatching { - val room = matrixClientsProvider.getOrRestore(sessionId).getOrThrow().getRoom(roomId) ?: error("Room not found") + val matrixClient = matrixClientsProvider.getOrRestore(sessionId).getOrThrow() + val room = matrixClient.getRoom(roomId) ?: error("Room not found") val baseUrl = appPreferencesStore.getCustomElementCallBaseUrlFlow().firstOrNull() - ?: elementCallBaseUrlProvider.provides(sessionId) + ?: elementCallBaseUrlProvider.provides(matrixClient) ?: ElementCallConfig.DEFAULT_BASE_URL val widgetSettings = callWidgetSettingsProvider.provide(baseUrl, encrypted = room.isEncrypted) val callUrl = room.generateWidgetWebViewUrl( diff --git a/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/utils/ElementCallBaseUrlProvider.kt b/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/utils/ElementCallBaseUrlProvider.kt deleted file mode 100644 index 63eb5208dd..0000000000 --- a/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/utils/ElementCallBaseUrlProvider.kt +++ /dev/null @@ -1,61 +0,0 @@ -/* - * Copyright (c) 2024 New Vector Ltd - * - * 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.element.android.features.call.impl.utils - -import com.squareup.anvil.annotations.ContributesBinding -import io.element.android.features.call.impl.wellknown.CallWellknownAPI -import io.element.android.libraries.core.coroutine.CoroutineDispatchers -import io.element.android.libraries.di.AppScope -import io.element.android.libraries.di.SingleIn -import io.element.android.libraries.matrix.api.core.SessionId -import io.element.android.libraries.network.RetrofitFactory -import kotlinx.coroutines.withContext -import retrofit2.HttpException -import timber.log.Timber -import java.net.HttpURLConnection -import javax.inject.Inject - -interface ElementCallBaseUrlProvider { - suspend fun provides(sessionId: SessionId): String? -} - -@SingleIn(AppScope::class) -@ContributesBinding(AppScope::class) -class DefaultElementCallBaseUrlProvider @Inject constructor( - private val retrofitFactory: RetrofitFactory, - private val coroutineDispatchers: CoroutineDispatchers, -) : ElementCallBaseUrlProvider { - private val apiCache = mutableMapOf() - - override suspend fun provides(sessionId: SessionId): String? = withContext(coroutineDispatchers.io) { - val domain = sessionId.value.substringAfter(":") - val callWellknownAPI = apiCache.getOrPut(sessionId) { - retrofitFactory.create("https://$domain") - .create(CallWellknownAPI::class.java) - } - try { - callWellknownAPI.getCallWellKnown().widgetUrl - } catch (e: HttpException) { - // Ignore Http 404, but re-throws any other exceptions - if (e.code() != HttpURLConnection.HTTP_NOT_FOUND) { - throw e - } - Timber.w(e, "Failed to fetch wellknown data") - null - } - } -} diff --git a/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/MatrixClient.kt b/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/MatrixClient.kt index c4b56236e7..b3b47d4499 100644 --- a/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/MatrixClient.kt +++ b/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/MatrixClient.kt @@ -127,4 +127,9 @@ interface MatrixClient : Closeable { * compute it manually. */ fun userIdServerName(): String + + /** + * Execute generic GET requests through the SDKs internal HTTP client. + */ + suspend fun getUrl(url: String): Result } diff --git a/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/wellknown/CallWellknownAPI.kt b/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/call/ElementCallBaseUrlProvider.kt similarity index 67% rename from features/call/impl/src/main/kotlin/io/element/android/features/call/impl/wellknown/CallWellknownAPI.kt rename to libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/call/ElementCallBaseUrlProvider.kt index e2b5d0e54f..94c9cb3489 100644 --- a/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/wellknown/CallWellknownAPI.kt +++ b/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/call/ElementCallBaseUrlProvider.kt @@ -5,7 +5,7 @@ * 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 + * https://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, @@ -14,11 +14,10 @@ * limitations under the License. */ -package io.element.android.features.call.impl.wellknown +package io.element.android.libraries.matrix.api.call -import retrofit2.http.GET +import io.element.android.libraries.matrix.api.MatrixClient -internal interface CallWellknownAPI { - @GET(".well-known/element/call.json") - suspend fun getCallWellKnown(): CallWellKnown +interface ElementCallBaseUrlProvider { + suspend fun provides(matrixClient: MatrixClient): String? } diff --git a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/RustMatrixClient.kt b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/RustMatrixClient.kt index 7f47082fd1..c8574a7934 100644 --- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/RustMatrixClient.kt +++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/RustMatrixClient.kt @@ -291,6 +291,12 @@ class RustMatrixClient( ?: sessionId.value.substringAfter(":") } + override suspend fun getUrl(url: String): Result = withContext(sessionDispatcher) { + runCatching { + client.getUrl(url) + } + } + override suspend fun getRoom(roomId: RoomId): MatrixRoom? { return roomFactory.create(roomId) } diff --git a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/call/DefaultElementCallBaseUrlProvider.kt b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/call/DefaultElementCallBaseUrlProvider.kt new file mode 100644 index 0000000000..debc0e9174 --- /dev/null +++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/call/DefaultElementCallBaseUrlProvider.kt @@ -0,0 +1,52 @@ +/* + * Copyright (c) 2024 New Vector Ltd + * + * 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 + * + * https://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.element.android.libraries.matrix.impl.call + +import com.squareup.anvil.annotations.ContributesBinding +import io.element.android.libraries.di.AppScope +import io.element.android.libraries.matrix.api.MatrixClient +import io.element.android.libraries.matrix.api.call.ElementCallBaseUrlProvider +import timber.log.Timber +import javax.inject.Inject + +@ContributesBinding(AppScope::class) +class DefaultElementCallBaseUrlProvider @Inject constructor( + private val elementWellKnownParser: ElementWellKnownParser, +) : ElementCallBaseUrlProvider { + override suspend fun provides(matrixClient: MatrixClient): String? { + val url = buildString { + append("https://") + append(matrixClient.userIdServerName()) + append("/.well-known/element/element.json") + } + return matrixClient.getUrl(url) + .onFailure { failure -> + Timber.w(failure, "Failed to fetch well-known element.json") + } + .getOrNull() + ?.let { wellKnownStr -> + elementWellKnownParser.parse(wellKnownStr) + .onFailure { failure -> + // Can be a HTML 404. + Timber.w(failure, "Failed to parse content") + } + .getOrNull() + } + ?.call + ?.widgetUrl + } +} diff --git a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/call/ElementWellKnownParser.kt b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/call/ElementWellKnownParser.kt new file mode 100644 index 0000000000..afc0baf240 --- /dev/null +++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/call/ElementWellKnownParser.kt @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2024 New Vector Ltd + * + * 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 + * + * https://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.element.android.libraries.matrix.impl.call + +import com.squareup.anvil.annotations.ContributesBinding +import io.element.android.libraries.di.AppScope +import org.matrix.rustcomponents.sdk.ElementWellKnown +import org.matrix.rustcomponents.sdk.makeElementWellKnown + +interface ElementWellKnownParser { + fun parse(str: String): Result +} + +@ContributesBinding(AppScope::class) +class RustElementWellKnownParser : ElementWellKnownParser { + override fun parse(str: String): Result { + return runCatching { + makeElementWellKnown(str) + } + } +} diff --git a/libraries/matrix/impl/src/test/kotlin/io/element/android/libraries/matrix/impl/call/DefaultElementCallBaseUrlProviderTest.kt b/libraries/matrix/impl/src/test/kotlin/io/element/android/libraries/matrix/impl/call/DefaultElementCallBaseUrlProviderTest.kt new file mode 100644 index 0000000000..1d6e8fe443 --- /dev/null +++ b/libraries/matrix/impl/src/test/kotlin/io/element/android/libraries/matrix/impl/call/DefaultElementCallBaseUrlProviderTest.kt @@ -0,0 +1,107 @@ +/* + * Copyright (c) 2024 New Vector Ltd + * + * 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 + * + * https://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.element.android.libraries.matrix.impl.call + +import com.google.common.truth.Truth.assertThat +import io.element.android.libraries.matrix.test.AN_EXCEPTION +import io.element.android.libraries.matrix.test.FakeMatrixClient +import io.element.android.tests.testutils.lambda.lambdaRecorder +import io.element.android.tests.testutils.lambda.value +import kotlinx.coroutines.test.runTest +import org.junit.Test +import org.matrix.rustcomponents.sdk.ElementCallWellKnown +import org.matrix.rustcomponents.sdk.ElementWellKnown + +class DefaultElementCallBaseUrlProviderTest { + @Test + fun `provides returns null when getUrl returns an error`() = runTest { + val userIdServerNameLambda = lambdaRecorder { "example.com" } + val getUrlLambda = lambdaRecorder> { _ -> + Result.failure(AN_EXCEPTION) + } + val sut = DefaultElementCallBaseUrlProvider( + FakeElementWellKnownParser( + Result.success(createElementWellKnown("")) + ) + ) + val matrixClient = FakeMatrixClient( + userIdServerNameLambda = userIdServerNameLambda, + getUrlLambda = getUrlLambda, + ) + val result = sut.provides(matrixClient) + assertThat(result).isNull() + userIdServerNameLambda.assertions().isCalledOnce() + getUrlLambda.assertions().isCalledOnce() + .with(value("https://example.com/.well-known/element/element.json")) + } + + @Test + fun `provides returns null when content parsing fails`() = runTest { + val userIdServerNameLambda = lambdaRecorder { "example.com" } + val getUrlLambda = lambdaRecorder> { _ -> + Result.success("""{"call":{"widget_url":"https://example.com/call"}}""") + } + val sut = DefaultElementCallBaseUrlProvider( + createFakeElementWellKnownParser( + Result.failure(AN_EXCEPTION) + ) + ) + val matrixClient = FakeMatrixClient( + userIdServerNameLambda = userIdServerNameLambda, + getUrlLambda = getUrlLambda, + ) + val result = sut.provides(matrixClient) + assertThat(result).isNull() + userIdServerNameLambda.assertions().isCalledOnce() + getUrlLambda.assertions().isCalledOnce() + .with(value("https://example.com/.well-known/element/element.json")) + } + + @Test + fun `provides returns value when getUrl returns correct content`() = runTest { + val userIdServerNameLambda = lambdaRecorder { "example.com" } + val getUrlLambda = lambdaRecorder> { _ -> + Result.success("""{"call":{"widget_url":"https://example.com/call"}}""") + } + val sut = DefaultElementCallBaseUrlProvider( + createFakeElementWellKnownParser( + Result.success(createElementWellKnown("aUrl")) + ) + ) + val matrixClient = FakeMatrixClient( + userIdServerNameLambda = userIdServerNameLambda, + getUrlLambda = getUrlLambda, + ) + val result = sut.provides(matrixClient) + assertThat(result).isEqualTo("aUrl") + userIdServerNameLambda.assertions().isCalledOnce() + getUrlLambda.assertions().isCalledOnce() + .with(value("https://example.com/.well-known/element/element.json")) + } + + private fun createFakeElementWellKnownParser(result: Result): FakeElementWellKnownParser { + return FakeElementWellKnownParser(result) + } + + private fun createElementWellKnown(widgetUrl: String): ElementWellKnown { + return ElementWellKnown( + call = ElementCallWellKnown( + widgetUrl = widgetUrl + ) + ) + } +} diff --git a/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/wellknown/CallWellKnown.kt b/libraries/matrix/impl/src/test/kotlin/io/element/android/libraries/matrix/impl/call/FakeElementWellKnownParser.kt similarity index 58% rename from features/call/impl/src/main/kotlin/io/element/android/features/call/impl/wellknown/CallWellKnown.kt rename to libraries/matrix/impl/src/test/kotlin/io/element/android/libraries/matrix/impl/call/FakeElementWellKnownParser.kt index b2e87c907b..d6108b955f 100644 --- a/features/call/impl/src/main/kotlin/io/element/android/features/call/impl/wellknown/CallWellKnown.kt +++ b/libraries/matrix/impl/src/test/kotlin/io/element/android/libraries/matrix/impl/call/FakeElementWellKnownParser.kt @@ -5,7 +5,7 @@ * 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 + * https://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, @@ -14,22 +14,14 @@ * limitations under the License. */ -package io.element.android.features.call.impl.wellknown +package io.element.android.libraries.matrix.impl.call -import kotlinx.serialization.SerialName -import kotlinx.serialization.Serializable +import org.matrix.rustcomponents.sdk.ElementWellKnown -/** - * Example: - * 
- * {
- *     "widget_url": "https://call.server.com"
- * }
- *
- * . - */ -@Serializable -data class CallWellKnown( - @SerialName("widget_url") - val widgetUrl: String? = null, -) +class FakeElementWellKnownParser( + private val result: Result +) : ElementWellKnownParser { + override fun parse(str: String): Result { + return result + } +} diff --git a/libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/FakeMatrixClient.kt b/libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/FakeMatrixClient.kt index 5fb58694be..1b6223279c 100644 --- a/libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/FakeMatrixClient.kt +++ b/libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/FakeMatrixClient.kt @@ -82,6 +82,8 @@ class FakeMatrixClient( private val resolveRoomAliasResult: (RoomAlias) -> Result = { Result.success(ResolvedRoomAlias(A_ROOM_ID, emptyList())) }, private val getRoomPreviewFromRoomIdResult: (RoomId, List) -> Result = { _, _ -> Result.failure(AN_EXCEPTION) }, private val clearCacheLambda: () -> Unit = { lambdaError() }, + private val userIdServerNameLambda: () -> String = { lambdaError() }, + private val getUrlLambda: (String) -> Result = { lambdaError() }, ) : MatrixClient { var setDisplayNameCalled: Boolean = false private set @@ -315,6 +317,10 @@ class FakeMatrixClient( override fun sendQueueDisabledFlow(): Flow = sendQueueDisabledFlow override fun userIdServerName(): String { - TODO("Not yet implemented") + return userIdServerNameLambda() + } + + override suspend fun getUrl(url: String): Result { + return getUrlLambda(url) } }