Rename methods and update documentation.

Author: bmarty

enterprise

@@ -21,15 +21,15 @@ interface ClientBuilderEnterpriseHook {
      * @param clientBuilder The [MatrixClientBuilder] to customize.
      * @return The customized [MatrixClientBuilder].
      */
-    suspend fun tweakClientBuilder(clientBuilder: MatrixClientBuilder): MatrixClientBuilder
+    suspend fun beforeClientCreation(clientBuilder: MatrixClientBuilder): MatrixClientBuilder
 
     /**
      * Customize the [MatrixClientBuilder] for enterprise features.
-     * This method is invoked when a new [MatrixClientBuilder] is created to build a client for a specific session.
+     * This method is invoked as well as the other method when a new [MatrixClientBuilder] is created to build a client for a specific session.
      *
      * @param clientBuilder The [MatrixClientBuilder] to customize.
      * @param sessionId The [SessionId] for which the [MatrixClientBuilder] is being created.
      * @return The customized [MatrixClientBuilder].
      */
-    suspend fun tweakClientBuilder(clientBuilder: MatrixClientBuilder, sessionId: SessionId): MatrixClientBuilder
+    suspend fun beforeClientCreationWithSession(clientBuilder: MatrixClientBuilder, sessionId: SessionId): MatrixClientBuilder
 }

features/enterprise/api/src/main/kotlin/io/element/android/features/enterprise/api/ClientBuilderEnterpriseHook.kt

@@ -18,12 +18,12 @@ import io.element.android.libraries.matrix.api.core.SessionId
  */
 @ContributesBinding(AppScope::class)
 class DefaultClientBuilderEnterpriseHook : ClientBuilderEnterpriseHook {
-    override suspend fun tweakClientBuilder(clientBuilder: MatrixClientBuilder): MatrixClientBuilder {
+    override suspend fun beforeClientCreation(clientBuilder: MatrixClientBuilder): MatrixClientBuilder {
         // No modification
         return clientBuilder
     }
 
-    override suspend fun tweakClientBuilder(clientBuilder: MatrixClientBuilder, sessionId: SessionId): MatrixClientBuilder {
+    override suspend fun beforeClientCreationWithSession(clientBuilder: MatrixClientBuilder, sessionId: SessionId): MatrixClientBuilder {
         // No modification
         return clientBuilder
     }

features/enterprise/impl-foss/src/main/kotlin/io/element/android/features/enterprise/impl/DefaultClientBuilderEnterpriseHook.kt

@@ -12,14 +12,14 @@ import io.element.android.libraries.matrix.api.MatrixClientBuilder
 import io.element.android.libraries.matrix.api.core.SessionId
 
 class FakeClientBuilderEnterpriseHook(
-    private val tweakClientBuilderResult: (MatrixClientBuilder) -> MatrixClientBuilder = { it },
-    private val tweakClientBuilderWithSessionIdResult: (MatrixClientBuilder, SessionId) -> MatrixClientBuilder = { clientBuilder, _ -> clientBuilder },
+    private val beforeClientCreationResult: (MatrixClientBuilder) -> MatrixClientBuilder = { it },
+    private val beforeClientCreationWithSessionResult: (MatrixClientBuilder, SessionId) -> MatrixClientBuilder = { clientBuilder, _ -> clientBuilder },
 ) : ClientBuilderEnterpriseHook {
-    override suspend fun tweakClientBuilder(clientBuilder: MatrixClientBuilder): MatrixClientBuilder {
-        return tweakClientBuilderResult(clientBuilder)
+    override suspend fun beforeClientCreation(clientBuilder: MatrixClientBuilder): MatrixClientBuilder {
+        return beforeClientCreationResult(clientBuilder)
     }
 
-    override suspend fun tweakClientBuilder(clientBuilder: MatrixClientBuilder, sessionId: SessionId): MatrixClientBuilder {
-        return tweakClientBuilderWithSessionIdResult(clientBuilder, sessionId)
+    override suspend fun beforeClientCreationWithSession(clientBuilder: MatrixClientBuilder, sessionId: SessionId): MatrixClientBuilder {
+        return beforeClientCreationWithSessionResult(clientBuilder, sessionId)
     }
 }

features/enterprise/test/src/main/kotlin/io/element/android/features/enterprise/test/FakeClientBuilderEnterpriseHook.kt

@@ -100,7 +100,7 @@ class RustMatrixClientFactory(
             .homeserverUrl(sessionData.homeserverUrl)
             .enableAutomaticBackPagination(featureFlagService.isFeatureEnabled(FeatureFlags.AutomaticBackPagination))
             .let {
-                (clientBuilderEnterpriseHook.tweakClientBuilder(RustMatrixClientBuilder(it), SessionId(sessionData.userId)) as RustMatrixClientBuilder).inner
+                (clientBuilderEnterpriseHook.beforeClientCreationWithSession(RustMatrixClientBuilder(it), SessionId(sessionData.userId)) as RustMatrixClientBuilder).inner
             }
             .use { it.build() }
 
@@ -222,7 +222,7 @@ class RustMatrixClientFactory(
                 proxyProvider.provides()?.let { proxy(it) } ?: this
             }
             .let {
-                (clientBuilderEnterpriseHook.tweakClientBuilder(RustMatrixClientBuilder(it)) as RustMatrixClientBuilder).inner
+                (clientBuilderEnterpriseHook.beforeClientCreation(RustMatrixClientBuilder(it)) as RustMatrixClientBuilder).inner
             }
     }
 }