feat(light-model-client): support for remote execution of ModelQL on nodes returned by the client

Author: slisson

light-model-client/build.gradle.kts

@@ -23,10 +23,15 @@ kotlin {
                 implementation(project(":model-api"))
                 implementation(project(":model-api-gen-runtime"))
                 implementation(project(":model-server-api"))
+                implementation(project(":modelql-core"))
+                implementation(project(":modelql-untyped"))
+                implementation(project(":modelql-client"))
+
                 implementation(libs.ktor.client.websockets)
                 implementation(libs.kotlin.stdlib.common)
                 implementation(libs.kotlin.logging)
                 implementation(libs.kotlin.coroutines.core)
+                implementation(libs.kotlin.serialization.json)
 
 //                implementation("io.ktor:ktor-client-core:$ktorVersion")
 //                implementation("io.ktor:ktor-client-cio:$ktorVersion")
@@ -50,10 +55,12 @@ kotlin {
         val jvmTest by getting {
             dependencies {
                 implementation(kotlin("test"))
-                implementation(kotlin("test-junit"))
 
-                implementation(project(":model-server"))
                 implementation(project(":authorization"))
+//                implementation(project(":model-client"))
+                implementation(project(":model-server"))
+                implementation(project(":model-server-lib"))
+
                 implementation(libs.ktor.server.core)
                 implementation(libs.ktor.server.cors)
                 implementation(libs.ktor.server.netty)

light-model-client/src/commonMain/kotlin/org/modelix/client/light/LightModelClient.kt

@@ -1,12 +1,52 @@
 package org.modelix.client.light
 
-import io.ktor.client.*
-import io.ktor.client.engine.*
-import io.ktor.client.plugins.websocket.*
+import io.ktor.client.HttpClient
+import io.ktor.client.engine.HttpClientEngine
+import io.ktor.client.engine.HttpClientEngineFactory
+import io.ktor.client.plugins.websocket.WebSockets
 import kotlinx.coroutines.delay
-import org.modelix.model.api.*
-import org.modelix.model.area.*
-import org.modelix.model.server.api.*
+import org.modelix.model.api.ConceptReference
+import org.modelix.model.api.IBranch
+import org.modelix.model.api.IConcept
+import org.modelix.model.api.IConceptReference
+import org.modelix.model.api.INode
+import org.modelix.model.api.INodeEx
+import org.modelix.model.api.INodeReference
+import org.modelix.model.api.INodeReferenceSerializer
+import org.modelix.model.api.INodeReferenceSerializerEx
+import org.modelix.model.api.NodeReferenceById
+import org.modelix.model.api.SerializedNodeReference
+import org.modelix.model.api.getAncestors
+import org.modelix.model.api.resolve
+import org.modelix.model.area.IArea
+import org.modelix.model.area.IAreaChangeEvent
+import org.modelix.model.area.IAreaChangeList
+import org.modelix.model.area.IAreaListener
+import org.modelix.model.area.IAreaReference
+import org.modelix.model.server.api.AddNewChildNodeOpData
+import org.modelix.model.server.api.ChangeSetId
+import org.modelix.model.server.api.DeleteNodeOpData
+import org.modelix.model.server.api.ExceptionData
+import org.modelix.model.server.api.MessageFromClient
+import org.modelix.model.server.api.MessageFromServer
+import org.modelix.model.server.api.ModelQuery
+import org.modelix.model.server.api.MoveNodeOpData
+import org.modelix.model.server.api.NodeData
+import org.modelix.model.server.api.NodeId
+import org.modelix.model.server.api.NodeUpdateData
+import org.modelix.model.server.api.OperationData
+import org.modelix.model.server.api.QueryRootNode
+import org.modelix.model.server.api.SetPropertyOpData
+import org.modelix.model.server.api.SetReferenceOpData
+import org.modelix.model.server.api.VersionData
+import org.modelix.model.server.api.merge
+import org.modelix.model.server.api.replaceChildren
+import org.modelix.model.server.api.replaceContainment
+import org.modelix.model.server.api.replaceId
+import org.modelix.model.server.api.replaceReferences
+import org.modelix.modelql.client.ModelQLClient
+import org.modelix.modelql.core.IQueryExecutor
+import org.modelix.modelql.untyped.ISupportsModelQL
 import kotlin.jvm.JvmStatic
 import kotlin.time.Duration
 import kotlin.time.Duration.Companion.milliseconds
@@ -18,7 +58,8 @@ class LightModelClient internal constructor(
     val connection: IConnection,
     private val transactionManager: ITransactionManager,
     val autoFilterNonLoadedNodes: Boolean,
-    val debugName: String = ""
+    val debugName: String = "",
+    val modelQLClient: ModelQLClient? = null
 ) {
 
     private val nodes: MutableMap<NodeId, NodeData> = HashMap()
@@ -324,7 +365,7 @@ class LightModelClient internal constructor(
         }
     }
 
-    inner class NodeAdapter(var nodeId: NodeId) : INodeEx {
+    inner class NodeAdapter(var nodeId: NodeId) : INodeEx, ISupportsModelQL {
         fun getData() = requiresRead { getNodeData(nodeId) }
 
         override fun usesRoleIds(): Boolean = usesRoleIds
@@ -562,6 +603,11 @@ class LightModelClient internal constructor(
         override fun toString(): String {
             return nodeId
         }
+
+        override fun createQueryExecutor(): IQueryExecutor<INode> {
+            val client = modelQLClient ?: throw UnsupportedOperationException("Connection doesn't support ModelQL: $connection")
+            return client.getNode(SerializedNodeReference(nodeId))
+        }
     }
 
     inner class Area : IArea {
@@ -732,6 +778,7 @@ abstract class LightModelClientBuilder {
     private var debugName: String = ""
     private var transactionManager: ITransactionManager = ReadWriteLockTransactionManager()
     private var autoFilterNonLoadedNodes: Boolean = false
+    private var modelQLClient: ModelQLClient? = null
 
     protected abstract fun getDefaultEngineFactory(): HttpClientEngineFactory<*>
 
@@ -749,7 +796,8 @@ abstract class LightModelClientBuilder {
             ),
             transactionManager,
             autoFilterNonLoadedNodes = autoFilterNonLoadedNodes,
-            debugName = debugName
+            debugName = debugName,
+            modelQLClient = modelQLClient
         )
     }
     fun autoFilterNonLoadedNodes(value: Boolean = true): LightModelClientBuilder {
@@ -795,6 +843,10 @@ abstract class LightModelClientBuilder {
         this.httpEngineFactory = httpEngineFactory
         return this
     }
+    fun modelQLClient(c: ModelQLClient): LightModelClientBuilder {
+        this.modelQLClient = c
+        return this
+    }
 }
 
 class LightClientNodeReference(val nodeId: NodeId) : INodeReference {

light-model-client/src/commonMain/kotlin/org/modelix/client/light/WebsocketConnection.kt

@@ -16,18 +16,22 @@
 
 package org.modelix.client.light
 
-import io.ktor.client.*
-import io.ktor.client.plugins.websocket.*
-import io.ktor.websocket.*
+import io.ktor.client.HttpClient
+import io.ktor.client.plugins.websocket.webSocket
+import io.ktor.websocket.CloseReason
+import io.ktor.websocket.Frame
+import io.ktor.websocket.WebSocketSession
+import io.ktor.websocket.close
+import io.ktor.websocket.readText
+import io.ktor.websocket.send
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
-import kotlinx.coroutines.GlobalScope
-import kotlinx.coroutines.cancel
 import kotlinx.coroutines.channels.Channel
 import kotlinx.coroutines.channels.ClosedReceiveChannelException
 import kotlinx.coroutines.launch
 import org.modelix.model.server.api.MessageFromClient
 import org.modelix.model.server.api.MessageFromServer
+import org.modelix.modelql.client.ModelQLClient
 
 class WebsocketConnection(val httpClient: HttpClient, val url: String) : LightModelClient.IConnection {
     val coroutineScope = CoroutineScope(Dispatchers.Default)
@@ -73,5 +77,4 @@ class WebsocketConnection(val httpClient: HttpClient, val url: String) : LightMo
             }
         }
     }
-
 }