[rd-factoring]

review fix

Author: Domonion

docs/contributing/InterProcessDebugging.md

@@ -32,7 +32,7 @@ For engine and instrumented processes you need to enable some options:
 4. Additionally, you can set additional options for JDWP agent if debug is enabled:
    * `engineProcessDebugPort` and `instrumentedProcessDebugPort` - port for debugging. 
    Default values - 5005 for Engine and 5006 for Instrumented processes. 
-   * `engineProcessDebugSuspendPolicy` and `instrumentedProcessSuspendPolicy` - whether JDWP agent should
+   * `suspendEngineProcessExecutionInDebugMode` and `suspendInstrumentedProcessExecutionInDebugMode` - whether JDWP agent should
    suspend process until debugger is connected. 
 
    More formally, if debug is enabled following switch is added to engine process JVM at start by default:
@@ -44,7 +44,7 @@ For engine and instrumented processes you need to enable some options:
    ```
    runEngineProcessWithDebug=true
    engineProcessDebugPort=12345
-   engineProcessDebugSuspendPolicy=false
+   suspendEngineProcessExecutionInDebugMode=false
    ```
    result switch will be:
    ```

utbot-framework-api/src/main/kotlin/org/utbot/framework/UtSettings.kt

@@ -274,35 +274,39 @@ object UtSettings : AbstractSettings(
     var engineProcessLogConfigFile by getStringProperty("")
 
     /**
-     * Property useful only for idea
-     * If true - runs engine process with the ability to attach a debugger
+     * The property is useful only for the IntelliJ IDEs.
+     * If the property is set in true the engine process opens a debug port.
      * @see runInstrumentedProcessWithDebug
      * @see org.utbot.intellij.plugin.process.EngineProcess
      */
     var runEngineProcessWithDebug by getBooleanProperty(false)
 
     /**
-     * Port which will be used for debugging engine process
+     * The engine process JDWP agent's port of the instrumented process.
+     * A debugger attaches to the port in order to debug the process.
      */
     var engineProcessDebugPort by getIntProperty(5005)
 
     /**
-     * Whether engine process should suspend until debugger attached
+     * Value of the suspend mode for the JDWP agent of the engine process.
+     * If the value is true, the engine process will suspend until a debugger attaches to it.
      */
-    var engineProcessDebugSuspendPolicy by getBooleanProperty(true)
+    var suspendEngineProcessExecutionInDebugMode by getBooleanProperty(true)
 
 // endregion
 
 // region instrumented process debug
     /**
-     * Port which will be used for debugging instrumented process
+     * The instrumented process JDWP agent's port of the instrumented process.
+     * A debugger attaches to the port in order to debug the process.
      */
     var instrumentedProcessDebugPort by getIntProperty(5006)
 
     /**
-     * Whether instrumented process should suspend until debugger attached
+     * Value of the suspend mode for the JDWP agent of the instrumented process.
+     * If the value is true, the instrumented process will suspend until a debugger attaches to it.
      */
-    var instrumentedProcessSuspendPolicy by getBooleanProperty(true)
+    var suspendInstrumentedProcessExecutionInDebugMode by getBooleanProperty(true)
 
     /**
      * If true, runs the instrumented process with the ability to attach a debugger.

utbot-instrumentation/src/main/kotlin/org/utbot/instrumentation/ConcreteExecutor.kt

@@ -242,7 +242,7 @@ class ConcreteExecutor<TIResult, TInstrumentation : Instrumentation<TIResult>> p
             val parametersByteArray = kryoHelper.writeObject(parameters)
             val params = InvokeMethodCommandParams(className, signature, argumentsByteArray, parametersByteArray)
 
-            val ba = chidlProcessModel.invokeMethodCommand.startSuspending(lifetime, params).result
+            val ba = instrumentedProcessModel.invokeMethodCommand.startSuspending(lifetime, params).result
             kryoHelper.readObject(ba)
         }
     } catch (e: Throwable) {
@@ -282,7 +282,7 @@ class ConcreteExecutor<TIResult, TInstrumentation : Instrumentation<TIResult>> p
                 if (alive) {
                     try {
                         processInstance?.run {
-                            chidlProcessModel.stopProcess.start(lifetime, Unit)
+                            instrumentedProcessModel.stopProcess.start(lifetime, Unit)
                         }
                     } catch (_: Exception) {}
                     processInstance = null
@@ -296,7 +296,7 @@ class ConcreteExecutor<TIResult, TInstrumentation : Instrumentation<TIResult>> p
 
 fun ConcreteExecutor<*,*>.warmup() = runBlocking {
     withProcess {
-        chidlProcessModel.warmup.start(lifetime, Unit)
+        instrumentedProcessModel.warmup.start(lifetime, Unit)
     }
 }
 
@@ -308,7 +308,7 @@ fun <T> ConcreteExecutor<*, *>.computeStaticField(fieldId: FieldId): Result<T> =
         val fieldIdSerialized = kryoHelper.writeObject(fieldId)
         val params = ComputeStaticFieldParams(fieldIdSerialized)
 
-        val result = chidlProcessModel.computeStaticField.startSuspending(lifetime, params)
+        val result = instrumentedProcessModel.computeStaticField.startSuspending(lifetime, params)
 
         kryoHelper.readObject(result.result)
     }

utbot-instrumentation/src/main/kotlin/org/utbot/instrumentation/instrumentation/coverage/CoverageInstrumentation.kt

@@ -103,6 +103,6 @@ fun ConcreteExecutor<Result<*>, CoverageInstrumentation>.collectCoverage(clazz:
     withProcess {
         val clazzByteArray = kryoHelper.writeObject(clazz)
 
-        kryoHelper.readObject(chidlProcessModel.collectCoverage.startSuspending(lifetime, CollectCoverageParams(clazzByteArray)).coverageInfo)
+        kryoHelper.readObject(instrumentedProcessModel.collectCoverage.startSuspending(lifetime, CollectCoverageParams(clazzByteArray)).coverageInfo)
     }
 }

utbot-instrumentation/src/main/kotlin/org/utbot/instrumentation/process/InstrumentedProcessRunner.kt

@@ -59,7 +59,7 @@ class InstrumentedProcessRunner {
     }
 
     companion object {
-        private fun suspendValue(): String = if (UtSettings.engineProcessDebugSuspendPolicy) "y" else "n"
+        private fun suspendValue(): String = if (UtSettings.suspendInstrumentedProcessExecutionInDebugMode) "y" else "n"
 
         private const val UTBOT_INSTRUMENTATION = "utbot-instrumentation"
         private const val ERRORS_FILE_PREFIX = "utbot-instrumentedprocess-errors"

utbot-instrumentation/src/main/kotlin/org/utbot/instrumentation/rd/InstrumentedProcess.kt

@@ -32,7 +32,7 @@ class InstrumentedProcess private constructor(
     val kryoHelper = KryoHelper(lifetime.createNested()).apply {
         classLoader?.let { setKryoClassLoader(it) }
     }
-    val chidlProcessModel: InstrumentedProcessModel = onSchedulerBlocking { protocol.instrumentedProcessModel }
+    val instrumentedProcessModel: InstrumentedProcessModel = onSchedulerBlocking { protocol.instrumentedProcessModel }
 
     companion object {
         suspend operator fun <TIResult, TInstrumentation : Instrumentation<TIResult>> invoke(
@@ -65,15 +65,15 @@ class InstrumentedProcess private constructor(
             }
 
             logger.trace("sending add paths")
-            proc.chidlProcessModel.addPaths.startSuspending(
+            proc.instrumentedProcessModel.addPaths.startSuspending(
                 proc.lifetime, AddPathsParams(
                     pathsToUserClasses,
                     pathsToDependencyClasses
                 )
             )
 
             logger.trace("sending instrumentation")
-            proc.chidlProcessModel.setInstrumentation.startSuspending(
+            proc.instrumentedProcessModel.setInstrumentation.startSuspending(
                 proc.lifetime, SetInstrumentationParams(
                     proc.kryoHelper.writeObject(instrumentation)
                 )

utbot-intellij/src/main/kotlin/org/utbot/intellij/plugin/process/EngineProcess.kt

@@ -90,7 +90,7 @@ class EngineProcess private constructor(val project: Project, rdProcess: Process
 
         private val log4j2ConfigSwitch = "-Dlog4j2.configurationFile=${log4j2ConfigFile.canonicalPath}"
 
-        private fun suspendValue(): String = if (UtSettings.engineProcessDebugSuspendPolicy) "y" else "n"
+        private fun suspendValue(): String = if (UtSettings.suspendEngineProcessExecutionInDebugMode) "y" else "n"
 
         private val debugArgument: String?
             get() = "-agentlib:jdwp=transport=dt_socket,server=y,suspend=${suspendValue()},quiet=y,address=${UtSettings.engineProcessDebugPort}"

utbot-rd/src/main/kotlin/org/utbot/rd/ClientProcessUtil.kt

@@ -30,7 +30,7 @@ internal fun childCreatedFileName(port: Int): String {
     return "$port.created"
 }
 
-internal fun signalInstrumentedReady(port: Int) {
+internal fun signalProcessReady(port: Int) {
     processSyncDirectory.mkdirs()
 
     val signalFile = File(processSyncDirectory, childCreatedFileName(port))
@@ -161,7 +161,7 @@ class ClientProtocolBuilder {
                 clientProtocol.block(synchronizer)
             }
 
-            signalInstrumentedReady(port)
+            signalProcessReady(port)
             logger.info { "signalled" }
             clientProtocol.synchronizationModel.synchronizationSignal.let { sync ->
                 val answerFromMainProcess = sync.adviseForConditionAsync(ldef) {

utbot-rd/src/main/kotlin/org/utbot/rd/LifetimedProcess.kt

@@ -4,6 +4,7 @@ import com.jetbrains.rd.util.lifetime.Lifetime
 import com.jetbrains.rd.util.lifetime.LifetimeDefinition
 import com.jetbrains.rd.util.lifetime.throwIfNotAlive
 import kotlinx.coroutines.delay
+import java.util.concurrent.ConcurrentSkipListSet
 import java.util.concurrent.TimeUnit
 import kotlin.concurrent.thread
 
@@ -90,7 +91,7 @@ class LifetimedProcessIml(override val process: Process, lifetime: Lifetime? = n
     }
 
     companion object {
-        private val allProcessList = mutableListOf<LifetimedProcess>()
+        private val allProcessList = ConcurrentSkipListSet<LifetimedProcess>()
 
         init {
             Runtime.getRuntime().addShutdownHook(thread(start = false) {

utbot-rd/src/main/kotlin/org/utbot/rd/RdSettingsContainer.kt

@@ -35,7 +35,7 @@ class RdSettingsContainer(val logger: KLogger, val key: String, val settingsMode
                 }
 
                 override fun setValue(thisRef: Any?, property: KProperty<*>, value: T) {
-                    throw NotImplementedError("Setting properties allowed only from plugin process")
+                    throw IllegalStateException("Setting properties allowed only from plugin process")
                 }
             }
         }

utbot-rd/src/main/kotlin/org/utbot/rd/UtRdCoroutineScope.kt

@@ -11,7 +11,7 @@ class UtRdCoroutineScope(lifetime: Lifetime) : RdCoroutineScope(lifetime) {
     companion object {
         val current = UtRdCoroutineScope(Lifetime.Eternal)
         fun initialize() {
-            // only to initialize load and initialize class
+            // only to load and initialize class
         }
     }