Merge remote-tracking branch 'origin/main' into node-reference-resolution

# Conflicts:
#	model-client/build.gradle.kts

Author: slisson

.github/workflows/build.yaml

@@ -21,9 +21,15 @@ jobs:
           distribution: 'temurin'
           java-version: '11'
       - name: Build
+        uses: gradle/gradle-build-action@v2
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: ./gradlew build publishToMavenLocal -PciBuild=true
+        with:
+          arguments: |
+            --build-cache
+            build
+            publishToMavenLocal
+            -PciBuild=true
       - name: Test Model API Generator Gradle Plugin
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

docs/global/modules/core/pages/reference/component-mps-model-server-plugin.adoc

@@ -0,0 +1,25 @@
+= mps-model-server-plugin
+
+== Health checks
+
+The plugin offers a set of health checks via HTTP on port 48305 and path `/health`.
+Health checks can be enabled adding query parameters with the health check name and the value `true` to the request.
+
+=== indexer
+
+The check fails, if the indexer is currently running for one of the opened projects.
+
+[NOTE]
+====
+This check indicates a healthy system until a project is opened.
+Combine it with the `projects` health check to effectively wait for the system to be ready to serve data immediately.
+====
+
+=== projects
+
+Reports an unhealthy system whenever no project is loaded.
+
+=== virtualFolders
+
+Reports an unhealthy system when no virtual folders are available.
+This might also be true in case a project without virtual folders is fully loaded.

docs/global/modules/core/partials/nav-reference.adoc

@@ -4,3 +4,4 @@
 * xref:core:reference/component-model-api-gen.adoc[]
 * xref:core:reference/component-model-api-gen-gradle.adoc[]
 * xref:core:reference/component-light-model-client.adoc[]
+* xref:core:reference/component-mps-model-server-plugin.adoc[]

gradle/libs.versions.toml

@@ -12,15 +12,15 @@ kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
 kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
 gitVersion = { id = "com.palantir.git-version", version = "3.0.0" }
 ktlint = { id = "org.jlleitschuh.gradle.ktlint", version = "11.5.1" }
-spotless = { id = "com.diffplug.spotless", version = "6.20.0" }
+spotless = { id = "com.diffplug.spotless", version = "6.21.0" }
 tasktree = { id = "com.dorongold.task-tree", version = "2.1.1" }
 modelix-mps-buildtools = { id = "org.modelix.mps.build-tools", version = "1.1.0" }
-dokka = {id = "org.jetbrains.dokka", version = "1.8.20"}
+dokka = {id = "org.jetbrains.dokka", version = "1.9.0"}
 
 [versions]
 kotlin = "1.9.10"
 kotlinCoroutines="1.7.3"
-ktor="2.3.3"
+ktor="2.3.4"
 kotlinHtml="0.8.0"
 kotlinSerialization="1.6.0"
 ignite="2.15.0"
