Add an allowExtraKeys setting in ProductFormats #166
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jrudolph
reviewed
Oct 23, 2017
jrudolph
reviewed
Oct 23, 2017
| jsonFormat(construct, [#p1#]) | ||
| } | ||
| def jsonFormat[[#P1 :JF#], T <: Product](construct: ([#P1#]) => T, [#fieldName1: String#]): RootJsonFormat[T] = new RootJsonFormat[T]{ | ||
| val knownFields = HashSet[String]() |
There was a problem hiding this comment.
Can we try to make the feature free when allowExtraKeys is false (default behavior). Maybe just make this a lazy val to make sure it is not initialized when not needed.
jrudolph
reviewed
Oct 23, 2017
| val keySet = jsObject.fields.keys.toSet | ||
| val keySetDiff = keySet.diff(knownFields) | ||
| if (!keySetDiff.isEmpty) { | ||
| throw new DeserializationException(s"${keySetDiff.head} is not a known key", null, keySetDiff.toList) |
There was a problem hiding this comment.
Can we give more complete information when it fails? Missing set, given set and expected set of keys.
jrudolph
reviewed
Oct 23, 2017
| * will throw an error if the input contains keys that are not a field of the | ||
| * target case class. | ||
| */ | ||
| trait ExtraKeysOptions extends ProductFormats { |
There was a problem hiding this comment.
Do we actually need that trait? Seems a bit weird API to just change the flag from true to false. Maybe just document allowExtraKeys directly.
jrudolph
reviewed
Oct 23, 2017
| import scala.collection.mutable.HashSet | ||
|
|
||
| trait ProductFormatsInstances { self: ProductFormats with StandardFormats => | ||
| def allowExtraKeys: Boolean = true |
There was a problem hiding this comment.
I wonder (but I'm not sure) if reversing the naming could be more clear? failOnExtraKeys or something like this?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes issue #165 .