You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by GitBox <gi...@apache.org> on 2022/09/22 11:15:56 UTC
[GitHub] [spark] cloud-fan opened a new pull request, #37969: [SPARK-40530][SQL] Add error-related developer APIs
cloud-fan opened a new pull request, #37969:
URL: https://github.com/apache/spark/pull/37969
<!--
Thanks for sending a pull request! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
4. Be sure to keep the PR description updated to reflect all changes.
5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a faster review.
7. If you want to add a new configuration, please read the guideline first for naming configurations in
'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
8. If you want to add or modify an error type or message, please read the guideline first in
'core/src/main/resources/error/README.md'.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
2. If you fix some SQL features, you can provide some references of other DBMSes.
3. If there is design documentation, please add the link.
4. If there is a discussion in the mailing list, please add the link.
-->
Third-party Spark plugins may define their own errors using the same framework as Spark: put error definition in json files. This PR moves some error-related code to a new file and marks them as developer APIs, so that others can reuse them instead of writing its own json reader.
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
make it easier for Spark plugins to define errors.
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as the documentation fix.
If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to the released Spark versions or within the unreleased branches such as master.
If no, write 'No'.
-->
no
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why it was difficult to add.
If benchmark tests were added, please run the benchmarks in GitHub Actions for the consistent environment, and the instructions could accord to: https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
-->
existing tests
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] MaxGekk commented on a diff in pull request #37969: [SPARK-40530][SQL] Add error-related developer APIs
Posted by GitBox <gi...@apache.org>.
MaxGekk commented on code in PR #37969:
URL: https://github.com/apache/spark/pull/37969#discussion_r977867254
##########
core/src/main/scala/org/apache/spark/SparkThrowableHelper.scala:
##########
@@ -178,9 +90,7 @@ private[spark] object SparkThrowableHelper {
val errorSubClass = e.getErrorSubClass
if (errorSubClass != null) g.writeStringField("errorSubClass", errorSubClass)
if (format == STANDARD) {
- val errorInfo = errorClassToInfoMap.getOrElse(errorClass,
- throw SparkException.internalError(s"Cannot find the error class '$errorClass'"))
- g.writeStringField("message", errorInfo.messageFormat)
+ g.writeStringField("message", e.getMessage)
Review Comment:
> The STANDARD mode is a combination of PRETTY and MINIMAL mode
From where it comes? In the current implementation, the info is orthogonal. If you need, you can substitute params your self as you want.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on a diff in pull request #37969: [SPARK-40530][SQL] Add error-related developer APIs
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on code in PR #37969:
URL: https://github.com/apache/spark/pull/37969#discussion_r978415268
##########
core/src/main/scala/org/apache/spark/ErrorClassesJSONReader.scala:
##########
@@ -0,0 +1,114 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.spark
+
+import java.net.URL
+
+import scala.collection.JavaConverters._
+import scala.collection.immutable.SortedMap
+
+import com.fasterxml.jackson.annotation.JsonIgnore
+import com.fasterxml.jackson.core.`type`.TypeReference
+import com.fasterxml.jackson.databind.json.JsonMapper
+import com.fasterxml.jackson.module.scala.DefaultScalaModule
+import org.apache.commons.text.StringSubstitutor
+
+import org.apache.spark.annotation.DeveloperApi
+
+/**
+ * A reader to load error information from one or more JSON files. Note that, if one error appears
+ * in more than one JSON files, the latter wins.
+ */
+@DeveloperApi
+class ErrorClassesJsonReader(jsonFileURLs: Seq[URL]) {
+ assert(jsonFileURLs.nonEmpty)
+
+ private def readAsMap(url: URL): SortedMap[String, ErrorInfo] = {
+ val mapper: JsonMapper = JsonMapper.builder()
+ .addModule(DefaultScalaModule)
+ .build()
+ mapper.readValue(url, new TypeReference[SortedMap[String, ErrorInfo]]() {})
+ }
+
+ // Exposed for testing
+ private[spark] val errorInfoMap = jsonFileURLs.map(readAsMap).reduce(_ ++ _)
+
+ def getErrorMessage(errorClass: String, messageParameters: Map[String, String]): String = {
+ val errorClasses = errorClass.split("\\.")
+ assert(errorClasses.length == 1 || errorClasses.length == 2)
+
+ val mainErrorClass = errorClasses.head
+ val subErrorClass = errorClasses.tail.headOption
+ val errorInfo = errorInfoMap.getOrElse(
+ mainErrorClass,
+ throw SparkException.internalError(s"Cannot find error class '$errorClass'"))
Review Comment:
I think it's better to include more information and put the full error class (main + sub)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on a diff in pull request #37969: [SPARK-40530][SQL] Add error-related developer APIs
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on code in PR #37969:
URL: https://github.com/apache/spark/pull/37969#discussion_r977762334
##########
core/src/main/scala/org/apache/spark/SparkThrowableHelper.scala:
##########
@@ -69,37 +31,8 @@ object ErrorMessageFormat extends Enumeration {
* construct error messages.
*/
private[spark] object SparkThrowableHelper {
- val errorClassesUrl: URL =
- Utils.getSparkClassLoader.getResource("error/error-classes.json")
- val errorClassToInfoMap: SortedMap[String, ErrorInfo] = {
- val mapper: JsonMapper = JsonMapper.builder()
- .addModule(DefaultScalaModule)
- .build()
- mapper.readValue(errorClassesUrl, new TypeReference[SortedMap[String, ErrorInfo]]() {})
- }
-
- def getParameterNames(errorClass: String, errorSubCLass: String): Array[String] = {
Review Comment:
this method is called no where.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on a diff in pull request #37969: [SPARK-40530][SQL] Add error-related developer APIs
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on code in PR #37969:
URL: https://github.com/apache/spark/pull/37969#discussion_r977525688
##########
core/src/main/scala/org/apache/spark/SparkThrowableHelper.scala:
##########
@@ -69,37 +33,8 @@ object ErrorMessageFormat extends Enumeration {
* construct error messages.
*/
private[spark] object SparkThrowableHelper {
- val errorClassesUrl: URL =
- Utils.getSparkClassLoader.getResource("error/error-classes.json")
- val errorClassToInfoMap: SortedMap[String, ErrorInfo] = {
- val mapper: JsonMapper = JsonMapper.builder()
- .addModule(DefaultScalaModule)
- .build()
- mapper.readValue(errorClassesUrl, new TypeReference[SortedMap[String, ErrorInfo]]() {})
- }
-
- def getParameterNames(errorClass: String, errorSubCLass: String): Array[String] = {
Review Comment:
not related to this PR, but I found this method is not called anywhere.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] viirya commented on a diff in pull request #37969: [SPARK-40530][SQL] Add error-related developer APIs
Posted by GitBox <gi...@apache.org>.
viirya commented on code in PR #37969:
URL: https://github.com/apache/spark/pull/37969#discussion_r978093752
##########
core/src/main/scala/org/apache/spark/ErrorClassesJSONReader.scala:
##########
@@ -0,0 +1,114 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.spark
+
+import java.net.URL
+
+import scala.collection.JavaConverters._
+import scala.collection.immutable.SortedMap
+
+import com.fasterxml.jackson.annotation.JsonIgnore
+import com.fasterxml.jackson.core.`type`.TypeReference
+import com.fasterxml.jackson.databind.json.JsonMapper
+import com.fasterxml.jackson.module.scala.DefaultScalaModule
+import org.apache.commons.text.StringSubstitutor
+
+import org.apache.spark.annotation.DeveloperApi
+
+/**
+ * A reader to load error information from one or more JSON files. Note that, if one error appears
+ * in more than one JSON files, the latter wins.
+ */
+@DeveloperApi
+class ErrorClassesJsonReader(jsonFileURLs: Seq[URL]) {
+ assert(jsonFileURLs.nonEmpty)
+
+ private def readAsMap(url: URL): SortedMap[String, ErrorInfo] = {
+ val mapper: JsonMapper = JsonMapper.builder()
+ .addModule(DefaultScalaModule)
+ .build()
+ mapper.readValue(url, new TypeReference[SortedMap[String, ErrorInfo]]() {})
+ }
+
+ // Exposed for testing
+ private[spark] val errorInfoMap = jsonFileURLs.map(readAsMap).reduce(_ ++ _)
+
+ def getErrorMessage(errorClass: String, messageParameters: Map[String, String]): String = {
+ val errorClasses = errorClass.split("\\.")
+ assert(errorClasses.length == 1 || errorClasses.length == 2)
+
+ val mainErrorClass = errorClasses.head
+ val subErrorClass = errorClasses.tail.headOption
+ val errorInfo = errorInfoMap.getOrElse(
+ mainErrorClass,
+ throw SparkException.internalError(s"Cannot find error class '$errorClass'"))
+ assert(errorInfo.subClass.isDefined == subErrorClass.isDefined)
+
+ val finalFormat = if (subErrorClass.isEmpty) {
+ errorInfo.messageFormat
+ } else {
+ val errorSubInfo = errorInfo.subClass.get.getOrElse(
+ subErrorClass.get,
+ throw SparkException.internalError(s"Cannot find sub error class '${subErrorClass.get}'"))
Review Comment:
Why not keep IllegalArgumentException?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on a diff in pull request #37969: [SPARK-40530][SQL] Add error-related developer APIs
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on code in PR #37969:
URL: https://github.com/apache/spark/pull/37969#discussion_r978416368
##########
core/src/main/scala/org/apache/spark/SparkThrowableHelper.scala:
##########
@@ -178,9 +90,7 @@ private[spark] object SparkThrowableHelper {
val errorSubClass = e.getErrorSubClass
if (errorSubClass != null) g.writeStringField("errorSubClass", errorSubClass)
if (format == STANDARD) {
- val errorInfo = errorClassToInfoMap.getOrElse(errorClass,
- throw SparkException.internalError(s"Cannot find the error class '$errorClass'"))
- g.writeStringField("message", errorInfo.messageFormat)
+ g.writeStringField("message", e.getMessage)
Review Comment:
Makes sense, we should allow the caller side to do substitution as they want.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] viirya commented on a diff in pull request #37969: [SPARK-40530][SQL] Add error-related developer APIs
Posted by GitBox <gi...@apache.org>.
viirya commented on code in PR #37969:
URL: https://github.com/apache/spark/pull/37969#discussion_r978065616
##########
core/src/main/scala/org/apache/spark/ErrorClassesJSONReader.scala:
##########
@@ -0,0 +1,114 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.spark
+
+import java.net.URL
+
+import scala.collection.JavaConverters._
+import scala.collection.immutable.SortedMap
+
+import com.fasterxml.jackson.annotation.JsonIgnore
+import com.fasterxml.jackson.core.`type`.TypeReference
+import com.fasterxml.jackson.databind.json.JsonMapper
+import com.fasterxml.jackson.module.scala.DefaultScalaModule
+import org.apache.commons.text.StringSubstitutor
+
+import org.apache.spark.annotation.DeveloperApi
+
+/**
+ * A reader to load error information from one or more JSON files. Note that, if one error appears
+ * in more than one JSON files, the latter wins.
+ */
+@DeveloperApi
+class ErrorClassesJsonReader(jsonFileURLs: Seq[URL]) {
+ assert(jsonFileURLs.nonEmpty)
+
+ private def readAsMap(url: URL): SortedMap[String, ErrorInfo] = {
+ val mapper: JsonMapper = JsonMapper.builder()
+ .addModule(DefaultScalaModule)
+ .build()
+ mapper.readValue(url, new TypeReference[SortedMap[String, ErrorInfo]]() {})
+ }
+
+ // Exposed for testing
+ private[spark] val errorInfoMap = jsonFileURLs.map(readAsMap).reduce(_ ++ _)
+
+ def getErrorMessage(errorClass: String, messageParameters: Map[String, String]): String = {
+ val errorClasses = errorClass.split("\\.")
+ assert(errorClasses.length == 1 || errorClasses.length == 2)
+
+ val mainErrorClass = errorClasses.head
+ val subErrorClass = errorClasses.tail.headOption
+ val errorInfo = errorInfoMap.getOrElse(
+ mainErrorClass,
+ throw SparkException.internalError(s"Cannot find error class '$errorClass'"))
Review Comment:
Here should be `mainErrorClass`? in the internal error message?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] viirya commented on a diff in pull request #37969: [SPARK-40530][SQL] Add error-related developer APIs
Posted by GitBox <gi...@apache.org>.
viirya commented on code in PR #37969:
URL: https://github.com/apache/spark/pull/37969#discussion_r978094495
##########
core/src/test/scala/org/apache/spark/SparkThrowableSuite.scala:
##########
@@ -137,22 +139,22 @@ class SparkThrowableSuite extends SparkFunSuite {
.addModule(DefaultScalaModule)
.enable(SerializationFeature.INDENT_OUTPUT)
.build()
- mapper.writeValue(tmpFile, errorClassToInfoMap)
+ mapper.writeValue(tmpFile, errorReader.errorInfoMap)
val rereadErrorClassToInfoMap = mapper.readValue(
tmpFile, new TypeReference[Map[String, ErrorInfo]]() {})
- assert(rereadErrorClassToInfoMap == errorClassToInfoMap)
+ assert(rereadErrorClassToInfoMap == errorReader.errorInfoMap)
}
test("Check if error class is missing") {
- val ex1 = intercept[IllegalArgumentException] {
+ val ex1 = intercept[SparkException] {
Review Comment:
Related to https://github.com/apache/spark/pull/37969/files#r978093752.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] viirya commented on a diff in pull request #37969: [SPARK-40530][SQL] Add error-related developer APIs
Posted by GitBox <gi...@apache.org>.
viirya commented on code in PR #37969:
URL: https://github.com/apache/spark/pull/37969#discussion_r978064295
##########
core/src/main/scala/org/apache/spark/ErrorClassesJSONReader.scala:
##########
@@ -0,0 +1,114 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.spark
+
+import java.net.URL
+
+import scala.collection.JavaConverters._
+import scala.collection.immutable.SortedMap
+
+import com.fasterxml.jackson.annotation.JsonIgnore
+import com.fasterxml.jackson.core.`type`.TypeReference
+import com.fasterxml.jackson.databind.json.JsonMapper
+import com.fasterxml.jackson.module.scala.DefaultScalaModule
+import org.apache.commons.text.StringSubstitutor
+
+import org.apache.spark.annotation.DeveloperApi
+
+/**
+ * A reader to load error information from one or more JSON files. Note that, if one error appears
+ * in more than one JSON files, the latter wins.
+ */
+@DeveloperApi
Review Comment:
As a developer API, do we need to briefly describe the error JSON format here?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on a diff in pull request #37969: [SPARK-40530][SQL] Add error-related developer APIs
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on code in PR #37969:
URL: https://github.com/apache/spark/pull/37969#discussion_r978415586
##########
core/src/main/scala/org/apache/spark/ErrorClassesJSONReader.scala:
##########
@@ -0,0 +1,114 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.spark
+
+import java.net.URL
+
+import scala.collection.JavaConverters._
+import scala.collection.immutable.SortedMap
+
+import com.fasterxml.jackson.annotation.JsonIgnore
+import com.fasterxml.jackson.core.`type`.TypeReference
+import com.fasterxml.jackson.databind.json.JsonMapper
+import com.fasterxml.jackson.module.scala.DefaultScalaModule
+import org.apache.commons.text.StringSubstitutor
+
+import org.apache.spark.annotation.DeveloperApi
+
+/**
+ * A reader to load error information from one or more JSON files. Note that, if one error appears
+ * in more than one JSON files, the latter wins.
+ */
+@DeveloperApi
+class ErrorClassesJsonReader(jsonFileURLs: Seq[URL]) {
+ assert(jsonFileURLs.nonEmpty)
+
+ private def readAsMap(url: URL): SortedMap[String, ErrorInfo] = {
+ val mapper: JsonMapper = JsonMapper.builder()
+ .addModule(DefaultScalaModule)
+ .build()
+ mapper.readValue(url, new TypeReference[SortedMap[String, ErrorInfo]]() {})
+ }
+
+ // Exposed for testing
+ private[spark] val errorInfoMap = jsonFileURLs.map(readAsMap).reduce(_ ++ _)
+
+ def getErrorMessage(errorClass: String, messageParameters: Map[String, String]): String = {
+ val errorClasses = errorClass.split("\\.")
+ assert(errorClasses.length == 1 || errorClasses.length == 2)
+
+ val mainErrorClass = errorClasses.head
+ val subErrorClass = errorClasses.tail.headOption
+ val errorInfo = errorInfoMap.getOrElse(
+ mainErrorClass,
+ throw SparkException.internalError(s"Cannot find error class '$errorClass'"))
+ assert(errorInfo.subClass.isDefined == subErrorClass.isDefined)
+
+ val finalFormat = if (subErrorClass.isEmpty) {
+ errorInfo.messageFormat
+ } else {
+ val errorSubInfo = errorInfo.subClass.get.getOrElse(
+ subErrorClass.get,
+ throw SparkException.internalError(s"Cannot find sub error class '${subErrorClass.get}'"))
Review Comment:
Because this means a bug and it's better to throw intenal error.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] MaxGekk commented on a diff in pull request #37969: [SPARK-40530][SQL] Add error-related developer APIs
Posted by GitBox <gi...@apache.org>.
MaxGekk commented on code in PR #37969:
URL: https://github.com/apache/spark/pull/37969#discussion_r978508477
##########
core/src/test/scala/org/apache/spark/SparkThrowableSuite.scala:
##########
@@ -321,4 +323,22 @@ class SparkThrowableSuite extends SparkFunSuite {
| }
|}""".stripMargin)
}
+
+ test("overwrite error classes") {
+ withTempDir { dir =>
+ val json = new File(dir, "errors.json")
+ FileUtils.writeStringToFile(json,
+ """
+ |{
+ | "DIVIDE_BY_ZERO" : {
+ | "message" : [
+ | "abc"
+ | ]
+ | }
+ |}
+ |""".stripMargin)
+ val reader = new ErrorClassesJsonReader(Seq(errorJsonFilePath.toUri.toURL, json.toURL))
Review Comment:
Do you use the existing JSON file? How can you guarantee that one JSON overrides the standard one? Maybe you will add small one for testing to check that it overrides error-classes.json?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on pull request #37969: [SPARK-40530][SQL] Add error-related developer APIs
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on PR #37969:
URL: https://github.com/apache/spark/pull/37969#issuecomment-1254880689
cc @MaxGekk @viirya
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on a diff in pull request #37969: [SPARK-40530][SQL] Add error-related developer APIs
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on code in PR #37969:
URL: https://github.com/apache/spark/pull/37969#discussion_r979647477
##########
core/src/test/scala/org/apache/spark/SparkThrowableSuite.scala:
##########
@@ -321,4 +323,22 @@ class SparkThrowableSuite extends SparkFunSuite {
| }
|}""".stripMargin)
}
+
+ test("overwrite error classes") {
+ withTempDir { dir =>
+ val json = new File(dir, "errors.json")
+ FileUtils.writeStringToFile(json,
+ """
+ |{
+ | "DIVIDE_BY_ZERO" : {
+ | "message" : [
+ | "abc"
+ | ]
+ | }
+ |}
+ |""".stripMargin)
+ val reader = new ErrorClassesJsonReader(Seq(errorJsonFilePath.toUri.toURL, json.toURL))
Review Comment:
This test uses 2 JSON files: the existing official one and a temporary one which was written in this test.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on a diff in pull request #37969: [SPARK-40530][SQL] Add error-related developer APIs
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on code in PR #37969:
URL: https://github.com/apache/spark/pull/37969#discussion_r978429407
##########
core/src/main/scala/org/apache/spark/ErrorClassesJSONReader.scala:
##########
@@ -0,0 +1,114 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.spark
+
+import java.net.URL
+
+import scala.collection.JavaConverters._
+import scala.collection.immutable.SortedMap
+
+import com.fasterxml.jackson.annotation.JsonIgnore
+import com.fasterxml.jackson.core.`type`.TypeReference
+import com.fasterxml.jackson.databind.json.JsonMapper
+import com.fasterxml.jackson.module.scala.DefaultScalaModule
+import org.apache.commons.text.StringSubstitutor
+
+import org.apache.spark.annotation.DeveloperApi
+
+/**
+ * A reader to load error information from one or more JSON files. Note that, if one error appears
+ * in more than one JSON files, the latter wins.
+ */
+@DeveloperApi
Review Comment:
Added the reference to the readme file of the error framework.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on a diff in pull request #37969: [SPARK-40530][SQL] Add error-related developer APIs
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on code in PR #37969:
URL: https://github.com/apache/spark/pull/37969#discussion_r977763652
##########
core/src/main/scala/org/apache/spark/SparkThrowableHelper.scala:
##########
@@ -178,9 +90,7 @@ private[spark] object SparkThrowableHelper {
val errorSubClass = e.getErrorSubClass
if (errorSubClass != null) g.writeStringField("errorSubClass", errorSubClass)
if (format == STANDARD) {
- val errorInfo = errorClassToInfoMap.getOrElse(errorClass,
- throw SparkException.internalError(s"Cannot find the error class '$errorClass'"))
- g.writeStringField("message", errorInfo.messageFormat)
+ g.writeStringField("message", e.getMessage)
Review Comment:
@MaxGekk I think this is a mistake. The STANDARD mode is a combine of PRETTY and MINIMAL mode: it can get all the structured information, as well as the original pretty message.
##########
core/src/main/scala/org/apache/spark/SparkThrowableHelper.scala:
##########
@@ -178,9 +90,7 @@ private[spark] object SparkThrowableHelper {
val errorSubClass = e.getErrorSubClass
if (errorSubClass != null) g.writeStringField("errorSubClass", errorSubClass)
if (format == STANDARD) {
- val errorInfo = errorClassToInfoMap.getOrElse(errorClass,
- throw SparkException.internalError(s"Cannot find the error class '$errorClass'"))
- g.writeStringField("message", errorInfo.messageFormat)
+ g.writeStringField("message", e.getMessage)
Review Comment:
@MaxGekk I think this is a mistake. The STANDARD mode is a combination of PRETTY and MINIMAL mode: it can get all the structured information, as well as the original pretty message.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] MaxGekk commented on a diff in pull request #37969: [SPARK-40530][SQL] Add error-related developer APIs
Posted by GitBox <gi...@apache.org>.
MaxGekk commented on code in PR #37969:
URL: https://github.com/apache/spark/pull/37969#discussion_r977867254
##########
core/src/main/scala/org/apache/spark/SparkThrowableHelper.scala:
##########
@@ -178,9 +90,7 @@ private[spark] object SparkThrowableHelper {
val errorSubClass = e.getErrorSubClass
if (errorSubClass != null) g.writeStringField("errorSubClass", errorSubClass)
if (format == STANDARD) {
- val errorInfo = errorClassToInfoMap.getOrElse(errorClass,
- throw SparkException.internalError(s"Cannot find the error class '$errorClass'"))
- g.writeStringField("message", errorInfo.messageFormat)
+ g.writeStringField("message", e.getMessage)
Review Comment:
> The STANDARD mode is a combination of PRETTY and MINIMAL mode
From where it comes? In the current implementation, the info is orthogonal. If you need, you can substitute params yourself as you want.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on pull request #37969: [SPARK-40530][SQL] Add error-related developer APIs
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on PR #37969:
URL: https://github.com/apache/spark/pull/37969#issuecomment-1257593431
thanks for review, merging to master!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan closed pull request #37969: [SPARK-40530][SQL] Add error-related developer APIs
Posted by GitBox <gi...@apache.org>.
cloud-fan closed pull request #37969: [SPARK-40530][SQL] Add error-related developer APIs
URL: https://github.com/apache/spark/pull/37969
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org