Refactor UI related logic

Author: EgorkaKulikov

clion-plugin/README.md

@@ -43,7 +43,7 @@ all configuration options.
 1. Open plugin settings in settings - Tools - UTBot Settings
 2. Click `detect paths`. It will try to get source paths, build dir paths from CLion 
 CMake model.
-3. Specify absolute path to build folder, it should be different from build folder that CLion uses, 
+3. Specify absolute path to build directory, it should be different from build directory that CLion uses, 
 because there can be conflicts between UTBotCpp and CLion. For example, if CLion uses `project_path/cmake-build-debug`, 
 then you can specify `project_path/utbot_build`.
 4. For target path specify `/utbot/auto/target/path`

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/UTBotStartupActivity.kt

@@ -1,11 +1,9 @@
 package org.utbot.cpp.clion.plugin
 
 import com.intellij.ide.util.RunOnceUtil
-import com.intellij.openapi.components.service
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.startup.StartupActivity
 import org.utbot.cpp.clion.plugin.client.Client
-import org.utbot.cpp.clion.plugin.settings.UTBotPluginSpecificSettings
 import org.utbot.cpp.clion.plugin.settings.pluginSettings
 import org.utbot.cpp.clion.plugin.settings.settings
 import org.utbot.cpp.clion.plugin.ui.wizard.UTBotWizard
