chore: use public API types internally #1100
Merged
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
googlebot
added
the
cla: yes
schmidt-sebastian
force-pushed
the
mrschmidt/publicapitypes
branch
from
3e84708
to
f41f905
Compare
Codecov Report
@@ Coverage Diff @@
## node10 #1100 +/- ##
==========================================
- Coverage 98.62% 98.61% -0.02%
==========================================
Files 28 28
Lines 18141 17973 -168
Branches 1407 1405 -2
==========================================
- Hits 17892 17724 -168
Misses 246 246
Partials 3 3
Continue to review full report at Codecov.
|
schmidt-sebastian
force-pushed
the
mrschmidt/publicapitypes
branch
from
8093855
to
1d63e91
Compare
thebrianchen
approved these changes
Jun 3, 2020
There was a problem hiding this comment.
LGTM
I played around with adding some additional prefixes, feel free to include them or ignore: https://github.com/googleapis/nodejs-firestore/compare/mrschmidt/publicapitypes...bc/public-api?expand=1
dev/src/bulk-writer.ts
Outdated
| @@ -122,13 +126,13 @@ class BulkCommitBatch { | |||
| set<T>( | |||
| documentRef: DocumentReference<T>, | |||
There was a problem hiding this comment.
I tried s/: DocumentReference/: firestore.DocumentReference, which resulted in working code even when BulkWriter is made public .
| @@ -26,7 +28,7 @@ import api = google.firestore.v1; | |||
| * | |||
| * @class | |||
| */ | |||
| export class GeoPoint implements Serializable { | |||
| export class GeoPoint implements Serializable, firestore.GeoPoint { | |||
There was a problem hiding this comment.
change static:
static fromProto(proto: google.type.ILatLng): firestore.GeoPoint
| @@ -34,7 +36,7 @@ import api = proto.google.firestore.v1; | |||
| * | |||
| * @class | |||
| */ | |||
| export class FieldValue { | |||
| export class FieldValue implements firestore.FieldValue { | |||
There was a problem hiding this comment.
You can use firestore.FieldValue in several places w/o breaking.
There was a problem hiding this comment.
Thanks for the review and the follow up changes. I imported part of your PR. I opted not to include the following:
- Changes to the return types. I prefer the consistency of the current approach, as we return the internal API type everywhere.
- I did not modify the public types. I think we should to that in an explicit PR.
schmidt-sebastian
added a commit
that referenced
this pull request
Jun 24, 2020
* fix!: mark v1beta1 client as deprecated (#937) * feat!: use QueryDocumentSnapshot in FirestoreDataConverter (#965) * deps: update to gts 2.x (#1013) * chore!: update settings for Node 10 (#1019) * deps: drop through2 (#1014) * feat: support BigInt (#1016) * fix: make update.sh work on Linux (#1043) * fix: only use BigInt in BigInt system test (#1044) * fix: make pbjs compile admin proto again (#1045) * Add BulkWriter (#1055) * docs: Add documentation for FirestoreDataConverter (#1059) * chore: enforce return types (#1065) * fix: add generic to Firestore.getAll() (#1066) * chore: remove internal WriteOp (#1067) * chore: add linter checks for it|describe.only (#1068) * fix: handle terminate in BulkWriter (#1070) * chore: run template copying last in synthtool (#1071) * feat: Firestore Bundles implementation (#1078) * feat: add support for set() with SetOptions when using FirestoreDataConverter (#1087) * feat: Add totalDocuments and totalBytes to bundle metadata. (#1085) * feat: Add totalDocuments and totalBytes to bundle metadata. * fix: Better comment * fix: Better testing. * fix: Improve metadata testing. * fix: incomplete expect in rate-limiter test (#1092) * Remove BatchWrite proto, fix conformance tests * chore: use public API types internally (#1100) * feat: add Partition and BatchWrite protos (#1110) * fix: remove GCF transaction fallback (#1112) * fix: add BulkWriter integration tests, java backport changes, delete fix (#1117) * chore: merge master (#1218) * chore: add eslint check for console.log statements (#1229) * fix: another attempt at fixing the flaky BulkWriter test (#1228) * Fix comment * Renames * Test fix * Fix unit tests Co-authored-by: Brian Chen <chenbrian@google.com> Co-authored-by: wu-hui <53845758+wu-hui@users.noreply.github.com>
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.
This PR updates the code to implement the interfaces for all public types, which should ensure that our API matches our types. It also removes the duplication that we had in
types.ts, since w can directly depend on the interface types that are defined in our.d.tsfile.