refactor(model-api): extract replaceNode into IReplaceableNode

mhuster23 · mhuster23 · commit 306474d729a9 · 2024-04-10T13:53:11.000+02:00
diff --git a/bulk-model-sync-lib/src/commonMain/kotlin/org/modelix/model/sync/bulk/ModelImporter.kt b/bulk-model-sync-lib/src/commonMain/kotlin/org/modelix/model/sync/bulk/ModelImporter.kt
@@ -22,6 +22,7 @@ import org.modelix.model.api.ConceptReference
 import org.modelix.model.api.INode
 import org.modelix.model.api.INodeReference
 import org.modelix.model.api.INodeResolutionScope
+import org.modelix.model.api.IReplaceableNode
 import org.modelix.model.api.SerializedNodeReference
 import org.modelix.model.api.getDescendants
 import org.modelix.model.api.isChildRoleOrdered
@@ -273,7 +274,7 @@ class ModelImporter(
         if (existingNode.getConceptReference() == newConcept) {
             return existingNode
         }
-        requireNotNull(newConcept) { "Unexpected null concept" }
+        require(existingNode is IReplaceableNode) { "Concept has changed but node is not replaceable. node=$existingNode" }
         return existingNode.replaceNode(newConcept)
     }
 
diff --git a/light-model-client/src/commonMain/kotlin/org/modelix/client/light/LightModelClient.kt b/light-model-client/src/commonMain/kotlin/org/modelix/client/light/LightModelClient.kt
@@ -455,10 +455,6 @@ class LightModelClient internal constructor(
             }
         }
 