@@ -14,13 +12,14 @@ import org.utbot.cpp.clion.plugin.utils.invokeOnEdt
 
 class UTBotStartupActivity : StartupActivity {
     override fun runActivity(project: Project) {
-
+        //TODO: preload instantiating the client and avoid such magic
         project.getClient()
-        guessPathsOnFirstProjectOpen(project)
-        showWizardOnFirstProjectOpen(project)
+
+        guessPathsOnFirstOpen(project)
+        showWizardOnFirstOpen(project)
     }
 
-    private fun showWizardOnFirstProjectOpen(project: Project) {
+    private fun showWizardOnFirstOpen(project: Project) {
         if (pluginSettings.isFirstLaunch && !Client.IS_TEST_MODE) {
             pluginSettings.isFirstLaunch = false
             invokeOnEdt {
@@ -29,7 +28,7 @@ class UTBotStartupActivity : StartupActivity {
         }
     }
 
-    private fun guessPathsOnFirstProjectOpen(project: Project) {
+    private fun guessPathsOnFirstOpen(project: Project) {
         RunOnceUtil.runOnceForProject(project, "Guess UTBot paths in settings") {
             project.settings.predictPaths()
         }

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/actions/generate/BaseGenerateTestsAction.kt

@@ -2,15 +2,15 @@ package org.utbot.cpp.clion.plugin.actions.generate
 
 import com.intellij.openapi.actionSystem.AnAction
 import com.intellij.openapi.actionSystem.AnActionEvent
-import org.utbot.cpp.clion.plugin.utils.client
+import org.utbot.cpp.clion.plugin.utils.getClient
 
 abstract class BaseGenerateTestsAction : AnAction() {
 
     override fun update(e: AnActionEvent) {
         val isDefined: Boolean = isDefined(e)
 
         e.presentation.isVisible = isDefined
-        e.presentation.isEnabled = isDefined && e.client.isServerAvailable()
+        e.presentation.isEnabled = isDefined && e.getClient().isServerAvailable()
     }
 
     /**

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/actions/generate/GenerateForPredicateAction.kt

@@ -14,7 +14,7 @@ import org.utbot.cpp.clion.plugin.grpc.getPredicateGrpcRequest
 import org.utbot.cpp.clion.plugin.client.requests.FunctionReturnTypeRequest
 import org.utbot.cpp.clion.plugin.client.requests.PredicateRequest
 import org.utbot.cpp.clion.plugin.utils.activeProject
-import org.utbot.cpp.clion.plugin.utils.client
+import org.utbot.cpp.clion.plugin.utils.getClient
 import org.utbot.cpp.clion.plugin.utils.notifyError
 import testsgen.Util.ValidationType
 import java.awt.Dimension
@@ -48,7 +48,7 @@ class GenerateForPredicateAction : BaseGenerateTestsAction() {
                 getPredicateGrpcRequest(e, comparisonOperator, validationType, valueToCompare),
                 e.activeProject()
             ).apply {
-                e.client.executeRequest(this)
+                e.getClient().executeRequest(this)
             }
 
         // ask for comparison operator to use in predicate
@@ -111,7 +111,7 @@ class GenerateForPredicateAction : BaseGenerateTestsAction() {
                 }
             }
         }.apply {
-            e.client.executeRequest(this)
+            e.getClient().executeRequest(this)
         }
     }
 

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/actions/generate/GenerateForProjectAction.kt

@@ -4,15 +4,15 @@ import com.intellij.openapi.actionSystem.AnActionEvent
 import org.utbot.cpp.clion.plugin.grpc.getProjectGrpcRequest
 import org.utbot.cpp.clion.plugin.client.requests.ProjectRequest
 import org.utbot.cpp.clion.plugin.utils.activeProject
-import org.utbot.cpp.clion.plugin.utils.client
+import org.utbot.cpp.clion.plugin.utils.getClient
 
 class GenerateForProjectAction : BaseGenerateTestsAction() {
     override fun actionPerformed(e: AnActionEvent) {
         ProjectRequest(
             getProjectGrpcRequest(e),
             e.activeProject(),
         ).apply {
-            e.client.executeRequest(this)
+            e.getClient().executeRequest(this)
         }
     }
 

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/actions/generate/RunWithCoverageAction.kt

@@ -14,7 +14,7 @@ class RunWithCoverageAction(val element: PsiElement) : BaseGenerateTestsAction()
     override fun actionPerformed(e: AnActionEvent) {
         logger.debug("Action RunWithCoverageAction was called")
 
-        val testArgs = TestNameAndTestSuite.getFromPsiElement(element)
+        val testArgs = TestNameAndTestSuite.create(element)
         val suiteName = testArgs.suite
         val testedMethodName = testArgs.name
         val filePath = e.getRequiredData(CommonDataKeys.VIRTUAL_FILE).path

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/client/Client.kt

@@ -12,6 +12,7 @@ import kotlinx.coroutines.SupervisorJob
 import kotlinx.coroutines.cancel
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.isActive
+import kotlinx.coroutines.job
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.withTimeout
@@ -20,7 +21,6 @@ import org.utbot.cpp.clion.plugin.grpc.getProjectConfigGrpcRequest
 import org.utbot.cpp.clion.plugin.listeners.ConnectionStatus
 import org.utbot.cpp.clion.plugin.listeners.UTBotEventsListener
 import org.utbot.cpp.clion.plugin.settings.projectIndependentSettings
-import org.utbot.cpp.clion.plugin.utils.hasChildren
 import org.utbot.cpp.clion.plugin.utils.logger
 import testsgen.Testgen
 
@@ -49,15 +49,15 @@ class Client(
         exception.printStackTrace()
     }
 
-    val dispatcher = Dispatchers.IO
+    private val dispatcher = Dispatchers.IO
 
     // coroutine scope for requests that don't have a lifetime of a plugin, e.g. generation requests
     // this division is needed for testing: when in test we send a generate request to server, we need to wait
     // until it completes, the indicator that all such requests have completed is that this scope has no children
-    val requestsCS: CoroutineScope = CoroutineScope(dispatcher + excHandler + SupervisorJob())
+    private val requestsCS: CoroutineScope = CoroutineScope(dispatcher + excHandler + SupervisorJob())
 
     // coroutine scope for suspending functions that can live entire plugin lifetime, e.g. server logs, gtest logs, heartbeat
-    val servicesCS: CoroutineScope = CoroutineScope(dispatcher + excHandler + SupervisorJob())
+    private val servicesCS: CoroutineScope = CoroutineScope(dispatcher + excHandler + SupervisorJob())
 
     init {
         logger.info { "Connecting to server on host: ${projectIndependentSettings.serverName} , port: ${projectIndependentSettings.port}" }
@@ -179,14 +179,16 @@ class Client(
     fun waitForServerRequestsToFinish(timeout: Long = SERVER_TIMEOUT) {
         runBlocking {
             withTimeout(timeout) {
-                while (requestsCS.hasChildren()) {
+                val hasChildJobs = requestsCS.coroutineContext.job.children.any()
+                while (hasChildJobs) {
                     delay(DELAY_TIME)
                 }
             }
         }
     }
 
     companion object {
+        //TODO: why don't use process this setting similarly to "isFirstLaunch"? Why is it a property of the client?
         var IS_TEST_MODE = false
         const val HEARTBEAT_INTERVAL: Long = 500L
         const val SERVER_TIMEOUT: Long = 300000L

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/client/LoggingChannels.kt

@@ -7,7 +7,7 @@ import kotlinx.coroutines.flow.catch
 import kotlinx.coroutines.flow.collect
 import org.utbot.cpp.clion.plugin.grpc.getDummyGrpcRequest
 import org.utbot.cpp.clion.plugin.grpc.getLogChannelGrpcRequest
-import org.utbot.cpp.clion.plugin.ui.userLog.OutputProvider
+import org.utbot.cpp.clion.plugin.ui.services.OutputProvider
 import org.utbot.cpp.clion.plugin.ui.userLog.UTBotConsole
 import org.utbot.cpp.clion.plugin.utils.invokeOnEdt
 import org.utbot.cpp.clion.plugin.utils.logger

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/client/handlers/ProjectConfigurationHandler.kt

@@ -13,7 +13,7 @@ import org.utbot.cpp.clion.plugin.utils.notifyError
 import org.utbot.cpp.clion.plugin.utils.notifyInfo
 import org.utbot.cpp.clion.plugin.utils.notifyUnknownResponse
 import org.utbot.cpp.clion.plugin.utils.notifyWarning
-import org.utbot.cpp.clion.plugin.utils.refreshAndFindIOFile
+import org.utbot.cpp.clion.plugin.utils.refreshAndFindNioFile
 import testsgen.Testgen
 
 abstract class ProjectConfigResponseHandler(
@@ -56,8 +56,9 @@ class CheckProjectConfigurationHandler(
                 val missingFileName =
                     if (response.type == Testgen.ProjectConfigStatus.LINK_COMMANDS_JSON_NOT_FOUND) "link_commands.json" else "compile_commands.json"
                 notifyError(
-                    "Project is not configured properly: $missingFileName is missing in the build folder.",
-                    project, AskServerToGenerateJsonForProjectConfiguration()
+                    "Project is not configured properly: file $missingFileName is missed in the build directory",
+                    project,
+                    AskServerToGenerateJsonForProjectConfiguration(),
                 )
             }
             Testgen.ProjectConfigStatus.BUILD_DIR_SAME_AS_PROJECT -> {
@@ -87,7 +88,7 @@ class CreateBuildDirHandler(
             }
             else -> notifyUnknownResponse(response, project)
         }
-        refreshAndFindIOFile(project.settings.buildDirPath.toString())
+        refreshAndFindNioFile(project.settings.buildDirPath)
     }
 }
 
@@ -106,6 +107,6 @@ class GenerateJsonHandler(
             )
             else -> notifyUnknownResponse(response, project)
         }
-        refreshAndFindIOFile(project.settings.buildDirPath.toString())
+        refreshAndFindNioFile(project.settings.buildDirPath)
     }
 }

clion-plugin/src/main/kotlin/org/utbot/cpp/clion/plugin/client/handlers/StreamHandlerWithProgress.kt

@@ -27,7 +27,7 @@ abstract class StreamHandlerWithProgress<T>(
     override fun onFinish() {
         super.onFinish()
         invokeOnEdt {
-            indicator.complete()
+            indicator.finish()
         }
     }