Repository navigation
[13.x] Include identical BelongsToMany resources once in JSON:API compound documents - #62360
Merged
taylorotwell merged 2 commits intoNov 7, 2026
Merged
Conversation
This was referenced Nov 7, 2026
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
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.
A
BelongsToManyinclude gets a random_uniqueKey, soincludedcan never deduplicate it. When several primary resources share the same related model,includedrepeats that model once for every primary resource:returns 60 user objects in
includedinstead of 3. The JSON:API spec says a compound document must not include more than one resource object for eachtypeandidpair.The random key exists so that the same model with different pivot data is not collapsed into one object (covered by
testItCanGenerateJsonApiResponseWithRelationshipsUsingSparseIncluded). This PR keeps that, but replaces the random part of the key with a hash of the resolved resource object. Objects that differ, for example in pivot data, still get their own entry. Byte-identical objects are included once.The new test attaches one team to two users and requests
fields[teams]=name. It fails on 13.x (the team appears twice) and passes with this change. The existing JSON:API tests pass unchanged.