You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "vladanvasi-db (via GitHub)" <gi...@apache.org> on 2024/08/28 08:59:27 UTC
[PR] [ES-1203248] Modified UnivocityParser to throw runtime exceptions caused by ArrayIndexOutOfBounds with more user-oriented messages [spark]
vladanvasi-db opened a new pull request, #47906:
URL: https://github.com/apache/spark/pull/47906
…wn it with more descriptive message
<!--
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
'common/utils/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.
-->
I propose to catch and rethrow runtime `ArrayIndexOutOfBounds` exceptions in the `UnivocityParser` class - `parse` method, but with more user-oriented messages. Instead of throwing exceptions in the original format, I propose to inform the users which csv record caused the error.
### 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.
-->
Proper informing of users' errors improves user experience. Instead of throwing `ArrayIndexOutOfBounds` exception without clear reason why it happened, proposed changes throw `SparkRuntimeException` with the message that includes original csv line which caused the error.
### 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'.
-->
This PR introduces a user-facing change which happens when `UnivocityParser` parses malformed csv line with from the input. More specifically, the change is reproduces in the test case within `UnivocityParserSuite` when user specifies `maxColumns` in parser options and parsed csv record has more columns. Instead of resulting in `ArrayIndexOutOfBounds` like mentioned in the HMR ticket, users now get `SparkRuntimeException` with message that contains the input line which caused the error.
### 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.
-->
This patch was tested in `UnivocityParserSuite`. Test named "Array index out of bounds when parsing CSV with more columns than expected" covers this patch. Additionally, test for bad records in `UnivocityParser`'s `PERMISSIVE` mode is added to confirm that `BadRecordException` is being thrown properly.
### Was this patch authored or co-authored using generative AI tooling?
<!--
If generative AI tooling has been used in the process of authoring this patch, please include the
phrase: 'Generated-by: ' followed by the name of the tool and its version.
If no, write 'No'.
Please refer to the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) for details.
-->
No
--
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
Re: [PR] [SPARK-49444][SQL] Modified UnivocityParser to throw runtime exceptions caused by ArrayIndexOutOfBounds with more user-oriented messages [spark]
Posted by "cloud-fan (via GitHub)" <gi...@apache.org>.
cloud-fan commented on PR #47906:
URL: https://github.com/apache/spark/pull/47906#issuecomment-2377223419
thanks, 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
Re: [PR] [SPARK-49444][SQL] Modified UnivocityParser to throw runtime exceptions caused by ArrayIndexOutOfBounds with more user-oriented messages [spark]
Posted by "MaxGekk (via GitHub)" <gi...@apache.org>.
MaxGekk commented on code in PR #47906:
URL: https://github.com/apache/spark/pull/47906#discussion_r1754140343
##########
sql/core/src/test/scala/org/apache/spark/sql/execution/datasources/csv/CSVSuite.scala:
##########
@@ -3439,6 +3440,39 @@ abstract class CSVSuite
expected)
}
}
+
+ test("SPARK-49444: CSV parsing failure with more than max columns") {
+ val schema = new StructType()
+ .add("intColumn", IntegerType, nullable = true)
+ .add("decimalColumn", DecimalType(10, 2), nullable = true)
+
+ val fileReadException = intercept[SparkException] {
+ spark
+ .read
+ .schema(schema)
+ .option("header", "false")
+ .option("maxColumns", "2")
+ .csv(testFile(moreColumnsFile))
+ .collect()
+ }
+
+ checkErrorMatchPVals(
+ exception = fileReadException,
+ errorClass = "FAILED_READ_FILE.NO_HINT",
Review Comment:
Please, rebase on the recent master. `errorClass` was renamed to `condition`. Thanks.
--
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
Re: [PR] [SPARK-49444][SQL] Modified UnivocityParser to throw runtime exceptions caused by ArrayIndexOutOfBounds with more user-oriented messages [spark]
Posted by "cloud-fan (via GitHub)" <gi...@apache.org>.
cloud-fan closed pull request #47906: [SPARK-49444][SQL] Modified UnivocityParser to throw runtime exceptions caused by ArrayIndexOutOfBounds with more user-oriented messages
URL: https://github.com/apache/spark/pull/47906
--
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
Re: [PR] [SPARK-49444] Modified UnivocityParser to throw runtime exceptions caused by ArrayIndexOutOfBounds with more user-oriented messages [spark]
Posted by "MaxGekk (via GitHub)" <gi...@apache.org>.
MaxGekk commented on code in PR #47906:
URL: https://github.com/apache/spark/pull/47906#discussion_r1734318734
##########
sql/catalyst/src/test/scala/org/apache/spark/sql/catalyst/csv/UnivocityParserSuite.scala:
##########
@@ -273,11 +273,11 @@ class UnivocityParserSuite extends SparkFunSuite with SQLHelper {
test("skipping rows using pushdown filters") {
def check(
- input: String = "1,a",
- dataSchema: StructType = StructType.fromDDL("i INTEGER, s STRING"),
- requiredSchema: StructType = StructType.fromDDL("i INTEGER"),
- filters: Seq[Filter],
- expected: Option[InternalRow]): Unit = {
+ input: String = "1,a",
+ dataSchema: StructType = StructType.fromDDL("i INTEGER, s STRING"),
+ requiredSchema: StructType = StructType.fromDDL("i INTEGER"),
+ filters: Seq[Filter],
+ expected: Option[InternalRow]): Unit = {
Review Comment:
wrong indentation
--
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
Re: [PR] [SPARK-49444][SQL] Modified UnivocityParser to throw runtime exceptions caused by ArrayIndexOutOfBounds with more user-oriented messages [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on code in PR #47906:
URL: https://github.com/apache/spark/pull/47906#discussion_r1741543021
##########
sql/catalyst/src/test/scala/org/apache/spark/sql/catalyst/csv/UnivocityParserSuite.scala:
##########
@@ -98,7 +98,7 @@ class UnivocityParserSuite extends SparkFunSuite with SQLHelper {
test("Throws exception for empty string with non null type") {
val options = new CSVOptions(Map.empty[String, String], false, "UTC")
val parser = new UnivocityParser(StructType(Seq.empty), options)
- val exception = intercept[RuntimeException]{
Review Comment:
Can we remove unrelated changes?
--
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
Re: [PR] [SPARK-49444][SQL] Modified UnivocityParser to throw runtime exceptions caused by ArrayIndexOutOfBounds with more user-oriented messages [spark]
Posted by "vladanvasi-db (via GitHub)" <gi...@apache.org>.
vladanvasi-db commented on code in PR #47906:
URL: https://github.com/apache/spark/pull/47906#discussion_r1775214133
##########
sql/catalyst/src/test/scala/org/apache/spark/sql/catalyst/csv/UnivocityParserSuite.scala:
##########
@@ -323,6 +323,41 @@ class UnivocityParserSuite extends SparkFunSuite with SQLHelper {
parameters = Map("fieldName" -> "`i`", "fields" -> ""))
}
+ test("Bad records test in permissive mode") {
+ def checkBadRecord(
+ input: String = "1,a",
+ dataSchema: StructType = StructType.fromDDL("i INTEGER, s STRING, d DOUBLE"),
+ requiredSchema: StructType = StructType.fromDDL("i INTEGER, s STRING"),
+ options: Map[String, String] = Map("mode" -> "PERMISSIVE")): BadRecordException = {
+ val csvOptions = new CSVOptions(options, false, "UTC")
+ val parser = new UnivocityParser(dataSchema, requiredSchema, csvOptions, Seq())
+ intercept[BadRecordException] {
+ parser.parse(input)
+ }
+ }
+
+ // Bad record exception caused by conversion error
Review Comment:
The `PERMISSIVE` mode will "Fill the row in a best-effort manner", so if it throws the exception, also the `FAILFAST` mode will throw the exception as well, so we do not need to check that one additionally. On the other hand, `DROPMALFORMED` mode will just drop the row and not throw the exception, so it is not applicable here when checking `BadRecordException`.
--
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
Re: [PR] [SPARK-49444] Modified UnivocityParser to throw runtime exceptions caused by ArrayIndexOutOfBounds with more user-oriented messages [spark]
Posted by "MaxGekk (via GitHub)" <gi...@apache.org>.
MaxGekk commented on code in PR #47906:
URL: https://github.com/apache/spark/pull/47906#discussion_r1739606803
##########
sql/catalyst/src/test/scala/org/apache/spark/sql/catalyst/csv/UnivocityParserSuite.scala:
##########
@@ -323,6 +323,41 @@ class UnivocityParserSuite extends SparkFunSuite with SQLHelper {
parameters = Map("fieldName" -> "`i`", "fields" -> ""))
}
+ test("Bad records test in permissive mode") {
+ def checkBadRecord(
+ input: String = "1,a",
+ dataSchema: StructType = StructType.fromDDL("i INTEGER, s STRING, d DOUBLE"),
+ requiredSchema: StructType = StructType.fromDDL("i INTEGER, s STRING"),
+ options: Map[String, String] = Map("mode" -> "PERMISSIVE")): BadRecordException = {
+ val csvOptions = new CSVOptions(options, false, "UTC")
+ val parser = new UnivocityParser(dataSchema, requiredSchema, csvOptions, Seq())
+ intercept[BadRecordException] {
+ parser.parse(input)
+ }
+ }
+
+ // Bad record exception caused by conversion error
+ checkBadRecord(input = "1.5,a,10.3")
+
+ // Bad record exception caused by insufficient number of columns
+ checkBadRecord(input = "2")
+ }
+
+ test("Array index out of bounds when parsing CSV with more columns than expected") {
+ val input = "1,string,3.14,5,7"
+ val dataSchema: StructType = StructType.fromDDL("i INTEGER, a STRING")
+ val requiredSchema: StructType = StructType.fromDDL("i INTEGER, a STRING")
+ val options = new CSVOptions(Map("maxColumns" -> "2"), false, "UTC")
+ val filters = Seq()
+ val parser = new UnivocityParser(dataSchema, requiredSchema, options, filters)
+ checkError(
+ exception = intercept[SparkRuntimeException] {
+ parser.parse(input)
+ },
+ errorClass = "MALFORMED_CSV_RECORD",
+ parameters = Map("badRecord" -> "1,string,3.14,5,7"))
Review Comment:
The error condition name seems misleading to me. The CSV record is not malformed, but we actually hit to some limits of implementation.
--
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
Re: [PR] [SPARK-49444][SQL] Modified UnivocityParser to throw runtime exceptions caused by ArrayIndexOutOfBounds with more user-oriented messages [spark]
Posted by "cloud-fan (via GitHub)" <gi...@apache.org>.
cloud-fan commented on code in PR #47906:
URL: https://github.com/apache/spark/pull/47906#discussion_r1775195589
##########
sql/catalyst/src/test/scala/org/apache/spark/sql/catalyst/csv/UnivocityParserSuite.scala:
##########
@@ -323,6 +323,41 @@ class UnivocityParserSuite extends SparkFunSuite with SQLHelper {
parameters = Map("fieldName" -> "`i`", "fields" -> ""))
}
+ test("Bad records test in permissive mode") {
+ def checkBadRecord(
+ input: String = "1,a",
+ dataSchema: StructType = StructType.fromDDL("i INTEGER, s STRING, d DOUBLE"),
+ requiredSchema: StructType = StructType.fromDDL("i INTEGER, s STRING"),
+ options: Map[String, String] = Map("mode" -> "PERMISSIVE")): BadRecordException = {
+ val csvOptions = new CSVOptions(options, false, "UTC")
+ val parser = new UnivocityParser(dataSchema, requiredSchema, csvOptions, Seq())
+ intercept[BadRecordException] {
+ parser.parse(input)
+ }
+ }
+
+ // Bad record exception caused by conversion error
Review Comment:
shall we test the same thing in the next test case that do not use PERMISSIVE mode?
--
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