BREAKING CHANGE: apply minimize by default when updating document #13843
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 #13782
Summary
This change is small code-wise, but significant and worth thinking about carefully. The docs on minimize say that
Mongoose will, by default, "minimize" schemas by removing empty objects.
but don't specify exactly when minimize is applied.Right now, Mongoose only applies
minimize()
when$toObject()
is called. So that means when yousave()
a new doc, Mongoose appliesminimize()
unless you setminimize: false
option in your schema. However, if you try to update an existing doc's nested or subdocument property, Mongoose will currently not apply minimize: Mongoose will store an empty object in MongoDB. However, if you update a document array on an existing document, Mongoose will minimize the document array.This behavior is inconsistent. This PR makes it so that Mongoose applies
minimize()
when updating an existing document withsave()
. However, I'm a bit worried about changing this behavior; I'm worried of unforeseen consequences. Any thoughts @hasezoey @AbdelrahmanHafez ?Examples