fix(query): clone PopulateOptions when setting _localModel to avoid state leaking between subpopulate instances #15082
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
…e hood for stack traces
…tate leaking between subpopulate instances Fix #15026
hasezoey
approved these changes
Dec 11, 2024
1 task
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.
Summary
#15026 is a very tricky bug where sometimes
_localModelpopulate option leaks between subpopulate instances. I wasn't able to find the exact root cause to my satisfaction, nor was I able to come up with a consistent repro that doesn't involve repeatedly running the repro script from #15026. However, the more high level explanation is thatutils.populate()doesn't clone instances ofPopulateOptions, so PopulateOptions instances are shared between nested populate calls. This PR makes it so that we clone populate options before setting_localModel.Also, to aid in debugging, I went ahead and refactored populate internals to use async/await instead of callbacks. Should be much cleaner.
Examples