Refactor LiveView implementation and Service object structure

Author: BFergerson

src/main/kotlin/spp/protocol/platform/general/Service.kt

@@ -27,15 +27,24 @@ import spp.protocol.platform.general.util.IDManager
  */
 @DataObject
 data class Service(
-    val id: String,
     val name: String,
     val group: String = "",
     val shortName: String? = null,
     val layers: List<String> = emptyList(),
-    val normal: Boolean = true
+    val normal: Boolean = true,
+    val environment: String? = null,
+    val commitId: String? = null
 ) {
+
+    val id by lazy {
+        if (commitId != null) {
+            IDManager.ServiceID.buildId("$name|$environment|$commitId", normal)
+        } else {
+            IDManager.ServiceID.buildId(name, normal)
+        }
+    }
+
     constructor(json: JsonObject) : this(
-        json.getString("id"),
         json.getString("name"),
         json.getString("group"),
         json.getString("shortName"),
@@ -45,7 +54,6 @@ data class Service(
 
     fun toJson(): JsonObject {
         val json = JsonObject()
-        json.put("id", id)
         json.put("name", name)
         json.put("group", group)
         json.put("shortName", shortName)
@@ -54,23 +62,59 @@ data class Service(
         return json
     }
 
+    fun withEnvironment(environment: String?): Service {
+        return copy(environment = environment)
+    }
+
+    fun withCommitId(commitId: String?): Service {
+        return copy(commitId = commitId)
+    }
+
+    /**
+     * Ensures all non-null fields are equal.
+     */
+    fun isSameLocation(other: Service): Boolean {
+        if (name != other.name) return false
+        if (group != other.group) return false
+        if (shortName != null && shortName != other.shortName) return false
+        if (layers != other.layers) return false
+        if (normal != other.normal) return false
+        if (environment != null && environment != other.environment) return false
+        if (commitId != null && commitId != other.commitId) return false
+        return true
+    }
+
+    fun withName(name: String?): Service {
+        if (name == null) return this
+        if (name.contains("|")) {
+            val parts = name.split("|")
+            return withName(parts[0])
+                .withEnvironment(parts[1])
+                .withCommitId(parts[2])
+        }
+        return copy(name = name)
+    }
+
     companion object {
+
+        @JvmStatic
         fun fromId(id: String): Service {
             val definition = IDManager.ServiceID.analysisId(id)
-            return Service(
-                id = id,
-                name = definition.name,
-                normal = definition.isReal
-            )
+            return fromName(definition.name)
         }
 
+        @JvmStatic
         fun fromName(name: String): Service {
-            return Service(
-                id = IDManager.ServiceID.buildId(name, true),
-                name = name
-            )
+            if (name.contains("|")) {
+                val parts = name.split("|")
+                return fromName(parts[0])
+                    .withEnvironment(parts[1])
+                    .withCommitId(parts[2])
+            }
+            return Service(name = name)
         }
 
+        @JvmStatic
         fun fromNameIfPresent(name: String?): Service? {
             return if (name != null) {
                 fromName(name)

src/main/kotlin/spp/protocol/view/LiveView.kt

@@ -20,8 +20,7 @@ import io.vertx.codegen.annotations.DataObject
 import io.vertx.core.Vertx
 import io.vertx.core.json.JsonArray
 import io.vertx.core.json.JsonObject
-import spp.protocol.artifact.ArtifactQualifiedName
-import spp.protocol.instrument.location.LiveSourceLocation
+import spp.protocol.platform.general.Service
 import spp.protocol.service.SourceServices.Subscribe.toLiveViewSubscription
 
 /**
@@ -32,27 +31,27 @@ import spp.protocol.service.SourceServices.Subscribe.toLiveViewSubscription
  */
 @DataObject
 data class LiveView(
-    val subscriptionId: String? = null, //todo: actual bottom
     val entityIds: MutableSet<String>,
-    val artifactQualifiedName: ArtifactQualifiedName? = null, //todo: remove, use artifactLocation
-    val artifactLocation: LiveSourceLocation? = null, //todo: bottom?
-    val viewConfig: LiveViewConfig
+    val viewConfig: LiveViewConfig,
+    val service: Service? = null,
+    val serviceInstance: String? = null,
+    val subscriptionId: String? = null
 ) {
     constructor(json: JsonObject) : this(
         subscriptionId = json.getString("subscriptionId"),
         entityIds = json.getJsonArray("entityIds").map { it.toString() }.toMutableSet(),
-        artifactQualifiedName = json.getJsonObject("artifactQualifiedName")?.let { ArtifactQualifiedName(it) },
-        artifactLocation = json.getJsonObject("artifactLocation")?.let { LiveSourceLocation(it) },
-        viewConfig = LiveViewConfig(json.getJsonObject("viewConfig"))
+        viewConfig = LiveViewConfig(json.getJsonObject("viewConfig")),
+        service = json.getJsonObject("service")?.let { Service(it) },
+        serviceInstance = json.getString("serviceInstance")
     )
 
     fun toJson(): JsonObject {
         val json = JsonObject()
         json.put("subscriptionId", subscriptionId)
         json.put("entityIds", JsonArray().apply { entityIds.forEach { add(it) } })
-        artifactQualifiedName?.let { json.put("artifactQualifiedName", it.toJson()) }
-        artifactLocation?.let { json.put("artifactLocation", it.toJson()) }
         json.put("viewConfig", viewConfig.toJson())
+        service?.let { json.put("service", it.toJson()) }
+        json.put("serviceInstance", serviceInstance)
         return json
     }
 
@@ -73,9 +72,9 @@ data class LiveView(
             append("LiveView(")
             if (subscriptionId != null) append("subscriptionId=$subscriptionId, ")
             append("entityIds=$entityIds, ")
-            if (artifactQualifiedName != null) append("artifactQualifiedName=$artifactQualifiedName, ")
-            if (artifactLocation != null) append("artifactLocation=$artifactLocation, ")
             append("viewConfig=$viewConfig")
+            if (service != null) append(", service=$service")
+            if (serviceInstance != null) append(", serviceInstance=$serviceInstance")
             append(")")
         }
     }

src/main/kotlin/spp/protocol/view/LiveViewEvent.kt

@@ -18,7 +18,6 @@ package spp.protocol.view
 
 import io.vertx.codegen.annotations.DataObject
 import io.vertx.core.json.JsonObject
-import spp.protocol.artifact.ArtifactQualifiedName
 
 /**
  * An event that occurred in a [LiveView].
@@ -30,15 +29,13 @@ import spp.protocol.artifact.ArtifactQualifiedName
 data class LiveViewEvent(
     val subscriptionId: String,
     val entityId: String,
-    val artifactQualifiedName: ArtifactQualifiedName? = null,
     val timeBucket: String,
     val viewConfig: LiveViewConfig,
     val metricsData: String, //todo: type out
 ) {
     constructor(json: JsonObject) : this(
         json.getString("subscriptionId"),
         json.getString("entityId"),
-        json.getJsonObject("artifactQualifiedName")?.let { ArtifactQualifiedName(it) },
         json.getString("timeBucket"),
         LiveViewConfig(json.getJsonObject("viewConfig")),
         json.getString("metricsData")

src/test/kotlin/spp/protocol/view/LiveViewTest.kt

@@ -25,9 +25,9 @@ class LiveViewTest {
     @Test
     fun `test mutable entity ids`() {
         val sub = LiveView(
-            "id",
             mutableSetOf("entity-1"),
-            viewConfig = LiveViewConfig("name", listOf("metrics"))
+            viewConfig = LiveViewConfig("name", listOf("metrics")),
+            subscriptionId = "id"
         )
         val subJson = sub.toJson()
         assertEquals(JsonArray(listOf("entity-1")), subJson.getJsonArray("entityIds"))