@@ -34,7 +34,7 @@ kotlin-serialization-json = { group = "org.jetbrains.kotlinx", name = "kotlinx-s
 kotlin-serialization-yaml = { group = "com.charleskorn.kaml", name = "kaml", version = "0.55.0" }
 kotlin-logging = { group = "io.github.microutils", name = "kotlin-logging", version = "3.0.5" }
 kotlin-collections-immutable = { group = "org.jetbrains.kotlinx", name = "kotlinx-collections-immutable", version = "0.3.5" }
-kotlin-datetime = { group = "org.jetbrains.kotlinx", name = "kotlinx-datetime", version = "0.4.0" }
+kotlin-datetime = { group = "org.jetbrains.kotlinx", name = "kotlinx-datetime", version = "0.4.1" }
 
 kotlin-coroutines-core = { group = "org.jetbrains.kotlinx", name = "kotlinx-coroutines-core", version.ref = "kotlinCoroutines" }
 kotlin-coroutines-swing = { group = "org.jetbrains.kotlinx", name = "kotlinx-coroutines-swing", version.ref = "kotlinCoroutines" }
@@ -55,14 +55,15 @@ ktor-server-websockets = { group = "io.ktor", name = "ktor-server-websockets", v
 
 ktor-client-core = { group = "io.ktor", name = "ktor-client-core", version.ref = "ktor" }
 ktor-client-content-negotiation = { group = "io.ktor", name = "ktor-client-content-negotiation", version.ref = "ktor" }
+ktor-client-mock = { group = "io.ktor", name = "ktor-client-mock", version.ref = "ktor" }
 ktor-client-cio = { group = "io.ktor", name = "ktor-client-cio", version.ref = "ktor" }
 ktor-client-websockets = { group = "io.ktor", name = "ktor-client-websockets", version.ref = "ktor" }
 ktor-client-js = { group = "io.ktor", name = "ktor-client-js", version.ref = "ktor" }
 ktor-client-auth = { group = "io.ktor", name = "ktor-client-auth", version.ref = "ktor" }
 
 ktor-serialization-json = { group = "io.ktor", name = "ktor-serialization-kotlinx-json", version.ref = "ktor" }
 
-keycloak-authz-client = { group = "org.keycloak", name = "keycloak-authz-client", version = "22.0.1" }
+keycloak-authz-client = { group = "org.keycloak", name = "keycloak-authz-client", version = "22.0.3" }
 guava = { group = "com.google.guava", name = "guava", version = "32.1.2-jre" }
 modelix-incremental = { group = "org.modelix", name = "incremental", version = "0.2.0" }
 kotlinpoet = { group = "com.squareup", name = "kotlinpoet", version = "1.14.2" }
@@ -79,11 +80,11 @@ ignite-indexing = { group = "org.apache.ignite", name = "ignite-indexing", versi
 logback-classic = { group = "ch.qos.logback", name = "logback-classic", version = "1.4.11" }
 postgresql = { group = "org.postgresql", name = "postgresql", version = "42.6.0" }
 jcommander = { group = "com.beust", name = "jcommander", version = "1.82" }
-cucumber-java = { group = "io.cucumber", name = "cucumber-java", version = "7.13.0" }
+cucumber-java = { group = "io.cucumber", name = "cucumber-java", version = "7.14.0" }
 junit = { group = "junit", name = "junit", version = "4.13.2" }
 
 apache-cxf-sse = { group = "org.apache.cxf", name = "cxf-rt-rs-sse", version.ref = "apacheCxf" }
 apache-cxf-client = { group = "org.apache.cxf", name = "cxf-rt-rs-client", version.ref = "apacheCxf" }
 
 semver = { group = "org.semver", name = "api", version = "0.9.33"}
-dokka-versioning = { group = "org.jetbrains.dokka", name = "versioning-plugin", version = "1.8.20"}
+dokka-versioning = { group = "org.jetbrains.dokka", name = "versioning-plugin", version = "1.9.0"}

model-api-gen-runtime/src/commonMain/kotlin/org/modelix/metamodel/ModelApiExt.kt

@@ -0,0 +1,23 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.modelix.metamodel
+
+import org.modelix.model.api.INode
+import org.modelix.model.api.addNewChild
+
+inline fun <reified NodeT : ITypedNode> INode.addNewChild(concept: INonAbstractConcept<NodeT>) =
+    addNewChild(null, concept.untyped()).typed<NodeT>()
+
+inline fun <reified NodeT : ITypedNode> INode.addNewChild(role: String, concept: INonAbstractConcept<NodeT>) =
+    addNewChild(role, concept.untyped()).typed<NodeT>()

model-client/build.gradle.kts

@@ -55,6 +55,8 @@ kotlin {
         }
         val commonTest by getting {
             dependencies {
+                implementation(libs.ktor.client.mock)
+                implementation(libs.kotlin.coroutines.test)
                 implementation(kotlin("test"))
             }
         }
@@ -80,10 +82,6 @@ kotlin {
                 implementation(libs.ktor.serialization.json)
             }
         }
-        val jvmTest by getting {
-            dependencies {
-            }
-        }
         val jsMain by getting {
             dependencies {
                 implementation(kotlin("stdlib-js"))
@@ -92,10 +90,6 @@ kotlin {
                 implementation(npm("js-base64", "^3.4.5"))
             }
         }
-        val jsTest by getting {
-            dependencies {
-            }
-        }
     }
 }
 

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

@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2023.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.modelix.model.client2
+
+internal expect interface Closable {
+    fun close()
+}

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

@@ -19,6 +19,19 @@ import org.modelix.model.lazy.BranchReference
 import org.modelix.model.lazy.RepositoryId
 import org.modelix.model.server.api.ModelQuery
 
+/**
+ * This interface is meant exclusively for model client usage.
+ *
+ * It is designed to ensure decoupling between model client usage operations and other aspects,
+ * such as lifecycle management.
+ * Users of this interface cannot incidentally depend on non-usage functionality.
+ * See also: [Interface segregation principle](https://en.wikipedia.org/wiki/Interface_segregation_principle)
+ *
+ * Specifically, this interface should not be used for managing the client's lifecycle,
+ * as the lifecycle management may vary depending on the specific implementation.
+ * If you need to manage the client's lifecycle, use the methods in the class interface of the concrete implementations,
+ * such as [ModelClientV2].
+ */
 interface IModelClientV2 {
     fun getClientId(): Int
     fun getIdGenerator(): IIdGenerator

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

@@ -24,6 +24,7 @@ import io.ktor.client.request.post
 import io.ktor.client.request.setBody
 import io.ktor.client.statement.bodyAsText
 import io.ktor.http.ContentType
+import io.ktor.http.URLBuilder
 import io.ktor.http.appendPathSegments
 import io.ktor.http.contentType
 import io.ktor.http.takeFrom
@@ -49,7 +50,7 @@ import kotlin.time.Duration.Companion.seconds
 class ModelClientV2(
     private val httpClient: HttpClient,
     val baseUrl: String,
-) : IModelClientV2 {
+) : IModelClientV2, Closable {
     private var clientId: Int = 0
     private var idGenerator: IIdGenerator = IdGeneratorDummy()
     private var userId: String? = null
@@ -90,7 +91,7 @@ class ModelClientV2(
         val response = httpClient.post {
             url {
                 takeFrom(baseUrl)
-                appendPathSegments("repositories", repository.id, "init")
+                appendPathSegmentsEncodingSlash("repositories", repository.id, "init")
             }
         }
         val delta = response.body<VersionDelta>()
@@ -110,7 +111,7 @@ class ModelClientV2(
         return httpClient.get {
             url {
                 takeFrom(baseUrl)
-                appendPathSegments("repositories", repository.id, "branches")
+                appendPathSegmentsEncodingSlash("repositories", repository.id, "branches")
             }
         }.bodyAsText().lines().map { repository.getBranchReference(it) }
     }
@@ -138,7 +139,7 @@ class ModelClientV2(
         val response = httpClient.post {
             url {
                 takeFrom(baseUrl)
-                appendPathSegments("repositories", branch.repositoryId.id, "branches", branch.branchName)
+                appendPathSegmentsEncodingSlash("repositories", branch.repositoryId.id, "branches", branch.branchName)
             }
             contentType(ContentType.Application.Json)
             val body = VersionDelta(version.getContentHash(), null, objectsMap = objects)
@@ -154,7 +155,7 @@ class ModelClientV2(
         val response = httpClient.get {
             url {
                 takeFrom(baseUrl)
-                appendPathSegments("repositories", branch.repositoryId.id, "branches", branch.branchName)
+                appendPathSegmentsEncodingSlash("repositories", branch.repositoryId.id, "branches", branch.branchName)
                 if (lastKnownVersion != null) {
                     parameters["lastKnown"] = lastKnownVersion.hash
                 }
@@ -170,7 +171,7 @@ class ModelClientV2(
         val response = httpClient.get {
             url {
                 takeFrom(baseUrl)
-                appendPathSegments("repositories", branch.repositoryId.id, "branches", branch.branchName, "poll")
+                appendPathSegmentsEncodingSlash("repositories", branch.repositoryId.id, "branches", branch.branchName, "poll")
                 if (lastKnownVersion != null) {
                     parameters["lastKnown"] = lastKnownVersion.hash
                 }
@@ -189,6 +190,10 @@ class ModelClientV2(
         TODO("Not yet implemented")
     }
 
+    override fun close() {
+        httpClient.close()
+    }
+
     private fun createVersion(baseVersion: CLVersion?, delta: VersionDelta): CLVersion {
         return if (baseVersion == null) {
             CLVersion(
@@ -280,5 +285,8 @@ expect class ModelClientV2PlatformSpecificBuilder() : ModelClientV2Builder
 fun VersionDelta.checkObjectHashes() {
     HashUtil.checkObjectHashes(objectsMap)
 }
+private fun URLBuilder.appendPathSegmentsEncodingSlash(vararg components: String): URLBuilder {
+    return appendPathSegments(components.toList(), true)
+}
 
 fun VersionDelta.getAllObjects(): Map<String, String> = objectsMap + objects.associateBy { HashUtil.sha256(it) }

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

@@ -17,6 +17,7 @@ import org.modelix.model.lazy.CLTree
 import org.modelix.model.lazy.CLVersion
 import org.modelix.model.operations.OTBranch
 import org.modelix.model.server.api.ModelQuery
+import kotlin.coroutines.cancellation.CancellationException
 
 class ReplicatedModel(val client: IModelClientV2, val branchRef: BranchReference, val query: ModelQuery? = null) {
     private val scope = CoroutineScope(Dispatchers.Default)
@@ -62,6 +63,9 @@ class ReplicatedModel(val client: IModelClientV2, val branchRef: BranchReference
                     } as CLVersion
                     remoteVersionReceived(newRemoteVersion)
                     nextDelayMs = 0
+                } catch (ex: CancellationException) {
+                    LOG.debug { "Stop to poll branch $branchRef after disposing." }
+                    throw ex
                 } catch (ex: Throwable) {
                     LOG.error(ex) { "Failed to poll branch $branchRef" }
                     nextDelayMs = (nextDelayMs * 3 / 2).coerceIn(1000, 30000)