fix(graphql): preserve hasMany relationship order in populated results#17004
Open
yashs33244 wants to merge 1 commit into
Open
fix(graphql): preserve hasMany relationship order in populated results#17004yashs33244 wants to merge 1 commit into
yashs33244 wants to merge 1 commit into
Conversation
hasMany relationship and upload fields could return populated documents in the wrong order when a single relationship to the same collection was queried before the array field in the same request. The populate promises run in parallel via Promise.all and pushed onto results in resolution order, so a dataloader cache hit on a shared document settled out of input order. Assign each populated doc to its source index instead of pushing, then filter out the holes left by skipped entries, so the returned list always matches the stored order regardless of which promise settles first.
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
1 participant
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.
What?
hasMany relationship and upload fields could return populated documents in the wrong order when a single relationship to the same collection was queried before the array field in the same request.
Why?
The populate promises run in parallel via Promise.all and were pushed onto the results array in resolution order, not input order. When a sibling single relationship warms the per-request dataloader cache for a shared document, that document settles out of order, so e.g. [A, B, C] comes back as [B, C, A].
How?
Assign each populated doc to its source index (results[i] = ...) instead of pushing, then filter out the holes left by skipped entries, so the returned list always matches the stored order regardless of which promise settles first. Applied to both the relationship and upload resolvers. Added an int test that reproduces the reorder.
Fixes #14956