azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[JS IR] Use a special executor for stepping tests

Browse Source 
This will hopefully fix flakiness for some tests
This commit is contained in:
Sergej Jaskiewicz
2022-08-26 19:44:21 +02:00
committed by Space
parent 6ebbe12d44
commit 17f22c7204
4 changed files with 119 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files
compiler/testData/debug/stepping/tryCatchFinally.kt
Vendored
+26 -1
View File
@@ -1,4 +1,4 @@
// IGNORE_BACKEND: JS_IR
// FILE: test.kt
fun foo() {
@@ -93,3 +93,28 @@ fun box() {
// test.kt:39 box
// EXPECTATIONS JS_IR
// test.kt:34 box
// test.kt:6 foo
// test.kt:26 mightThrow
// test.kt:14 foo
// test.kt:30 mightThrow2
// test.kt:13 foo
// test.kt:35 box
// test.kt:36 box
// test.kt:6 foo
// test.kt:26 mightThrow
// test.kt:14 foo
// test.kt:30 mightThrow2
// test.kt:30 mightThrow2
// test.kt:16 foo
// test.kt:13 foo
// test.kt:37 box
// test.kt:38 box
// test.kt:6 foo
// test.kt:26 mightThrow
// test.kt:26 mightThrow
// test.kt:14 foo
// test.kt:30 mightThrow2
// test.kt:30 mightThrow2
// test.kt:16 foo
// test.kt:13 foo
js/js.tests/test/org/jetbrains/kotlin/js/test/debugger/NodeJsInspectorClient.kt
+62 -39
View File
@@ -13,10 +13,7 @@ import kotlinx.serialization.SerializationException
import kotlinx.serialization.encodeToString
import kotlinx.serialization.json.Json
import org.jetbrains.kotlin.utils.addToStdlib.cast
import java.util.logging.ConsoleHandler
import java.util.logging.Level
import java.util.logging.Logger
import java.util.logging.MemoryHandler
import kotlin.coroutines.*
/**
@@ -59,21 +56,32 @@ class NodeJsInspectorClient(val scriptPath: String, val args: List<String>) {
}
})
context.listenForMessages { message ->
when (val response = decodeCDPResponse(message) { context.messageContinuations[it]!!.first }) {
is CDPResponse.Event -> onDebuggerEventCallback?.invoke(response.event)
is CDPResponse.MethodInvocationResult -> context.messageContinuations.remove(response.id)!!.second.resume(response.result)
is CDPResponse.Error -> context.messageContinuations[response.id]!!.second.resumeWithException(
IllegalStateException("error ${response.error.code}" + (response.error.message?.let { ": $it" } ?: ""))
)
}
context.waitingOnPredicate?.let { (predicate, continuation) ->
if (predicate()) {
context.waitingOnPredicate = null
continuation.resume(Unit)
try {
context.listenForMessages { message ->
when (val response = decodeCDPResponse(message) { context.messageContinuations[it]!!.encodingInfo }) {
is CDPResponse.Event -> onDebuggerEventCallback?.invoke(response.event)
is CDPResponse.MethodInvocationResult -> context.messageContinuations.remove(response.id)!!.continuation.resume(response.result)
is CDPResponse.Error -> context.messageContinuations[response.id]!!.let { (_, continuation, stackTrace) ->
continuation.resumeWithException(
IllegalStateException("error ${response.error.code}" + (response.error.message?.let { ": $it" } ?: "")).apply {
this.stackTrace = stackTrace
}
)
}
}
context.waitingOnPredicate?.let { (predicate, continuation, _) ->
if (predicate()) {
context.waitingOnPredicate = null
continuation.resume(Unit)
}
}
blockResult != null
}
blockResult != null
} catch (e: Exception) {
val callerStackTrace = context.messageContinuations.values.singleOrNull()?.stackTrace ?: context.waitingOnPredicate?.stackTrace
if (callerStackTrace != null)
e.stackTrace = callerStackTrace
throw e
}
return blockResult!!.getOrThrow()
@@ -94,16 +102,7 @@ private const val NODE_WS_DEBUG_URL_PREFIX = "Debugger listening on ws://"
*/
private class NodeJsInspectorClientContextImpl(engine: NodeJsInspectorClient) : NodeJsInspectorClientContext, CDPRequestEvaluator {
private val consoleLoggingHandler = ConsoleHandler().apply {
level = Level.FINER
}
private val memoryLoggingHandler = MemoryHandler(consoleLoggingHandler, 5000, Level.WARNING)
private val logger = Logger.getLogger(this::class.java.name).apply {
level = Level.FINER
addHandler(memoryLoggingHandler)
}
private val logger = Logger.getLogger(this::class.java.name)
private val nodeProcess = ProcessBuilder(
System.getProperty("javascript.engine.path.NodeJs"),
@@ -130,16 +129,31 @@ private class NodeJsInspectorClientContextImpl(engine: NodeJsInspectorClient) :
private val webSocketClient = HttpClient(CIO) {
install(WebSockets)
engine {
requestTimeout = 0
}
}
private var webSocketSession: DefaultClientWebSocketSession? = null
val messageContinuations = mutableMapOf<Int, Pair<CDPMethodCallEncodingInfo, Continuation<CDPMethodInvocationResult>>>()
data class MessageContinuation(
val encodingInfo: CDPMethodCallEncodingInfo,
val continuation: Continuation<CDPMethodInvocationResult>,
val stackTrace: Array<StackTraceElement>
)
val messageContinuations = mutableMapOf<Int, MessageContinuation>()
data class WaitingOnPredicate(
val predicate: () -> Boolean,
val continuation: Continuation<Unit>,
val stackTrace: Array<StackTraceElement>,
)
/**
* See [waitForConditionToBecomeTrue].
*/
var waitingOnPredicate: Pair<(() -> Boolean), Continuation<Unit>>? = null
var waitingOnPredicate: WaitingOnPredicate? = null
private var nextMessageId = 0
@@ -165,14 +179,9 @@ private class NodeJsInspectorClientContextImpl(engine: NodeJsInspectorClient) :
suspend fun listenForMessages(receiveMessage: (String) -> Boolean) {
val session = webSocketSession ?: error("Session closed")
do {
val message = try {
when (val frame = session.incoming.receive()) {
is Frame.Text -> frame.readText()
else -> error("Unexpected frame kind: $frame")
}
} catch (e: Exception) {
logger.log(Level.SEVERE, "Could not receive message", e)
throw e
val message = when (val frame = session.incoming.receive()) {
is Frame.Text -> frame.readText()
else -> error("Unexpected frame kind: $frame")
}
logger.finer {
"Received message:\n${prettyPrintJson(message)}"
@@ -186,9 +195,13 @@ private class NodeJsInspectorClientContextImpl(engine: NodeJsInspectorClient) :
override suspend fun waitForConditionToBecomeTrue(predicate: () -> Boolean) {
if (predicate()) return
// Save the stack trace to show it later. If the condition never becomes true due to an exception,
// this stack trace will be shown instead of some obscure coroutine-related one, which will make debugging easier.
val stacktrace = Thread.currentThread().stackTrace
suspendCoroutine { continuation ->
require(waitingOnPredicate == null) { "already waiting!" }
waitingOnPredicate = predicate to continuation
waitingOnPredicate = WaitingOnPredicate(predicate, continuation, stacktrace)
}
}
@@ -203,9 +216,14 @@ private class NodeJsInspectorClientContextImpl(engine: NodeJsInspectorClient) :
@Deprecated("Only for debugging purposes", level = DeprecationLevel.WARNING)
override suspend fun sendPlainTextMessage(methodName: String, paramsJson: String): String {
val messageId = nextMessageId++
// Save the stack trace to show it later. If we won't be able to receive a response for this message due to an exception,
// this stack trace will be shown instead of some obscure coroutine-related one, which will make debugging easier.
val stacktrace = Thread.currentThread().stackTrace
sendPlainTextMessage("""{"id":$messageId,"method":$methodName,"params":$paramsJson}""")
return suspendCoroutine { continuation ->
messageContinuations[messageId] = CDPMethodCallEncodingInfoPlainText to continuation
messageContinuations[messageId] = MessageContinuation(CDPMethodCallEncodingInfoPlainText, continuation, stacktrace)
}.cast<CDPMethodInvocationResultPlainText>().string
}
@@ -213,10 +231,15 @@ private class NodeJsInspectorClientContextImpl(engine: NodeJsInspectorClient) :
encodeMethodCallWithMessageId: (Int) -> Pair<String, CDPMethodCallEncodingInfo>
): CDPMethodInvocationResult {
val messageId = nextMessageId++
// Save the stack trace to show it later. If we won't be able to receive a response for this message due to an exception,
// this stack trace will be shown instead of some obscure coroutine-related one, which will make debugging easier.
val stacktrace = Thread.currentThread().stackTrace
val (encodedMessage, encodingInfo) = encodeMethodCallWithMessageId(messageId)
sendPlainTextMessage(encodedMessage)
return suspendCoroutine { continuation ->
messageContinuations[messageId] = encodingInfo to continuation
messageContinuations[messageId] = MessageContinuation(encodingInfo, continuation, stacktrace)
}
}
js/js.tests/test/org/jetbrains/kotlin/js/test/debugger/stepping_test_executor.js
+20
View File
@@ -0,0 +1,20 @@
/*
* Copyright 2010-2022 JetBrains s.r.o. and Kotlin Programming Language contributors.
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
*/
const vm = require('vm');
const fs = require('fs');
var testFilePath = process.argv[2];
const sandbox = {};
vm.createContext(sandbox);
const code = fs.readFileSync(testFilePath, 'utf-8');
try {
vm.runInContext(code, sandbox, testFilePath);
vm.runInContext('main.box()', sandbox);
} catch (e) {
// Ignore any exceptions
}
js/js.tests/test/org/jetbrains/kotlin/js/test/handlers/JsDebugRunner.kt
+11 -2
View File
@@ -4,6 +4,7 @@
*/
package org.jetbrains.kotlin.js.test.handlers
import kotlinx.coroutines.withTimeout
import org.jetbrains.kotlin.KtPsiSourceFileLinesMapping
import org.jetbrains.kotlin.ir.backend.js.transformers.irToJs.TranslationMode
import org.jetbrains.kotlin.js.parser.sourcemaps.*
@@ -104,6 +105,8 @@ class JsDebugRunner(testServices: TestServices) : AbstractJsArtifactsCollector(t
debugger.stepInto()
waitForResumeEvent()
}
debugger.resume()
waitForResumeEvent()
}
}
checkSteppingTestResult(
@@ -216,7 +219,8 @@ class JsDebugRunner(testServices: TestServices) : AbstractJsArtifactsCollector(t
*/
private class NodeJsDebuggerFacade(jsFilePath: String) {
private val inspector = NodeJsInspectorClient("js/js.translator/testData/runIrTestInNode.js", listOf(jsFilePath))
private val inspector =
NodeJsInspectorClient("js/js.tests/test/org/jetbrains/kotlin/js/test/debugger/stepping_test_executor.js", listOf(jsFilePath))
private val scriptUrls = mutableMapOf<Runtime.ScriptId, String>()
@@ -228,12 +232,15 @@ private class NodeJsDebuggerFacade(jsFilePath: String) {
is Debugger.Event.ScriptParsed -> {
scriptUrls[event.scriptId] = event.url
}
is Debugger.Event.Paused -> {
pausedEvent = event
}
is Debugger.Event.Resumed -> {
pausedEvent = null
}
else -> {}
}
}
@@ -248,7 +255,9 @@ private class NodeJsDebuggerFacade(jsFilePath: String) {
runtime.runIfWaitingForDebugger()
waitForPauseEvent { it.reason == Debugger.PauseReason.BREAK_ON_START }
body()
withTimeout(30000) {
body()
}
}
fun scriptUrlByScriptId(scriptId: Runtime.ScriptId) = scriptUrls[scriptId] ?: error("unknown scriptId")