Add ClientEnterpriseHook and ClientBuilderEnterpriseHook

These allow us to not expose the enterprise internal when setting up custom configs for both `ClientBuilder` and `Client`
2026-10-31 16:22:49 +00:00 · 2026-08-21 10:05:00 +02:00
parent d710b23513
commit 4b32816b32
18 changed files with 155 additions and 94 deletions
@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2026 Element Creations 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.features.enterprise.api
+
+import io.element.android.libraries.matrix.api.MatrixClientBuilder
+import io.element.android.libraries.matrix.api.core.SessionId
+
+/**
+ * A hook that can be used to customize the [MatrixClientBuilder] for enterprise features.
+ */
+fun interface ClientBuilderEnterpriseHook {
+    suspend operator fun invoke(clientBuilder: MatrixClientBuilder, sessionId: SessionId)
+}
@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2026 Element Creations 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.features.enterprise.api
+
+import io.element.android.libraries.matrix.api.MatrixClient
+
+/**
+ * A hook that can be used to customize the [MatrixClient] for enterprise features.
+ */
+fun interface ClientEnterpriseHook {
+    suspend operator fun invoke(client: MatrixClient)
+}
@@ -19,11 +19,9 @@ sealed interface RemoteEnterpriseConfigResult<out T> {
    data class Outdated<out T>(val data: T) : RemoteEnterpriseConfigResult<T>

    /**
-     * Well-known data is not found (file does not exist server side, we got a 404). `needsRefresh` indicates whether a refresh must be done
-     * to replace this value: if it's `true`, the caller must trigger a refresh to try to fetch the data again;
-     * if it's `false`, the caller can assume that the data is not available and no refresh is needed before returning the data.
+     * Well-known data is not found (file does not exist server side, we got a 404).
     */
-    data class NotFound(val needsRefresh: Boolean) : RemoteEnterpriseConfigResult<Nothing>
+    data object NotFound : RemoteEnterpriseConfigResult<Nothing>

    /**
     * Any other error.
@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2026 Element Creations 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.features.enterprise.impl
+
+import dev.zacsweers.metro.AppScope
+import dev.zacsweers.metro.ContributesBinding
+import dev.zacsweers.metro.SingleIn
+import io.element.android.features.enterprise.api.ClientBuilderEnterpriseHook
+import io.element.android.libraries.matrix.api.MatrixClientBuilder
+import io.element.android.libraries.matrix.api.core.SessionId
+
+/**
+ * Default implementation of [ClientBuilderEnterpriseHook] that does nothing for FOSS.
+ */
+@SingleIn(AppScope::class)
+@ContributesBinding(AppScope::class)
+class DefaultClientBuilderEnterpriseHook : ClientBuilderEnterpriseHook {
+    override suspend fun invoke(clientBuilder: MatrixClientBuilder, sessionId: SessionId) {
+        // No-op
+    }
+}
@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2026 Element Creations 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.features.enterprise.impl
+
+import dev.zacsweers.metro.AppScope
+import dev.zacsweers.metro.ContributesBinding
+import dev.zacsweers.metro.SingleIn
+import io.element.android.features.enterprise.api.ClientEnterpriseHook
+import io.element.android.libraries.matrix.api.MatrixClient
+
+/**
+ * Default implementation of [ClientEnterpriseHook] that does nothing for FOSS.
+ */
+@SingleIn(AppScope::class)
+@ContributesBinding(AppScope::class)
+class DefaultClientEnterpriseHook : ClientEnterpriseHook {
+    override suspend fun invoke(client: MatrixClient) {
+        // No-op
+    }
+}
@@ -1,29 +0,0 @@
-/*
- * Copyright (c) 2026 Element Creations 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.features.enterprise.impl.scanner
-
-import dev.zacsweers.metro.AppScope
-import dev.zacsweers.metro.ContributesBinding
-import io.element.android.libraries.matrix.api.ClientUrlContentFetcher
-import io.element.android.libraries.matrix.api.core.SessionId
-import io.element.android.libraries.matrix.api.scanner.ContentScannerUrlProvider
-
-/**
- * Default FOSS implementation of [ContentScannerUrlProvider] that returns `null` for the content scanner URL.
- */
-@ContributesBinding(AppScope::class)
-class DefaultContentScannerUrlProvider : ContentScannerUrlProvider {
-    override suspend fun getContentScannerUrl(sessionId: SessionId): Result<String?> = Result.success(null)
-
-    @ContributesBinding(AppScope::class)
-    class Factory : ContentScannerUrlProvider.Factory {
-        override fun create(urlContentFetcher: ClientUrlContentFetcher): ContentScannerUrlProvider {
-            return DefaultContentScannerUrlProvider()
-        }
-    }
-}
@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) 2026 Element Creations 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.matrix.api
+
+/**
+ * An abstraction over the Matrix SDK's `ClientBuilder` to allow sharing it with other modules without exposing the SDK directly.
+ */
+interface MatrixClientBuilder
@@ -1,31 +0,0 @@
-/*
- * Copyright (c) 2026 Element Creations 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.matrix.api.scanner
-
-import io.element.android.libraries.matrix.api.ClientUrlContentFetcher
-import io.element.android.libraries.matrix.api.core.SessionId
-
-/**
- * Provides the URL of the content scanner service for a given homeserver, if any is set up.
- */
-fun interface ContentScannerUrlProvider {
-    /**
-     * Returns the URL of the content scanner service for the given [sessionId], or `null` if no content scanner is set up.
-     */
-    suspend fun getContentScannerUrl(sessionId: SessionId): Result<String?>
-
-    /**
-     * Creates a provider, which needs a fetcher because the scanner URL is itself discovered over HTTP.
-     */
-    fun interface Factory {
-        /**
-         * @param urlContentFetcher used to read the configuration advertised by the homeserver; a client that is not authenticated yet also works.
-         */
-        fun create(urlContentFetcher: ClientUrlContentFetcher): ContentScannerUrlProvider
-    }
-}
@@ -21,12 +21,12 @@ android {
 setupDependencyInjection()

 dependencies {
-    releaseImplementation(libs.matrix.sdk)
+    releaseApi(libs.matrix.sdk)
    if (file("${rootDir.path}/libraries/rustsdk/matrix-rust-sdk.aar").exists()) {
        println("\nNote: Using local binary of the Rust SDK.\n")
-        debugImplementation(projects.libraries.rustsdk)
+        debugApi(projects.libraries.rustsdk)
    } else {
-        debugImplementation(libs.matrix.sdk)
+        debugApi(libs.matrix.sdk)
    }
    implementation(projects.libraries.rustlsTls)

@@ -146,7 +146,7 @@ import org.matrix.rustcomponents.sdk.SyncService as ClientSyncService
@Suppress("LargeClass")
 class RustMatrixClient(
    override val sessionPaths: SessionPaths,
-    private val innerClient: Client,
+    val innerClient: Client,
    private val sessionStore: SessionStore,
    private val sessionDelegate: RustClientSessionDelegate,
    private val innerSyncService: ClientSyncService,
@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2026 Element Creations 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.matrix.impl
+
+import io.element.android.libraries.matrix.api.MatrixClientBuilder
+import org.matrix.rustcomponents.sdk.ClientBuilder
+
+/**
+ * A wrapper around the Matrix SDK's [ClientBuilder] to allow sharing it with other modules without exposing the SDK directly.
+ */
+class RustMatrixClientBuilder(
+    val inner: ClientBuilder,
+) : MatrixClientBuilder
@@ -9,6 +9,7 @@
 package io.element.android.libraries.matrix.impl

 import dev.zacsweers.metro.Inject
+import io.element.android.features.enterprise.api.ClientBuilderEnterpriseHook
 import io.element.android.libraries.androidutils.crypto.ClientSecret
 import io.element.android.libraries.core.coroutine.CoroutineDispatchers
 import io.element.android.libraries.core.data.ByteUnit
@@ -19,7 +20,6 @@ import io.element.android.libraries.featureflag.api.FeatureFlagService
 import io.element.android.libraries.featureflag.api.FeatureFlags
 import io.element.android.libraries.matrix.api.core.SessionId
 import io.element.android.libraries.matrix.api.paths.SessionPaths
-import io.element.android.libraries.matrix.api.scanner.ContentScannerUrlProvider
 import io.element.android.libraries.matrix.impl.analytics.UtdTracker
 import io.element.android.libraries.matrix.impl.paths.getSessionPaths
 import io.element.android.libraries.matrix.impl.proxy.ProxyProvider
@@ -37,7 +37,6 @@ import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.withContext
 import org.matrix.rustcomponents.sdk.Client
 import org.matrix.rustcomponents.sdk.ClientBuilder
-import org.matrix.rustcomponents.sdk.ContentScanner
 import org.matrix.rustcomponents.sdk.CrossProcessLockConfig
 import org.matrix.rustcomponents.sdk.RequestConfig
 import org.matrix.rustcomponents.sdk.Session
@@ -70,7 +69,7 @@ class RustMatrixClientFactory(
    private val clientBuilderProvider: ClientBuilderProvider,
    private val sqliteStoreBuilderProvider: SqliteStoreBuilderProvider,
    private val workManagerScheduler: WorkManagerScheduler,
-    private val contentScannerUrlProviderFactory: ContentScannerUrlProvider.Factory,
+    private val clientBuilderEnterpriseHook: ClientBuilderEnterpriseHook,
 ) {
    private val sessionDelegate = RustClientSessionDelegate(
        sessionStore = sessionStore,
@@ -101,6 +100,7 @@ class RustMatrixClientFactory(
        )
            .homeserverUrl(sessionData.homeserverUrl)
            .username(sessionData.userId)
+            .also { clientBuilderEnterpriseHook(RustMatrixClientBuilder(it), SessionId(sessionData.userId)) }
            .use { it.build() }

        client.setMediaRetentionPolicy(
@@ -135,21 +135,6 @@ class RustMatrixClientFactory(

        client.setUtdDelegate(UtdTracker(analyticsService))

-        // If a content scanner URL is available for the homeserver, create a RustContentScanner and set it on the client.
-        // This allows the SDK to use the content scanner for automatic media scanning.
-        // If no content scanner URL is available, the contentScanner will be null.
-        val contentScannerUrlProvider = contentScannerUrlProviderFactory.create(RustTemporaryMatrixClient(client, null))
-        val contentScanner = contentScannerUrlProvider.getContentScannerUrl(SessionId(client.userId()))
-            .getOrNull()
-            ?.let { contentScannerUrl ->
-                val contentScanner = ContentScanner(contentScannerUrl)
-                client.setContentScanner(contentScanner)
-                RustContentScanner(
-                    client = client,
-                    rustScanner = contentScanner,
-                )
-        }
-
        val syncService = client.syncService()
            .withSharePos(true)
            .withOfflineMode()
@@ -170,7 +155,7 @@ class RustMatrixClientFactory(
            featureFlagService = featureFlagService,
            analyticsService = analyticsService,
            workManagerScheduler = workManagerScheduler,
-            contentScanner = contentScanner,
+            contentScanner = client.contentScanner()?.let { RustContentScanner(client, it) },
            isMessageSearchAvailable = isMessageSearchAvailable,
        ).also {
            Timber.tag("RustMatrixClient").i("Creating Client with access token '$anonymizedAccessToken' and refresh token '$anonymizedRefreshToken'")
@@ -11,6 +11,7 @@ package io.element.android.libraries.matrix.impl.auth
 import dev.zacsweers.metro.AppScope
 import dev.zacsweers.metro.ContributesBinding
 import dev.zacsweers.metro.SingleIn
+import io.element.android.features.enterprise.api.ClientEnterpriseHook
 import io.element.android.features.enterprise.api.EnterpriseService
 import io.element.android.libraries.androidutils.crypto.ClientSecret
 import io.element.android.libraries.core.coroutine.CoroutineDispatchers
@@ -73,6 +74,7 @@ class RustMatrixAuthenticationService(
    private val oAuthConfigurationProvider: OAuthConfigurationProvider,
    private val enterpriseService: EnterpriseService,
    private val featureFlagService: FeatureFlagService,
+    private val clientEnterpriseHook: ClientEnterpriseHook,
 ) : MatrixAuthenticationService {
    // Any existing Element Classic session that we want to try to import secrets from during login.
    private var elementClassicSession: ElementClassicSession? = null
@@ -166,6 +168,10 @@ class RustMatrixAuthenticationService(
                        sessionPaths = currentSessionPaths,
                    )
                val matrixClient = rustMatrixClientFactory.create(client, sessionData, isMessageSearchAvailable())
+
+                // Apply enterprise hooks to the newly created client as soon as possible
+                clientEnterpriseHook(matrixClient)
+
                newMatrixClientObservers.forEach { it.invoke(matrixClient) }
                sessionStore.addSession(sessionData)

@@ -242,6 +248,9 @@ class RustMatrixAuthenticationService(
                client.restoreSession(sessionData.toSession())
                val matrixClient = rustMatrixClientFactory.create(client, sessionData, isMessageSearchAvailable())

+                // Apply enterprise hooks to the newly created client as soon as possible
+                clientEnterpriseHook(matrixClient)
+
                // We wait for the verification state to be known
                matrixClient.waitForKnownVerificationState()

@@ -332,6 +341,10 @@ class RustMatrixAuthenticationService(
                    sessionPaths = currentSessionPaths,
                )
                val matrixClient = rustMatrixClientFactory.create(client, sessionData, isMessageSearchAvailable())
+
+                // Apply enterprise hooks to the newly created client as soon as possible
+                clientEnterpriseHook(matrixClient)
+
                matrixClient.waitForKnownVerificationState()

                newMatrixClientObservers.forEach { it.invoke(matrixClient) }
@@ -397,6 +410,10 @@ class RustMatrixAuthenticationService(
                        sessionPaths = emptySessionPaths,
                    )
                val matrixClient = rustMatrixClientFactory.create(client, sessionData, isMessageSearchAvailable())
+
+                // Apply enterprise hooks to the newly created client as soon as possible
+                clientEnterpriseHook(matrixClient)
+
                newMatrixClientObservers.forEach { it.invoke(matrixClient) }
                sessionStore.addSession(sessionData)

@@ -11,7 +11,6 @@ package io.element.android.libraries.matrix.impl
 import com.google.common.truth.Truth.assertThat
 import io.element.android.libraries.featureflag.test.FakeFeatureFlagService
 import io.element.android.libraries.matrix.api.core.SessionId
-import io.element.android.libraries.matrix.api.scanner.ContentScannerUrlProvider
 import io.element.android.libraries.matrix.impl.auth.FakeProxyProvider
 import io.element.android.libraries.matrix.impl.room.FakeTimelineEventFilterFactory
 import io.element.android.libraries.matrix.impl.storage.FakeSqliteStoreBuilderProvider
@@ -52,7 +51,6 @@ fun TestScope.createRustMatrixClientFactory(
    ),
    clientBuilderProvider: ClientBuilderProvider = FakeClientBuilderProvider(),
    workManagerScheduler: FakeWorkManagerScheduler = FakeWorkManagerScheduler(),
-    contentScannerUrlProviderFactory: ContentScannerUrlProvider.Factory = { ContentScannerUrlProvider { Result.success(null) } },
 ) = RustMatrixClientFactory(
    cacheDirectory = cacheDirectory,
    appCoroutineScope = backgroundScope,
@@ -67,5 +65,5 @@ fun TestScope.createRustMatrixClientFactory(
    clientBuilderProvider = clientBuilderProvider,
    sqliteStoreBuilderProvider = FakeSqliteStoreBuilderProvider(),
    workManagerScheduler = workManagerScheduler,
-    contentScannerUrlProviderFactory = contentScannerUrlProviderFactory,
+    clientBuilderEnterpriseHook = { _, _ -> },
 )
@@ -9,7 +9,6 @@ package io.element.android.libraries.matrix.impl

 import com.google.common.truth.Truth.assertThat
 import io.element.android.libraries.featureflag.test.FakeFeatureFlagService
-import io.element.android.libraries.matrix.api.scanner.ContentScannerUrlProvider
 import io.element.android.libraries.matrix.impl.auth.FakeProxyProvider
 import io.element.android.libraries.matrix.impl.paths.SessionPathsFactory
 import io.element.android.libraries.matrix.impl.room.FakeTimelineEventFilterFactory
@@ -64,7 +63,6 @@ class RustTemporaryMatrixClientFactoryTest {
        ),
        clientBuilderProvider: ClientBuilderProvider = FakeClientBuilderProvider(),
        workManagerScheduler: FakeWorkManagerScheduler = FakeWorkManagerScheduler(),
-        contentScannerUrlProviderFactory: ContentScannerUrlProvider.Factory = { ContentScannerUrlProvider { Result.success(null) } },
    ) = RustMatrixClientFactory(
        cacheDirectory = cacheDirectory,
        appCoroutineScope = backgroundScope,
@@ -79,6 +77,6 @@ class RustTemporaryMatrixClientFactoryTest {
        clientBuilderProvider = clientBuilderProvider,
        sqliteStoreBuilderProvider = FakeSqliteStoreBuilderProvider(),
        workManagerScheduler = workManagerScheduler,
-        contentScannerUrlProviderFactory = contentScannerUrlProviderFactory,
+        clientBuilderEnterpriseHook = { _, _ -> },
    )
 }
@@ -98,6 +98,7 @@ class RustMatrixAuthenticationServiceTest {
            ),
            enterpriseService = enterpriseService,
            featureFlagService = FakeFeatureFlagService(),
+            clientEnterpriseHook = {},
        )
    }
 }
@@ -10,6 +10,7 @@ package io.element.android.libraries.matrix.impl.fixtures.fakes

 import io.element.android.libraries.matrix.impl.fixtures.factories.aRustSession
 import io.element.android.libraries.matrix.impl.fixtures.factories.aRustUserProfile
+import io.element.android.libraries.matrix.impl.scanner.FakeFfiContentScanner
 import io.element.android.libraries.matrix.test.A_DEVICE_ID
 import io.element.android.libraries.matrix.test.A_HOMESERVER_URL
 import io.element.android.libraries.matrix.test.A_SERVER_NAME
@@ -18,6 +19,7 @@ import io.element.android.tests.testutils.lambda.lambdaError
 import io.element.android.tests.testutils.simulateLongTask
 import org.matrix.rustcomponents.sdk.Client
 import org.matrix.rustcomponents.sdk.ClientDelegate
+import org.matrix.rustcomponents.sdk.ContentScanner
 import org.matrix.rustcomponents.sdk.CreateRoomParameters
 import org.matrix.rustcomponents.sdk.Encryption
 import org.matrix.rustcomponents.sdk.HomeserverCapabilities
@@ -64,6 +66,7 @@ class FakeFfiClient(
    private val isProfilesSlidingSyncExtensionSupportedResult: () -> Boolean = { false },
    private val subscribeToOwnProfileResult: (ProfileListener) -> Unit = {},
    private val getUrlResult: (String) -> ByteArray = { lambdaError() },
+    private val contentScannerResult: () -> ContentScanner = { FakeFfiContentScanner() },
    private val closeResult: () -> Unit = {},
 ) : Client(NoHandle) {
    override fun userId(): String = userId
@@ -145,5 +148,9 @@ class FakeFfiClient(
        getUrlResult(url)
    }

+    override suspend fun contentScanner(): ContentScanner = simulateLongTask {
+        contentScannerResult()
+    }
+
    override fun close() = closeResult()
 }