Support special characters in coroutine names in JSON dumps (#3747)

Kotlin · May 12, 2023 · 1aacb04 · 1aacb04
1 parent c8b3e5e
commit 1aacb04
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 4 deletions.
diff --git a/kotlinx-coroutines-core/jvm/src/debug/internal/DebugProbesImpl.kt b/kotlinx-coroutines-core/jvm/src/debug/internal/DebugProbesImpl.kt
@@ -182,8 +182,8 @@ internal object DebugProbesImpl {
         val coroutinesInfoAsJson = ArrayList<String>(size)
         for (info in coroutinesInfo) {
             val context = info.context
-            val name = context[CoroutineName.Key]?.name?.toStringWithQuotes()
-            val dispatcher = context[CoroutineDispatcher.Key]?.toStringWithQuotes()
+            val name = context[CoroutineName.Key]?.name?.toStringRepr()
+            val dispatcher = context[CoroutineDispatcher.Key]?.toStringRepr()
             coroutinesInfoAsJson.add(
                 """
                 {
@@ -219,7 +219,7 @@ internal object DebugProbesImpl {
                 {
                     "declaringClass": "${element.className}",
                     "methodName": "${element.methodName}",
-                    "fileName": ${element.fileName?.toStringWithQuotes()},
+                    "fileName": ${element.fileName?.toStringRepr()},
                     "lineNumber": ${element.lineNumber}
                 }
                 """.trimIndent()
@@ -229,7 +229,7 @@ internal object DebugProbesImpl {
         return "[${stackTraceElementsInfoAsJson.joinToString()}]"
     }
 
-    private fun Any.toStringWithQuotes() = "\"$this\""
+    private fun Any.toStringRepr() = toString().repr()
 
     /*
      * Internal (JVM-public) method used by IDEA debugger as of 1.4-M3.
@@ -590,3 +590,19 @@ internal object DebugProbesImpl {
 
     private val StackTraceElement.isInternalMethod: Boolean get() = className.startsWith("kotlinx.coroutines")
 }
+
+private fun String.repr(): String = buildString {
+    append('"')
+    for (c in this@repr) {
+        when (c) {
+            '"' -> append("\\\"")
+            '\\' -> append("\\\\")
+            '\b' -> append("\\b")
+            '\n' -> append("\\n")
+            '\r' -> append("\\r")
+            '\t' -> append("\\t")
+            else -> append(c)
+        }
+    }
+    append('"')
+}
diff --git a/kotlinx-coroutines-debug/test/DumpCoroutineInfoAsJsonAndReferencesTest.kt b/kotlinx-coroutines-debug/test/DumpCoroutineInfoAsJsonAndReferencesTest.kt
@@ -29,6 +29,10 @@ class DumpCoroutineInfoAsJsonAndReferencesTest : DebugTestBase() {
     fun testDumpOfNamedCoroutine() =
         runTestWithNamedDeferred("Name")
 
+    @Test
+    fun testDumpOfNamedCoroutineWithSpecialCharacters() =
+        runTestWithNamedDeferred("Name with\n \"special\" characters\\/\t\b")
+
     @Test
     fun testDumpWithNoCoroutines() {
         val dumpResult = DebugProbesImpl.dumpCoroutinesInfoAsJsonAndReferences()