Merge branch 'master' into live-insight

Author: BFergerson

src/main/kotlin/spp/protocol/artifact/ArtifactQualifiedName.kt

@@ -30,16 +30,14 @@ data class ArtifactQualifiedName(
     val identifier: String,
     val commitId: String? = null,
     val type: ArtifactType,
-    val lineNumber: Int? = null,
-    val operationName: String? = null //todo: only method artifacts need
+    val lineNumber: Int? = null
 ) {
 
     constructor(json: JsonObject) : this(
         json.getString("identifier"),
         json.getString("commitId"),
         ArtifactType.valueOf(json.getString("type")),
-        json.getInteger("lineNumber"),
-        json.getString("operationName")
+        json.getInteger("lineNumber")
     )
 
     fun toJson(): JsonObject {
@@ -48,7 +46,6 @@ data class ArtifactQualifiedName(
         json.put("commitId", commitId)
         json.put("type", type.name)
         json.put("lineNumber", lineNumber)
-        json.put("operationName", operationName)
         return json
     }
 

src/main/kotlin/spp/protocol/artifact/OrderType.kt

@@ -16,19 +16,13 @@
  */
 package spp.protocol.artifact.log
 
-import spp.protocol.artifact.OrderType
-
 /**
- * todo: description.
+ * Represents a known order type for sorting logs.
  *
  * @since 0.2.0
  * @author [Brandon Fergerson](mailto:bfergerson@apache.org)
  */
-enum class LogOrderType : OrderType {
+enum class LogOrderType {
     NEWEST_LOGS,
-    OLDEST_LOGS;
-
-    //todo: not need to replace _LOGS?
-    val id = name.replace("_LOGS", "").toLowerCase()
-    override val description = id.toLowerCase().capitalize()
+    OLDEST_LOGS
 }

src/main/kotlin/spp/protocol/artifact/log/LogOrderType.kt

@@ -16,21 +16,14 @@
  */
 package spp.protocol.artifact.trace
 
-import spp.protocol.artifact.OrderType
-
 /**
- * todo: description.
+ * Represents a known order type for sorting traces.
  *
  * @since 0.1.0
  * @author [Brandon Fergerson](mailto:bfergerson@apache.org)
  */
-enum class TraceOrderType : OrderType {
+enum class TraceOrderType {
     LATEST_TRACES,
     SLOWEST_TRACES,
-    FAILED_TRACES;
-
-    //todo: not need to replace _TRACES?
-    val id = name.replace("_TRACES", "").toLowerCase()
-    override val description = id.toLowerCase().capitalize()
-    val fullDescription = name.toLowerCase().split("_").joinToString(" ") { it.capitalize() }
+    FAILED_TRACES
 }

src/main/kotlin/spp/protocol/artifact/trace/TraceOrderType.kt

@@ -117,19 +117,17 @@ data class LiveBreakpoint(
     /**
      * Specify explicitly so Kotlin doesn't override.
      */
+    @Suppress("RedundantOverride")
     override fun equals(other: Any?): Boolean = super.equals(other)
 
     /**
      * Specify explicitly so Kotlin doesn't override.
      */
+    @Suppress("RedundantOverride")
     override fun hashCode(): Int = super.hashCode()
 
     fun addHitListener(vertx: Vertx, listener: (LiveBreakpointHit) -> Unit) {
-        val instrumentId = id
-        if (instrumentId == null) {
-            error("Instrument must be applied before adding a hit listener")
-        }
-
+        val instrumentId = id ?: error("Instrument must be applied before adding a hit listener")
         vertx.eventBus().consumer<JsonObject>(toLiveInstrumentSubscription(instrumentId)).handler {
             val event = LiveInstrumentEvent.fromJson(it.body())
             if (event.eventType == LiveInstrumentEventType.BREAKPOINT_HIT) {

src/main/kotlin/spp/protocol/instrument/LiveBreakpoint.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(location: 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/LiveLocation.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(location: LiveLocation): Boolean {
+        if (location !is LiveSourceLocation) return false
+        if (source != location.source) return false
+        if (line != location.line && line != -1 && location.line != -1) return false //-1 is wildcard
+        if (service != null && (location.service == null || !service.isSameLocation(location.service!!))) return false
+        if (probeId != null && probeId != location.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/instrument/location/LiveSourceLocation.kt

@@ -84,9 +84,9 @@ enum class RolePermission(val manager: Boolean, val commandType: CommandType) {
     BREAKPOINT_VARIABLE_CONTROL(false, LIVE_INSTRUMENT),
 
     //views
-    ADD_LIVE_VIEW_SUBSCRIPTION(false, LIVE_VIEW),
-    REMOVE_LIVE_VIEW_SUBSCRIPTION(false, LIVE_VIEW),
-    GET_LIVE_VIEW_SUBSCRIPTIONS(false, LIVE_VIEW),
+    ADD_LIVE_VIEW(false, LIVE_VIEW),
+    REMOVE_LIVE_VIEW(false, LIVE_VIEW),
+    GET_LIVE_VIEWS(false, LIVE_VIEW),
 
 //    VIEW_OVERVIEW(false, LIVE_VIEW),
     VIEW_ACTIVITY(false, LIVE_VIEW),
@@ -95,7 +95,20 @@ enum class RolePermission(val manager: Boolean, val commandType: CommandType) {
     SHOW_QUICK_STATS(false, LIVE_VIEW);
 
     companion object {
-        fun fromString(s: String): RolePermission? {
+        fun fromString(s: String): RolePermission {
+            return fromStringOrNull(s) ?: RolePermission.valueOf(s)
+        }
+
+        fun fromStringOrNull(s: String): RolePermission? {
+            //todo: remove v0.8.0+
+            if (s == "ADD_LIVE_VIEW_SUBSCRIPTION") {
+                return ADD_LIVE_VIEW
+            } else if (s == "REMOVE_LIVE_VIEW_SUBSCRIPTION") {
+                return REMOVE_LIVE_VIEW
+            } else if (s == "GET_LIVE_VIEW_SUBSCRIPTIONS") {
+                return GET_LIVE_VIEWS
+            }
+
             val exactMatch = values().firstOrNull { it.name.equals(s, true) }
             if (exactMatch != null) {
                 return exactMatch

src/main/kotlin/spp/protocol/platform/auth/RolePermission.kt

@@ -33,8 +33,7 @@ data class SelfInfo(
     constructor(json: JsonObject) : this(
         developer = Developer(json.getJsonObject("developer")),
         roles = json.getJsonArray("roles").map { DeveloperRole.fromString(it.toString()) },
-        permissions = json.getJsonArray("permissions")
-            .map { RolePermission.fromString(it.toString()) ?: error("Invalid permission: $it") },
+        permissions = json.getJsonArray("permissions").map { RolePermission.fromString(it.toString()) },
         access = json.getJsonArray("access").map { AccessPermission(JsonObject.mapFrom(it)) }
     )
 

src/main/kotlin/spp/protocol/platform/developer/SelfInfo.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(location: LiveLocation): Boolean {
+        val other = location.service ?: return false
         if (name != other.name) return false
         if (group != null && group != other.group) return false
         if (shortName != null && shortName != other.shortName) return false