fix(model): disallow Model.findOneAndUpdate( 8000 update) and fix TypeScript types re: findOneAndUpdate #15365
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
…t types re: findOneAndUpdate
There was a problem hiding this comment.
Pull Request Overview
This PR disallows the use of Model.findOneAndUpdate() with a single update argument and updates the corresponding documentation and TypeScript types.
- Removed tests for single-argument usage in the test suite
- Updated documentation in both the query and model files to clarify the new behavior
- Removed the legacy single-argument handling block in the model implementation
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| test/model.findOneAndUpdate.test.js | Removed tests that invoked findOneAndUpdate() with a single update argument |
| lib/query.js | Updated the function signature documentation to use "filter" instead of "conditions" |
| lib/model.js | Updated docs and removed legacy behavior for single-argument usage, reflecting the new disallowed usage |
Comments suppressed due to low confidence (1)
test/model.findOneAndUpdate.test.js:328
- Consider adding explicit tests that verify calling findOneAndUpdate with a single argument now throws an appropriate error or is disallowed, to clearly document the expected behavior.
query = M.findOneAndUpdate({ $set: { date: now } });
AbdelrahmanHafez
approved these changes
Apr 22, 2025
hasezoey
approved these changes
Apr 23, 2025
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
Apply #15199 to
findOneAndUpdate(). This looks to be the last model function where we replaceconditionswithupdateif there's only 1 arg.Examples