You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "justaparth (via GitHub)" <gi...@apache.org> on 2023/11/11 14:46:01 UTC
[PR] test [spark]
justaparth opened a new pull request, #43767:
URL: https://github.com/apache/spark/pull/43767
<!--
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.
-->
### 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.
-->
### 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'.
-->
### 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.
-->
### 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.
-->
--
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-44001][PROTOBUF] Add option to allow unwrapping protobuf well known wrapper types [spark]
Posted by "justaparth (via GitHub)" <gi...@apache.org>.
justaparth commented on PR #43767:
URL: https://github.com/apache/spark/pull/43767#issuecomment-1866181520
hey @rangadi just wanted to bump this! i think i've responded to everything
--
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-44001][PROTOBUF] Add option to allow unwrapping protobuf well known wrapper types [spark]
Posted by "justaparth (via GitHub)" <gi...@apache.org>.
justaparth commented on code in PR #43767:
URL: https://github.com/apache/spark/pull/43767#discussion_r1400822484
##########
connector/protobuf/src/test/resources/protobuf/functions_suite.proto:
##########
@@ -324,3 +325,19 @@ message Proto3AllTypes {
}
map<string, string> map = 13;
}
+
+message WellKnownWrapperTypes {
+ google.protobuf.BoolValue bool_val = 1;
+ google.protobuf.Int32Value int32_val = 2;
Review Comment:
yeah, great suggestion. I added that test!
basically the internal `value` field should operate the same as any primitive, and when unwrapping it should unwrap that value correctly. I added a test that confirms every configuration of emit.default.values and unwrap.primitive.wrapper.types
--
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-44001][PROTOBUF] Add option to allow unwrapping protobuf well known wrapper types [spark]
Posted by "rangadi (via GitHub)" <gi...@apache.org>.
rangadi commented on code in PR #43767:
URL: https://github.com/apache/spark/pull/43767#discussion_r1430672903
##########
connector/protobuf/src/main/scala/org/apache/spark/sql/protobuf/utils/ProtobufOptions.scala:
##########
@@ -180,6 +180,28 @@ private[sql] class ProtobufOptions(
// can contain large unsigned values without overflow.
val upcastUnsignedInts: Boolean =
parameters.getOrElse("upcast.unsigned.ints", false.toString).toBoolean
+
+ // Whether to unwrap the struct representation for well known primitve wrapper types when
+ // deserializing. By default, the wrapper types for primitives (i.e. google.protobuf.Int32Value,
+ // google.protobuf.Int64Value, etc.) will get deserialized as structs. We allow the option to
+ // deserialize them as their respective primitives.
Review Comment:
Could you update this to clarify that `emit.default.values` does not apply here? I.e. an `Int32Value` value field would be null if unset, even if `emit.default.values` is set to true.
--
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-44001][PROTOBUF] Add option to allow unwrapping protobuf well known wrapper types [spark]
Posted by "justaparth (via GitHub)" <gi...@apache.org>.
justaparth commented on code in PR #43767:
URL: https://github.com/apache/spark/pull/43767#discussion_r1430692782
##########
connector/protobuf/src/main/scala/org/apache/spark/sql/protobuf/utils/ProtobufOptions.scala:
##########
@@ -180,6 +180,28 @@ private[sql] class ProtobufOptions(
// can contain large unsigned values without overflow.
val upcastUnsignedInts: Boolean =
parameters.getOrElse("upcast.unsigned.ints", false.toString).toBoolean
+
+ // Whether to unwrap the struct representation for well known primitve wrapper types when
+ // deserializing. By default, the wrapper types for primitives (i.e. google.protobuf.Int32Value,
+ // google.protobuf.Int64Value, etc.) will get deserialized as structs. We allow the option to
+ // deserialize them as their respective primitives.
Review Comment:
sure! just added a comment with an example
--
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-44001][PROTOBUF] Add option to allow unwrapping protobuf well known wrapper types [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon closed pull request #43767: [SPARK-44001][PROTOBUF] Add option to allow unwrapping protobuf well known wrapper types
URL: https://github.com/apache/spark/pull/43767
--
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-44001][PROTOBUF] Add option to allow unwrapping protobuf well known wrapper types [spark]
Posted by "justaparth (via GitHub)" <gi...@apache.org>.
justaparth commented on code in PR #43767:
URL: https://github.com/apache/spark/pull/43767#discussion_r1400821080
##########
connector/protobuf/src/main/scala/org/apache/spark/sql/protobuf/utils/ProtobufOptions.scala:
##########
@@ -168,6 +168,28 @@ private[sql] class ProtobufOptions(
// instead of string, so use caution if changing existing parsing logic.
val enumsAsInts: Boolean =
parameters.getOrElse("enums.as.ints", false.toString).toBoolean
+
+ // Whether to unwrap the struct representation for well known primitve wrapper types when
+ // deserializing. By default, the wrapper types for primitives (i.e. google.protobuf.Int32Value,
+ // google.protobuf.Int64Value, etc.) will get deserialized as structs. We allow the option to
+ // deserialize them as their respective primitives.
+ // https://protobuf.dev/reference/protobuf/google.protobuf/
+ //
+ // For example, given a message like:
+ // ```
+ // syntax = "proto3";
+ // message = Example {
+ // google.protobuf.Int32Value val = 1;
+ // }
+ // ```
+ //
+ // The message Example(Int32Value(1)) would be deserialized by default as
+ // {val: {value: 1}}
+ //
+ // However, with this option set, it would be deserialized as
+ // {val: 1}
+ val unwrapWellKnownTypes: Boolean =
+ parameters.getOrElse("unwrap.protobuf.wkt", false.toString).toBoolean
Review Comment:
yes, definitely. i updated it, let me know what you think
--
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-44001][PROTOBUF] Add option to allow unwrapping protobuf well known wrapper types [spark]
Posted by "justaparth (via GitHub)" <gi...@apache.org>.
justaparth commented on code in PR #43767:
URL: https://github.com/apache/spark/pull/43767#discussion_r1430607010
##########
connector/protobuf/src/test/scala/org/apache/spark/sql/protobuf/ProtobufFunctionsSuite.scala:
##########
@@ -1600,6 +1600,195 @@ class ProtobufFunctionsSuite extends QueryTest with SharedSparkSession with Prot
}
}
+ test("well known types deserialization and round trip") {
+ val message = spark.range(1).select(
+ lit(WellKnownWrapperTypes
+ .newBuilder()
+ .setBoolVal(BoolValue.of(true))
+ .setInt32Val(Int32Value.of(100))
+ .setUint32Val(UInt32Value.of(200))
+ .setInt64Val(Int64Value.of(300))
+ .setUint64Val(UInt64Value.of(400))
+ .setStringVal(StringValue.of("string"))
+ .setBytesVal(BytesValue.of(ByteString.copyFromUtf8("bytes")))
+ .setFloatVal(FloatValue.of(1.23f))
+ .setDoubleVal(DoubleValue.of(4.56))
+ .addInt32List(Int32Value.of(1))
+ .addInt32List(Int32Value.of(2))
+ .putWktMap(1, StringValue.of("mapval"))
+ .build().toByteArray
+ ).as("raw_proto"))
+
+ // By default, well known wrapper types should come out as structs.
+ val expectedWithoutFlag = spark.range(1).select(
+ struct(
+ struct(lit(true) as ("value")).as("bool_val"),
+ struct(lit(100).as("value")).as("int32_val"),
+ struct(lit(200).as("value")).as("uint32_val"),
+ struct(lit(300).as("value")).as("int64_val"),
+ struct(lit(400).as("value")).as("uint64_val"),
+ struct(lit("string").as("value")).as("string_val"),
+ struct(lit("bytes".getBytes).as("value")).as("bytes_val"),
+ struct(lit(1.23f).as("value")).as("float_val"),
+ struct(lit(4.56).as("value")).as("double_val"),
+ array(struct(lit(1).as("value")), struct(lit(2).as("value"))).as("int32_list"),
+ map(lit(1), struct(lit("mapval").as("value"))).as("wkt_map")
+ ).as("proto")
+ )
+
+ // With the flag set, ensure that well known wrapper types get deserialized as primitives.
+ val expectedWithFlag = spark.range(1).select(
+ struct(
+ lit(true).as("bool_val"),
+ lit(100).as("int32_val"),
+ lit(200).as("uint32_val"),
+ lit(300).as("int64_val"),
+ lit(400).as("uint64_val"),
+ lit("string").as("string_val"),
+ lit("bytes".getBytes).as("bytes_val"),
+ lit(1.23f).as("float_val"),
+ lit(4.56).as("double_val"),
+ typedLit(List(1, 2)).as("int32_list"),
+ typedLit(Map(1 -> "mapval")).as("wkt_map")
+ ).as("proto")
+ )
+
+ checkWithFileAndClassName("WellKnownWrapperTypes") { case (name, descFilePathOpt) =>
+ // With the option not set or set as false, ensure that the deserialization is as
+ // expected and that round-tripping works.
+ List(Map.empty[String, String], Map("unwrap.primitive.wrapper.types" -> "false"))
+ .foreach(opts => {
+ val parsed = message.select(from_protobuf_wrapper(
+ $"raw_proto",
+ name,
+ descFilePathOpt,
+ opts).as("parsed"))
+ checkAnswer(parsed, expectedWithoutFlag)
+
+ // Verify that round-tripping gives us the same parsed representation.
+ val reserialized = parsed.select(
+ to_protobuf_wrapper($"parsed", name, descFilePathOpt).as("reserialized"))
+ val reparsed = reserialized.select(
+ from_protobuf_wrapper($"reserialized", name, descFilePathOpt, opts).as("reparsed"))
+ checkAnswer(parsed, reparsed)
+ })
+
+ // Without the option not set or set as false, ensure that the deserialization is as
+ // expected and that round-tripping works.
+ val opt = Map("unwrap.primitive.wrapper.types" -> "true")
+ val parsed = message.select(from_protobuf_wrapper(
+ $"raw_proto",
+ name,
+ descFilePathOpt,
+ opt).as("parsed"))
+ checkAnswer(parsed, expectedWithFlag)
+
+ val reserialized = parsed.select(
+ to_protobuf_wrapper($"parsed", name, descFilePathOpt).as("reserialized"))
+ val reparsed = reserialized.select(
+ from_protobuf_wrapper($"reserialized", name, descFilePathOpt, opt).as("reparsed"))
+ checkAnswer(parsed, reparsed)
+ }
+ }
+
+ // Test that the emit defaults behavior and unwrap primitives behavior work correctly together.
+ test("test well known wrappers with emit defaults") {
+
+ val unset = spark.range(1).select(
+ lit(
+ WellKnownWrapperTypes.newBuilder().build().toByteArray
+ ).as("raw_proto"))
+
+ val explicitZero = spark.range(1).select(
+ lit(
+ WellKnownWrapperTypes.newBuilder().setInt32Val(Int32Value.of(0)).build().toByteArray
+ ).as("raw_proto"))
+
+ val explicitNonzero = spark.range(1).select(
+ lit(
+ WellKnownWrapperTypes.newBuilder().setInt32Val(Int32Value.of(100)).build().toByteArray
+ ).as("raw_proto"))
+
+ val expectedEmpty = spark.range(1).select(lit(null).as("int32_val"))
+
+ checkWithFileAndClassName("WellKnownWrapperTypes") { case (name, descFilePathOpt) =>
+ for {
+ unwrap <- Seq("true", "false")
+ defaults <- Seq("true", "false")
+ } {
+ // For unset values, we'll always get back null
Review Comment:
yes! exactly
--
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-44001][PROTOBUF] Add option to allow unwrapping protobuf well known wrapper types [spark]
Posted by "justaparth (via GitHub)" <gi...@apache.org>.
justaparth commented on PR #43767:
URL: https://github.com/apache/spark/pull/43767#issuecomment-1861558995
thanks for the review @rangadi , and sorry for the dealy in getting back to this. i've just updated and i think i've responded to all comments, do you mind taking another look?
--
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-44001][PROTOBUF] Add option to allow unwrapping protobuf well known wrapper types [spark]
Posted by "justaparth (via GitHub)" <gi...@apache.org>.
justaparth commented on PR #43767:
URL: https://github.com/apache/spark/pull/43767#issuecomment-1821206772
thanks for the review @rangadi ! i updated based on your comments, lmk what you think. Also it could be good to check #43773 first, since that could also affect this PR 🤔
--
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-44001][PROTOBUF] Add option to allow unwrapping protobuf well known wrapper types [spark]
Posted by "justaparth (via GitHub)" <gi...@apache.org>.
justaparth commented on PR #43767:
URL: https://github.com/apache/spark/pull/43767#issuecomment-1807276390
@rangadi do you mind taking a look? i've modified this to make it an option so that the default behavior doesn't change
--
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-44001][PROTOBUF] Add option to allow unwrapping protobuf well known wrapper types [spark]
Posted by "rangadi (via GitHub)" <gi...@apache.org>.
rangadi commented on code in PR #43767:
URL: https://github.com/apache/spark/pull/43767#discussion_r1401347343
##########
connector/protobuf/src/test/scala/org/apache/spark/sql/protobuf/ProtobufFunctionsSuite.scala:
##########
@@ -1600,6 +1600,195 @@ class ProtobufFunctionsSuite extends QueryTest with SharedSparkSession with Prot
}
}
+ test("well known types deserialization and round trip") {
+ val message = spark.range(1).select(
+ lit(WellKnownWrapperTypes
+ .newBuilder()
+ .setBoolVal(BoolValue.of(true))
+ .setInt32Val(Int32Value.of(100))
+ .setUint32Val(UInt32Value.of(200))
+ .setInt64Val(Int64Value.of(300))
+ .setUint64Val(UInt64Value.of(400))
+ .setStringVal(StringValue.of("string"))
+ .setBytesVal(BytesValue.of(ByteString.copyFromUtf8("bytes")))
+ .setFloatVal(FloatValue.of(1.23f))
+ .setDoubleVal(DoubleValue.of(4.56))
+ .addInt32List(Int32Value.of(1))
+ .addInt32List(Int32Value.of(2))
+ .putWktMap(1, StringValue.of("mapval"))
+ .build().toByteArray
+ ).as("raw_proto"))
+
+ // By default, well known wrapper types should come out as structs.
+ val expectedWithoutFlag = spark.range(1).select(
+ struct(
+ struct(lit(true) as ("value")).as("bool_val"),
+ struct(lit(100).as("value")).as("int32_val"),
+ struct(lit(200).as("value")).as("uint32_val"),
+ struct(lit(300).as("value")).as("int64_val"),
+ struct(lit(400).as("value")).as("uint64_val"),
+ struct(lit("string").as("value")).as("string_val"),
+ struct(lit("bytes".getBytes).as("value")).as("bytes_val"),
+ struct(lit(1.23f).as("value")).as("float_val"),
+ struct(lit(4.56).as("value")).as("double_val"),
+ array(struct(lit(1).as("value")), struct(lit(2).as("value"))).as("int32_list"),
+ map(lit(1), struct(lit("mapval").as("value"))).as("wkt_map")
+ ).as("proto")
+ )
+
+ // With the flag set, ensure that well known wrapper types get deserialized as primitives.
+ val expectedWithFlag = spark.range(1).select(
+ struct(
+ lit(true).as("bool_val"),
+ lit(100).as("int32_val"),
+ lit(200).as("uint32_val"),
+ lit(300).as("int64_val"),
+ lit(400).as("uint64_val"),
+ lit("string").as("string_val"),
+ lit("bytes".getBytes).as("bytes_val"),
+ lit(1.23f).as("float_val"),
+ lit(4.56).as("double_val"),
+ typedLit(List(1, 2)).as("int32_list"),
+ typedLit(Map(1 -> "mapval")).as("wkt_map")
+ ).as("proto")
+ )
+
+ checkWithFileAndClassName("WellKnownWrapperTypes") { case (name, descFilePathOpt) =>
+ // With the option not set or set as false, ensure that the deserialization is as
+ // expected and that round-tripping works.
+ List(Map.empty[String, String], Map("unwrap.primitive.wrapper.types" -> "false"))
+ .foreach(opts => {
+ val parsed = message.select(from_protobuf_wrapper(
+ $"raw_proto",
+ name,
+ descFilePathOpt,
+ opts).as("parsed"))
+ checkAnswer(parsed, expectedWithoutFlag)
+
+ // Verify that round-tripping gives us the same parsed representation.
+ val reserialized = parsed.select(
+ to_protobuf_wrapper($"parsed", name, descFilePathOpt).as("reserialized"))
+ val reparsed = reserialized.select(
+ from_protobuf_wrapper($"reserialized", name, descFilePathOpt, opts).as("reparsed"))
+ checkAnswer(parsed, reparsed)
+ })
+
+ // Without the option not set or set as false, ensure that the deserialization is as
+ // expected and that round-tripping works.
Review Comment:
Fix the comment.
##########
connector/protobuf/src/main/scala/org/apache/spark/sql/protobuf/utils/ProtobufOptions.scala:
##########
@@ -168,6 +168,28 @@ private[sql] class ProtobufOptions(
// instead of string, so use caution if changing existing parsing logic.
val enumsAsInts: Boolean =
parameters.getOrElse("enums.as.ints", false.toString).toBoolean
+
+ // Whether to unwrap the struct representation for well known primitve wrapper types when
+ // deserializing. By default, the wrapper types for primitives (i.e. google.protobuf.Int32Value,
+ // google.protobuf.Int64Value, etc.) will get deserialized as structs. We allow the option to
+ // deserialize them as their respective primitives.
+ // https://protobuf.dev/reference/protobuf/google.protobuf/
+ //
+ // For example, given a message like:
+ // ```
+ // syntax = "proto3";
+ // message = Example {
Review Comment:
Remove `=`
##########
connector/protobuf/src/test/scala/org/apache/spark/sql/protobuf/ProtobufFunctionsSuite.scala:
##########
@@ -1600,6 +1600,195 @@ class ProtobufFunctionsSuite extends QueryTest with SharedSparkSession with Prot
}
}
+ test("well known types deserialization and round trip") {
+ val message = spark.range(1).select(
+ lit(WellKnownWrapperTypes
+ .newBuilder()
+ .setBoolVal(BoolValue.of(true))
+ .setInt32Val(Int32Value.of(100))
+ .setUint32Val(UInt32Value.of(200))
+ .setInt64Val(Int64Value.of(300))
+ .setUint64Val(UInt64Value.of(400))
+ .setStringVal(StringValue.of("string"))
+ .setBytesVal(BytesValue.of(ByteString.copyFromUtf8("bytes")))
+ .setFloatVal(FloatValue.of(1.23f))
+ .setDoubleVal(DoubleValue.of(4.56))
+ .addInt32List(Int32Value.of(1))
+ .addInt32List(Int32Value.of(2))
+ .putWktMap(1, StringValue.of("mapval"))
+ .build().toByteArray
+ ).as("raw_proto"))
+
+ // By default, well known wrapper types should come out as structs.
+ val expectedWithoutFlag = spark.range(1).select(
+ struct(
+ struct(lit(true) as ("value")).as("bool_val"),
+ struct(lit(100).as("value")).as("int32_val"),
+ struct(lit(200).as("value")).as("uint32_val"),
+ struct(lit(300).as("value")).as("int64_val"),
+ struct(lit(400).as("value")).as("uint64_val"),
+ struct(lit("string").as("value")).as("string_val"),
+ struct(lit("bytes".getBytes).as("value")).as("bytes_val"),
+ struct(lit(1.23f).as("value")).as("float_val"),
+ struct(lit(4.56).as("value")).as("double_val"),
+ array(struct(lit(1).as("value")), struct(lit(2).as("value"))).as("int32_list"),
+ map(lit(1), struct(lit("mapval").as("value"))).as("wkt_map")
+ ).as("proto")
+ )
+
+ // With the flag set, ensure that well known wrapper types get deserialized as primitives.
+ val expectedWithFlag = spark.range(1).select(
+ struct(
+ lit(true).as("bool_val"),
+ lit(100).as("int32_val"),
+ lit(200).as("uint32_val"),
+ lit(300).as("int64_val"),
+ lit(400).as("uint64_val"),
+ lit("string").as("string_val"),
+ lit("bytes".getBytes).as("bytes_val"),
+ lit(1.23f).as("float_val"),
+ lit(4.56).as("double_val"),
+ typedLit(List(1, 2)).as("int32_list"),
+ typedLit(Map(1 -> "mapval")).as("wkt_map")
+ ).as("proto")
+ )
+
+ checkWithFileAndClassName("WellKnownWrapperTypes") { case (name, descFilePathOpt) =>
+ // With the option not set or set as false, ensure that the deserialization is as
+ // expected and that round-tripping works.
+ List(Map.empty[String, String], Map("unwrap.primitive.wrapper.types" -> "false"))
+ .foreach(opts => {
+ val parsed = message.select(from_protobuf_wrapper(
+ $"raw_proto",
+ name,
+ descFilePathOpt,
+ opts).as("parsed"))
+ checkAnswer(parsed, expectedWithoutFlag)
+
+ // Verify that round-tripping gives us the same parsed representation.
+ val reserialized = parsed.select(
+ to_protobuf_wrapper($"parsed", name, descFilePathOpt).as("reserialized"))
+ val reparsed = reserialized.select(
+ from_protobuf_wrapper($"reserialized", name, descFilePathOpt, opts).as("reparsed"))
+ checkAnswer(parsed, reparsed)
+ })
+
+ // Without the option not set or set as false, ensure that the deserialization is as
+ // expected and that round-tripping works.
+ val opt = Map("unwrap.primitive.wrapper.types" -> "true")
+ val parsed = message.select(from_protobuf_wrapper(
+ $"raw_proto",
+ name,
+ descFilePathOpt,
+ opt).as("parsed"))
+ checkAnswer(parsed, expectedWithFlag)
+
+ val reserialized = parsed.select(
+ to_protobuf_wrapper($"parsed", name, descFilePathOpt).as("reserialized"))
+ val reparsed = reserialized.select(
+ from_protobuf_wrapper($"reserialized", name, descFilePathOpt, opt).as("reparsed"))
+ checkAnswer(parsed, reparsed)
+ }
+ }
+
+ // Test that the emit defaults behavior and unwrap primitives behavior work correctly together.
+ test("test well known wrappers with emit defaults") {
+
+ val unset = spark.range(1).select(
+ lit(
+ WellKnownWrapperTypes.newBuilder().build().toByteArray
+ ).as("raw_proto"))
+
+ val explicitZero = spark.range(1).select(
+ lit(
+ WellKnownWrapperTypes.newBuilder().setInt32Val(Int32Value.of(0)).build().toByteArray
+ ).as("raw_proto"))
+
+ val explicitNonzero = spark.range(1).select(
+ lit(
+ WellKnownWrapperTypes.newBuilder().setInt32Val(Int32Value.of(100)).build().toByteArray
+ ).as("raw_proto"))
+
+ val expectedEmpty = spark.range(1).select(lit(null).as("int32_val"))
+
+ checkWithFileAndClassName("WellKnownWrapperTypes") { case (name, descFilePathOpt) =>
+ for {
+ unwrap <- Seq("true", "false")
+ defaults <- Seq("true", "false")
+ } {
+ // For unset values, we'll always get back null
Review Comment:
This is fine. Just to make sure, this is different from primitive int, right?
In the case of primitive int, value would be 0, not null when `emit.default.values` is true.
##########
connector/protobuf/src/test/scala/org/apache/spark/sql/protobuf/ProtobufFunctionsSuite.scala:
##########
@@ -1600,6 +1600,195 @@ class ProtobufFunctionsSuite extends QueryTest with SharedSparkSession with Prot
}
}
+ test("well known types deserialization and round trip") {
+ val message = spark.range(1).select(
+ lit(WellKnownWrapperTypes
+ .newBuilder()
+ .setBoolVal(BoolValue.of(true))
+ .setInt32Val(Int32Value.of(100))
+ .setUint32Val(UInt32Value.of(200))
+ .setInt64Val(Int64Value.of(300))
+ .setUint64Val(UInt64Value.of(400))
+ .setStringVal(StringValue.of("string"))
+ .setBytesVal(BytesValue.of(ByteString.copyFromUtf8("bytes")))
+ .setFloatVal(FloatValue.of(1.23f))
+ .setDoubleVal(DoubleValue.of(4.56))
+ .addInt32List(Int32Value.of(1))
+ .addInt32List(Int32Value.of(2))
+ .putWktMap(1, StringValue.of("mapval"))
+ .build().toByteArray
+ ).as("raw_proto"))
+
+ // By default, well known wrapper types should come out as structs.
+ val expectedWithoutFlag = spark.range(1).select(
+ struct(
+ struct(lit(true) as ("value")).as("bool_val"),
+ struct(lit(100).as("value")).as("int32_val"),
+ struct(lit(200).as("value")).as("uint32_val"),
+ struct(lit(300).as("value")).as("int64_val"),
+ struct(lit(400).as("value")).as("uint64_val"),
+ struct(lit("string").as("value")).as("string_val"),
+ struct(lit("bytes".getBytes).as("value")).as("bytes_val"),
+ struct(lit(1.23f).as("value")).as("float_val"),
+ struct(lit(4.56).as("value")).as("double_val"),
+ array(struct(lit(1).as("value")), struct(lit(2).as("value"))).as("int32_list"),
+ map(lit(1), struct(lit("mapval").as("value"))).as("wkt_map")
+ ).as("proto")
+ )
+
+ // With the flag set, ensure that well known wrapper types get deserialized as primitives.
+ val expectedWithFlag = spark.range(1).select(
+ struct(
+ lit(true).as("bool_val"),
+ lit(100).as("int32_val"),
+ lit(200).as("uint32_val"),
+ lit(300).as("int64_val"),
+ lit(400).as("uint64_val"),
+ lit("string").as("string_val"),
+ lit("bytes".getBytes).as("bytes_val"),
+ lit(1.23f).as("float_val"),
+ lit(4.56).as("double_val"),
+ typedLit(List(1, 2)).as("int32_list"),
+ typedLit(Map(1 -> "mapval")).as("wkt_map")
+ ).as("proto")
+ )
+
+ checkWithFileAndClassName("WellKnownWrapperTypes") { case (name, descFilePathOpt) =>
+ // With the option not set or set as false, ensure that the deserialization is as
+ // expected and that round-tripping works.
+ List(Map.empty[String, String], Map("unwrap.primitive.wrapper.types" -> "false"))
+ .foreach(opts => {
+ val parsed = message.select(from_protobuf_wrapper(
+ $"raw_proto",
+ name,
+ descFilePathOpt,
+ opts).as("parsed"))
+ checkAnswer(parsed, expectedWithoutFlag)
+
+ // Verify that round-tripping gives us the same parsed representation.
+ val reserialized = parsed.select(
+ to_protobuf_wrapper($"parsed", name, descFilePathOpt).as("reserialized"))
+ val reparsed = reserialized.select(
+ from_protobuf_wrapper($"reserialized", name, descFilePathOpt, opts).as("reparsed"))
+ checkAnswer(parsed, reparsed)
+ })
+
+ // Without the option not set or set as false, ensure that the deserialization is as
+ // expected and that round-tripping works.
+ val opt = Map("unwrap.primitive.wrapper.types" -> "true")
+ val parsed = message.select(from_protobuf_wrapper(
+ $"raw_proto",
+ name,
+ descFilePathOpt,
+ opt).as("parsed"))
+ checkAnswer(parsed, expectedWithFlag)
+
+ val reserialized = parsed.select(
+ to_protobuf_wrapper($"parsed", name, descFilePathOpt).as("reserialized"))
+ val reparsed = reserialized.select(
+ from_protobuf_wrapper($"reserialized", name, descFilePathOpt, opt).as("reparsed"))
+ checkAnswer(parsed, reparsed)
+ }
+ }
+
+ // Test that the emit defaults behavior and unwrap primitives behavior work correctly together.
+ test("test well known wrappers with emit defaults") {
+
Review Comment:
Could you add a short description of what the following is doing? It will save time for future readers. The above above gives the goal for the test. The description here would help with how it tests.
##########
connector/protobuf/src/main/scala/org/apache/spark/sql/protobuf/utils/SchemaConverters.scala:
##########
@@ -161,7 +192,7 @@ object SchemaConverters extends Logging {
case Nil =>
log.info(
s"Dropping ${fd.getFullName} as it does not have any fields left " +
- "likely due to recursive depth limit."
Review Comment:
Remove?
##########
connector/protobuf/src/main/scala/org/apache/spark/sql/protobuf/utils/ProtobufOptions.scala:
##########
@@ -168,6 +168,28 @@ private[sql] class ProtobufOptions(
// instead of string, so use caution if changing existing parsing logic.
val enumsAsInts: Boolean =
parameters.getOrElse("enums.as.ints", false.toString).toBoolean
+
+ // Whether to unwrap the struct representation for well known primitve wrapper types when
+ // deserializing. By default, the wrapper types for primitives (i.e. google.protobuf.Int32Value,
+ // google.protobuf.Int64Value, etc.) will get deserialized as structs. We allow the option to
+ // deserialize them as their respective primitives.
+ // https://protobuf.dev/reference/protobuf/google.protobuf/
+ //
+ // For example, given a message like:
+ // ```
+ // syntax = "proto3";
+ // message = Example {
+ // google.protobuf.Int32Value val = 1;
Review Comment:
nit: rename this to `int_val` ('val' is confusing for Scala code).
Also use a value of 5 or 10 in the example below (just to make it different from field value in message definition.
--
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-44001][PROTOBUF] Add option to allow unwrapping protobuf well known wrapper types [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #43767:
URL: https://github.com/apache/spark/pull/43767#issuecomment-1874709340
Merged 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-44001][PROTOBUF] Add option to allow unwrapping protobuf well known wrapper types [spark]
Posted by "justaparth (via GitHub)" <gi...@apache.org>.
justaparth commented on PR #43767:
URL: https://github.com/apache/spark/pull/43767#issuecomment-1874510477
hey @rangadi just wanted to bump this again in case you get a chance 🙏
--
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-44001][PROTOBUF] Add option to allow unwrapping protobuf well known wrapper types [spark]
Posted by "rangadi (via GitHub)" <gi...@apache.org>.
rangadi commented on code in PR #43767:
URL: https://github.com/apache/spark/pull/43767#discussion_r1391516380
##########
connector/protobuf/src/test/resources/protobuf/functions_suite.proto:
##########
@@ -324,3 +325,19 @@ message Proto3AllTypes {
}
map<string, string> map = 13;
}
+
+message WellKnownWrapperTypes {
+ google.protobuf.BoolValue bool_val = 1;
+ google.protobuf.Int32Value int32_val = 2;
Review Comment:
Could you add test where `int32_val` is not set. What should the Spark struct contain:
* When `emit.default.values` is false (default)
* When `emit.default.values` is true
Please comment on the expected behavior.
Another similar test with `int32_val.value` set to `0` (default value).
##########
connector/protobuf/src/main/scala/org/apache/spark/sql/protobuf/ProtobufDeserializer.scala:
##########
@@ -247,12 +247,86 @@ private[sql] class ProtobufDeserializer(
updater.setLong(ordinal, micros + TimeUnit.NANOSECONDS.toMicros(nanoSeconds))
case (MESSAGE, StringType)
- if protoType.getMessageType.getFullName == "google.protobuf.Any" =>
+ if protoType.getMessageType.getFullName == "google.protobuf.Any" =>
(updater, ordinal, value) =>
// Convert 'Any' protobuf message to JSON string.
val jsonStr = jsonPrinter.print(value.asInstanceOf[DynamicMessage])
updater.set(ordinal, UTF8String.fromString(jsonStr))
+ // Handle well known wrapper types. We unpack the value field instead of keeping
+ // them as nested structs
+ case (MESSAGE, BooleanType)
+ if protoType.getMessageType.getFullName == BoolValue.getDescriptor.getFullName =>
+ (updater, ordinal, value) =>
+ val dm = value.asInstanceOf[DynamicMessage]
+ updater.setBoolean(
+ ordinal,
+ dm.getField(
+ dm.getDescriptorForType.findFieldByName("value")
+ ).asInstanceOf[Boolean]
+ )
+ case (MESSAGE, IntegerType)
+ if (protoType.getMessageType.getFullName == Int32Value.getDescriptor.getFullName
+ || protoType.getMessageType.getFullName == UInt32Value.getDescriptor.getFullName) =>
+ (updater, ordinal, value) =>
+ val dm = value.asInstanceOf[DynamicMessage]
+ updater.setInt(
+ ordinal,
+ dm.getField(
+ dm.getDescriptorForType.findFieldByName("value")
+ ).asInstanceOf[Int]
+ )
+ case (MESSAGE, LongType)
+ if (protoType.getMessageType.getFullName == Int64Value.getDescriptor.getFullName
+ || protoType.getMessageType.getFullName == UInt64Value.getDescriptor.getFullName) =>
+ (updater, ordinal, value) =>
+ val dm = value.asInstanceOf[DynamicMessage]
+ updater.setLong(
+ ordinal,
+ dm.getField(
+ dm.getDescriptorForType.findFieldByName("value")
Review Comment:
Better to do `getFields().get(0)`, rather than find by value each time.
##########
connector/protobuf/src/main/scala/org/apache/spark/sql/protobuf/utils/ProtobufOptions.scala:
##########
@@ -168,6 +168,28 @@ private[sql] class ProtobufOptions(
// instead of string, so use caution if changing existing parsing logic.
val enumsAsInts: Boolean =
parameters.getOrElse("enums.as.ints", false.toString).toBoolean
+
+ // Whether to unwrap the struct representation for well known primitve wrapper types when
+ // deserializing. By default, the wrapper types for primitives (i.e. google.protobuf.Int32Value,
+ // google.protobuf.Int64Value, etc.) will get deserialized as structs. We allow the option to
+ // deserialize them as their respective primitives.
+ // https://protobuf.dev/reference/protobuf/google.protobuf/
+ //
+ // For example, given a message like:
+ // ```
+ // syntax = "proto3";
+ // message = Example {
+ // google.protobuf.Int32Value val = 1;
+ // }
+ // ```
+ //
+ // The message Example(Int32Value(1)) would be deserialized by default as
+ // {val: {value: 1}}
+ //
+ // However, with this option set, it would be deserialized as
+ // {val: 1}
+ val unwrapWellKnownTypes: Boolean =
+ parameters.getOrElse("unwrap.protobuf.wkt", false.toString).toBoolean
Review Comment:
Lets find a better name for this.
`unwrap.primitive.value.types` or something on those lines? Better to avoid short forms like `wkt`.
--
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