Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SPARK-45317][SQL][CONNECT] Handle null filename in stack traces of exceptions #43103

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,34 @@ import org.apache.spark.sql.types._

class ClientE2ETestSuite extends RemoteSparkSession with SQLHelper with PrivateMethodTester {

test(s"throw SparkException with null filename in stack trace elements") {
withSQLConf("spark.sql.connect.enrichError.enabled" -> "true") {
val session = spark
import session.implicits._

val throwException =
udf((_: String) => {
val testError = new SparkException("test")
val stackTrace = testError.getStackTrace()
stackTrace(0) = new StackTraceElement(
stackTrace(0).getClassName,
stackTrace(0).getMethodName,
null,
stackTrace(0).getLineNumber)
testError.setStackTrace(stackTrace)
throw testError
})

val ex = intercept[SparkException] {
Seq("1").toDS.withColumn("udf_val", throwException($"value")).collect()
}

assert(ex.getCause.isInstanceOf[SparkException])
assert(ex.getCause.getStackTrace().length > 0)
assert(ex.getCause.getStackTrace()(0).getFileName == null)
}
}

for (enrichErrorEnabled <- Seq(false, true)) {
test(s"cause exception - ${enrichErrorEnabled}") {
withSQLConf("spark.sql.connect.enrichError.enabled" -> enrichErrorEnabled.toString) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -808,7 +808,7 @@ message FetchErrorDetailsResponse {
string method_name = 2;

// The name of the file containing the execution point.
string file_name = 3;
optional string file_name = 3;

// The line number of the source line containing the execution point.
int32 line_number = 4;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ private object GrpcExceptionConverter {
new StackTraceElement(
stackTraceElement.getDeclaringClass,
stackTraceElement.getMethodName,
stackTraceElement.getFileName,
if (stackTraceElement.hasFileName) stackTraceElement.getFileName else null,
stackTraceElement.getLineNumber)
})
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,13 +92,17 @@ private[connect] object ErrorUtils extends Logging {
builder.addAllStackTrace(
currentError.getStackTrace
.map { stackTraceElement =>
FetchErrorDetailsResponse.StackTraceElement
val stackTraceBuilder = FetchErrorDetailsResponse.StackTraceElement
.newBuilder()
.setDeclaringClass(stackTraceElement.getClassName)
.setMethodName(stackTraceElement.getMethodName)
.setFileName(stackTraceElement.getFileName)
.setLineNumber(stackTraceElement.getLineNumber)
.build()

if (stackTraceElement.getFileName != null) {
stackTraceBuilder.setFileName(stackTraceElement.getFileName)
}

stackTraceBuilder.build()
}
.toIterable
.asJava)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,4 +163,29 @@ class FetchErrorDetailsHandlerSuite extends SharedSparkSession with ResourceHelp
testError = new Exception(s"test$i", testError)
}
}

test("null filename in stack trace elements") {
val testError = new Exception("test")
val stackTrace = testError.getStackTrace()
stackTrace(0) = new StackTraceElement(
stackTrace(0).getClassName,
stackTrace(0).getMethodName,
null,
stackTrace(0).getLineNumber)
testError.setStackTrace(stackTrace)

val errorId = UUID.randomUUID().toString()

SparkConnectService
.getOrCreateIsolatedSession(userId, sessionId)
.errorIdToError
.put(errorId, testError)

val response = fetchErrorDetails(userId, sessionId, errorId)
assert(response.hasRootErrorIdx)
assert(response.getRootErrorIdx == 0)

assert(response.getErrors(0).getStackTraceCount > 0)
assert(!response.getErrors(0).getStackTrace(0).hasFileName)
}
}
14 changes: 7 additions & 7 deletions python/pyspark/sql/connect/proto/base_pb2.py

Large diffs are not rendered by default.

13 changes: 12 additions & 1 deletion python/pyspark/sql/connect/proto/base_pb2.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -2816,12 +2816,20 @@ class FetchErrorDetailsResponse(google.protobuf.message.Message):
*,
declaring_class: builtins.str = ...,
method_name: builtins.str = ...,
file_name: builtins.str = ...,
file_name: builtins.str | None = ...,
line_number: builtins.int = ...,
) -> None: ...
def HasField(
self,
field_name: typing_extensions.Literal[
"_file_name", b"_file_name", "file_name", b"file_name"
],
) -> builtins.bool: ...
def ClearField(
self,
field_name: typing_extensions.Literal[
"_file_name",
b"_file_name",
"declaring_class",
b"declaring_class",
"file_name",
Expand All @@ -2832,6 +2840,9 @@ class FetchErrorDetailsResponse(google.protobuf.message.Message):
b"method_name",
],
) -> None: ...
def WhichOneof(
self, oneof_group: typing_extensions.Literal["_file_name", b"_file_name"]
) -> typing_extensions.Literal["file_name"] | None: ...

class Error(google.protobuf.message.Message):
"""Error defines the schema for the representing exception."""
Expand Down