refactor: replace Service with LiveLocation in LiveView

necessary for sourceplusplus/sourceplusplus#771

Author: BFergerson

src/main/kotlin/spp/protocol/instrument/location/LiveLocation.kt

@@ -16,6 +16,7 @@
  */
 package spp.protocol.instrument.location
 
+import io.vertx.core.json.JsonObject
 import spp.protocol.platform.general.Service
 
 /**
@@ -24,4 +25,17 @@ import spp.protocol.platform.general.Service
 interface LiveLocation {
  val service: Service?
  val probeId: String?
+
+ fun isSameLocation(other: LiveLocation): Boolean
+ fun toJson(): JsonObject
+
+ companion object {
+ fun fromJson(json: JsonObject): LiveLocation {
+ return if (json.containsKey("source")) {
+ LiveSourceLocation(json)
+ } else {
+ Service(json)
+ }
+ }
+ }
 }

src/main/kotlin/spp/protocol/instrument/location/LiveSourceLocation.kt

@@ -36,6 +36,10 @@ data class LiveSourceLocation @JvmOverloads constructor(
  val scope: LocationScope = LocationScope.LINE
 ) : LiveLocation, Comparable<LiveSourceLocation> {
 
+ init {
+ require(source.isNotBlank()) { "source is required" }
+ }
+
  constructor(json: JsonObject) : this(
  source = json.getString("source"),
  line = json.getInteger("line") ?: -1,
@@ -51,7 +55,16 @@ data class LiveSourceLocation @JvmOverloads constructor(
  scope = json.getString("scope")?.let { LocationScope.valueOf(it) } ?: LocationScope.LINE
  )
 
- fun toJson(): JsonObject {
+ override fun isSameLocation(other: LiveLocation): Boolean {
+ if (other !is LiveSourceLocation) return false
+ if (source != other.source) return false
+ if (line != other.line && line != -1 && other.line != -1) return false //-1 is wildcard
+ if (service != null && (other.service == null || !service.isSameLocation(other.service!!))) return false
+ if (probeId != null && probeId != other.probeId) return false
+ return true
+ }
+
+ override fun toJson(): JsonObject {
  val json = JsonObject()
  json.put("source", source)
  json.put("line", line)
@@ -70,7 +83,7 @@ data class LiveSourceLocation @JvmOverloads constructor(
  fun isSameLocation(other: LiveSourceLocation): Boolean {
  if (source != other.source) return false
  if (line != other.line && line != -1 && other.line != -1) return false //-1 is wildcard
- if (service != null && (other.service == null || !service.isSameService(other.service))) return false
+ if (service != null && (other.service == null || !service.isSameLocation(other.service))) return false
  if (probeId != null && probeId != other.probeId) return false
  return true
  }

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

@@ -16,8 +16,11 @@
  */
 package spp.protocol.platform.general
 
+import com.fasterxml.jackson.annotation.JsonIgnore
 import io.vertx.codegen.annotations.DataObject
+import io.vertx.codegen.annotations.GenIgnore
 import io.vertx.core.json.JsonObject
+import spp.protocol.instrument.location.LiveLocation
 import spp.protocol.platform.general.util.IDManager
 
 /**
@@ -34,7 +37,16 @@ data class Service(
  val normal: Boolean = true,
  val environment: String? = null,
  val version: String? = null
-) {
+) : LiveLocation {
+
+ @GenIgnore
+ @get:JsonIgnore
+ @delegate:JsonIgnore
+ override val service: Service by lazy { this }
+
+ @GenIgnore
+ @get:JsonIgnore
+ override val probeId: String? = null
 
  val id by lazy {
  if (version != null) {
@@ -54,7 +66,7 @@ data class Service(
  json.getString("version")
  )
 
- fun toJson(): JsonObject {
+ override fun toJson(): JsonObject {
  val json = JsonObject()
  json.put("name", name)
  json.put("group", group)
@@ -77,7 +89,8 @@ data class Service(
  /**
  * Ensures all non-null fields are equal.
  */
- fun isSameService(other: Service): Boolean {
+ override fun isSameLocation(other: LiveLocation): Boolean {
+ if (other !is Service) return false //todo: support other types
  if (name != other.name) return false
  if (group != null && group != other.group) return false
  if (shortName != null && shortName != other.shortName) return false

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

@@ -20,7 +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.platform.general.Service
+import spp.protocol.instrument.location.LiveLocation
 import spp.protocol.service.SourceServices.Subscribe.toLiveViewSubscription
 
 /**
@@ -33,25 +33,22 @@ import spp.protocol.service.SourceServices.Subscribe.toLiveViewSubscription
 data class LiveView(
  val entityIds: MutableSet<String>,
  val viewConfig: LiveViewConfig,
- val service: Service? = null,
- val serviceInstance: String? = null,
+ val location: LiveLocation? = null,
  val subscriptionId: String? = null
 ) {
  constructor(json: JsonObject) : this(
  subscriptionId = json.getString("subscriptionId"),
  entityIds = json.getJsonArray("entityIds").map { it.toString() }.toMutableSet(),
  viewConfig = LiveViewConfig(json.getJsonObject("viewConfig")),
- service = json.getJsonObject("service")?.let { Service(it) },
- serviceInstance = json.getString("serviceInstance")
+ location = json.getJsonObject("location")?.let { LiveLocation.fromJson(it) },
  )
 
  fun toJson(): JsonObject {
  val json = JsonObject()
- json.put("subscriptionId", subscriptionId)
  json.put("entityIds", JsonArray().apply { entityIds.forEach { add(it) } })
  json.put("viewConfig", viewConfig.toJson())
- service?.let { json.put("service", it.toJson()) }
- json.put("serviceInstance", serviceInstance)
+ json.put("location", location?.toJson())
+ json.put("subscriptionId", subscriptionId)
  return json
  }
 
@@ -73,8 +70,7 @@ data class LiveView(
  if (subscriptionId != null) append("subscriptionId=$subscriptionId, ")
  append("entityIds=$entityIds, ")
  append("viewConfig=$viewConfig")
- if (service != null) append(", service=$service")
- if (serviceInstance != null) append(", serviceInstance=$serviceInstance")
+ if (location != null) append(", location=$location")
  append(")")
  }
  }