test(NODE-4498): ts tests for OptionalId wrapping schemas with _id #3486
Conversation
This file contains 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
dariakp
changed the title
baileympearson
previously approved these changes
Dec 14, 2022
| @@ -44,20 +55,110 @@ class MyId {} | |||
| expectNotType<OptionalId<{ _id: MyId; a: number }>>({ a: 3 }); | |||
| expectNotType<OptionalId<{ _id: MyId; a: number }>>({ _id: new ObjectId(), a: 3 }); | |||
|
|
|||
| // OptionalId assignability when wrapping a schema with _id: ObjectId | |||
There was a problem hiding this comment.
optional, non-blocking
I've had two thoughts for better "grouping" tests in our typescript tests
- we could wrap them in functions (
async function testOptionalIdAssignibility() { ... }) - we could just wrap them in arbitrary scopes
two benefits of either approach would be better understanding of where each set of tests start and end, as well as no need to worry about naming collisions
thoughts?
There was a problem hiding this comment.
It's an interesting idea but I don't want to set the precedent in this PR, we can discuss this further when we revisit cleaning up our TS tests at some point
test/types/schema_helpers.test-d.ts
Outdated
Comment on lines
68
to
69
| const typeTestCollection = new Collection<OptionalId<SchemaWithIdType>>({} as Db, 'test'); | ||
| const interfaceTestCollection = new Collection<OptionalId<SchemaWithIdInterface>>({} as Db, 'test'); |
There was a problem hiding this comment.
Suggested change
| const typeTestCollection = new Collection<OptionalId<SchemaWithIdType>>({} as Db, 'test'); | |
| const interfaceTestCollection = new Collection<OptionalId<SchemaWithIdInterface>>({} as Db, 'test'); | |
| declare const typeTestCollection: Collection<OptionalId<SchemaWithIdType>>; | |
| declare const interfaceTestCollection: Collection<OptionalId<SchemaWithIdInterface>>; |
up to you - I find using declare less cluttered than actually instantiating our classes.
dariakp
added
the
Primary Review
baileympearson
approved these changes
Dec 14, 2022
nbbeeken
approved these changes
Dec 15, 2022
baileympearson
deleted the
NODE-4498/ts-optionalid-assignability-tests
branch
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.
Description
NODE-4498
What is changing?
Adding tests to make sure document types returned from methods on a collection using an
OptionalId-wrapped schema with a defined_idare still assignable to the original schema.Is there new documentation needed for these changes?
No
What is the motivation for this change?
Ensure user types continue to work as expected when using the
OptionalIdhelper wrapperDouble check the following
npm run check:lintscripttype(NODE-xxxx)[!]: descriptionfeat(NODE-1234)!: rewriting everything in coffeescript