refactor: migrate LiveSourceLocation.service to Service type

Author: BFergerson

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

@@ -0,0 +1,30 @@
+/*
+ * Source++, the continuous feedback platform for developers.
+ * Copyright (C) 2022-2023 CodeBrig, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package spp.protocol.instrument.location
+
+import spp.protocol.platform.general.Service
+
+/**
+ * Represents a location in a live application.
+ */
+interface LiveLocation {
+    val service: Service?
+    val serviceInstance: String?
+    val commitId: String?
+    val fileChecksum: String?
+    val probeId: String?
+}

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

@@ -18,10 +18,11 @@ package spp.protocol.instrument.location
 
 import io.vertx.codegen.annotations.DataObject
 import io.vertx.core.json.JsonObject
+import spp.protocol.platform.general.Service
 import spp.protocol.platform.status.InstanceConnection
 
 /**
- * todo: description.
+ * Represents a location in source code.
  *
  * @since 0.3.0
  * @author [Brandon Fergerson](mailto:bfergerson@apache.org)
@@ -30,23 +31,21 @@ import spp.protocol.platform.status.InstanceConnection
 data class LiveSourceLocation @JvmOverloads constructor(
     val source: String,
     val line: Int = -1,
-    val service: String? = null, //todo: can use Service
-    val serviceInstance: String? = null, //todo: fully impl
-    val commitId: String? = null, //todo: impl
-    val fileChecksum: String? = null, //todo: impl
-    //val language: ArtifactLanguage? = null, //todo: impl
-    val probeId: String? = null,
+    override val service: Service? = null,
+    override val serviceInstance: String? = null,
+    override val commitId: String? = null,
+    override val fileChecksum: String? = null, //todo: impl
+    override val probeId: String? = null, //todo: impl
     val scope: LocationScope = LocationScope.LINE
-) : Comparable<LiveSourceLocation> {
+) : LiveLocation, Comparable<LiveSourceLocation> {
 
     constructor(json: JsonObject) : this(
         source = json.getString("source"),
         line = json.getInteger("line") ?: -1,
-        service = json.getString("service"),
+        service = json.getJsonObject("service")?.let { Service(it) },
         serviceInstance = json.getString("serviceInstance"),
         commitId = json.getString("commitId"),
         fileChecksum = json.getString("fileChecksum"),
-        //language = json.getString("language")?.let { ArtifactLanguage.valueOf(it) }
         probeId = json.getString("probeId"),
         scope = json.getString("scope")?.let { LocationScope.valueOf(it) } ?: LocationScope.LINE
     )
@@ -55,11 +54,10 @@ data class LiveSourceLocation @JvmOverloads constructor(
         val json = JsonObject()
         json.put("source", source)
         json.put("line", line)
-        json.put("service", service)
+        json.put("service", service?.toJson())
         json.put("serviceInstance", serviceInstance)
         json.put("commitId", commitId)
         json.put("fileChecksum", fileChecksum)
-        //json.put("language", language?.name)
         json.put("probeId", probeId)
         json.put("scope", scope.name)
         return json
@@ -78,13 +76,12 @@ data class LiveSourceLocation @JvmOverloads constructor(
         if (serviceInstance != other.serviceInstance) return false
         if (commitId != other.commitId) return false
         if (fileChecksum != other.fileChecksum) return false
-        //if (language != other.language) return false
         if (probeId != other.probeId) return false
         return true
     }
 
     fun isSameLocation(other: InstanceConnection): Boolean {
-        if (service != null && service != other.meta["service"]) return false
+        if (service != null && service.name != other.meta["service"]) return false
         if (serviceInstance != null && serviceInstance != other.meta["service_instance"]) return false
         if (commitId != null && commitId != other.meta["commit_id"]) return false
         if (probeId != null && probeId != other.instanceId) return false
@@ -100,7 +97,6 @@ data class LiveSourceLocation @JvmOverloads constructor(
             if (serviceInstance != null) append(", serviceInstance=$serviceInstance")
             if (commitId != null) append(", commitId=$commitId")
             if (fileChecksum != null) append(", fileChecksum=$fileChecksum")
-            //if (language != null) append(", language=$language")
             if (probeId != null) append(", probeId=$probeId")
             if (scope != LocationScope.LINE) append(", scope=$scope")
             append(")")

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

@@ -18,6 +18,7 @@ package spp.protocol.platform.general
 
 import io.vertx.codegen.annotations.DataObject
 import io.vertx.core.json.JsonObject
+import spp.protocol.platform.general.util.IDManager
 
 /**
  * Represents a service.
@@ -52,4 +53,30 @@ data class Service(
         json.put("normal", normal)
         return json
     }
+
+    companion object {
+        fun fromId(id: String): Service {
+            val definition = IDManager.ServiceID.analysisId(id)
+            return Service(
+                id = id,
+                name = definition.name,
+                normal = definition.isReal
+            )
+        }
+
+        fun fromName(name: String): Service {
+            return Service(
+                id = IDManager.ServiceID.buildId(name, true),
+                name = name
+            )
+        }
+
+        fun fromNameIfPresent(name: String?): Service? {
+            return if (name != null) {
+                fromName(name)
+            } else {
+                null
+            }
+        }
+    }
 }

src/main/kotlin/spp/protocol/platform/general/util/Const.kt

@@ -0,0 +1,52 @@
+/*
+ * Source++, the continuous feedback platform for developers.
+ * Copyright (C) 2022-2023 CodeBrig, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package spp.protocol.platform.general.util
+
+/**
+ * Code taken from https://github.com/apache/skywalking/blob/v9.5.0/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/Const.java.
+ */
+object Const {
+    const val NONE = 0
+    const val SERVICE_ID_CONNECTOR = "."
+    const val SERVICE_ID_PARSER_SPLIT = "\\."
+    const val ID_CONNECTOR = "_"
+    const val ID_PARSER_SPLIT = "\\_"
+    const val RELATION_ID_CONNECTOR = "-"
+    const val RELATION_ID_PARSER_SPLIT = "\\-"
+    const val LINE = "-"
+    const val UNDERSCORE = "_"
+    const val COMMA = ","
+    const val SPACE = " "
+    const val KEY_VALUE_SPLIT = ","
+    const val ARRAY_SPLIT = "|"
+    const val ARRAY_PARSER_SPLIT = "\\|"
+    const val USER_SERVICE_NAME = "User"
+    const val USER_INSTANCE_NAME = "User"
+    const val USER_ENDPOINT_NAME = "User"
+    const val SEGMENT_SPAN_SPLIT = "S"
+    const val UNKNOWN = "Unknown"
+    const val EMPTY_STRING = ""
+    const val POINT = "."
+    const val DOUBLE_COLONS_SPLIT = "::"
+    const val BLANK_ENTITY_NAME = "_blank"
+
+    object TLS_MODE {
+        const val NON_TLS = "NONE"
+        const val M_TLS = "mTLS"
+        const val TLS = "TLS"
+    }
+}