Validate JSON after decode #623
Merged
Conversation
This file contains 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
Closes #621 Custom JSON validations are currently run before the value stored in the database is converted to the Python type. This creates an asymmetry in the validation function as it runs against the Python type on create/update, but against the raw JSON string on fetch. This changes the order of operations so the JSON is decoded before validation is run, along with a test for each of the three supported input types for the field.
gregbeech
commented
Jan 25, 2021
| id = fields.IntField(pk=True) | ||
| data = fields.JSONField() | ||
| data_null = fields.JSONField(null=True) | ||
| data_default = fields.JSONField(default={"a": 1}) | ||
| data_validate = fields.JSONField(null=True, validators=[lambda v: JSONFields.dict_or_list(v)]) |
There was a problem hiding this comment.
Putting the field on this model means the 'describe' tests need to be updated, but it feels more appropriate than putting it on the validation model as this is testing the JSONField itself, not packaged validations. I've used a static method on the object rather than a module method as the validator to keep things self-contained, but happy to change if you find it too clumsy.
|
Looks good, could you update changelog and version? After CI pass, I will merge it. |
Pull Request Test Coverage Report for Build 509686588
💛 - Coveralls |
long2ice
approved these changes
Jan 25, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Validates JSON retrieved from the database after decode rather than before.
Description
Changes the order of operations so JSON is decoded before validation is run, along with a test for each of the three supported input types for the field.
Motivation and Context
Custom JSON validations are currently run before the value stored in the database is converted to the Python type. This creates an asymmetry in the validation function as it runs against the Python type on create/update, but against the raw JSON string on fetch.
Closes #621
How Has This Been Tested?
All unit tests run.
Checklist: