feat(mps-sync-plugin): show synchronization progress

Author: slisson

bulk-model-sync-lib/src/commonMain/kotlin/org/modelix/model/sync/bulk/ModelSynchronizer.kt

@@ -42,14 +42,26 @@ class ModelSynchronizer(
 ) {
     private val nodesToRemove: MutableSet<IWritableNode> = HashSet()
     private val pendingReferences: MutableList<PendingReference> = ArrayList()
+    private val syncStack = ArrayList<IReadableNode>()
+
+    fun getCurrentSyncStack(): List<IReadableNode> = syncStack.toList()
+
+    private inline fun <R> withPushSyncStack(element: IReadableNode, body: () -> R): R {
+        syncStack.add(element)
+        try {
+            return body()
+        } finally {
+            syncStack.removeLast()
+        }
+    }
 
     private fun <R> runSafe(body: () -> R): Result<R> {
         return if (onException == null) {
             Result.success(body())
         } else {
             runCatching(body)
-                .onFailure { LOG.error(it) { "Ignoring exception during synchronization" } }
                 .onFailure { onException(it) }
+                .onFailure { LOG.error(it) { "Ignoring exception during synchronization" } }
         }
     }
 
@@ -81,7 +93,11 @@ class ModelSynchronizer(
         LOG.debug { "Synchronization finished." }
     }
 
-    private fun synchronizeNode(sourceNode: IReadableNode, targetNode: IWritableNode, forceSyncDescendants: Boolean) {
+    private fun synchronizeNode(
+        sourceNode: IReadableNode,
+        targetNode: IWritableNode,
+        forceSyncDescendants: Boolean,
+    ): Unit = withPushSyncStack(sourceNode) {
         nodeAssociation.associate(sourceNode, targetNode)
         if (forceSyncDescendants || filter.needsSynchronization(sourceNode)) {
             LOG.trace { "Synchronizing changed node. sourceNode = $sourceNode" }

mps-sync-plugin3/src/main/kotlin/org/modelix/mps/sync3/BindingWorker.kt

@@ -17,6 +17,7 @@ import org.modelix.model.api.IReadableNode
 import org.modelix.model.api.IWritableNode
 import org.modelix.model.api.NodeReference
 import org.modelix.model.api.TreePointer
+import org.modelix.model.api.getName
 import org.modelix.model.api.getOriginalReference
 import org.modelix.model.api.getRootNode
 import org.modelix.model.client2.runWrite
@@ -52,6 +53,8 @@ class BindingWorker(
     private var syncJob: Job? = null
     private var syncToServerTask: ValidatingJob? = null
     private var invalidatingListener: MyInvalidatingListener? = null
+    private var activeSynchronizer: ModelSynchronizer? = null
+    private var previousSyncStack: List<IReadableNode> = emptyList()
 
     private val repository: SRepository get() = mpsProject.repository
     private suspend fun client() = serverConnection.getClient()
@@ -75,6 +78,28 @@ class BindingWorker(
         invalidatingListener = null
     }
 
+    private fun ModelSynchronizer.executeSync() {
+        try {
+            activeSynchronizer = this
+            synchronize()
+        } finally {
+            activeSynchronizer = null
+            previousSyncStack = emptyList()
+        }
+    }
+
+    fun getSyncProgress(): String? {
+        val synchronizer = activeSynchronizer ?: return null
+        val current = synchronizer.getCurrentSyncStack()
+        val previous = previousSyncStack
+        previousSyncStack = current
+        val firstChange = current.zip(previous).indexOfFirst { it.first != it.second }
+        val busyPath = current.take(firstChange + 1)
+        return busyPath.joinToString(" > ") {
+            it.getName() ?: it.tryGetConcept()?.getShortName() ?: it.getNodeReference().serialize()
+        }
+    }
+
     private suspend fun checkInSync(): String? {
         check(activated.get()) { "Binding is deactivated" }
         val version = lastSyncedVersion.flush()?.getOrThrow()
@@ -250,7 +275,7 @@ class BindingWorker(
                     sourceMask = MPSProjectSyncMask(listOf(mpsProject), false),
                     targetMask = MPSProjectSyncMask(listOf(mpsProject), true),
                     onException = { getMPSListener().synchronizationErrorHappened() },
-                ).synchronize()
+                ).executeSync()
             }
         }
     }
@@ -310,7 +335,7 @@ class BindingWorker(
                             nodeAssociation = nodeAssociation,
                             sourceMask = MPSProjectSyncMask(listOf(mpsProject), true),
                             targetMask = MPSProjectSyncMask(listOf(mpsProject), false),
-                        ).synchronize()
+                        ).executeSync()
                     }
                 }
             }

mps-sync-plugin3/src/main/kotlin/org/modelix/mps/sync3/IModelSyncService.kt

@@ -75,4 +75,6 @@ interface IBinding : Closeable {
     suspend fun flushIfEnabled(): IVersion?
     fun forceSync(push: Boolean)
     fun getCurrentVersion(): IVersion?
+
+    fun getSyncProgress(): String?
 }

mps-sync-plugin3/src/main/kotlin/org/modelix/mps/sync3/ModelSyncService.kt

@@ -345,6 +345,10 @@ class ModelSyncService(val project: Project) :
             return workers[id]?.getCurrentVersion()
         }
 
+        override fun getSyncProgress(): String? {
+            return workers[id]?.getSyncProgress()
+        }
+
         private fun getService(): ModelSyncService = this@ModelSyncService
 
         override fun equals(other: Any?): Boolean {

mps-sync-plugin3/src/main/kotlin/org/modelix/mps/sync3/ui/ModelSyncStatusWidget.kt

@@ -242,7 +242,9 @@ class ModelSyncStatusWidget(val project: Project) : CustomStatusBarWidget, Statu
                             return "Click to log in"
                         }
                     }
-                    result = binding.getCurrentVersion()?.getContentHash()?.let { "Synchronized: ${it.take(5)}" } ?: result
+                    result = binding.getSyncProgress()?.let { "Synchronizing: $it" }
+                        ?: binding.getCurrentVersion()?.getContentHash()?.let { "Synchronized: ${it.take(5)}" }
+                        ?: result
                 }
             }
         }