You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "rangadi (via GitHub)" <gi...@apache.org> on 2023/02/14 08:33:40 UTC
[GitHub] [spark] rangadi opened a new pull request, #40011: [SPARK-42406][PROTOBUF] Fix recursive depth setting for Protobuf functions
rangadi opened a new pull request, #40011:
URL: https://github.com/apache/spark/pull/40011
### What changes were proposed in this pull request?
This fixes how setting for limiting recursive depth is handled in Protobuf functions (`recursive.fields.max.depth`).
Original documentation says as setting it to '0' removes the recursive field. But we never did that. We allow at least once. E.g. schema for recursive message 'EventPerson' does not change between the settings '0' or '1'.
This fixes it by requiring the max depth to be at least 1. It also fixes how the recursion enfored.
Updated the tests and added an extra test with new protobuf 'EventPersonWrapper'.
I will annotate the diff inline pointing to main fixes.
### Why are the changes needed?
This fixes a bug with enforcing `recursive.fields.max.depth` and clarifies more in the documentation.
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
- Unit 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] rangadi commented on a diff in pull request #40011: [SPARK-42406][PROTOBUF] Fix recursive depth setting for Protobuf functions
Posted by "rangadi (via GitHub)" <gi...@apache.org>.
rangadi commented on code in PR #40011:
URL: https://github.com/apache/spark/pull/40011#discussion_r1106333293
##########
connector/protobuf/src/test/scala/org/apache/spark/sql/protobuf/ProtobufFunctionsSuite.scala:
##########
@@ -457,6 +415,19 @@ class ProtobufFunctionsSuite extends QueryTest with SharedSparkSession with Prot
}
}
+ test("Setting recursive depth to 0 should result in an error (same as -1) (B -> A -> B)") {
Review Comment:
Done. Thanks for the review.
--
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] rangadi commented on pull request #40011: [SPARK-42406][PROTOBUF] Fix recursive depth setting for Protobuf functions
Posted by "rangadi (via GitHub)" <gi...@apache.org>.
rangadi commented on PR #40011:
URL: https://github.com/apache/spark/pull/40011#issuecomment-1429328683
@HeartSaVioR , @HyukjinKwon , @SandishKumarHN PTAL. I would like to get this fix asap to make it into 3.4.x in OSS and 12.2 RC cut in DBR.
--
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] rangadi commented on pull request #40011: [SPARK-42406][PROTOBUF] Fix recursive depth setting for Protobuf functions
Posted by "rangadi (via GitHub)" <gi...@apache.org>.
rangadi commented on PR #40011:
URL: https://github.com/apache/spark/pull/40011#issuecomment-1429341925
cc: @gengliangwang
--
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] gengliangwang commented on pull request #40011: [SPARK-42406][PROTOBUF] Fix recursive depth setting for Protobuf functions
Posted by "gengliangwang (via GitHub)" <gi...@apache.org>.
gengliangwang commented on PR #40011:
URL: https://github.com/apache/spark/pull/40011#issuecomment-1430514890
Thanks, merging to master/3.4
--
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] rangadi commented on a diff in pull request #40011: [SPARK-42406][PROTOBUF] Fix recursive depth setting for Protobuf functions
Posted by "rangadi (via GitHub)" <gi...@apache.org>.
rangadi commented on code in PR #40011:
URL: https://github.com/apache/spark/pull/40011#discussion_r1105466945
##########
connector/protobuf/src/test/scala/org/apache/spark/sql/protobuf/ProtobufFunctionsSuite.scala:
##########
@@ -385,34 +387,12 @@ class ProtobufFunctionsSuite extends QueryTest with SharedSparkSession with Prot
}
}
- test("Handle recursive fields in Protobuf schema, A->B->A") {
- val schemaA = ProtobufUtils.buildDescriptor(testFileDesc, "recursiveA")
Review Comment:
This extra code to create actual records is not required since we are testing an AnalysisException. It does not need real data.
##########
connector/protobuf/src/main/scala/org/apache/spark/sql/protobuf/utils/SchemaConverters.scala:
##########
@@ -118,17 +118,17 @@ object SchemaConverters {
// discarded.
// SQL Schema for the protobuf message `message Person { string name = 1; Person bff = 2}`
// will vary based on the value of "recursive.fields.max.depth".
- // 0: struct<name: string, bff: null>
- // 1: struct<name string, bff: <name: string, bff: null>>
- // 2: struct<name string, bff: <name: string, bff: struct<name: string, bff: null>>> ...
+ // 1: struct<name: string, bff: null>
+ // 2: struct<name string, bff: <name: string, bff: null>>
+ // 3: struct<name string, bff: <name: string, bff: struct<name: string, bff: null>>> ...
val recordName = fd.getMessageType.getFullName
val recursiveDepth = existingRecordNames.getOrElse(recordName, 0)
val recursiveFieldMaxDepth = protobufOptions.recursiveFieldMaxDepth
- if (existingRecordNames.contains(recordName) && (recursiveFieldMaxDepth < 0 ||
+ if (existingRecordNames.contains(recordName) && (recursiveFieldMaxDepth <= 0 ||
recursiveFieldMaxDepth > 10)) {
throw QueryCompilationErrors.foundRecursionInProtobufSchema(fd.toString())
} else if (existingRecordNames.contains(recordName) &&
- recursiveDepth > recursiveFieldMaxDepth) {
+ recursiveDepth >= recursiveFieldMaxDepth) {
Review Comment:
The main bug fix:
We allowed recursive depth go over by one. This makes the setting of '0' does not work as documented (earlier documentation stated even the first occurrence would be removed it it was set to 0).
Removing the first occurrence does not make sense since we don't know if this field is recursive until the second occurrence.
##########
connector/protobuf/src/test/scala/org/apache/spark/sql/protobuf/ProtobufFunctionsSuite.scala:
##########
@@ -853,7 +824,7 @@ class ProtobufFunctionsSuite extends QueryTest with SharedSparkSession with Prot
val df = Seq(employee.toByteArray).toDF("protoEvent")
val options = new java.util.HashMap[String, String]()
- options.put("recursive.fields.max.depth", "1")
+ options.put("recursive.fields.max.depth", "2")
Review Comment:
We need to increase the setting because this PR fixes off by one with enforcement.
--
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] gengliangwang commented on a diff in pull request #40011: [SPARK-42406][PROTOBUF] Fix recursive depth setting for Protobuf functions
Posted by "gengliangwang (via GitHub)" <gi...@apache.org>.
gengliangwang commented on code in PR #40011:
URL: https://github.com/apache/spark/pull/40011#discussion_r1106324457
##########
connector/protobuf/src/test/scala/org/apache/spark/sql/protobuf/ProtobufFunctionsSuite.scala:
##########
@@ -457,6 +415,19 @@ class ProtobufFunctionsSuite extends QueryTest with SharedSparkSession with Prot
}
}
+ test("Setting recursive depth to 0 should result in an error (same as -1) (B -> A -> B)") {
Review Comment:
nit: let's test -1 as well?
--
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] gengliangwang closed pull request #40011: [SPARK-42406][PROTOBUF] Fix recursive depth setting for Protobuf functions
Posted by "gengliangwang (via GitHub)" <gi...@apache.org>.
gengliangwang closed pull request #40011: [SPARK-42406][PROTOBUF] Fix recursive depth setting for Protobuf functions
URL: https://github.com/apache/spark/pull/40011
--
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