feat(model-client): Add the possibility to set the userId in model client V2

Author: Oleksandr Dzhychko

model-client/src/commonMain/kotlin/org/modelix/model/client2/ModelClientV2.kt

@@ -57,10 +57,11 @@ import kotlin.time.Duration.Companion.seconds
 class ModelClientV2(
     private val httpClient: HttpClient,
     val baseUrl: String,
+    private var clientProvidedUserId: String?,
 ) : IModelClientV2, Closable {
     private var clientId: Int = 0
     private var idGenerator: IIdGenerator = IdGeneratorDummy()
-    private var userId: String? = null
+    private var serverProvidedUserId: String? = null
     private val kvStore = MapBasedStore()
     val store = ObjectStoreCache(kvStore) // TODO the store will accumulate garbage
 
@@ -80,19 +81,30 @@ class ModelClientV2(
     }
 
     suspend fun updateUserId() {
-        userId = httpClient.get {
+        serverProvidedUserId = httpClient.get {
             url {
                 takeFrom(baseUrl)
                 appendPathSegments("user-id")
             }
         }.bodyAsText()
     }
 
+    /**
+     * Set or remove the client provided user ID.
+     *
+     * When the used ID is removed by passing null, [[getUserId]] might return the [[serverProvidedUserId]].
+     *
+     * @param userId A new user ID, or null to remove the old one.
+     */
+    fun setClientProvideUserId(userId: String?) {
+        clientProvidedUserId = userId
+    }
+
     override fun getClientId(): Int = clientId
 
     override fun getIdGenerator(): IIdGenerator = idGenerator
 
-    override fun getUserId(): String? = userId
+    override fun getUserId(): String? = clientProvidedUserId ?: serverProvidedUserId
 
     override suspend fun initRepository(repository: RepositoryId): IVersion {
         val response = httpClient.post {
@@ -283,11 +295,13 @@ abstract class ModelClientV2Builder {
     protected var httpClient: HttpClient? = null
     protected var baseUrl: String = "https://localhost/model/v2"
     protected var authTokenProvider: (() -> String?)? = null
+    protected var userId: String? = null
 
     fun build(): ModelClientV2 {
         return ModelClientV2(
             httpClient?.config { configureHttpClient(this) } ?: createHttpClient(),
             baseUrl,
+            userId,
         )
     }
 
@@ -306,6 +320,11 @@ abstract class ModelClientV2Builder {
         return this
     }
 
+    fun userId(userId: String?): ModelClientV2Builder {
+        this.userId = userId
+        return this
+    }
+
     protected open fun configureHttpClient(config: HttpClientConfig<*>) {
         config.apply {
             expectSuccess = true

model-client/src/commonMain/kotlin/org/modelix/model/client2/ReplicatedModel.kt

@@ -128,6 +128,10 @@ class ReplicatedModel(
         }
     }
 
+    suspend fun getCurrentVersion(): CLVersion {
+        return localModel.getCurrentVersion()
+    }
+
     private enum class State {
         New,
         Starting,

model-server/src/test/kotlin/org/modelix/model/server/ModelClientV2Test.kt

@@ -118,4 +118,36 @@ class ModelClientV2Test {
             setOf(repositoryId.getBranchReference(), branchId),
         )
     }
+
+    @Test
+    fun `user id can be provided to client after creation`() = runTest {
+        val url = "http://localhost/v2"
+        val modelClient = ModelClientV2
+            .builder()
+            .url(url)
+            .client(client)
+            .build()
+            .also { it.init() }
+
+        val userId = "a_user_id"
+        modelClient.setClientProvideUserId(userId)
+
+        assertEquals(userId, modelClient.getUserId())
+    }
+
+    @Test
+    fun `user id provided by client can be removed`() = runTest {
+        val url = "http://localhost/v2"
+        val modelClient = ModelClientV2
+            .builder()
+            .url(url)
+            .client(client)
+            .userId("a_user_id")
+            .build()
+            .also { it.init() }
+
+        modelClient.setClientProvideUserId(null)
+
+        assertEquals("localhost", modelClient.getUserId())
+    }
 }

model-server/src/test/kotlin/org/modelix/model/server/ReplicatedRepositoryTest.kt

@@ -478,6 +478,33 @@ class ReplicatedRepositoryTest {
             branch.getRootNode().allChildren.map { (it as PNodeAdapter).nodeId.toString(16) }.toSortedSet()
         }
     }
+
+    @Test
+    fun `used id specified for client is used in replicated model`() = runTest {
+        val userId = "a_user_id"
+        val url = "http://localhost/v2"
+        val modelClient = ModelClientV2
+            .builder()
+            .url(url)
+            .client(client)
+            .userId(userId)
+            .build()
+            .also { it.init() }
+        val repositoryId = RepositoryId("repo1")
+        modelClient.initRepository(repositoryId)
+        val replicatedModel = modelClient.getReplicatedModel(repositoryId.getBranchReference())
+        val branch = replicatedModel.start() as OTBranch
+        val initialVersion = modelClient.pull(replicatedModel.branchRef, null) as CLVersion
+
+        branch.computeWriteT {
+            it.addNewChild(ITree.ROOT_ID, "role", -1, null as IConceptReference?)
+        }
+        while (replicatedModel.getCurrentVersion() == initialVersion) {
+            delay(10)
+        }
+
+        assertEquals(userId, replicatedModel.getCurrentVersion().author)
+    }
 }
 
 private fun IBranch.treeHash(): String = computeReadT { t -> (t.tree as CLTree).hash }