org.jetbrains.kotlinx.jupyter.exceptions.ReplEvalRuntimeException.kt Maven / Gradle / Ivy
The newest version!
package org.jetbrains.kotlinx.jupyter.exceptions
import org.jetbrains.kotlinx.jupyter.repl.CellErrorMetaData
/**
* Class wrapping metadata for locating the source of the error in the user's notebook.
*
* @param jupyterRequestCount User visible request count
* @param lineNumber line number as reported in the stack trace.
* @param visibleSourceLines Since the compiler might inject invisible code into the cell,
* [lineNumber] can sometimes point to a line outside the visible range. [visibleSourceLines] tracks
* the visible limit. Note, a compiler plugin might inject code in the middle of a users code.
* If this happens, there is no way to detect it, so for now, we ignore the possibility.
*/
class ErrorLocation(val jupyterRequestCount: Int, val lineNumber: Int, val visibleSourceLines: Int)
/**
* Thrown if the user's REPL code threw an exception at runtime.
*/
class ReplEvalRuntimeException(
fileExtension: String,
scriptFqnToJupyterExecutionCount: Map,
message: String,
cause: Throwable? = null,
) : ReplException(message, cause) {
// List of cell error locations for each line in the stacktrace. I.e.
// each index matches the current line index in `Exception.stackTraceToString()`
// There is only an entry if we can locate the cell and line number
// the exception line is referring to, otherwise it is null.
val cellErrorLocations: List =
if (cause != null) {
// Possible patterns we need to look out for:
// - Top-level cell code: `at Line_4_jupyter.(Line_4.jupyter.kts:7)`
// - Method in cell: `at Line_5_jupyter.methodName(Line_5.jupyter.kts:7)`
// - Class inside cell: `at Line_7_jupyter$ClassName.(Line_7.jupyter.kts:12)`
// - Lambda defined in cell: `at Line_4_jupyter$callback$1.invoke(Line_4.jupyter.kts:2)`
val pattern = "(?Line_\\d+_jupyter).*\\(Line_\\d+.$fileExtension:(?\\d+)\\)".toRegex()
// Search all exception causes all the way down for errors in the executed code.
cause.stackTraceToString().lines().mapIndexed { i, line ->
pattern.find(line)?.let { match: MatchResult ->
val scriptFQName: String? = match.groups["scriptFQN"]?.value
val data = scriptFqnToJupyterExecutionCount[scriptFQName]
val requestCount: Int? = data?.executionCount?.value
val lineNumber: Int? = match.groups["lineNumber"]?.value?.toInt()
val maxLines = data?.linesOfUserSourceCode ?: 0
if (requestCount != null && lineNumber != null) {
ErrorLocation(requestCount, lineNumber, maxLines)
} else {
null
}
}
}
} else {
emptyList()
}
override fun render(): String {
return cause?.messageAndStackTrace() ?: messageAndStackTrace()
}
}