fix(query): propagate read preference to populate if read() called after populate()
#15567
+69
−18
Conversation
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
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
hasezoey
approved these changes
Aug 5, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR fixes an issue where read preferences and read concerns were not properly propagated to populate queries when read() or readConcern() methods were called after populate(). The fix ensures that read preferences and read concerns are consistently applied to populate operations regardless of the method call order.
- Moved read preference/concern propagation logic from
populate()method to_optionsForExec()method - Added comprehensive test coverage for both read preference and read concern propagation scenarios
- Fixed existing test to include proper execution for assertion validation
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| lib/query.js | Relocated read preference/concern propagation logic from populate method to execution options preparation |
| test/query.test.js | Added comprehensive test cases for read preference and read concern propagation scenarios |
| test/model.populate.test.js | Fixed existing test by adding missing query execution before assertion |
Comments suppressed due to low confidence (3)
test/query.test.js:4479
- This test accesses internal implementation details (_mongooseOptions) rather than testing the actual behavior. Consider testing the actual MongoDB queries or using a mock to verify the read preference is applied correctly.
assert.strictEqual(query._mongooseOptions.populate.friends.options.readPreference.mode, 'secondaryPreferred');
test/query.test.js:4492
- This assertion checks for a string value while other assertions in the same test check for
.modeproperty. This inconsistency suggests the test may not be validating the correct behavior when explicit readPreference options are provided.
assert.strictEqual(query._mongooseOptions.populate.friends.options.readPreference, 'secondaryPreferred');
test/query.test.js:4515
- This assertion checks for a string value while other assertions in the same test check for
.levelproperty. This inconsistency suggests the test may not be validating the correct behavior when explicit readConcern options are provided.
assert.strictEqual(query._mongooseOptions.populate.friends.options.readConcern, 'local');
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.
Fix #15553
Summary
#15553 points out that
TestModel.findOne().read('secondaryPreferred').populate('friends')applies read preference to populate queries, butTestModel.findOne().populate('friends').read('secondaryPreferred')currently does not. With this PR, we'll apply top-level read preference to all populate queries when executing the query.Examples