feat(subdocument): support schematype-level minimize option to disable minimizing empty subdocuments

[vkarpov15]

Fix #15313

Summary

In #11247, we made it so that Mongoose would minimize empty subdocuments by default. However, there isn't a great way to configure that behavior right now: #14151 disabled that behavior for required subdocs, but you might not want to make the field required.

This PR lets you set a minimize option on the schematype itself, like subdoc: { type: Schema, minimize: false } to disable minimize on the full subdocument. Setting minimize: false on the schematype will also override the child schema's minimize.

Examples

[Copilot]

Pull Request Overview

This PR adds support for a schematype-level minimize option on subdocuments to disable the default minimizing behavior for empty subdocuments.

• Adds tests ensuring that an empty subdocument and one with an empty child are retained when minimize is false.
• Overrides the subdocument’s $toObject method to check for schematype-level minimize settings.
• Removes redundant minimize logic from the clone helper to avoid conflicts with the new behavior.

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
test/types.subdocument.test.js	Adds test cases for schematype-level minimize option behavior
lib/types/subdocument.js	Modifies $toObject to respect the schematype-level minimize flag
lib/schema/subdocument.js	Sets schema type options on subdocument prototypes
lib/helpers/clone.js	Removes redundant logic for minimizing empty subdocuments within cloning
lib/document.js	Adjusts toObject implementation to incorporate schematype minimize settings

Comments suppressed due to low confidence (1)

lib/helpers/clone.js:70

• The removal of the minimization check in the clone function may lead to inconsistent behavior compared to the updated $toObject logic. Please verify that this change is intentional and that cloning subdocuments with the minimize option set behaves as expected.

if (options && options.minimize && !obj.constructor.$__required && isSingleNested && Object.keys(ret).length === 0) {

[hasezoey]

LGTM, though i think this option still needs to be added to SchemaSubDocumentOptions (at least i did not see it in the chain yet)

[vkarpov15]

Fixed in 5853a8b