Split module deeplink to api and impl.

bmarty · bmarty · commit 4e5bbaf94640 · 2025-08-25T11:36:42.000+02:00
diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -301,6 +301,7 @@ dependencies {
     testImplementation(libs.test.turbine)
     testImplementation(projects.libraries.matrix.test)
     testImplementation(projects.services.toolbox.test)
+    testImplementation(projects.tests.testutils)
 
     koverDependencies()
 }
diff --git a/app/src/main/kotlin/io/element/android/x/intent/DefaultIntentProvider.kt b/app/src/main/kotlin/io/element/android/x/intent/DefaultIntentProvider.kt
@@ -11,7 +11,7 @@ import android.content.Context
 import android.content.Intent
 import androidx.core.net.toUri
 import com.squareup.anvil.annotations.ContributesBinding
-import io.element.android.libraries.deeplink.DeepLinkCreator
+import io.element.android.libraries.deeplink.api.DeepLinkCreator
 import io.element.android.libraries.di.AppScope
 import io.element.android.libraries.di.ApplicationContext
 import io.element.android.libraries.matrix.api.core.RoomId
diff --git a/app/src/test/kotlin/io/element/android/x/intent/DefaultIntentProviderTest.kt b/app/src/test/kotlin/io/element/android/x/intent/DefaultIntentProviderTest.kt
@@ -5,15 +5,22 @@
  * Please see LICENSE files in the repository root for full details.
  */
 
+@file:Suppress("SameParameterValue")
+
 package io.element.android.x.intent
 
 import android.content.Context
 import android.content.Intent
 import com.google.common.truth.Truth.assertThat
-import io.element.android.libraries.deeplink.DeepLinkCreator
+import io.element.android.libraries.deeplink.api.DeepLinkCreator
+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.ThreadId
 import io.element.android.libraries.matrix.test.A_ROOM_ID
 import io.element.android.libraries.matrix.test.A_SESSION_ID
 import io.element.android.libraries.matrix.test.A_THREAD_ID
+import io.element.android.tests.testutils.lambda.lambdaRecorder
+import io.element.android.tests.testutils.lambda.value
 import io.element.android.x.MainActivity
 import org.junit.Test
 import org.junit.runner.RunWith
