fix(db-mongodb): handle admin.condition in sparse unique indexes#16648
Open
rachit367 wants to merge 1 commit into
Open
fix(db-mongodb): handle admin.condition in sparse unique indexes#16648rachit367 wants to merge 1 commit into
rachit367 wants to merge 1 commit into
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
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.
What?
formatBaseSchemainpackages/db-mongodb/src/models/buildSchema.tsdecides whether a unique index should besparseby checking the staticfield.requiredproperty. A field withrequired: truealways gets a non-sparse unique index, even whenadmin.conditionmakes it only conditionally required.This change treats a field as effectively optional for index purposes whenever
required: trueis combined with anadmin.condition, so a sparse unique index is created and documents that omit the field do not collide onnull.Why?
Fixes #16298.
Today, the following field definition creates a non-sparse unique index:
Two documents where
type !== 'page'both leaveslugasnull, and the second insert fails with a Mongo unique constraint violation because the index treats bothnulls as duplicates.How?
buildSchema.ts:effectivelyOptional = field.required !== true || Boolean(field.admin?.condition).field.required !== truecheck inside the sparse-index branch.No behavior change for fields without
admin.condition— the expression collapses to the original check. Fields that are conditionally required now getsparse: true, matching what already happens forrequired: false, localized, or drafts-enabled fields.Scope is limited to
@payloadcms/db-mongodbsince the issue is reported against the Mongo index builder; other adapters are not touched.