Add `disallowUnrecognizedKeys` option by jakemac53 · Pull Request #212 · google/json_serializable.dart

jakemac53 · 2018-05-31T16:14:12Z

Fixes #184

Added on JsonSerializable annotation, defaults to false (old behavior). If true then it throws an UnrecognizedKeysException which contains all the information about the allowed keys, unrecognized keys, etc.

As a part of this I also migrated everything to use blocks instead of fat arrows to simplify the codegen (this requires adding in an additional method call).

~~@kevmoo not sure how crazy you want me to go with testing here - there is a single test right now in the yaml_test.dart file which is more of an e2e_test as its checking for the actual error output.~~

Added a nested object in kitchen sink which uses this.

…cognizedKeys boolean field

kevmoo

Also should have output that validates non-checked

kevmoo · 2018-05-31T16:16:51Z

@@ -1,3 +1,15 @@
+## 0.2.7
+
+* Added `JsonSerializable.allowUnrecognizedKeys`.


disallowUnregognizedKeys – keep the defaults to `false'

kevmoo · 2018-05-31T16:17:01Z

+* Added `JsonSerializable.allowUnrecognizedKeys`.
+  * Defaults to `true` which maintains the previous behavior.
+  * Throws an `UnrecognizedKeysException` if it finds unrecognized keys in any
+    json maps.


JSON map used to create the annotated object.

kevmoo · 2018-05-31T16:20:47Z

+///
+/// Should not be used directly.
+void $checkAllowedKeys(Map map, Iterable<String> allowedKeys) {
+  var invalidKeys = map.keys.where((k) => !allowedKeys.contains(k));


Might as well add .toList here. If there are no keys, then you create an empty list – cheap.

Then we avoid hitting an iterator twice – which is something we should model...

kevmoo · 2018-05-31T16:21:36Z


 /// An annotation used to specify a class to generate code for.
 class JsonSerializable {
+  /// If `true` (the default), then any unrecognized keys passed to the


Flip name here...

kevmoo · 2018-05-31T16:23:00Z

+
        var fieldKeyMap = new Map.fromEntries(fieldsSetByFactory
            .map((k) => new MapEntry(k, _nameAccess(accessibleFields[k])))
-            .where((me) => me.key != me.value));


kevmoo · 2018-05-31T16:23:37Z

  # Use a tight version constraint to ensure that a constraint on
  # `json_annotation`. Properly constrains all features it provides.
-  json_annotation: '>=0.2.6 <0.2.7'
+  json_annotation: '>=0.2.7 <0.2.8'


Don't you need a dep override to make tests run?

added back - this got removed when I merged master (I didn't have to add it originally so it wasn't a merge conflict.... source control is fun)

…tests

jakemac53 · 2018-05-31T18:30:34Z

Updated @kevmoo PTAL (before you give me more merge conflicts lol)

kevmoo

A few nits...

kevmoo · 2018-05-31T17:40:00Z

+  * Defaults to `false` which maintains the previous behavior.
+  * Throws an `UnrecognizedKeysException` if it finds unrecognized keys in the
+    JSON map used to create the annotated object.
+  * Will be captured captured and wrapped in a `CheckedFromJsonException` if


kevmoo · 2018-05-31T21:12:40Z


 /// Helper function used in generated code when
-/// `JsonAnnotation.disallowUnregognizedKeys` is `true`.
+/// `JsonAnnotation.disallowUnrecognizedKeys` is `true`.


What's JsonAnnotation? You mean JsonSerializable?

kevmoo · 2018-05-31T21:13:21Z

+## 0.2.7
+
+* Added `JsonSerializable.disallowUnrecognizedKeys`.
+  * Defaults to `false` which maintains the previous behavior.


Remove this line

kevmoo · 2018-05-31T21:13:34Z

+
+* Added `JsonSerializable.disallowUnrecognizedKeys`.
+  * Defaults to `false` which maintains the previous behavior.
+  * Throws an `UnrecognizedKeysException` if it finds unrecognized keys in the


this and next bullet: Put runtime notes in json_serialiable changelog

kevmoo · 2018-05-31T21:15:28Z

+  /// generated FromJson factory will be ignored.
+  ///
+  /// If `true`, any unrecognized keys will be treated as an error.
+  /// ```


remove triple-ticks?

kevmoo · 2018-05-31T21:15:52Z

@@ -1,3 +1,7 @@
+## 0.5.6
+
+* Added support for `JsonSerializable.disallowUnrecognizedKeys`.


Put runtime info here from json_annotation

kevmoo · 2018-05-31T21:16:14Z

@@ -1,3 +1,7 @@
+## 0.5.6
+
+* Added support for `JsonSerializable.disallowUnrecognizedKeys`.


Also note that fromJson functions now use block syntax

kevmoo · 2018-05-31T21:16:51Z

  # Use a tight version constraint to ensure that a constraint on
  # `json_annotation`. Properly constrains all features it provides.
-  json_annotation: '>=0.2.6 <0.2.7'
+  json_annotation: '>=0.2.7 <0.2.8'


kevmoo · 2018-05-31T21:17:43Z

  bool get writeNotNull;
  String get string;
  SimpleObject get simpleObject;
+  StrictKeysObject get strictKeysObject;


nit: it'd be better to put this in the json_serial_example thingy

...this thing is SOOO big. Just update an existing class w/ the annotation to check behavior...

The point is that it literally tests everything though right? Fwiw adding this here did surface an actual error... and it gives coverage for all the combinations of other options which I think is good.

What is the json_serial_example thingy?

going to submit as is for now it should be trivial to make this change as a followup if desired

jakemac53 added 6 commits May 30, 2018 14:46

update json_annotation with the helper and JsonSerializable.allowUnre…

06bf1f6

…cognizedKeys boolean field

add support for JsonSerializable.allowUnrecognizedKeys

5d5acfb

rebuild

15a13fd

get remaining tests passing

2756a2a

disable allowing unrecognized keys for build config test

f321e74

add unit test and prettier error in the test as an example

bdd52e4

jakemac53 requested a review from kevmoo May 31, 2018 16:14

jakemac53 added 2 commits May 31, 2018 09:15

Merge branch 'master' into extra-keys

6e721ff

add path dependency override on json_annotation

e800077

kevmoo reviewed May 31, 2018

View reviewed changes

jakemac53 added 3 commits May 31, 2018 10:17

add a nested object using the new feature to kitchen sync and update …

389fda7

…tests

code review comments

8cbf830

Merge branch 'master' into extra-keys

e521eae

fix spelling error

3eee0e0

kevmoo approved these changes May 31, 2018

View reviewed changes

jakemac53 added 2 commits May 31, 2018 14:59

code review updates

4aabaef

more nits

7c8c1be

jakemac53 changed the title ~~Add allowUnrecognizedKeys option~~ Add disallowUnrecognizedKeys option May 31, 2018

jakemac53 merged commit d63205d into master Jun 1, 2018

jakemac53 deleted the extra-keys branch June 1, 2018 14:02

Gopinathp mentioned this pull request Jan 14, 2020

Float Nan conversion failed #588

Closed

		@@ -1,3 +1,15 @@
		## 0.2.7

		* Added `JsonSerializable.allowUnrecognizedKeys`.

		@@ -1,3 +1,7 @@
		## 0.5.6

		* Added support for `JsonSerializable.disallowUnrecognizedKeys`.

Uh oh!

Conversation

jakemac53 commented May 31, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kevmoo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jakemac53 commented May 31, 2018

Uh oh!

kevmoo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jakemac53 commented May 31, 2018 •

edited

Loading