Introduce value class RoomAlias

2024-04-16 10:39:45 +02:00
parent 6a46555462
commit dca3d56aa7
8 changed files with 50 additions and 12 deletions
--- 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
@@ -17,6 +17,7 @@
 package io.element.android.libraries.matrix.api

 import io.element.android.libraries.matrix.api.core.ProgressCallback
+import io.element.android.libraries.matrix.api.core.RoomAlias
 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.core.UserId
@@ -99,6 +100,6 @@ interface MatrixClient : Closeable {

    suspend fun trackRecentlyVisitedRoom(roomId: RoomId): Result<Unit>
    suspend fun getRecentlyVisitedRooms(): Result<List<RoomId>>
-    suspend fun resolveRoomAlias(roomAlias: String): Result<RoomId>
+    suspend fun resolveRoomAlias(roomAlias: RoomAlias): Result<RoomId>
    suspend fun getRoomPreview(roomIdOrAlias: String): Result<RoomPreview>
 }
--- a/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/RoomAlias.kt
+++ b/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/RoomAlias.kt
@@ -0,0 +1,31 @@
+/*
+ * 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.libraries.matrix.api.core
+
+import io.element.android.libraries.androidutils.metadata.isInDebug
+import java.io.Serializable
+
+@JvmInline
+value class RoomAlias(val value: String) : Serializable {
+    init {
+        if (isInDebug && !MatrixPatterns.isRoomAlias(value)) {
+            error("`$value` is not a valid room alias.\n Example room alias: `#room_alias:domain`.")
+        }
+    }
+
+    override fun toString(): String = value
+}
--- a/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/permalink/PermalinkData.kt
+++ b/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/permalink/PermalinkData.kt
@@ -19,6 +19,7 @@ package io.element.android.libraries.matrix.api.permalink
 import android.net.Uri
 import androidx.compose.runtime.Immutable
 import io.element.android.libraries.matrix.api.core.EventId
+import io.element.android.libraries.matrix.api.core.RoomAlias
 import io.element.android.libraries.matrix.api.core.RoomId
 import io.element.android.libraries.matrix.api.core.UserId
 import kotlinx.collections.immutable.ImmutableList
@@ -39,7 +40,7 @@ sealed interface PermalinkData {
    ) : RoomLink

    data class RoomAliasLink(
-        val roomAlias: String,
+        val roomAlias: RoomAlias,
        override val viaParameters: ImmutableList<String>
    ) : RoomLink

@@ -55,7 +56,7 @@ sealed interface PermalinkData {
    ) : EventLink

    data class EventIdAliasLink(
-        val roomAlias: String,
+        val roomAlias: RoomAlias,
        override val eventId: EventId,
        override val viaParameters: ImmutableList<String>
    ) : EventLink
--- 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
@@ -23,6 +23,7 @@ import io.element.android.libraries.core.coroutine.CoroutineDispatchers
 import io.element.android.libraries.core.coroutine.childScope
 import io.element.android.libraries.matrix.api.MatrixClient
 import io.element.android.libraries.matrix.api.core.ProgressCallback
+import io.element.android.libraries.matrix.api.core.RoomAlias
 import io.element.android.libraries.matrix.api.core.RoomId
 import io.element.android.libraries.matrix.api.core.UserId
 import io.element.android.libraries.matrix.api.createroom.CreateRoomParameters
@@ -462,9 +463,9 @@ class RustMatrixClient(
        }
    }

-    override suspend fun resolveRoomAlias(roomAlias: String): Result<RoomId> = withContext(sessionDispatcher) {
+    override suspend fun resolveRoomAlias(roomAlias: RoomAlias): Result<RoomId> = withContext(sessionDispatcher) {
        runCatching {
-            client.resolveRoomAlias(roomAlias).let(::RoomId)
+            client.resolveRoomAlias(roomAlias.value).let(::RoomId)
        }
    }

--- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/permalink/DefaultPermalinkParser.kt
+++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/permalink/DefaultPermalinkParser.kt
@@ -20,6 +20,7 @@ import android.net.Uri
 import com.squareup.anvil.annotations.ContributesBinding
 import io.element.android.libraries.di.AppScope
 import io.element.android.libraries.matrix.api.core.EventId
+import io.element.android.libraries.matrix.api.core.RoomAlias
 import io.element.android.libraries.matrix.api.core.RoomId
 import io.element.android.libraries.matrix.api.core.UserId
 import io.element.android.libraries.matrix.api.permalink.MatrixToConverter
@@ -67,7 +68,7 @@ class DefaultPermalinkParser @Inject constructor(
                    userId = UserId(id.id),
                )
                is MatrixId.RoomAlias -> PermalinkData.RoomAliasLink(
-                    roomAlias = id.alias,
+                    roomAlias = RoomAlias(id.alias),
                    viaParameters = viaParameters,
                )
                is MatrixId.EventOnRoomId -> PermalinkData.EventIdLink(
@@ -76,7 +77,7 @@ class DefaultPermalinkParser @Inject constructor(
                    viaParameters = viaParameters,
                )
                is MatrixId.EventOnRoomAlias -> PermalinkData.EventIdAliasLink(
-                    roomAlias = id.alias,
+                    roomAlias = RoomAlias(id.alias),
                    eventId = EventId(id.eventId),
                    viaParameters = viaParameters,
                )
--- 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
@@ -18,6 +18,7 @@ package io.element.android.libraries.matrix.test

 import io.element.android.libraries.matrix.api.MatrixClient
 import io.element.android.libraries.matrix.api.core.ProgressCallback
+import io.element.android.libraries.matrix.api.core.RoomAlias
 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.core.UserId
@@ -74,7 +75,7 @@ class FakeMatrixClient(
    private val encryptionService: FakeEncryptionService = FakeEncryptionService(),
    private val roomDirectoryService: RoomDirectoryService = FakeRoomDirectoryService(),
    private val accountManagementUrlString: Result<String?> = Result.success(null),
-    private val resolveRoomAliasResult: (String) -> Result<RoomId> = { Result.success(A_ROOM_ID) },
+    private val resolveRoomAliasResult: (RoomAlias) -> Result<RoomId> = { Result.success(A_ROOM_ID) },
    private val getRoomPreviewResult: (String) -> Result<RoomPreview> = { TODO("Not implemented") },
 ) : MatrixClient {
    var setDisplayNameCalled: Boolean = false
@@ -279,7 +280,7 @@ class FakeMatrixClient(
        return Result.success(Unit)
    }

-    override suspend fun resolveRoomAlias(roomAlias: String): Result<RoomId> {
+    override suspend fun resolveRoomAlias(roomAlias: RoomAlias): Result<RoomId> {
        return resolveRoomAliasResult(roomAlias)
    }

--- a/libraries/textcomposer/impl/src/main/kotlin/io/element/android/libraries/textcomposer/mentions/MentionSpanProvider.kt
+++ b/libraries/textcomposer/impl/src/main/kotlin/io/element/android/libraries/textcomposer/mentions/MentionSpanProvider.kt
@@ -39,6 +39,7 @@ import io.element.android.libraries.designsystem.theme.currentUserMentionPillBac
 import io.element.android.libraries.designsystem.theme.currentUserMentionPillText
 import io.element.android.libraries.designsystem.theme.mentionPillBackground
 import io.element.android.libraries.designsystem.theme.mentionPillText
+import io.element.android.libraries.matrix.api.core.RoomAlias
 import io.element.android.libraries.matrix.api.core.SessionId
 import io.element.android.libraries.matrix.api.core.UserId
 import io.element.android.libraries.matrix.api.permalink.PermalinkData
@@ -140,7 +141,7 @@ internal fun MentionSpanPreview() {
                    "https://matrix.to/#/@me:matrix.org" -> PermalinkData.UserLink(UserId("@me:matrix.org"))
                    "https://matrix.to/#/@other:matrix.org" -> PermalinkData.UserLink(UserId("@other:matrix.org"))
                    "https://matrix.to/#/#room:matrix.org" -> PermalinkData.RoomAliasLink(
-                        roomAlias = "#room:matrix.org",
+                        roomAlias = RoomAlias("#room:matrix.org"),
                        viaParameters = persistentListOf(),
                    )
                    else -> TODO()
--- a/libraries/textcomposer/impl/src/test/kotlin/io/element/android/libraries/textcomposer/impl/mentions/MentionSpanProviderTest.kt
+++ b/libraries/textcomposer/impl/src/test/kotlin/io/element/android/libraries/textcomposer/impl/mentions/MentionSpanProviderTest.kt
@@ -18,6 +18,7 @@ package io.element.android.libraries.textcomposer.impl.mentions

 import android.graphics.Color
 import com.google.common.truth.Truth.assertThat
+import io.element.android.libraries.matrix.api.core.RoomAlias
 import io.element.android.libraries.matrix.api.core.UserId
 import io.element.android.libraries.matrix.api.permalink.PermalinkData
 import io.element.android.libraries.matrix.test.A_SESSION_ID
@@ -69,7 +70,7 @@ class MentionSpanProviderTest {
    fun `getting mention span for a room should return a MentionSpan with normal colors`() {
        permalinkParser.givenResult(
            PermalinkData.RoomAliasLink(
-                roomAlias = "#room:matrix.org",
+                roomAlias = RoomAlias("#room:matrix.org"),
                viaParameters = persistentListOf(),
            )
        )
@@ -82,7 +83,7 @@ class MentionSpanProviderTest {
    fun `getting mention span for @room should return a MentionSpan with normal colors`() {
        permalinkParser.givenResult(
            PermalinkData.RoomAliasLink(
-                roomAlias = "#",
+                roomAlias = RoomAlias("#"),
                viaParameters = persistentListOf(),
            )
        )