fix(map): avoid throwing required error if saving map of primitives with required: true #15542
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
…ith required: true
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a bug where maps with required schema values were incorrectly throwing validation errors on the internal $* path representation instead of validating the actual map entries properly.
- Adds logic to skip validation of
$*paths which represent map schemas rather than actual document paths - Includes comprehensive test coverage for the required validation behavior in maps
- Updates existing test to use async/await pattern for consistency
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| lib/document.js | Adds check to skip validation of $* paths in _getPathsToValidate function |
| test/types.map.test.js | Adds new test case for required validation in maps and updates existing test to async |
Comments suppressed due to low confidence (1)
test/types.map.test.js:108
- [nitpick] The test name 'handles required in maps' is somewhat vague. Consider a more descriptive name like 'should validate required fields in map values' or 'should enforce required validation on map entries'.
it('handles required in maps', async function() {
hasezoey
approved these changes
Jul 19, 2025
AbdelrahmanHafez
approved these changes
Jul 19, 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
If you create a map path using
type: { Map, of: String }, you can storenullvalues in that map. However, currently, if you try to setrequired: trueon a map value path you get a validation error onmap.$*whenever you try to validate a document.Examples