refactor(model-sync-lib): unified id property key by moving it to node data

Author: mhuster23

model-api/src/commonMain/kotlin/org/modelix/model/data/ModelData.kt

@@ -79,7 +79,11 @@ data class NodeData(
     val children: List<NodeData> = emptyList(),
     val properties: Map<String, String> = emptyMap(),
     val references: Map<String, String> = emptyMap()
-)
+) {
+    companion object {
+        const val idPropertyKey = "originalId"
+    }
+}
 
 fun NodeData.uid(model: ModelData): String {
     return (model.id ?: throw IllegalArgumentException("Model has no ID")) +

model-sync-lib/src/main/kotlin/org/modelix/model/sync/ModelExporter.kt

@@ -10,9 +10,6 @@ import org.modelix.model.data.associateWithNotNull
 import java.io.File
 
 class ModelExporter(private val branch: IBranch) {
-    companion object {
-        const val idRole = "originalId"
-    }
 
     fun export(outputFile: File) {
         lateinit var modelData: ModelData
@@ -28,14 +25,15 @@ class ModelExporter(private val branch: IBranch) {
 }
 
 fun INode.asExported() : NodeData {
+    val idKey = NodeData.idPropertyKey
     return NodeData(
-        id = getPropertyValue(ModelExporter.idRole) ?: reference.serialize(),
+        id = getPropertyValue(idKey) ?: reference.serialize(),
         concept = concept?.getUID(),
         role = roleInParent,
-        properties = getPropertyRoles().associateWithNotNull { getPropertyValue(it) }.filterKeys { it != ModelExporter.idRole },
+        properties = getPropertyRoles().associateWithNotNull { getPropertyValue(it) }.filterKeys { it != idKey },
         references = getReferenceRoles().associateWithNotNull {
             getReferenceTarget(it)?.let { node ->
-                node.getPropertyValue(ModelExporter.idRole) ?: node.reference.serialize()
+                node.getPropertyValue(idKey) ?: node.reference.serialize()
             }
         },
         children = allChildren.map { it.asExported() }

model-sync-lib/src/main/kotlin/org/modelix/model/sync/ModelImporter.kt

@@ -6,10 +6,6 @@ import org.modelix.model.data.NodeData
 
 class ModelImporter(private val branch: IBranch) {
 
-    companion object {
-        const val idRole = "originalId"
-    }
-
     private lateinit var originalIdToRef: MutableMap<String, INodeReference>
 
     fun import(data: ModelData) {
@@ -63,7 +59,7 @@ class ModelImporter(private val branch: IBranch) {
         toBeAdded.forEach {
             val index = nodeData.children.indexOf(it)
             val createdNode = node.addNewChild(it.role, index, it.concept?.let { s -> ConceptReference(s) })
-            createdNode.setPropertyValue(idRole, it.properties[idRole] ?: it.id)
+            createdNode.setPropertyValue(NodeData.idPropertyKey, it.originalId())
         }
         toBeRemoved.forEach { node.removeChild(it) }
             syncChildOrder(node, nodeData)
@@ -84,11 +80,11 @@ class ModelImporter(private val branch: IBranch) {
     }
 
     private fun INode.originalId(): String? {
-        return this.getPropertyValue(idRole)
+        return this.getPropertyValue(NodeData.idPropertyKey)
     }
 
     private fun NodeData.originalId(): String? {
-        return properties[idRole] ?: id
+        return properties[NodeData.idPropertyKey] ?: id
     }
 
 }

model-sync-lib/src/test/kotlin/org/modelix/model/sync/ModelImporterTest.kt

@@ -9,6 +9,7 @@ import org.modelix.model.api.PBranch
 import org.modelix.model.api.getRootNode
 import org.modelix.model.client.IdGenerator
 import org.modelix.model.data.ModelData
+import org.modelix.model.data.NodeData
 import org.modelix.model.data.asData
 import org.modelix.model.lazy.CLTree
 import org.modelix.model.lazy.ObjectStoreCache
@@ -48,8 +49,8 @@ class ModelImporterTest {
             val expectedNode = newModel.root.children[0]
             val expectedProperties = expectedNode.properties
             val actualProperties = branch.getRootNode().allChildren.first().asData().properties
-            assertEquals(expectedProperties, actualProperties.filterKeys { it != ModelImporter.idRole })
-            assertEquals(expectedNode.id, actualProperties[ModelImporter.idRole])
+            assertEquals(expectedProperties, actualProperties.filterKeys { it != NodeData.idPropertyKey })
+            assertEquals(expectedNode.id, actualProperties[NodeData.idPropertyKey])
         }
     }
 
@@ -70,8 +71,8 @@ class ModelImporterTest {
         branch.runRead {
             val index = 2
             val node = branch.getRootNode().allChildren.toList()[index]
-            val specifiedOrder = newModel.root.children[index].children.map { it.properties[ModelImporter.idRole] ?: it.id }
-            val actualOrder = node.allChildren.map { it.getPropertyValue(ModelImporter.idRole) }
+            val specifiedOrder = newModel.root.children[index].children.map { it.properties[NodeData.idPropertyKey] ?: it.id }
+            val actualOrder = node.allChildren.map { it.getPropertyValue(NodeData.idPropertyKey) }
             assertEquals(specifiedOrder, actualOrder)
         }
     }