fix!: mark v1beta1 client as deprecated #937
Conversation
googlebot
added
the
cla: yes
| s.replace( | ||
| "dev/test/gapic-firestore-v1beta1.ts", | ||
| "/protos/protos'", | ||
| "/protos/firestore_v1beta1_proto_api'" | ||
| ) | ||
|
|
||
| # Mark v1beta1 as deprecated |
There was a problem hiding this comment.
@AlanGasperini @alexander-fenster so this is a funny use for synthtool :) For cases where a specific API version itself is deprecated, how do we let customers know?
There was a problem hiding this comment.
@lukesneeringer Is there any annotation that might help mark the whole API version as deprecated?
| @@ -52,6 +54,7 @@ const version = require('../../../package.json').version; | |||
| * committed. Any read with an equal or greater `read_time` is guaranteed | |||
| * to see the effects of the transaction. | |||
| * @class | |||
| * @deprecated Use v1/firestore_client instead. | |||
There was a problem hiding this comment.
Do we know specifically which tools/situations where this will be surfaced? I think the TypeScript compiler, and eslint will do stuff. Should we consider emitting runtime warnings for users not using these kinds of tools though?
There was a problem hiding this comment.
It shows up in the generated docs (barely legible) and as a warning in VSCode/IntelliJ.
|
@lukesneeringer @JustinBeckwith We want to launch this as part of the breaking Node 10 release, as deprecation warnings might be considered a breaking change by some of our users. Are there any other strategies worth exploring that don't involve search/replace? |
|
that sounds fine to me |
schmidt-sebastian
changed the title
schmidt-sebastian
added
the
do not merge
|
Merging into feature branch. |
* 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 <[email protected]> Co-authored-by: wu-hui <[email protected]>
This PR marks the old v1beta1 protocol as deprecated, which has not been used in our client since 0.20.