types: make versionKey: false disable __v from hydrated document #15511
+110
−82
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
There was a problem hiding this comment.
Pull Request Overview
This PR enhances type tests by transitioning strict expectType checks to expectAssignable for improved flexibility and adds a new test suite (gh15494) to verify that setting versionKey: false removes __v from documents.
- Swapped
expectTypetoexpectAssignablein schema, query, and middleware tests - Introduced
gh15494inschema.test.tsto testversionKey: falsebehavior on__vpresence - Updated query and middleware type assertions for consistency with assignable expectations
Reviewed Changes
Copilot reviewed 4 out of 6 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| test/types/schema.test.ts | Updated type assertions and added gh15494 tests |
| test/types/queries.test.ts | Swapped expectType to expectAssignable in query |
| test/types/middleware.test.ts | Swapped expectType to expectAssignable in middleware |
| test/types/middleware.preposttypes.test.ts | Swapped expectType to expectAssignable across pre/post middleware |
Comments suppressed due to low confidence (1)
test/types/schema.test.ts:1863
- Add similar assertions for toJSON(), e.g.
expectType<number>(docA.toJSON().__v);andexpectError(docB.toJSON().__v);, since the PR description mentionstoJSON()output should also omit__vwhenversionKey: false.
const objA = docA.toObject();
hasezoey
approved these changes
Jul 3, 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.
Fix #15424
Summary
Remove __v from hydrated doc and
toObject()+toJSON()output if user setsversionKey: falsein schema options. Looking to add this in 8.17 as a precaution.Examples