Introduce commHandlers for kernel-provided functionality; support debugPortComm messages in kernel

Author: nikolay-egorov

jupyter-lib/shared-compiler/src/main/kotlin/org/jetbrains/kotlinx/jupyter/messaging/debugUtility.kt

@@ -0,0 +1,13 @@
+package org.jetbrains.kotlinx.jupyter.messaging
+
+import kotlinx.serialization.Serializable
+
+object ProvidedCommMessages {
+    const val OPEN_DEBUG_PORT_TARGET: String = "debug_port_request"
+}
+
+
+@Serializable
+class CommDebugPortReply(
+    val port: Int
+) : OkReply()

src/main/kotlin/org/jetbrains/kotlinx/jupyter/connection.kt

@@ -271,6 +271,9 @@ class JupyterConnectionImpl(
 
     override val stdinIn = StdinInputStream()
 
+    override val debugPort: Int?
+        get() = config.debugPort
+
     var contextMessage: Message? = null
 
     override val executor: JupyterExecutor = JupyterExecutorImpl()

src/main/kotlin/org/jetbrains/kotlinx/jupyter/messaging/JupyterConnectionInternal.kt

@@ -19,6 +19,8 @@ interface JupyterConnectionInternal : JupyterConnection {
     val executor: JupyterExecutor
     val stdinIn: InputStream
 
+    val debugPort: Int?
+
     fun sendStatus(status: KernelStatus, incomingMessage: Message? = null)
     fun doWrappedInBusyIdle(incomingMessage: Message? = null, action: () -> Unit)
 }

src/main/kotlin/org/jetbrains/kotlinx/jupyter/messaging/defaultCommHandlers.kt

@@ -0,0 +1,53 @@
+package org.jetbrains.kotlinx.jupyter.messaging
+
+import kotlinx.serialization.json.JsonObject
+import kotlinx.serialization.json.JsonPrimitive
+import org.jetbrains.kotlinx.jupyter.ReplForJupyterImpl
+import org.jetbrains.kotlinx.jupyter.api.libraries.Comm
+import org.jetbrains.kotlinx.jupyter.messaging.ProvidedCommMessages.OPEN_DEBUG_PORT_TARGET
+
+typealias CommMessageProcessCallback = (Comm, JsonObject, ReplForJupyterImpl) -> Unit
+
+abstract class DefaultCommHandler {
+    abstract val targetId: String
+
+    abstract val onReceiveAction: CommMessageProcessCallback
+
+    abstract fun registerAction(repl: ReplForJupyterImpl)
+}
+
+class DebugPortCommHandler : DefaultCommHandler() {
+    override val targetId: String
+        get() = OPEN_DEBUG_PORT_TARGET
+
+    override val onReceiveAction: CommMessageProcessCallback
+        get() = { comm, _, repl ->
+            comm.send(
+                JsonObject(
+                    mapOf(
+                        "port" to JsonPrimitive(repl.debugPort)
+                    )
+                )
+            )
+        }
+
+    override fun registerAction(repl: ReplForJupyterImpl) {
+        repl.notebook.commManager.registerCommTarget(targetId) { comm, d ->
+            onReceiveAction(comm, d, repl)
+
+            comm.onMessage {
+                onReceiveAction(comm, it, repl)
+            }
+        }
+    }
+}
+
+object ProvidedCommHandlersUtility {
+    private val providedComms = setOf<DefaultCommHandler>(DebugPortCommHandler())
+
+    fun registerKnownCommsHandlersOnStartUp(repl: ReplForJupyterImpl) {
+        providedComms.forEach {
+            it.registerAction(repl)
+        }
+    }
+}

src/main/kotlin/org/jetbrains/kotlinx/jupyter/repl.kt

@@ -53,6 +53,7 @@ import org.jetbrains.kotlinx.jupyter.magics.FullMagicsHandler
 import org.jetbrains.kotlinx.jupyter.magics.MagicsProcessor
 import org.jetbrains.kotlinx.jupyter.messaging.DisplayHandler
 import org.jetbrains.kotlinx.jupyter.messaging.NoOpDisplayHandler
+import org.jetbrains.kotlinx.jupyter.messaging.ProvidedCommHandlersUtility.registerKnownCommsHandlersOnStartUp
 import org.jetbrains.kotlinx.jupyter.repl.CellExecutor
 import org.jetbrains.kotlinx.jupyter.repl.CompletionResult
 import org.jetbrains.kotlinx.jupyter.repl.ContextUpdater
@@ -122,6 +123,7 @@ interface ReplOptions {
     var executedCodeLogging: ExecutedCodeLogging
     var writeCompiledClasses: Boolean
     var outputConfig: OutputConfig
+    val debugPort: Int?
 }
 
 interface ReplForJupyter {
@@ -186,7 +188,8 @@ class ReplForJupyterImpl(
     private val scriptReceivers: List<Any> = emptyList(),
     override val isEmbedded: Boolean = false,
     override val notebook: MutableNotebook,
-    override val librariesScanner: LibrariesScanner
+    override val librariesScanner: LibrariesScanner,
+    override val debugPort: Int? = null
 ) : ReplForJupyter, ReplOptions, BaseKernelHost, UserHandlesProvider {
 
     override val currentBranch: String
@@ -205,6 +208,10 @@ class ReplForJupyterImpl(
 
     private val resourcesProcessor = LibraryResourcesProcessorImpl()
 
+    init {
+        registerKnownCommsHandlersOnStartUp(this)
+    }
+
     override val sessionOptions: SessionOptions = object : SessionOptions {
         override var resolveSources: Boolean
             get() = resolver.resolveSources
@@ -414,7 +421,7 @@ class ReplForJupyterImpl(
     @Suppress("unused")
     private fun printUsagesInfo(cellId: Int, usedVariables: Set<String>?) {
         log.debug(buildString {
-            if (usedVariables == null || usedVariables.isEmpty()) {
+            if (usedVariables.isNullOrEmpty()) {
                 append("No usages for cell $cellId")
                 return@buildString
             }

src/main/kotlin/org/jetbrains/kotlinx/jupyter/repl/creating/MockJupyterConnection.kt

@@ -32,6 +32,8 @@ object MockJupyterConnection : JupyterConnectionInternal {
         get() = throw NotImplementedError()
     override val stdinIn: InputStream
         get() = throw NotImplementedError()
+    override val debugPort: Int?
+        get() = null
 
     override fun sendStatus(status: KernelStatus, incomingMessage: Message?) {
         throw NotImplementedError()

src/main/kotlin/org/jetbrains/kotlinx/jupyter/repl/creating/ReplFactory.kt

@@ -26,7 +26,8 @@ abstract class ReplFactory {
             scriptReceivers,
             isEmbedded,
             notebook,
-            librariesScanner
+            librariesScanner,
+            connection.debugPort
         )
     }
 

src/test/kotlin/org/jetbrains/kotlinx/jupyter/test/parseMagicsTests.kt

@@ -131,6 +131,7 @@ class ParseMagicsTests {
         override var executedCodeLogging = ExecutedCodeLogging.OFF
         override var writeCompiledClasses = false
         override var outputConfig = OutputConfig()
+        override val debugPort: Int? = null
     }
 
     private val options = TestReplOptions()