Various fixes to tag parsing logic for legacy providers. (#322)

Author: Joshlha

src/main/kotlin/io/github/inductiveautomation/kindling/tagconfig/ProviderStatisticsPanel.kt

@@ -13,11 +13,14 @@ import io.github.inductiveautomation.kindling.utils.PopupMenuCustomizer
 import io.github.inductiveautomation.kindling.utils.ReifiedJXTable
 import io.github.inductiveautomation.kindling.utils.ReifiedListTableModel
 import io.github.inductiveautomation.kindling.utils.ReifiedTableModel
+import io.github.inductiveautomation.kindling.utils.jFrame
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
 import net.miginfocom.swing.MigLayout
+import javax.swing.JButton
 import javax.swing.JLabel
+import javax.swing.JList
 import javax.swing.JPanel
 import javax.swing.JPopupMenu
 import javax.swing.table.AbstractTableModel
@@ -55,6 +58,11 @@ class ProviderStatisticsPanel :
                 }
 
                 loading = false
+
+                if (newProvider.providerStatistics.missingUdtDefinition.value.isEmpty()) {
+                    missingUdtsLabel.isVisible = false
+                    missingUdtsButton.isVisible = false
+                }
             }
         }
 
@@ -77,6 +85,12 @@ class ProviderStatisticsPanel :
         putClientProperty("FlatLaf.styleClass", "h3")
     }
 
+    private val missingUdtsLabel = JLabel("⚠ Some UDT Definitions are missing.").apply {
+        putClientProperty("FlatLaf.styleClass", "h3")
+    }
+
+    private val missingUdtsButton = JButton("Click to view")
+
     private var loading: Boolean = false
         set(value) {
             field = value
@@ -88,11 +102,21 @@ class ProviderStatisticsPanel :
                 it.isVisible = !value
             }
 
+            val showMissingUdts =
+                provider?.providerStatistics?.missingUdtDefinition?.value?.isNotEmpty() == true || !value
+
+            missingUdtsLabel.isVisible = showMissingUdts
+            missingUdtsButton.isVisible = showMissingUdts
+
             throbber.isVisible = value
         }
 
     init {
         add(throbber, "push, grow, span")
+
+        add(missingUdtsLabel)
+        add(missingUdtsButton, "wrap")
+
         add(generalStatsLabel, "growx, span")
         add(generalStatsScrollPane, "growx, span, h 250!")
 
@@ -103,6 +127,14 @@ class ProviderStatisticsPanel :
 
         // Show nothing on startup
         components.forEach { it.isVisible = false }
+
+        missingUdtsButton.addActionListener {
+            jFrame("Missing UDT Definitions", 300, 600) {
+                contentPane.add(
+                    FlatScrollPane(JList<String>(provider!!.providerStatistics.missingUdtDefinition.value.toTypedArray())),
+                )
+            }
+        }
     }
 
     override fun customizePopupMenu(menu: JPopupMenu) = menu.removeAll()
@@ -125,7 +157,7 @@ class MappedStatModel(
             it.key
         }
 
-        val statValue by column("Value") {
+        val statValue by column("Count") {
             it.value
         }
     }

src/main/kotlin/io/github/inductiveautomation/kindling/tagconfig/model/LegacyTagProvider.kt

@@ -94,6 +94,16 @@ class LegacyTagProvider(
         if (orphanedParentNode.config.tags.isNotEmpty()) {
             providerNode.addChildTag(orphanedParentNode)
         }
+
+        // Make the missing definitions list distinct
+        val seen = HashSet<String>()
+        val iterator = providerStatistics.missingUdtDefinition.value.iterator()
+        while (iterator.hasNext()) {
+            val element = iterator.next()
+            if (!seen.add(element)) {
+                iterator.remove()
+            }
+        }
     }
 
     // Effectively just the TagConfig table in memory.
@@ -210,12 +220,11 @@ class LegacyTagProvider(
         }
     }
 
-    override val Node.parentType: Node?
+    override val Node.parentType: IdbNode?
         get() {
-            require((statistics.isUdtDefinition || statistics.isUdtInstance) && config.typeId != null) {
-                "Not a top level UDT Instance or type! $this"
-            }
-            return udtDefinitions[config.typeId]
+            val typeId = config.typeId ?: return null
+            // Some typeIds start with _types_, or even [ProviderName]_types_. It's unclear why.
+            return udtDefinitions[typeId.substringAfter("_types_/")]
         }
 
     override fun Node.copyChildrenFrom(other: Node) {
@@ -224,14 +233,21 @@ class LegacyTagProvider(
 
         val thisNodeGroup = checkNotNull(nodeGroups[id]) { "This should never happen" }
 
-        val otherDefinition = checkNotNull(other.parentType as IdbNode?) { "Parent type is null!" }
+        val otherDefinition = other.parentType ?: run {
+            other.config.typeId?.let {
+                providerStatistics.missingUdtDefinition.value.add(it)
+            }
+            return
+        }
         val inheritedNodeGroup = checkNotNull(nodeGroups[otherDefinition.id]) { "This should never happen" }
 
         if (!otherDefinition.resolved) {
             otherDefinition.resolveInheritance()
         }
 
-        check(other.statistics.isUdtInstance) { "Not a UDT Instance!" }
+        check(other.statistics.isUdtInstance || other.statistics.isUdtDefinition) {
+            "Not a UDT Structure!"
+        }
 
         inheritedNodeGroup.drop(1).forEach { childNode ->
             val newId = childNode.id.replace(otherDefinition.id, other.id)

src/main/kotlin/io/github/inductiveautomation/kindling/tagconfig/model/ProviderStatistics.kt

@@ -13,7 +13,9 @@ class ProviderStatistics private constructor(
 ) : Map<String, ProviderStatistics.ProviderStatistic<*>> by statsMap {
     constructor() : this(mutableMapOf())
 
-    val orphanedTags = ListStatistic("orphanedTags", fun(_: ListStatistic<Node>, _: Node) = Unit)
+    val orphanedTags = ListStatistic<Node>("orphanedTags")
+
+    val missingUdtDefinition = ListStatistic<String>("missingUdtDefinitions")
 
     val totalAtomicTags by quantitativeStatistic {
         if (it.statistics.isAtomicTag) value++
@@ -77,7 +79,7 @@ class ProviderStatistics private constructor(
 
     companion object {
         private const val DEFAULT_DATA_TYPE = "Int4"
-        private const val DEFAULT_VALUE_SOURCE = "memory"
+        private const val DEFAULT_VALUE_SOURCE = "MEMORY"
     }
 
     sealed class ProviderStatistic<T>(val name: String) {
@@ -143,7 +145,7 @@ class ProviderStatistics private constructor(
 
     class ListStatistic<T>(
         name: String,
-        private val processNode: ListStatistic<T>.(node: Node) -> Unit,
+        private val processNode: ListStatistic<T>.(node: Node) -> Unit = {},
     ) : ProviderStatistic<MutableList<T>>(name) {
         override val value: MutableList<T> = mutableListOf()
         override fun processNode(node: Node) = processNode(this, node)

src/main/kotlin/io/github/inductiveautomation/kindling/tagconfig/model/TagProvider.kt

@@ -340,10 +340,7 @@ class TagProvider private constructor(
 
                         lastSeen = folderConfig
                     } else {
-                        val tags: List<Node> = currentPath.inputStream().use {
-                            Json.decodeFromStream(it)
-                        }
-
+                        val tags: List<Node> = currentPath.inputStream().use(Json::decodeFromStream)
                         lastSeen.addChildTags(tags)
                     }
                 }