code refactoring (#133)

Signed-off-by: Artem Zatsarynnyi <[email protected]>

Author: azatsarynnyy

src/main/kotlin/com/redhat/devtools/gateway/DevSpacesConnection.kt

@@ -13,7 +13,7 @@ package com.redhat.devtools.gateway
 
 import com.redhat.devtools.gateway.openshift.DevWorkspaces
 import com.redhat.devtools.gateway.openshift.Pods
-import com.redhat.devtools.gateway.server.RemoteServer
+import com.redhat.devtools.gateway.server.RemoteIDEServer
 import com.jetbrains.gateway.thinClientLink.LinkedClientManager
 import com.jetbrains.gateway.thinClientLink.ThinClientHandle
 import com.jetbrains.rd.util.lifetime.Lifetime
@@ -50,25 +50,25 @@ class DevSpacesConnection(private val devSpacesContext: DevSpacesContext) {
     ): ThinClientHandle {
         startAndWaitDevWorkspace()
 
-        val remoteServer = RemoteServer(devSpacesContext).also { it.waitProjectsReady() }
-        val projectStatus = remoteServer.getProjectStatus()
+        val remoteIdeServer = RemoteIDEServer(devSpacesContext).also { it.waitServerReady() }
+        val remoteIdeServerStatus = remoteIdeServer.getStatus()
 
         val client = LinkedClientManager
             .getInstance()
             .startNewClient(
                 Lifetime.Eternal,
-                URI(projectStatus.joinLink),
+                URI(remoteIdeServerStatus.joinLink),
                 "",
                 onConnected,
                 false
             )
 
-        val forwarder = Pods(devSpacesContext.client).forward(remoteServer.pod, 5990, 5990)
+        val forwarder = Pods(devSpacesContext.client).forward(remoteIdeServer.pod, 5990, 5990)
 
         client.run {
             lifetime.onTermination { forwarder.close() }
             lifetime.onTermination {
-                if (remoteServer.waitProjectsTerminated())
+                if (remoteIdeServer.waitServerTerminated())
                     DevWorkspaces(devSpacesContext.client)
                         .stop(
                             devSpacesContext.devWorkspace.metadata.namespace,

src/main/kotlin/com/redhat/devtools/gateway/server/RemoteServer.kt renamed to src/main/kotlin/com/redhat/devtools/gateway/server/RemoteIDEServer.kt

@@ -25,8 +25,10 @@ import java.util.concurrent.Executors
 import java.util.concurrent.TimeUnit
 import java.util.concurrent.atomic.AtomicBoolean
 
-
-class RemoteServer(private val devSpacesContext: DevSpacesContext) {
+/**
+ * Represent an IDE server running in a CDE.
+ */
+class RemoteIDEServer(private val devSpacesContext: DevSpacesContext) {
     var pod: V1Pod
     private var container: V1Container
     private var readyTimeout: Long = 60
@@ -37,7 +39,10 @@ class RemoteServer(private val devSpacesContext: DevSpacesContext) {
         container = findContainer()
     }
 
-    fun getProjectStatus(): ProjectStatus {
+    /**
+     * Asks the CDE for the remote IDE server status.
+     */
+    fun getStatus(): RemoteIDEServerStatus {
         Pods(devSpacesContext.client)
             .exec(
                 pod,
@@ -56,44 +61,44 @@ class RemoteServer(private val devSpacesContext: DevSpacesContext) {
             )
             .trim()
             .also {
-                return if (Strings.isNullOrEmpty(it)) ProjectStatus.empty()
-                else Gson().fromJson(it, ProjectStatus::class.java)
+                return if (Strings.isNullOrEmpty(it)) RemoteIDEServerStatus.empty()
+                else Gson().fromJson(it, RemoteIDEServerStatus::class.java)
             }
     }
 
     @Throws(IOException::class)
-    fun waitProjectsReady() {
-        doWaitProjectsState(true, readyTimeout)
+    fun waitServerReady() {
+        doWaitServerState(true, readyTimeout)
             .also {
                 if (!it) throw IOException(
                     String.format(
-                        "Projects are not ready after %d seconds.",
+                        "Remote IDE server is not ready after %d seconds.",
                         readyTimeout
                     )
                 )
             }
     }
 
     @Throws(IOException::class)
-    fun waitProjectsTerminated(): Boolean {
-        return doWaitProjectsState(false, terminationTimeout)
+    fun waitServerTerminated(): Boolean {
+        return doWaitServerState(false, terminationTimeout)
     }
 
     @Throws(IOException::class)
-    fun doWaitProjectsState(isReadyState: Boolean, timeout: Long): Boolean {
+    fun doWaitServerState(isReadyState: Boolean, timeout: Long): Boolean {
         val projectsInDesiredState = AtomicBoolean()
         val executor = Executors.newSingleThreadScheduledExecutor()
         executor.scheduleAtFixedRate(
             {
                 try {
-                    getProjectStatus().also {
+                    getStatus().also {
                         if (isReadyState == !Arrays.isNullOrEmpty(it.projects)) {
                             projectsInDesiredState.set(true)
                             executor.shutdown()
                         }
                     }
                 } catch (e: Exception) {
-                    thisLogger().debug("Failed to check project status", e)
+                    thisLogger().debug("Failed to check remote IDE server state.", e)
                 }
             }, 0, 5, TimeUnit.SECONDS
         )

src/main/kotlin/com/redhat/devtools/gateway/server/ProjectStatus.kt renamed to src/main/kotlin/com/redhat/devtools/gateway/server/RemoteIDEServerStatus.kt

@@ -12,7 +12,7 @@
 
 package com.redhat.devtools.gateway.server
 
-data class ProjectStatus(
+data class RemoteIDEServerStatus(
     val joinLink: String,
     val httpLink: String,
     val gatewayLink: String,
@@ -21,15 +21,15 @@ data class ProjectStatus(
     val projects: Array<ProjectInfo>
 ) {
     companion object {
-        fun empty(): ProjectStatus {
-            return ProjectStatus("", "", "", "", "", emptyArray())
+        fun empty(): RemoteIDEServerStatus {
+            return RemoteIDEServerStatus("", "", "", "", "", emptyArray())
         }
     }
     override fun equals(other: Any?): Boolean {
         if (this === other) return true
         if (javaClass != other?.javaClass) return false
 
-        other as ProjectStatus
+        other as RemoteIDEServerStatus
 
         if (joinLink != other.joinLink) return false
         if (httpLink != other.httpLink) return false