test+docs: improve tests and examples about allowNull - #16299
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves coverage and documentation around how allowNull: false behaves when paths are omitted vs explicitly set to undefined, including behavior in validation, saving, and findOneAndUpdate() with runValidators.
Changes:
- Expand validation tests to cover
{}vs{ name: undefined }forallowNull: false. - Adjust
findOneAndUpdate()tests to demonstrate that$set: { name: undefined }is stripped and does not modify the stored value. - Update
SchemaType#allowNullJSDoc example to include the{}case and clarifyundefinedbehavior.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| test/schema.validation.test.js | Adds a validation case for an omitted allowNull: false path ({}) to confirm it isn’t implicitly required. |
| test/model.findOneAndUpdate.test.js | Updates the runValidators test to assert behavior when $set contains undefined (no-op after Mongoose strips it). |
| test/document.test.js | Adds a save/insert regression test illustrating how undefined is handled for allowNull: false paths (top-level and nested). |
| lib/schemaType.js | Updates the allowNull API docs example to cover omitted paths and clarify undefined treatment. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
AbdelrahmanHafez
requested changes
May 28, 2026
AbdelrahmanHafez
left a comment
Collaborator
There was a problem hiding this comment.
One comment, otherwise LGTM
hasezoey
approved these changes
May 28, 2026
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
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
Add a quick example and some tests elaborating on how
allowNullhandles keys that are explicitly set toundefined.Examples