feat: add support for applying default converter in withConverter() #1394
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
google-cla
bot
added
the
cla: yes
product-auto-label
bot
added
the
api: firestore
Codecov Report
@@ Coverage Diff @@
## master #1394 +/- ##
==========================================
+ Coverage 98.28% 98.51% +0.22%
==========================================
Files 32 32
Lines 19341 19374 +33
Branches 1308 1273 -35
==========================================
+ Hits 19010 19086 +76
+ Misses 321 284 -37
+ Partials 10 4 -6
Continue to review full report at Codecov.
|
dev/src/collection-group.ts
Outdated
| * Firestore. | ||
| * @param {FirestoreDataConverter | null} converter Converts objects to and | ||
| * from Firestore. Passing in `null` applies the default `DocumentData` typed | ||
| * converter. |
There was a problem hiding this comment.
Maybe: Passing in null removes the current converter.
Up to you.
There was a problem hiding this comment.
Thanks, this is clearer since users might not have the concept of a default converter.
dev/src/collection-group.ts
Outdated
| ): CollectionGroup<U> { | ||
| return new CollectionGroup<U>( | ||
| this.firestore, | ||
| this._queryOptions.collectionId, | ||
| converter | ||
| converter !== null ? converter : defaultConverter() |
There was a problem hiding this comment.
Since this is NodeJS and we don't care as much about code size, you could also use converter ?? defaultConverter.
dev/system-test/firestore.ts
Outdated
| @@ -148,6 +148,7 @@ describe('Firestore class', () => { | |||
| }); | |||
|
|
|||
| it('getAll() supports generics', async () => { | |||
| randomCol.doc('lo')._converter; | |||
dev/test/query.ts
Outdated
Comment on lines
744
to
745
| // Check that the Post class's toString() override does not apply. | ||
| expect(posts.docs[0].data().toString()).to.equal('[object Object]'); |
There was a problem hiding this comment.
Can we not do an instanceof check here?
dev/test/query.ts
Outdated
| @@ -741,8 +742,7 @@ describe('query interface', () => { | |||
|
|
|||
| const posts = await coll.where('title', '==', 'post').get(); | |||
| expect(posts.size).to.equal(1); | |||
| // Check that the Post class's toString() override does not apply. | |||
| expect(posts.docs[0].data().toString()).to.equal('[object Object]'); | |||
| expect(posts.docs[0].data() instanceof Post).to.be.false; | |||
There was a problem hiding this comment.
to.not.be.an.instanceof
schmidt-sebastian
approved these changes
Jan 25, 2021
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.
No description provided.