Serialize fields that are relations to another model correctly #4
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
akikoskinen
changed the title
The snapshot tests require fixed data, which was previously provided by two tests. The fixed data can be provided by the test data factory too.
This is a more appropriate name for this value, which describes a field in model.
The inner function can get everything it needs from the outer context.
The previous code serialized every field twice. First to check if it should get included into the end result (if it's not `None`), and if yes, then another time for the actual return value.
Removes one identical getattr call.
If a model that is serialized has a field that is a relation to another model, that related model's (or manager's) `serialize` method needs to be called. Tested this by serializing also the User model that Profile model has a one-to-one relation to. The "user" field is now serialized twice, once via its `serialize` method and once with the special "accessor".
akikoskinen
force-pushed
the
fix-related-field-serialize
branch
from
90b0373
to
1ece52b
Compare
Codecov Report
@@ Coverage Diff @@
## main #4 +/- ##
==========================================
+ Coverage 91.83% 92.23% +0.39%
==========================================
Files 4 4
Lines 98 103 +5
Branches 13 14 +1
==========================================
+ Hits 90 95 +5
Misses 5 5
Partials 3 3
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
mikkokeskinen
approved these changes
Apr 13, 2023
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.
While making the library more configurable, I encountered an issue that the serialization didn't work for fields that are relations to another model. The
Profilemodel'suserfield, as a one-to-one relation to theUsermodel, is an example of such a field. Theuserfield was previously serialized only with an "accessor" that extracted only a single field from theUsermodel. Without an accessor serialization of theuserfield didn't work.Before fixing the above mentioned issue, I did some refactoring on the serialization code.