Merge pull request #1038 from modelix/feat/diff-viewer

MODELIX-1007 Improve comprehensibility of model server history

Author: mhuster23

model-server/src/main/kotlin/org/modelix/model/server/Main.kt

@@ -61,6 +61,7 @@ import org.modelix.model.server.handlers.Paths.registerJsonTypes
 import org.modelix.model.server.handlers.Problem
 import org.modelix.model.server.handlers.RepositoriesManager
 import org.modelix.model.server.handlers.ui.ContentExplorer
+import org.modelix.model.server.handlers.ui.DiffView
 import org.modelix.model.server.handlers.ui.HistoryHandler
 import org.modelix.model.server.handlers.ui.IndexPage
 import org.modelix.model.server.handlers.ui.RepositoryOverview
@@ -176,6 +177,7 @@ object Main {
             }
             val repositoryOverview = RepositoryOverview(repositoriesManager)
             val historyHandler = HistoryHandler(localModelClient, repositoriesManager)
+            val diffView = DiffView(repositoriesManager)
             val contentExplorer = ContentExplorer(localModelClient, repositoriesManager)
             val modelReplicationServer = ModelReplicationServer(repositoriesManager, localModelClient, inMemoryModels)
             val metricsApi = MetricsApiImpl()
@@ -217,6 +219,7 @@ object Main {
                 modelServer.init(this)
                 IndexPage().init(this)
                 historyHandler.init(this)
+                diffView.init(this)
                 repositoryOverview.init(this)
                 contentExplorer.init(this)
                 modelReplicationServer.init(this)

model-server/src/main/kotlin/org/modelix/model/server/handlers/HttpException.kt

@@ -18,6 +18,7 @@ package org.modelix.model.server.handlers
 
 import io.ktor.http.HttpStatusCode
 import org.modelix.model.lazy.BranchReference
+import org.modelix.model.persistent.SerializationUtil
 
 /**
  * A namespace for problems we use as the first part of every `type` in an application/problem+json response.
@@ -101,6 +102,21 @@ class VersionNotFoundException(versionHash: String, cause: Throwable? = null) :
         cause = cause,
     )
 
+/**
+ * A [HttpException] indicating that a node was not found.
+ *
+ * @param nodeId id of the missing node
+ * @param cause The causing exception for the bad request or null if none.
+ */
+class NodeNotFoundException(nodeId: Long, cause: Throwable? = null) :
+    HttpException(
+        HttpStatusCode.NotFound,
+        title = "Node not found",
+        details = "Node with id '${SerializationUtil.longToHex(nodeId)}' ('$nodeId') doesn't exist",
+        type = "/problems/node-not-found",
+        cause = cause,
+    )
+
 /**
  * An [HttpException] indicating that a provided repository name is not valid.
  *

model-server/src/main/kotlin/org/modelix/model/server/handlers/ui/ContentExplorer.kt

@@ -30,23 +30,29 @@ import io.ktor.server.routing.routing
 import kotlinx.html.BODY
 import kotlinx.html.FlowContent
 import kotlinx.html.UL
+import kotlinx.html.a
 import kotlinx.html.b
 import kotlinx.html.body
 import kotlinx.html.br
 import kotlinx.html.button
+import kotlinx.html.classes
 import kotlinx.html.div
+import kotlinx.html.getForm
 import kotlinx.html.h1
 import kotlinx.html.h3
 import kotlinx.html.id
+import kotlinx.html.label
 import kotlinx.html.li
 import kotlinx.html.link
 import kotlinx.html.script
 import kotlinx.html.small
 import kotlinx.html.stream.appendHTML
 import kotlinx.html.style
+import kotlinx.html.submitInput
 import kotlinx.html.table
 import kotlinx.html.tbody
 import kotlinx.html.td
+import kotlinx.html.textInput
 import kotlinx.html.th
 import kotlinx.html.thead
 import kotlinx.html.title
@@ -61,10 +67,12 @@ import org.modelix.model.api.PNodeAdapter
 import org.modelix.model.api.TreePointer
 import org.modelix.model.client.IModelClient
 import org.modelix.model.lazy.BranchReference
+import org.modelix.model.lazy.CLTree
 import org.modelix.model.lazy.CLVersion
 import org.modelix.model.lazy.RepositoryId
 import org.modelix.model.server.ModelServerPermissionSchema
 import org.modelix.model.server.handlers.IRepositoriesManager
+import org.modelix.model.server.handlers.NodeNotFoundException
 import org.modelix.model.server.templates.PageWithMenuBar
 import kotlin.collections.set
 
@@ -109,17 +117,36 @@ class ContentExplorer(private val client: IModelClient, private val repoManager:
                     return@get
                 }
 
+                // IMPORTANT Do not let `expandTo` be an arbitrary string to avoid code injection.
+                // The value of `expandTo` is expanded into JavaScript.
+                val expandTo = call.request.queryParameters["expandTo"]?.let {
+                    it.toLongOrNull() ?: return@get call.respondText("Invalid expandTo value. Provide a node id.", status = HttpStatusCode.BadRequest)
+                }
+
                 repoManager.runWithRepository(repositoryId) {
                     val tree = CLVersion.loadFromHash(versionHash, client.storeCache).getTree()
                     val rootNode = PNodeAdapter(ITree.ROOT_ID, TreePointer(tree))
 
+                    val expandedNodes = expandTo?.let { nodeId -> getAncestorsAndSelf(nodeId, tree) }.orEmpty()
+
                     call.respondHtmlTemplate(PageWithMenuBar("repos/", "../../../../..")) {
                         headContent {
                             title("Content Explorer")
                             link("../../../../../public/content-explorer.css", rel = "stylesheet")
                             script("text/javascript", src = "../../../../../public/content-explorer.js") {}
+                            if (expandTo != null) {
+                                script("text/javascript") {
+                                    unsafe {
+                                        +"""
+                                        document.addEventListener("DOMContentLoaded", function(event) {
+                                            scrollToElement('$expandTo');
+                                        });
+                                        """.trimIndent()
+                                    }
+                                }
+                            }
                         }
-                        bodyContent { contentPageBody(rootNode, versionHash, emptySet()) }
+                        bodyContent { contentPageBody(rootNode, versionHash, expandedNodes, expandTo) }
                     }
                 }
             }
@@ -188,6 +215,17 @@ class ContentExplorer(private val client: IModelClient, private val repoManager:
         }
     }
 
+    private fun getAncestorsAndSelf(expandTo: Long, tree: CLTree): Set<String> {
+        val seq = generateSequence(expandTo) { id ->
+            try {
+                tree.resolveElement(id)?.parentId
+            } catch (e: org.modelix.model.lazy.NodeNotFoundException) {
+                throw NodeNotFoundException(id, e)
+            }
+        }
+        return seq.map { it.toString() }.toSet()
+    }
+
     // The method traverses the expanded tree based on the alreadyExpandedNodeIds and
     // collects the expandable (not empty) nodes which are not expanded yet
     private fun collectExpandableChildNodes(under: PNodeAdapter, alreadyExpandedNodeIds: Set<String>): Set<String> {
@@ -206,7 +244,12 @@ class ContentExplorer(private val client: IModelClient, private val repoManager:
         return emptySet()
     }
 
-    private fun FlowContent.contentPageBody(rootNode: PNodeAdapter, versionHash: String, expandedNodeIds: Set<String>) {
+    private fun FlowContent.contentPageBody(
+        rootNode: PNodeAdapter,
+        versionHash: String,
+        expandedNodeIds: Set<String>,
+        expandTo: Long?,
+    ) {
         h1 { +"Model Server Content" }
         small {
             style = "color: #888; text-align: center; margin-bottom: 15px;"
@@ -223,24 +266,42 @@ class ContentExplorer(private val client: IModelClient, private val repoManager:
                 +"Collapse all"
             }
         }
+        getForm(action = ".") {
+            label {
+                htmlFor = "expandTo"
+                +"Expand to Node: "
+            }
+            textInput {
+                name = "expandTo"
+                placeholder = "nodeId"
+                required = true
+            }
+            submitInput(classes = "btn") {
+                value = "Go"
+            }
+        }
         div {
             id = "treeWrapper"
             ul("treeRoot") {
-                nodeItem(rootNode, expandedNodeIds)
+                nodeItem(rootNode, expandedNodeIds, expandTo)
             }
         }
         div {
             id = "nodeInspector"
         }
     }
 
-    private fun UL.nodeItem(node: PNodeAdapter, expandedNodeIds: Set<String>) {
+    private fun UL.nodeItem(node: PNodeAdapter, expandedNodeIds: Set<String>, expandTo: Long? = null) {
         li("nodeItem") {
+            id = node.nodeId.toString()
             val expanded = expandedNodeIds.contains(node.nodeId.toString())
             if (node.allChildren.toList().isNotEmpty()) {
                 div(if (expanded) "expander expander-expanded" else "expander") { unsafe { +"&#x25B6;" } }
             }
             div("nameField") {
+                if (expandTo == node.nodeId) {
+                    classes += "expandedToNameField"
+                }
                 attributes["data-nodeid"] = node.nodeId.toString()
                 b {
                     val namePropertyUID = BuiltinLanguages.jetbrains_mps_lang_core.INamedConcept.name.getUID()
@@ -268,7 +329,7 @@ class ContentExplorer(private val client: IModelClient, private val repoManager:
                 if (expanded) {
                     ul("nodeTree") {
                         for (child in node.allChildren) {
-                            nodeItem(child as PNodeAdapter, expandedNodeIds)
+                            nodeItem(child as PNodeAdapter, expandedNodeIds, expandTo)
                         }
                     }
                 }
@@ -322,7 +383,14 @@ class ContentExplorer(private val client: IModelClient, private val repoManager:
                             tr {
                                 td { +referenceRole }
                                 td {
-                                    +"${(node.getReferenceTarget(referenceRole) as? PNodeAdapter)?.nodeId}"
+                                    val nodeId = (node.getReferenceTarget(referenceRole) as? PNodeAdapter)?.nodeId
+                                    if (nodeId != null) {
+                                        a("?expandTo=$nodeId") {
+                                            +"$nodeId"
+                                        }
+                                    } else {
+                                        +"null"
+                                    }
                                 }
                                 td {
                                     +"${node.getReferenceTargetRef(referenceRole)?.serialize()}"