Bugfix: Include related virtualAttributes in toJSON() calls #1258
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
venables
force-pushed
the
bug/related-virtual-attributes
branch
from
0e1e189
to
ddaeb41
Compare
|
Oh, crap! I thought there was a test for this case, but it uses the same model class for the related items. I'll merge this or some other fix as soon as I get to my computer. |
|
I believe I also experienced the breakage that this PR addresses. |
|
@koskimas Considering this bug was introduced in a patch release, most apps will pick up this bug due to npm defaults. What are your thoughts on reverting the original change to fix the apps in the wild, and re-relasing as a minor version bump? |
|
Yeah, I'll release a new version right now. Why would I revert the original change instead of fixing this bug? |
|
By the way, thanks for fixing this @venables 🙇♂️ |
|
objection 1.6.5 is out |
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.
Bug: When calling toJSON on a model with related objects, the related objects do not include their virtualAttributes.
Cause: Due to the change introduced in 5530377 (to close #1252), calls to
toJSONset an array of virtualAttributes foropt.virtuals. This array is then passed to child/related objecttoJSONcalls. This causes the related models to believe they were called withtoJSON({ virtuals: [<parent attributes>] }), thus excluding their own virtualAttributes.For example, if a
Postbelongs to oneUser, and theUserhas a virtualfullName, callingpost.toJSON()would not includeuser.fullNameI can confirm
v1.6.3works as expected, andv1.6.4introduced the bug.Solution:
This PR partially reverts 5530377 to allow for virtualAttributes to be calculated on a per-model basis by default.
Another solution would be to entirely revert 5530377