Remove LiveService in favor of LiveManagementService (#807)

* Remove LiveService in favor of LiveManagementService

* refactor: rename

Co-authored-by: Brandon Fergerson <[email protected]>

Author: MrMineO5

.github/workflows/build.yml

@@ -84,7 +84,7 @@ jobs:
 
       # Check plugin
       - name: Check plugin
-        run: ./gradlew check -x :commander:kotlin-compiler-wrapper:test
+        run: ./gradlew check -x :commander:kotlin-compiler-wrapper:test --refresh-dependencies
 
       # Collect Tests Result of failed tests
       - name: Collect Tests Result

commander

@@ -21,13 +21,13 @@ import com.intellij.openapi.util.Key
 import io.vertx.core.Vertx
 import spp.jetbrains.monitor.skywalking.SkywalkingMonitorService
 import spp.protocol.service.LiveInstrumentService
-import spp.protocol.service.LiveService
+import spp.protocol.service.LiveManagementService
 import spp.protocol.service.LiveViewService
 
 object UserData {
 
     private val VERTX = Key.create<Vertx>("SPP_VERTX")
-    private val LIVE_SERVICE = Key.create<LiveService>("SPP_LIVE_SERVICE")
+    private val LIVE_MANAGEMENT_SERVICE = Key.create<LiveManagementService>("SPP_LIVE_MANAGEMENT_SERVICE")
     private val LIVE_VIEW_SERVICE = Key.create<LiveViewService>("SPP_LIVE_VIEW_SERVICE")
     private val LIVE_INSTRUMENT_SERVICE = Key.create<LiveInstrumentService>("SPP_LIVE_INSTRUMENT_SERVICE")
 
@@ -44,13 +44,13 @@ object UserData {
         return project.getUserData(SkywalkingMonitorService.KEY)!!
     }
 
-    fun liveService(project: Project): LiveService? {
-        return project.getUserData(LIVE_SERVICE)
+    fun liveManagementService(project: Project): LiveManagementService? {
+        return project.getUserData(LIVE_MANAGEMENT_SERVICE)
     }
 
-    fun liveService(project: Project, liveService: LiveService): LiveService {
-        project.putUserData(LIVE_SERVICE, liveService)
-        return liveService
+    fun liveManagementService(project: Project, liveManagementService: LiveManagementService): LiveManagementService {
+        project.putUserData(LIVE_MANAGEMENT_SERVICE, liveManagementService)
+        return liveManagementService
     }
 
     fun liveViewService(project: Project): LiveViewService? {
@@ -75,7 +75,7 @@ object UserData {
     fun clearServices(project: Project) {
         project.putUserData(VERTX, null)
         project.putUserData(SkywalkingMonitorService.KEY, null)
-        project.putUserData(LIVE_SERVICE, null)
+        project.putUserData(LIVE_MANAGEMENT_SERVICE, null)
         project.putUserData(LIVE_VIEW_SERVICE, null)
         project.putUserData(LIVE_INSTRUMENT_SERVICE, null)
     }

common/src/main/kotlin/spp/jetbrains/UserData.kt

@@ -36,7 +36,7 @@ abstract class LiveCommand(val project: Project) {
 
     val vertx = UserData.vertx(project)
     val skywalkingMonitorService = UserData.skywalkingMonitorService(project)
-    val liveService = UserData.liveService(project)!!
+    val liveService = UserData.liveManagementService(project)!!
     val liveViewService = UserData.liveViewService(project)!!
     val liveStatusManager = LiveStatusManager.getInstance(project)
     val liveInstrumentService = UserData.liveInstrumentService(project)

core/src/main/kotlin/spp/jetbrains/command/LiveCommand.kt

@@ -6,7 +6,7 @@ val vertxVersion: String by project
 val projectVersion: String by project
 
 intellij {
-    plugins.set(listOf("PythonCore:222.3739.67"))
+    plugins.set(listOf("PythonCore:222.3739.68"))
 }
 
 dependencies {

marker/py-marker/build.gradle.kts

@@ -32,7 +32,7 @@ import okhttp3.Protocol
 import spp.jetbrains.UserData
 import spp.jetbrains.monitor.skywalking.bridge.*
 import spp.jetbrains.monitor.skywalking.impl.SkywalkingMonitorServiceImpl
-import spp.jetbrains.monitor.skywalking.service.SWLiveService
+import spp.jetbrains.monitor.skywalking.service.SWLiveManagementService
 import spp.jetbrains.monitor.skywalking.service.SWLiveViewService
 import spp.jetbrains.status.SourceStatus.ConnectionError
 import spp.jetbrains.status.SourceStatusService
@@ -142,10 +142,10 @@ class SkywalkingMonitor(
             vertx.deployVerticle(EndpointTracesBridge(skywalkingClient)).await()
             vertx.deployVerticle(LogsBridge(skywalkingClient)).await()
 
-            if (UserData.liveService(project) == null) {
-                val swLiveService = SWLiveService()
-                vertx.deployVerticle(swLiveService).await()
-                UserData.liveService(project, swLiveService)
+            if (UserData.liveManagementService(project) == null) {
+                val swLiveManagementService = SWLiveManagementService()
+                vertx.deployVerticle(swLiveManagementService).await()
+                UserData.liveManagementService(project, swLiveManagementService)
             }
             if (UserData.liveViewService(project) == null) {
                 val swLiveViewService = SWLiveViewService()

monitor/src/main/kotlin/spp/jetbrains/monitor/skywalking/SkywalkingMonitor.kt

@@ -23,18 +23,60 @@ import io.vertx.kotlin.coroutines.CoroutineVerticle
 import io.vertx.kotlin.coroutines.dispatcher
 import kotlinx.coroutines.launch
 import spp.jetbrains.monitor.skywalking.bridge.ServiceBridge
+import spp.protocol.platform.auth.ClientAccess
 import spp.protocol.platform.auth.CommandType
 import spp.protocol.platform.auth.RolePermission
 import spp.protocol.platform.developer.Developer
 import spp.protocol.platform.developer.SelfInfo
 import spp.protocol.platform.general.Service
 import spp.protocol.platform.status.ActiveInstance
-import spp.protocol.service.LiveService
+import spp.protocol.service.LiveManagementService
 
 /**
- * Implements [LiveService] for SkyWalking-only environments.
+ * Implements [LiveManagementService] for SkyWalking-only environments.
  */
-class SWLiveService : CoroutineVerticle(), LiveService {
+class SWLiveManagementService : CoroutineVerticle(), LiveManagementService {
+    /**
+     * Requires Source++ platform. Fails in SkyWalking-only environments.
+     */
+    override fun getRolePermissions(role: String): Future<List<RolePermission>> {
+        return Future.failedFuture("Illegal operation")
+    }
+
+    /**
+     * Requires Source++ platform. Fails in SkyWalking-only environments.
+     */
+    override fun getClientAccessors(): Future<List<ClientAccess>> {
+        return Future.failedFuture("Illegal operation")
+    }
+
+    /**
+     * Requires Source++ platform. Fails in SkyWalking-only environments.
+     */
+    override fun getClientAccess(id: String): Future<ClientAccess?> {
+        return Future.failedFuture("Illegal operation")
+    }
+
+    /**
+     * Requires Source++ platform. Fails in SkyWalking-only environments.
+     */
+    override fun addClientAccess(): Future<ClientAccess> {
+        return Future.failedFuture("Illegal operation")
+    }
+
+    /**
+     * Requires Source++ platform. Fails in SkyWalking-only environments.
+     */
+    override fun removeClientAccess(id: String): Future<Boolean> {
+        return Future.failedFuture("Illegal operation")
+    }
+
+    /**
+     * Requires Source++ platform. Fails in SkyWalking-only environments.
+     */
+    override fun updateClientAccess(id: String): Future<ClientAccess> {
+        return Future.failedFuture("Illegal operation")
+    }
 
     /**
      * Requires Source++ platform. Fails in SkyWalking-only environments.

monitor/src/main/kotlin/spp/jetbrains/monitor/skywalking/service/SWLiveService.kt renamed to monitor/src/main/kotlin/spp/jetbrains/monitor/skywalking/service/SWLiveManagementService.kt

@@ -25,12 +25,11 @@ import io.vertx.kotlin.coroutines.CoroutineVerticle
 import io.vertx.kotlin.coroutines.dispatcher
 import kotlinx.coroutines.launch
 import kotlinx.datetime.toJavaInstant
-import spp.jetbrains.monitor.skywalking.model.DurationStep
-import spp.jetbrains.monitor.skywalking.SkywalkingClient
 import spp.jetbrains.monitor.skywalking.bridge.EndpointMetricsBridge
 import spp.jetbrains.monitor.skywalking.bridge.EndpointTracesBridge
 import spp.jetbrains.monitor.skywalking.bridge.LogsBridge
 import spp.jetbrains.monitor.skywalking.bridge.ServiceBridge
+import spp.jetbrains.monitor.skywalking.model.DurationStep
 import spp.jetbrains.monitor.skywalking.model.GetEndpointMetrics
 import spp.jetbrains.monitor.skywalking.model.GetEndpointTraces
 import spp.jetbrains.monitor.skywalking.model.ZonedDuration

monitor/src/main/kotlin/spp/jetbrains/monitor/skywalking/service/SWLiveViewService.kt

@@ -63,7 +63,6 @@ import org.apache.commons.text.CaseUtils
 import spp.jetbrains.PluginBundle.message
 import spp.jetbrains.ScopeExtensions.safeRunBlocking
 import spp.jetbrains.UserData
-import spp.jetbrains.safeLaunch
 import spp.jetbrains.marker.SourceMarker
 import spp.jetbrains.marker.jvm.ArtifactSearch
 import spp.jetbrains.marker.jvm.JVMMarker
@@ -73,6 +72,7 @@ import spp.jetbrains.marker.source.mark.api.filter.CreateSourceMarkFilter
 import spp.jetbrains.monitor.skywalking.SkywalkingMonitor
 import spp.jetbrains.plugin.LivePluginService
 import spp.jetbrains.plugin.LiveStatusManager
+import spp.jetbrains.safeLaunch
 import spp.jetbrains.sourcemarker.activities.PluginSourceMarkerStartupActivity.Companion.INTELLIJ_PRODUCT_CODES
 import spp.jetbrains.sourcemarker.mark.PluginSourceMarkEventListener
 import spp.jetbrains.sourcemarker.portal.PortalController
@@ -91,7 +91,7 @@ import spp.jetbrains.status.SourceStatus.Pending
 import spp.jetbrains.status.SourceStatusService
 import spp.protocol.SourceServices
 import spp.protocol.service.LiveInstrumentService
-import spp.protocol.service.LiveService
+import spp.protocol.service.LiveManagementService
 import spp.protocol.service.LiveViewService
 import java.io.File
 import java.net.ConnectException
@@ -355,14 +355,14 @@ class SourceMarkerPlugin(val project: Project) {
         log.info("Discovered $availableRecords.size services")
 
         //live service
-        if (availableRecords.any { it.name == SourceServices.Utilize.LIVE_SERVICE }) {
+        if (availableRecords.any { it.name == SourceServices.Utilize.LIVE_MANAGEMENT_SERVICE }) {
             log.info("Live service available")
 
-            val liveService = ServiceProxyBuilder(vertx)
+            val liveManagementService = ServiceProxyBuilder(vertx)
                 .apply { config.serviceToken?.let { setToken(it) } }
-                .setAddress(SourceServices.Utilize.LIVE_SERVICE)
-                .build(LiveService::class.java)
-            UserData.liveService(project, liveService)
+                .setAddress(SourceServices.Utilize.LIVE_MANAGEMENT_SERVICE)
+                .build(LiveManagementService::class.java)
+            UserData.liveManagementService(project, liveManagementService)
         } else {
             log.warn("Live service unavailable")
         }

plugin/src/main/kotlin/spp/jetbrains/sourcemarker/SourceMarkerPlugin.kt

@@ -54,7 +54,7 @@ object ControlBarController {
 
     private fun determineAvailableCommandsAtLocation(inlayMark: ExpressionInlayMark): List<LiveCommand> {
         //todo: should store selfInfo locally and add a platform listener to trigger on changes
-        val selfInfo = safeRunBlocking { UserData.liveService(inlayMark.project)!!.getSelf().await() }
+        val selfInfo = safeRunBlocking { UserData.liveManagementService(inlayMark.project)!!.getSelf().await() }
         val availableCommandsAtLocation = mutableSetOf<LiveCommand>()
         availableCommandsAtLocation.addAll(
             LivePluginService.getInstance(inlayMark.project)

plugin/src/main/kotlin/spp/jetbrains/sourcemarker/command/ControlBarController.kt

@@ -23,7 +23,6 @@ import com.intellij.openapi.fileEditor.FileEditorManager
 import com.intellij.openapi.project.Project
 import com.intellij.psi.PsiManager
 import io.vertx.core.Vertx
-import spp.jetbrains.safeLaunch
 import spp.jetbrains.marker.SourceMarker
 import spp.jetbrains.marker.jvm.JVMEndpointDetector
 import spp.jetbrains.marker.jvm.psi.LoggerDetector
@@ -34,6 +33,7 @@ import spp.jetbrains.marker.source.mark.api.event.SourceMarkEventCode
 import spp.jetbrains.marker.source.mark.api.event.SynchronousSourceMarkEventListener
 import spp.jetbrains.marker.source.mark.guide.MethodGuideMark
 import spp.jetbrains.monitor.skywalking.bridge.ServiceBridge
+import spp.jetbrains.safeLaunch
 import spp.jetbrains.sourcemarker.mark.SourceMarkKeys.ENDPOINT_DETECTOR
 import spp.jetbrains.sourcemarker.mark.SourceMarkKeys.LOGGER_DETECTOR
 

plugin/src/main/kotlin/spp/jetbrains/sourcemarker/mark/PluginSourceMarkEventListener.kt

@@ -26,8 +26,8 @@ import io.vertx.ext.bridge.BridgeEventType
 import io.vertx.ext.eventbus.bridge.tcp.impl.protocol.FrameHelper
 import io.vertx.kotlin.coroutines.CoroutineVerticle
 import spp.jetbrains.UserData
-import spp.jetbrains.plugin.LiveStatusManager
 import spp.jetbrains.marker.SourceMarker
+import spp.jetbrains.plugin.LiveStatusManager
 import spp.jetbrains.sourcemarker.mark.SourceMarkKeys
 import spp.jetbrains.sourcemarker.mark.SourceMarkSearch
 import spp.jetbrains.sourcemarker.service.discover.TCPServiceDiscoveryBackend

plugin/src/main/kotlin/spp/jetbrains/sourcemarker/service/LiveInstrumentManager.kt

@@ -149,7 +149,7 @@ class TCPServiceDiscoveryBackend : ServiceDiscoveryBackend {
 
             vertx.executeBlocking<Any> {
                 setupHandler(vertx, "get-records")
-                setupHandler(vertx, Utilize.LIVE_SERVICE)
+                setupHandler(vertx, Utilize.LIVE_MANAGEMENT_SERVICE)
                 setupHandler(vertx, Utilize.LIVE_INSTRUMENT)
                 setupHandler(vertx, Utilize.LIVE_VIEW)
 

plugin/src/main/kotlin/spp/jetbrains/sourcemarker/service/discover/TCPServiceDiscoveryBackend.kt

@@ -58,7 +58,7 @@ class SourceMarkerConfigurable(val project: Project) : Configurable {
         if (form == null) {
             val config = SourceMarkerPlugin.getInstance(project).getConfig()
             val availServices = safeRunBlocking {
-                UserData.liveService(project)?.getServices()?.await() ?: emptyList()
+                UserData.liveManagementService(project)?.getServices()?.await() ?: emptyList()
             }
             form = PluginConfigurationPanel(config, availServices)
             form!!.applySourceMarkerConfig(config)

plugin/src/main/kotlin/spp/jetbrains/sourcemarker/settings/SourceMarkerConfigurable.kt

@@ -27,11 +27,10 @@ import kotlinx.coroutines.isActive
 import spp.jetbrains.ScopeExtensions.safeGlobalAsync
 import spp.jetbrains.ScopeExtensions.safeGlobalLaunch
 import spp.jetbrains.sourcemarker.SourceMarkerPlugin
+import spp.jetbrains.sourcemarker.statusBar.SourceStatusBarWidget
 import spp.jetbrains.status.SourceStatus
 import spp.jetbrains.status.SourceStatus.*
 import spp.jetbrains.status.SourceStatusService
-import spp.jetbrains.sourcemarker.statusBar.SourceStatusBarWidget
-import java.lang.Runnable
 import javax.annotation.concurrent.GuardedBy
 
 class SourceStatusServiceImpl(val project: Project) : SourceStatusService {

plugin/src/main/kotlin/spp/jetbrains/sourcemarker/stat/SourceStatusServiceImpl.kt

@@ -28,7 +28,6 @@ import io.vertx.core.json.JsonObject
 import spp.jetbrains.ScopeExtensions.safeRunBlocking
 import spp.jetbrains.UserData
 import spp.jetbrains.icons.PluginIcons
-import spp.jetbrains.plugin.LiveStatusManager
 import spp.jetbrains.marker.impl.ArtifactCreationService
 import spp.jetbrains.marker.impl.ArtifactNamingService
 import spp.jetbrains.marker.impl.ArtifactScopeService
@@ -41,6 +40,7 @@ import spp.jetbrains.marker.source.mark.api.event.SourceMarkEvent
 import spp.jetbrains.marker.source.mark.api.event.SourceMarkEventCode
 import spp.jetbrains.marker.source.mark.api.event.SourceMarkEventListener
 import spp.jetbrains.marker.source.mark.inlay.InlayMark
+import spp.jetbrains.plugin.LiveStatusManager
 import spp.jetbrains.sourcemarker.SourceMarkerPlugin
 import spp.jetbrains.sourcemarker.mark.SourceMarkKeys
 import spp.jetbrains.sourcemarker.mark.SourceMarkKeys.INSTRUMENT_EVENT_LISTENERS