-        override fun replaceNode(concept: ConceptReference): INode {
-            TODO("Not yet implemented")
-        }
-
         override fun removeChild(child: INode) {
             require(child is NodeAdapter && child.getClient() == getClient()) { "Unsupported child type: $child" }
             requiresWrite {
diff --git a/model-api/src/commonMain/kotlin/org/modelix/model/api/INode.kt b/model-api/src/commonMain/kotlin/org/modelix/model/api/INode.kt
@@ -47,17 +47,6 @@ interface INode {
 
     fun tryGetConcept(): IConcept? = getConceptReference()?.tryResolve()
 
-    /**
-     * Replaces this node with a new node of the given concept that uses the same id as this node.
-     * Properties, references and children will be the same.
-     *
-     * @param concept the concept of the new node
-     * @return replacement for this node with the new given concept
-     */
-    fun replaceNode(concept: ConceptReference): INode {
-        throw UnsupportedOperationException() // Default implementation to avoid breaking change
-    }
-
     /**
      * Role of this node in its parent node if it exists,or null otherwise.
      */
@@ -308,6 +297,20 @@ interface IDeprecatedNodeDefaults : INode {
     override fun getReferenceLinks(): List<IReferenceLink>
 }
 
+/**
+ *  Interface for nodes that can be replaced by a new instance.
+ */
+interface IReplaceableNode : INode {
+    /**
+     * Replaces this node with a new node of the given concept that uses the same id as this node.
+     * Properties, references and children will be the same.
+     *
+     * @param concept the concept of the new node
+     * @return replacement for this node with the new given concept
+     */
+    fun replaceNode(concept: ConceptReference?): INode
+}
+
 @Deprecated("Use .key(INode), .key(IBranch), .key(ITransaction) or .key(ITree)")
 fun IRole.key(): String = RoleAccessContext.getKey(this)
 fun IRole.key(node: INode): String = if (node.usesRoleIds()) getUID() else getSimpleName()
diff --git a/model-api/src/commonMain/kotlin/org/modelix/model/api/PNodeAdapter.kt b/model-api/src/commonMain/kotlin/org/modelix/model/api/PNodeAdapter.kt
@@ -20,7 +20,7 @@ import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.mapNotNull
 import org.modelix.model.area.PArea
 
-open class PNodeAdapter(val nodeId: Long, val branch: IBranch) : INode, INodeEx {
+open class PNodeAdapter(val nodeId: Long, val branch: IBranch) : INode, INodeEx, IReplaceableNode {
 
     init {
         require(nodeId != 0L, { "Invalid node 0" })
@@ -82,7 +82,7 @@ open class PNodeAdapter(val nodeId: Long, val branch: IBranch) : INode, INodeEx
         return PNodeAdapter(branch.writeTransaction.addNewChild(nodeId, role.key(this), index, concept), branch)
     }
 
-    override fun replaceNode(concept: ConceptReference): INode {
+    override fun replaceNode(concept: ConceptReference?): INode {
         branch.writeTransaction.setConcept(nodeId, concept)
         return this
     }
diff --git a/model-api/src/commonMain/kotlin/org/modelix/model/area/AreaWithMounts.kt b/model-api/src/commonMain/kotlin/org/modelix/model/area/AreaWithMounts.kt
@@ -20,6 +20,7 @@ import org.modelix.model.api.IConceptReference
 import org.modelix.model.api.INode
 import org.modelix.model.api.INodeReference
 import org.modelix.model.api.INodeWrapper
+import org.modelix.model.api.IReplaceableNode
 
 @Deprecated("not supported anymore")
 class AreaWithMounts(val rootArea: IArea, mounts: Map<INode, IArea>) : IArea {
@@ -151,7 +152,7 @@ class AreaWithMounts(val rootArea: IArea, mounts: Map<INode, IArea>) : IArea {
         val mountValues: List<IAreaReference>,
     ) : IAreaReference
 
-    inner class NodeWrapper(val node: INode) : INode, INodeWrapper {
+    inner class NodeWrapper(val node: INode) : INode, INodeWrapper, IReplaceableNode {
         override fun getWrappedNode(): INode = node
 
         override fun getArea(): IArea = this@AreaWithMounts
@@ -160,7 +161,8 @@ class AreaWithMounts(val rootArea: IArea, mounts: Map<INode, IArea>) : IArea {
             return node.getChildren(role).map { NodeWrapper(getMountedArea(it)?.getRoot() ?: it) }
         }
 
-        override fun replaceNode(concept: ConceptReference): INode {
+        override fun replaceNode(concept: ConceptReference?): INode {
+            check(node is IReplaceableNode)
             return NodeWrapper(node.replaceNode(concept))
         }
 
diff --git a/model-api/src/commonMain/kotlin/org/modelix/model/area/CompositeArea.kt b/model-api/src/commonMain/kotlin/org/modelix/model/area/CompositeArea.kt
@@ -20,6 +20,7 @@ import org.modelix.model.api.IConceptReference
 import org.modelix.model.api.INode
 import org.modelix.model.api.INodeReference
 import org.modelix.model.api.INodeWrapper
+import org.modelix.model.api.IReplaceableNode
 
 @Deprecated("not supported anymore")
 class CompositeArea : IArea {
@@ -164,10 +165,6 @@ class CompositeArea : IArea {
             throw UnsupportedOperationException("Read only. Create a new CompositeArea instance instead.")
         }
 
-        override fun replaceNode(concept: ConceptReference): INode {
-            throw UnsupportedOperationException("Root cannot have a concept.")
-        }
-
         override fun removeChild(child: INode) {
             throw UnsupportedOperationException("Read only. Create a new CompositeArea instance instead.")
         }
@@ -214,7 +211,7 @@ class CompositeArea : IArea {
         }
     }
 
-    inner class NodeWrapper(val node: INode) : INode, INodeWrapper {
+    inner class NodeWrapper(val node: INode) : INode, INodeWrapper, IReplaceableNode {
 
         override fun getWrappedNode(): INode = node
 
@@ -224,7 +221,10 @@ class CompositeArea : IArea {
             return node.getChildren(role).map { NodeWrapper(it) }
         }
 
-        override fun replaceNode(concept: ConceptReference): INode = NodeWrapper(node.replaceNode(concept))
+        override fun replaceNode(concept: ConceptReference?): INode {
+            require(node is IReplaceableNode)
+            return NodeWrapper(node.replaceNode(concept))
+        }
 
         override fun removeChild(child: INode) {
             node.removeChild(unwrapNode(child))
diff --git a/model-client/src/commonTest/kotlin/org/modelix/model/api/CompositeAreaTest.kt b/model-client/src/commonTest/kotlin/org/modelix/model/api/CompositeAreaTest.kt
@@ -24,10 +24,6 @@ class MyNode(val name: String) : INode {
     override val concept: IConcept?
         get() = TODO("Not yet implemented")
 
-    override fun replaceNode(concept: ConceptReference): INode {
-        TODO("Not yet implemented")
-    }
-
     override val roleInParent: String?
         get() = TODO("Not yet implemented")
     override val parent: INode?
diff --git a/model-client/src/commonTest/kotlin/org/modelix/model/api/NodeUtilTest.kt b/model-client/src/commonTest/kotlin/org/modelix/model/api/NodeUtilTest.kt
@@ -87,10 +87,6 @@ class SimpleTestNode(override val concept: IConcept? = null) : INode {
     override val reference: INodeReference
         get() = TODO("Not yet implemented")
 
-    override fun replaceNode(concept: ConceptReference): INode {
-        TODO("Not yet implemented")
-    }
-
     override var roleInParent: String? = null
     override var parent: INode? = null
 
diff --git a/model-datastructure/src/jvmMain/kotlin/org/modelix/model/InMemoryModel.kt b/model-datastructure/src/jvmMain/kotlin/org/modelix/model/InMemoryModel.kt
@@ -317,10 +317,6 @@ data class InMemoryNode(val model: InMemoryModel, val nodeId: Long) : INode, INo
         throw UnsupportedOperationException("read-only")
     }
 
-    override fun replaceNode(concept: ConceptReference): INode {
-        throw UnsupportedOperationException("read-only")
-    }
-
     override fun removeChild(child: INode) {
         throw UnsupportedOperationException("read-only")
     }
diff --git a/modelql-client/src/commonMain/kotlin/org/modelix/modelql/client/ModelQLNode.kt b/modelql-client/src/commonMain/kotlin/org/modelix/modelql/client/ModelQLNode.kt
@@ -149,10 +149,6 @@ abstract class ModelQLNode(val client: ModelQLClient) : INode, ISupportsModelQL,
         return addNewChild(resolveChildLinkOrFallback(role), index, concept)
     }
 
-    override fun replaceNode(concept: ConceptReference): INode {
-        throw UnsupportedOperationException("ModelQL currently does not support replacing nodes.")
-    }
-
     override fun removeChild(child: INode) {
         blockingQuery { child.reference.asMono().resolve().remove() }
     }
diff --git a/mps-model-adapters-plugin/src/test/kotlin/org/modelix/model/mpsadapters/ReplaceNodeTest.kt b/mps-model-adapters-plugin/src/test/kotlin/org/modelix/model/mpsadapters/ReplaceNodeTest.kt
@@ -19,6 +19,7 @@ package org.modelix.model.mpsadapters
 import org.modelix.model.api.BuiltinLanguages
 import org.modelix.model.api.ConceptReference
 import org.modelix.model.api.INode
+import org.modelix.model.api.IReplaceableNode
 
 class ReplaceNodeTest : MpsAdaptersTestBase("SimpleProject") {
 
@@ -33,7 +34,7 @@ class ReplaceNodeTest : MpsAdaptersTestBase("SimpleProject") {
             val module = repositoryNode.getChildren(BuiltinLanguages.MPSRepositoryConcepts.Repository.modules)
                 .single { it.getPropertyValue(BuiltinLanguages.jetbrains_mps_lang_core.INamedConcept.name) == "Solution1" }
             val model = module.getChildren(BuiltinLanguages.MPSRepositoryConcepts.Module.models).single()
-            val rootNode = model.getChildren(BuiltinLanguages.MPSRepositoryConcepts.Model.rootNodes).single()
+            val rootNode = model.getChildren(BuiltinLanguages.MPSRepositoryConcepts.Model.rootNodes).single() as IReplaceableNode
 
             val oldProperties = rootNode.getAllProperties().toSet()
             val oldReferences = rootNode.getAllReferenceTargetRefs().toSet()
diff --git a/mps-model-adapters/src/main/kotlin/org/modelix/model/mpsadapters/IDefaultNodeAdapter.kt b/mps-model-adapters/src/main/kotlin/org/modelix/model/mpsadapters/IDefaultNodeAdapter.kt
@@ -16,7 +16,6 @@
 
 package org.modelix.model.mpsadapters
 
-import org.modelix.model.api.ConceptReference
 import org.modelix.model.api.IChildLink
 import org.modelix.model.api.IConcept
 import org.modelix.model.api.IConceptReference
@@ -97,8 +96,4 @@ interface IDefaultNodeAdapter : IDeprecatedNodeDefaults {
         val link = child.getContainmentLink() ?: error("ContainmentLink not found for node $child")
         throw UnsupportedOperationException("Cannot remove child in link $link of concept $concept.")
     }
-
-    override fun replaceNode(concept: ConceptReference): INode {
-        throw UnsupportedOperationException("Node replacement is not possible for node: $this")
-    }
 }
diff --git a/mps-model-adapters/src/main/kotlin/org/modelix/model/mpsadapters/MPSNode.kt b/mps-model-adapters/src/main/kotlin/org/modelix/model/mpsadapters/MPSNode.kt
@@ -36,10 +36,11 @@ import org.modelix.model.api.INode
 import org.modelix.model.api.INodeReference
 import org.modelix.model.api.IProperty
 import org.modelix.model.api.IReferenceLink
+import org.modelix.model.api.IReplaceableNode
 import org.modelix.model.api.resolveIn
 import org.modelix.model.area.IArea
 
-data class MPSNode(val node: SNode) : IDefaultNodeAdapter {
+data class MPSNode(val node: SNode) : IDefaultNodeAdapter, IReplaceableNode {
     override fun getArea(): IArea {
         return MPSArea(node.model?.repository ?: MPSModuleRepository.getInstance())
     }
@@ -73,7 +74,9 @@ data class MPSNode(val node: SNode) : IDefaultNodeAdapter {
             return node.children.map { MPSNode(it) }
         }
 
-    override fun replaceNode(concept: ConceptReference): INode {
+    override fun replaceNode(concept: ConceptReference?): INode {
+        requireNotNull(concept) { "Can't replace $node with null concept. Use BaseConcept explicitly." }
+
         val id = node.nodeId
         val model = checkNotNull(node.model) { "Node is not part of a model" }
         val newNode = model.createNode(SConceptAdapterById(SConceptId.deserialize(concept.uid), ""), id)

Original file line number	Diff line number	Diff line change
`@@ -455,10 +455,6 @@ class LightModelClient internal constructor(`
`455`	`455`	`}`
`456`	`456`	`}`
`457`	`457`
`458`		`- override fun replaceNode(concept: ConceptReference): INode {`
`459`		`- TODO("Not yet implemented")`
`460`		`- }`
`461`		`-`
`462`	`458`	`override fun removeChild(child: INode) {`
`463`	`459`	`require(child is NodeAdapter && child.getClient() == getClient()) { "Unsupported child type: $child" }`
`464`	`460`	`requiresWrite {`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ import kotlinx.coroutines.flow.map`
`20`	`20`	`import kotlinx.coroutines.flow.mapNotNull`
`21`	`21`	`import org.modelix.model.area.PArea`
`22`	`22`
`23`		`-open class PNodeAdapter(val nodeId: Long, val branch: IBranch) : INode, INodeEx {`
	`23`	`+open class PNodeAdapter(val nodeId: Long, val branch: IBranch) : INode, INodeEx, IReplaceableNode {`
`24`	`24`
`25`	`25`	`init {`
`26`	`26`	`require(nodeId != 0L, { "Invalid node 0" })`
`@@ -82,7 +82,7 @@ open class PNodeAdapter(val nodeId: Long, val branch: IBranch) : INode, INodeEx`
`82`	`82`	`return PNodeAdapter(branch.writeTransaction.addNewChild(nodeId, role.key(this), index, concept), branch)`
`83`	`83`	`}`
`84`	`84`
`85`		`- override fun replaceNode(concept: ConceptReference): INode {`
	`85`	`+ override fun replaceNode(concept: ConceptReference?): INode {`
`86`	`86`	`branch.writeTransaction.setConcept(nodeId, concept)`
`87`	`87`	`return this`
`88`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -317,10 +317,6 @@ data class InMemoryNode(val model: InMemoryModel, val nodeId: Long) : INode, INo`
`317`	`317`	`throw UnsupportedOperationException("read-only")`
`318`	`318`	`}`
`319`	`319`
`320`		`- override fun replaceNode(concept: ConceptReference): INode {`
`321`		`- throw UnsupportedOperationException("read-only")`
`322`		`- }`
`323`		`-`
`324`	`320`	`override fun removeChild(child: INode) {`
`325`	`321`	`throw UnsupportedOperationException("read-only")`
`326`	`322`	`}`
Original file line number	Diff line number	Diff line change
`@@ -149,10 +149,6 @@ abstract class ModelQLNode(val client: ModelQLClient) : INode, ISupportsModelQL,`
`149`	`149`	`return addNewChild(resolveChildLinkOrFallback(role), index, concept)`
`150`	`150`	`}`
`151`	`151`
`152`		`- override fun replaceNode(concept: ConceptReference): INode {`
`153`		`- throw UnsupportedOperationException("ModelQL currently does not support replacing nodes.")`
`154`		`- }`
`155`		`-`
`156`	`152`	`override fun removeChild(child: INode) {`
`157`	`153`	`blockingQuery { child.reference.asMono().resolve().remove() }`
`158`	`154`	`}`