@@ -23,45 +30,31 @@ import org.robolectric.RuntimeEnvironment
 @RunWith(RobolectricTestRunner::class)
 class DefaultIntentProviderTest {
     @Test
-    fun `test getViewRoomIntent with Session`() {
-        val sut = createDefaultIntentProvider()
-        val result = sut.getViewRoomIntent(
-            sessionId = A_SESSION_ID,
-            roomId = null,
-            threadId = null,
-        )
-        result.commonAssertions()
-        assertThat(result.data.toString()).isEqualTo("elementx://open/@alice:server.org")
-    }
-
-    @Test
-    fun `test getViewRoomIntent with Session and Room`() {
-        val sut = createDefaultIntentProvider()
-        val result = sut.getViewRoomIntent(
-            sessionId = A_SESSION_ID,
-            roomId = A_ROOM_ID,
-            threadId = null,
+    fun `test getViewRoomIntent with data`() {
+        val deepLinkCreator = lambdaRecorder<SessionId, RoomId?, ThreadId?, String> { _, _, _ -> "deepLinkCreatorResult" }
+        val sut = createDefaultIntentProvider(
+            deepLinkCreator = { sessionId, roomId, threadId -> deepLinkCreator.invoke(sessionId, roomId, threadId) },
         )
-        result.commonAssertions()
-        assertThat(result.data.toString()).isEqualTo("elementx://open/@alice:server.org/!aRoomId:domain")
-    }
-
-    @Test
-    fun `test getViewRoomIntent with Session, Room and Thread`() {
-        val sut = createDefaultIntentProvider()
         val result = sut.getViewRoomIntent(
             sessionId = A_SESSION_ID,
             roomId = A_ROOM_ID,
             threadId = A_THREAD_ID,
         )
         result.commonAssertions()
-        assertThat(result.data.toString()).isEqualTo("elementx://open/@alice:server.org/!aRoomId:domain/\$aThreadId")
+        assertThat(result.data.toString()).isEqualTo("deepLinkCreatorResult")
+        deepLinkCreator.assertions().isCalledOnce().with(
+            value(A_SESSION_ID),
+            value(A_ROOM_ID),
+            value(A_THREAD_ID),
+        )
     }
 
-    private fun createDefaultIntentProvider(): DefaultIntentProvider {
+    private fun createDefaultIntentProvider(
+        deepLinkCreator: DeepLinkCreator = DeepLinkCreator { _, _, _ -> "" },
+    ): DefaultIntentProvider {
         return DefaultIntentProvider(
             context = RuntimeEnvironment.getApplication() as Context,
-            deepLinkCreator = DeepLinkCreator(),
+            deepLinkCreator = deepLinkCreator,
         )
     }
 
diff --git a/appnav/build.gradle.kts b/appnav/build.gradle.kts
@@ -27,7 +27,7 @@ dependencies {
     implementation(projects.libraries.core)
     implementation(projects.libraries.androidutils)
     implementation(projects.libraries.architecture)
-    implementation(projects.libraries.deeplink)
+    implementation(projects.libraries.deeplink.api)
     implementation(projects.libraries.matrix.api)
     implementation(projects.libraries.oidc.api)
     implementation(projects.libraries.preferences.api)
diff --git a/appnav/src/main/kotlin/io/element/android/appnav/RootFlowNode.kt b/appnav/src/main/kotlin/io/element/android/appnav/RootFlowNode.kt
@@ -44,7 +44,7 @@ import io.element.android.libraries.architecture.BaseFlowNode
 import io.element.android.libraries.architecture.createNode
 import io.element.android.libraries.architecture.waitForChildAttached
 import io.element.android.libraries.core.uri.ensureProtocol
-import io.element.android.libraries.deeplink.DeeplinkData
+import io.element.android.libraries.deeplink.api.DeeplinkData
 import io.element.android.libraries.designsystem.theme.components.CircularProgressIndicator
 import io.element.android.libraries.di.AppScope
 import io.element.android.libraries.matrix.api.auth.MatrixAuthenticationService
diff --git a/appnav/src/main/kotlin/io/element/android/appnav/intent/IntentResolver.kt b/appnav/src/main/kotlin/io/element/android/appnav/intent/IntentResolver.kt
@@ -10,8 +10,8 @@ package io.element.android.appnav.intent
 import android.content.Intent
 import io.element.android.features.login.api.LoginIntentResolver
 import io.element.android.features.login.api.LoginParams
-import io.element.android.libraries.deeplink.DeeplinkData
-import io.element.android.libraries.deeplink.DeeplinkParser
+import io.element.android.libraries.deeplink.api.DeeplinkData
+import io.element.android.libraries.deeplink.api.DeeplinkParser
 import io.element.android.libraries.matrix.api.permalink.PermalinkData
 import io.element.android.libraries.matrix.api.permalink.PermalinkParser
 import io.element.android.libraries.oidc.api.OidcAction
diff --git a/appnav/src/test/kotlin/io/element/android/appnav/intent/IntentResolverTest.kt b/appnav/src/test/kotlin/io/element/android/appnav/intent/IntentResolverTest.kt
@@ -14,9 +14,7 @@ import androidx.core.net.toUri
 import com.google.common.truth.Truth.assertThat
 import io.element.android.features.login.api.LoginParams
 import io.element.android.features.login.test.FakeLoginIntentResolver
-import io.element.android.libraries.deeplink.DeepLinkCreator
-import io.element.android.libraries.deeplink.DeeplinkData
-import io.element.android.libraries.deeplink.DeeplinkParser
+import io.element.android.libraries.deeplink.api.DeeplinkData
 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_ROOM_ID
@@ -46,15 +44,11 @@ class IntentResolverTest {
 
     @Test
     fun `test resolve navigation intent root`() {
-        val sut = createIntentResolver()
+        val sut = createIntentResolver(
+            deeplinkParserResult = DeeplinkData.Root(A_SESSION_ID)
+        )
         val intent = Intent(RuntimeEnvironment.getApplication(), Activity::class.java).apply {
             action = Intent.ACTION_VIEW
-            data = DeepLinkCreator().room(
-                sessionId = A_SESSION_ID,
-                roomId = null,
-                threadId = null,
-            )
-                .toUri()
         }
         val result = sut.resolve(intent)
         assertThat(result).isEqualTo(
@@ -68,15 +62,15 @@ class IntentResolverTest {
 
     @Test
     fun `test resolve navigation intent room`() {
-        val sut = createIntentResolver()
-        val intent = Intent(RuntimeEnvironment.getApplication(), Activity::class.java).apply {
-            action = Intent.ACTION_VIEW
-            data = DeepLinkCreator().room(
+        val sut = createIntentResolver(
+            deeplinkParserResult = DeeplinkData.Room(
                 sessionId = A_SESSION_ID,
                 roomId = A_ROOM_ID,
                 threadId = null,
             )
-                .toUri()
+        )
+        val intent = Intent(RuntimeEnvironment.getApplication(), Activity::class.java).apply {
+            action = Intent.ACTION_VIEW
         }
         val result = sut.resolve(intent)
         assertThat(result).isEqualTo(
@@ -92,15 +86,15 @@ class IntentResolverTest {
 
     @Test
     fun `test resolve navigation intent thread`() {
-        val sut = createIntentResolver()
-        val intent = Intent(RuntimeEnvironment.getApplication(), Activity::class.java).apply {
-            action = Intent.ACTION_VIEW
-            data = DeepLinkCreator().room(
+        val sut = createIntentResolver(
+            deeplinkParserResult = DeeplinkData.Room(
                 sessionId = A_SESSION_ID,
                 roomId = A_ROOM_ID,
                 threadId = A_THREAD_ID,
             )
-                .toUri()
+        )
+        val intent = Intent(RuntimeEnvironment.getApplication(), Activity::class.java).apply {
+            action = Intent.ACTION_VIEW
         }
         val result = sut.resolve(intent)
         assertThat(result).isEqualTo(
@@ -240,12 +234,13 @@ class IntentResolverTest {
     }
 
     private fun createIntentResolver(
+        deeplinkParserResult: DeeplinkData? = null,
         permalinkParserResult: (String) -> PermalinkData = { lambdaError() },
         loginIntentResolverResult: (String) -> LoginParams? = { lambdaError() },
         oidcIntentResolverResult: (Intent) -> OidcAction? = { lambdaError() },
     ): IntentResolver {
         return IntentResolver(
-            deeplinkParser = DeeplinkParser(),
+            deeplinkParser = { deeplinkParserResult },
             loginIntentResolver = FakeLoginIntentResolver(
                 parseResult = loginIntentResolverResult,
             ),
diff --git a/features/createroom/impl/build.gradle.kts b/features/createroom/impl/build.gradle.kts
@@ -32,7 +32,7 @@ dependencies {
     implementation(projects.libraries.designsystem)
     implementation(projects.libraries.uiStrings)
     implementation(projects.libraries.androidutils)
-    implementation(projects.libraries.deeplink)
+    implementation(projects.libraries.deeplink.api)
     implementation(projects.libraries.mediapickers.api)
     implementation(projects.libraries.mediaupload.api)
     implementation(projects.libraries.permissions.api)
diff --git a/features/home/impl/build.gradle.kts b/features/home/impl/build.gradle.kts
@@ -38,7 +38,7 @@ dependencies {
     implementation(projects.libraries.dateformatter.api)
     implementation(projects.libraries.eventformatter.api)
     implementation(projects.libraries.indicator.api)
-    implementation(projects.libraries.deeplink)
+    implementation(projects.libraries.deeplink.api)
     implementation(projects.libraries.fullscreenintent.api)
     implementation(projects.libraries.permissions.api)
     implementation(projects.libraries.permissions.noop)
diff --git a/features/home/impl/src/main/kotlin/io/element/android/features/home/impl/HomeFlowNode.kt b/features/home/impl/src/main/kotlin/io/element/android/features/home/impl/HomeFlowNode.kt
@@ -44,7 +44,7 @@ import io.element.android.features.reportroom.api.ReportRoomEntryPoint
 import io.element.android.libraries.architecture.BackstackView
 import io.element.android.libraries.architecture.BaseFlowNode
 import io.element.android.libraries.architecture.appyx.launchMolecule
-import io.element.android.libraries.deeplink.usecase.InviteFriendsUseCase
+import io.element.android.libraries.deeplink.api.usecase.InviteFriendsUseCase
 import io.element.android.libraries.di.SessionScope
 import io.element.android.libraries.matrix.api.MatrixClient
 import io.element.android.libraries.matrix.api.core.RoomId
diff --git a/features/startchat/impl/build.gradle.kts b/features/startchat/impl/build.gradle.kts
@@ -33,7 +33,7 @@ dependencies {
     implementation(projects.libraries.designsystem)
     implementation(projects.libraries.uiStrings)
     implementation(projects.libraries.androidutils)
-    implementation(projects.libraries.deeplink)
+    implementation(projects.libraries.deeplink.api)
     implementation(projects.libraries.mediapickers.api)
     implementation(projects.libraries.mediaupload.api)
     implementation(projects.libraries.permissions.api)
diff --git a/features/startchat/impl/src/main/kotlin/io/element/android/features/startchat/impl/root/StartChatNode.kt b/features/startchat/impl/src/main/kotlin/io/element/android/features/startchat/impl/root/StartChatNode.kt
@@ -21,7 +21,7 @@ import dagger.assisted.AssistedInject
 import im.vector.app.features.analytics.plan.MobileScreen
 import io.element.android.anvilannotations.ContributesNode
 import io.element.android.features.startchat.StartChatNavigator
-import io.element.android.libraries.deeplink.usecase.InviteFriendsUseCase
+import io.element.android.libraries.deeplink.api.usecase.InviteFriendsUseCase
 import io.element.android.libraries.di.SessionScope
 import io.element.android.libraries.matrix.api.core.toRoomIdOrAlias
 import io.element.android.services.analytics.api.AnalyticsService
diff --git a/libraries/deeplink/api/build.gradle.kts b/libraries/deeplink/api/build.gradle.kts
@@ -0,0 +1,17 @@
+/*
+ * Copyright 2022-2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+ * Please see LICENSE files in the repository root for full details.
+ */
+plugins {
+    id("io.element.android-library")
+}
+
+android {
+    namespace = "io.element.android.libraries.deeplink.api"
+}
+
+dependencies {
+    implementation(projects.libraries.matrix.api)
+}
diff --git a/libraries/deeplink/api/src/main/kotlin/io/element/android/libraries/deeplink/api/DeepLinkCreator.kt b/libraries/deeplink/api/src/main/kotlin/io/element/android/libraries/deeplink/api/DeepLinkCreator.kt
@@ -0,0 +1,16 @@
+/*
+ * Copyright 2023, 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+package io.element.android.libraries.deeplink.api
+
+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.ThreadId
+
+fun interface DeepLinkCreator {
+    fun room(sessionId: SessionId, roomId: RoomId?, threadId: ThreadId?): String
+}
diff --git a/libraries/deeplink/api/src/main/kotlin/io/element/android/libraries/deeplink/api/DeeplinkData.kt b/libraries/deeplink/api/src/main/kotlin/io/element/android/libraries/deeplink/api/DeeplinkData.kt
@@ -5,7 +5,7 @@
  * Please see LICENSE files in the repository root for full details.
  */
 
-package io.element.android.libraries.deeplink
+package io.element.android.libraries.deeplink.api
 
 import io.element.android.libraries.matrix.api.core.RoomId
 import io.element.android.libraries.matrix.api.core.SessionId
diff --git a/libraries/deeplink/api/src/main/kotlin/io/element/android/libraries/deeplink/api/DeeplinkParser.kt b/libraries/deeplink/api/src/main/kotlin/io/element/android/libraries/deeplink/api/DeeplinkParser.kt
@@ -0,0 +1,14 @@
+/*
+ * Copyright 2023, 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+package io.element.android.libraries.deeplink.api
+
+import android.content.Intent
+
+fun interface DeeplinkParser {
+    fun getFromIntent(intent: Intent): DeeplinkData?
+}
diff --git a/libraries/deeplink/api/src/main/kotlin/io/element/android/libraries/deeplink/api/usecase/InviteFriendsUseCase.kt b/libraries/deeplink/api/src/main/kotlin/io/element/android/libraries/deeplink/api/usecase/InviteFriendsUseCase.kt
@@ -0,0 +1,14 @@
+/*
+ * Copyright 2023, 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+package io.element.android.libraries.deeplink.api.usecase
+
+import android.app.Activity
+
+interface InviteFriendsUseCase {
+    fun execute(activity: Activity)
+}
diff --git a/libraries/deeplink/impl/build.gradle.kts b/libraries/deeplink/impl/build.gradle.kts
@@ -6,17 +6,19 @@ import extension.setupAnvil
  * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
  * Please see LICENSE files in the repository root for full details.
  */
+
 plugins {
     id("io.element.android-library")
 }
 
 android {
-    namespace = "io.element.android.libraries.deeplink"
+    namespace = "io.element.android.libraries.deeplink.impl"
 }
 
 setupAnvil()
 
 dependencies {
+    api(projects.libraries.deeplink.api)
     implementation(projects.libraries.di)
     implementation(libs.dagger)
     implementation(libs.androidx.corektx)
diff --git a/libraries/deeplink/impl/src/main/kotlin/io/element/android/libraries/deeplink/impl/Constants.kt b/libraries/deeplink/impl/src/main/kotlin/io/element/android/libraries/deeplink/impl/Constants.kt
@@ -5,7 +5,7 @@
  * Please see LICENSE files in the repository root for full details.
  */
 
-package io.element.android.libraries.deeplink
+package io.element.android.libraries.deeplink.impl
 
 internal const val SCHEME = "elementx"
 internal const val HOST = "open"
diff --git a/libraries/deeplink/impl/src/main/kotlin/io/element/android/libraries/deeplink/impl/DefaultDeepLinkCreator.kt b/libraries/deeplink/impl/src/main/kotlin/io/element/android/libraries/deeplink/impl/DefaultDeepLinkCreator.kt
@@ -1,19 +1,23 @@
 /*
- * Copyright 2023, 2024 New Vector Ltd.
+ * Copyright 2025 New Vector Ltd.
  *
  * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
  * Please see LICENSE files in the repository root for full details.
  */
 
-package io.element.android.libraries.deeplink
+package io.element.android.libraries.deeplink.impl
 
+import com.squareup.anvil.annotations.ContributesBinding
+import io.element.android.libraries.deeplink.api.DeepLinkCreator
+import io.element.android.libraries.di.AppScope
 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.ThreadId
 import javax.inject.Inject
 
-class DeepLinkCreator @Inject constructor() {
-    fun room(sessionId: SessionId, roomId: RoomId?, threadId: ThreadId?): String {
+@ContributesBinding(AppScope::class)
+class DefaultDeepLinkCreator @Inject constructor() : DeepLinkCreator {
+    override fun room(sessionId: SessionId, roomId: RoomId?, threadId: ThreadId?): String {
         return buildString {
             append("$SCHEME://$HOST/")
             append(sessionId.value)
diff --git a/libraries/deeplink/impl/src/main/kotlin/io/element/android/libraries/deeplink/impl/DefaultDeeplinkParser.kt b/libraries/deeplink/impl/src/main/kotlin/io/element/android/libraries/deeplink/impl/DefaultDeeplinkParser.kt
diff --git a/libraries/deeplink/impl/src/main/kotlin/io/element/android/libraries/deeplink/impl/usecase/DefaultInviteFriendsUseCase.kt b/libraries/deeplink/impl/src/main/kotlin/io/element/android/libraries/deeplink/impl/usecase/DefaultInviteFriendsUseCase.kt
diff --git a/libraries/deeplink/impl/src/test/kotlin/io/element/android/libraries/deeplink/impl/DefaultDeepLinkCreatorTest.kt b/libraries/deeplink/impl/src/test/kotlin/io/element/android/libraries/deeplink/impl/DefaultDeepLinkCreatorTest.kt
diff --git a/libraries/deeplink/impl/src/test/kotlin/io/element/android/libraries/deeplink/impl/DefaultDeeplinkParserTest.kt b/libraries/deeplink/impl/src/test/kotlin/io/element/android/libraries/deeplink/impl/DefaultDeeplinkParserTest.kt
diff --git a/plugins/src/main/kotlin/extension/DependencyHandleScope.kt b/plugins/src/main/kotlin/extension/DependencyHandleScope.kt

Original file line number	Diff line number	Diff line change
`@@ -301,6 +301,7 @@ dependencies {`
`301`	`301`	`testImplementation(libs.test.turbine)`
`302`	`302`	`testImplementation(projects.libraries.matrix.test)`
`303`	`303`	`testImplementation(projects.services.toolbox.test)`
	`304`	`+ testImplementation(projects.tests.testutils)`
`304`	`305`
`305`	`306`	`koverDependencies()`
`306`	`307`	`}`