Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

add a parser option to validate oneofs #236

Merged
merged 2 commits into from
May 22, 2021
Merged

add a parser option to validate oneofs #236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58c1301
add a parser option to validate oneofs
sttawm May 7, 2021
853ffef
code review
sttawm May 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions src/main/scala/scalapb/json4s/JsonFormat.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,6 +461,7 @@ class Printer private (config: Printer.PrinterConfig) {
object Parser {
private final case class ParserConfig(
isIgnoringUnknownFields: Boolean,
isIgnoringOverlappingOneofFields: Boolean,
mapEntriesAsKeyValuePairs: Boolean,
formatRegistry: FormatRegistry,
typeRegistry: TypeRegistry
Expand All @@ -472,6 +473,7 @@ class Parser private (config: Parser.ParserConfig) {
this(
Parser.ParserConfig(
isIgnoringUnknownFields = false,
isIgnoringOverlappingOneofFields = false,
mapEntriesAsKeyValuePairs = false,
JsonFormat.DefaultRegistry,
TypeRegistry.empty
Expand All @@ -490,6 +492,7 @@ class Parser private (config: Parser.ParserConfig) {
this(
Parser.ParserConfig(
isIgnoringUnknownFields = false,
isIgnoringOverlappingOneofFields = false,
mapEntriesAsKeyValuePairs = false,
formatRegistry,
typeRegistry
Expand All @@ -499,6 +502,9 @@ class Parser private (config: Parser.ParserConfig) {
def ignoringUnknownFields: Parser =
new Parser(config.copy(isIgnoringUnknownFields = true))

def ignoringOverlappingOneofFields: Parser =
new Parser(config.copy(isIgnoringOverlappingOneofFields = true))

def mapEntriesAsKeyValuePairs: Parser =
new Parser(config.copy(mapEntriesAsKeyValuePairs = true))

Expand Down Expand Up @@ -593,12 +599,23 @@ class Parser private (config: Parser.ParserConfig) {
case None =>
value match {
case JObject(fields) =>
val usedOneofs = mutable.Set[OneofDescriptor]()
val fieldMap = JsonFormat.MemorizedFieldNameMap(cmp.scalaDescriptor)
val valueMapBuilder = Map.newBuilder[FieldDescriptor, PValue]
fields.foreach { case (name: String, jValue: JValue) =>
if (fieldMap.contains(name)) {
if (jValue != JNull) {
val fd = fieldMap(name)
fd.containingOneof.foreach(o =>
if (
!config.isIgnoringOverlappingOneofFields && !usedOneofs
.add(o)
) {
throw new JsonFormatException(
s"Overlapping field '${name}' in oneof"
)
}
)
valueMapBuilder += (fd -> parseValue(fd, jValue))
}
} else if (
Expand Down
15 changes: 15 additions & 0 deletions src/test/scala/scalapb/json4s/JsonFormatSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import com.google.protobuf.any.{Any => PBAny}
import com.google.protobuf.util.JsonFormat.{TypeRegistry => JavaTypeRegistry}
import com.google.protobuf.util.{JsonFormat => JavaJsonFormat}
import jsontest.custom_collection.{Guitar, Studio}
import jsontest.oneof.OneOf
import jsontest.test._
import jsontest.test3._
import org.json4s.JsonDSL._
Expand Down Expand Up @@ -674,6 +675,20 @@ class JsonFormatSpec
JsonFormat.parser.fromJsonString[TestAllTypes](javaJson) must be(obj)
}

"oneofs" should "fail for overlapping keys if failOnOverlappingOneofKeys" in new DefaultParserContext {
val extraKey = """{"primitive": "", "wrapper": ""}"""
assertFails(extraKey, OneOf)
}

"oneofs" should "not fail for overlapping keys if ignoreOverlappingOneofKeys" in {
val extraKey = """{"primitive": "", "wrapper": ""}"""
val scalaParser = new Parser().ignoringOverlappingOneofFields
val parsedScala = scalaParser.fromJsonString[OneOf](extraKey)(OneOf)
parsedScala must be(
OneOf(field = OneOf.Field.Primitive(""))
)
}

"TestProto" should "be TestJsonWithMapEntriesAsKeyValuePairs when converted to Proto with mapEntriesAsKeyValuePairs setting" in {
JsonFormat.printer.mapEntriesAsKeyValuePairs.toJson(TestProto) must be(
parse(TestJsonWithMapEntriesAsKeyValuePairs)
Expand Down