Merge pull request #176 from sourceplusplus/live-insight

feat: live insight

Author: BFergerson

src/main/kotlin/spp/protocol/insight/InsightWorkspace.kt

@@ -0,0 +1,45 @@
+/*
+ * 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.insight
+
+import io.vertx.codegen.annotations.DataObject
+import io.vertx.core.json.JsonObject
+import java.time.Instant
+
+/**
+ * Represents a siloed workspace for performing live insight analyses. Every commit
+ * to a project is analysed in a new workspace. Workspaces are isolated from
+ * each other and can be deleted when no longer needed.
+ */
+@DataObject
+data class InsightWorkspace(
+    val id: String,
+    val createDate: Instant,
+    val config: JsonObject = JsonObject()
+) {
+    constructor(json: JsonObject) : this(
+        id = json.getString("id"),
+        createDate = json.getInstant("createDate")
+    )
+
+    fun toJson(): JsonObject {
+        val json = JsonObject()
+        json.put("id", id)
+        json.put("createDate", createDate)
+        return json
+    }
+}

src/main/kotlin/spp/protocol/instrument/LiveMeter.kt

@@ -57,7 +57,7 @@ data class LiveMeter(
                 append(buildString {
                     append("Must begin with 'spp_', ")
                     append("contain only lowercase letters, numbers, ")
-                    append("and underscores, must be 1-64 characters in length, ")
+                    append("and underscores, must be 1-128 characters in length, ")
                     append("and cannot end with an underscore.")
                 })
             })
@@ -152,7 +152,7 @@ data class LiveMeter(
     }
 
     companion object {
-        val VALID_ID_PATTERN = Regex("spp_[a-zA-Z0-9_]{1,63}(?<!_)")
+        val VALID_ID_PATTERN = Regex("spp_[a-zA-Z0-9_]{1,127}(?<!_)")
 
         fun formatMeterName(meterName: String): String {
             val sb = StringBuilder()

src/main/kotlin/spp/protocol/service/LiveInsightService.kt

@@ -0,0 +1,63 @@
+/*
+ * 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.service
+
+import io.vertx.codegen.annotations.GenIgnore
+import io.vertx.codegen.annotations.ProxyGen
+import io.vertx.codegen.annotations.VertxGen
+import io.vertx.core.Future
+import io.vertx.core.Vertx
+import io.vertx.core.eventbus.DeliveryOptions
+import io.vertx.core.json.JsonArray
+import io.vertx.core.json.JsonObject
+import spp.protocol.artifact.ArtifactQualifiedName
+
+@ProxyGen
+@VertxGen
+interface LiveInsightService {
+    @GenIgnore
+    companion object {
+        @JvmStatic
+        fun createProxy(vertx: Vertx, authToken: String? = null): LiveInsightService {
+            val deliveryOptions = DeliveryOptions().apply {
+                authToken?.let { addHeader("auth-token", it) }
+            }
+            return LiveInsightServiceVertxEBProxy(vertx, SourceServices.LIVE_INSIGHT, deliveryOptions)
+        }
+    }
+
+    /**
+     * Uploads source code to the workspace.
+     * @param sourceCode The source code to upload.
+     */
+    fun uploadSourceCode(workspaceId: String, sourceCode: JsonObject): Future<Void>
+
+    /**
+     * Uploads source code repository to the workspace.
+     *
+     * @param repository The source code repository to upload.
+     */
+    fun uploadRepository(workspaceId: String, repository: JsonObject): Future<Void>
+
+    fun getArtifactInsights(workspaceId: String, artifact: ArtifactQualifiedName, types: JsonArray): Future<JsonObject>
+
+    fun getProjectClasses(workspaceId: String, offset: Int, limit: Int): Future<JsonArray>
+
+    fun getProjectFunctions(workspaceId: String, offset: Int, limit: Int): Future<JsonArray>
+
+    fun getFunctionCode(workspaceId: String, function: ArtifactQualifiedName): Future<JsonObject>
+}