Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat!: add support for the Query Partition API #202

Merged
merged 16 commits into from Aug 4, 2020
Merged

feat!: add support for the Query Partition API #202

merged 16 commits into from Aug 4, 2020

Conversation

schmidt-sebastian
Copy link
Contributor

@schmidt-sebastian schmidt-sebastian commented Apr 30, 2020 •
edited

This changes Firestore.collectionGroup() to return a new CollectionGroup class. CollectionGroup then gets a new getPartitions() API, which is usable as long as the Query hasn't been customized (which would turn CollectionGroup into a Query).

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Apr 30, 2020
@BenWhitehead BenWhitehead added the status: blocked Resolving the issue is dependent on other work. label May 1, 2020
@BenWhitehead
Copy link
Collaborator

Looks okay once we're able to get the protos in place for this to build.

@BenWhitehead BenWhitehead added this to the v2 milestone Jul 21, 2020
@BenWhitehead BenWhitehead removed the status: blocked Resolving the issue is dependent on other work. label Jul 21, 2020
@codecov
Copy link

codecov bot commented Jul 28, 2020 •
edited

Codecov Report

Merging #202 into master will decrease coverage by 0.66%.
The diff coverage is 41.66%.

Impacted file tree graph

@@             Coverage Diff              @@
##             master     #202      +/-   ##
============================================
- Coverage     72.75%   72.08%   -0.67%     
+ Complexity      979      968      -11     
============================================
  Files            58       60       +2     
  Lines          5098     5145      +47     
  Branches        641      651      +10     
============================================
  Hits           3709     3709              
- Misses         1184     1231      +47     
  Partials        205      205
Impacted Files Coverage Δ Complexity Δ
...ava/com/google/cloud/firestore/QueryPartition.java 0.00% <0.00%> (ø) 0.00 <0.00> (?)
...oogle/cloud/firestore/spi/v1/GrpcFirestoreRpc.java 0.00% <0.00%> (ø) 0.00 <0.00> (ø)
...va/com/google/cloud/firestore/CollectionGroup.java 23.33% <23.33%> (ø) 1.00 <1.00> (?)
.../com/google/cloud/firestore/UserDataConverter.java 96.26% <92.30%> (-1.27%) 37.00 <13.00> (+13.00) ⬇️
...a/com/google/cloud/firestore/DocumentSnapshot.java 79.06% <100.00%> (-3.08%) 37.00 <0.00> (-13.00)
...java/com/google/cloud/firestore/FirestoreImpl.java 80.00% <100.00%> (ø) 25.00 <0.00> (-2.00)
...rc/main/java/com/google/cloud/firestore/Query.java 87.93% <100.00%> (-0.16%) 120.00 <1.00> (-8.00)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 03ef755...b955c6d. Read the comment docs.

@google-cla
Copy link

google-cla bot commented Jul 28, 2020

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

@google-cla google-cla bot added cla: no This human has *not* signed the Contributor License Agreement. and removed cla: yes This human has signed the Contributor License Agreement. labels Jul 28, 2020
@schmidt-sebastian schmidt-sebastian changed the base branch from mrschmidt/parition-generated-code to master July 28, 2020 22:43
@schmidt-sebastian schmidt-sebastian changed the title Partition API proposal feat: add support for the Partition API Jul 28, 2020
@google-cla google-cla bot added cla: yes This human has signed the Contributor License Agreement. and removed cla: no This human has *not* signed the Contributor License Agreement. labels Jul 28, 2020
@schmidt-sebastian schmidt-sebastian added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 29, 2020
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 29, 2020
BenWhitehead
BenWhitehead requested changes Jul 30, 2020
View reviewed changes
Copy link
Collaborator

@BenWhitehead BenWhitehead left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few minor things

google-cloud-firestore/src/main/java/com/google/cloud/firestore/CollectionGroup.java Outdated Show resolved Hide resolved
google-cloud-firestore/src/main/java/com/google/cloud/firestore/QueryPartition.java Outdated Show resolved Hide resolved
google-cloud-firestore/src/main/java/com/google/cloud/firestore/QueryPartition.java Show resolved Hide resolved
google-cloud-firestore/src/main/java/com/google/cloud/firestore/QueryPartition.java Show resolved Hide resolved
google-cloud-firestore/src/test/java/com/google/cloud/firestore/it/ITSystemTest.java Outdated Show resolved Hide resolved
schmidt-sebastian and others added 4 commits July 31, 2020 09:53
@schmidt-sebastian @BenWhitehead
Update google-cloud-firestore/src/main/java/com/google/cloud/firestor…
3522641 
…e/CollectionGroup.java

Co-authored-by: BenWhitehead <BenWhitehead@users.noreply.github.com>
@schmidt-sebastian @BenWhitehead
Update google-cloud-firestore/src/main/java/com/google/cloud/firestor…
923b0e7 
…e/QueryPartition.java

Co-authored-by: BenWhitehead <BenWhitehead@users.noreply.github.com>
@schmidt-sebastian @BenWhitehead
Update google-cloud-firestore/src/test/java/com/google/cloud/firestor…
7f23045 
…e/it/ITSystemTest.java

Co-authored-by: BenWhitehead <BenWhitehead@users.noreply.github.com>
@schmidt-sebastian
Review
0f1ef47
@BenWhitehead BenWhitehead changed the title feat: add support for the Partition API feat: add support for the Query Partition API Jul 31, 2020
schmidt-sebastian and others added 5 commits July 31, 2020 11:52
@schmidt-sebastian @BenWhitehead
Update google-cloud-firestore/src/main/java/com/google/cloud/firestor…
01de6e6 
…e/QueryPartition.java

Co-authored-by: BenWhitehead <BenWhitehead@users.noreply.github.com>
@schmidt-sebastian @BenWhitehead
Update google-cloud-firestore/src/main/java/com/google/cloud/firestor…
12f3f0b 
…e/QueryPartition.java

Co-authored-by: BenWhitehead <BenWhitehead@users.noreply.github.com>
@schmidt-sebastian
Remove duplicate license header
9cfe528
@schmidt-sebastian
Fix compile
7f7f1d9
@BenWhitehead
chore: update clirr rules to allow new method on FirestoreRpc
7d7e425
@schmidt-sebastian schmidt-sebastian changed the title feat: add support for the Query Partition API feat!: add support for the Query Partition API Aug 4, 2020
@schmidt-sebastian schmidt-sebastian merged commit 3996548 into master Aug 4, 2020
@schmidt-sebastian schmidt-sebastian deleted the mrschmidt/partitionproposal branch August 4, 2020 21:00
@release-please release-please bot mentioned this pull request Aug 4, 2020
Merged
gcf-merge-on-green bot pushed a commit that referenced this pull request Aug 14, 2020
@release-please
chore: release 2.0.0 (#309)
f2ea1b9 
🤖 I have created a release \*beep\* \*boop\* 
---
## [2.0.0](https://www.github.com/googleapis/java-firestore/compare/v1.35.2...v2.0.0) (2020-08-14)


### New Features

#### Query Partition API

New API and backend RPC which allows for fetching a set of cursor keys for a 
Collection Group Query. Accessible via the new [`CollectionGroup#getPartitions(long,ApiStreamObserver)`](https://googleapis.dev/java/google-cloud-firestore/2.0.0/com/google/cloud/firestore/CollectionGroup.html#getPartitions-long-com.google.api.gax.rpc.ApiStreamObserver-) method. 

#### Read-Only Transaction Options

[`TransactionOptions`](https://googleapis.dev/java/google-cloud-firestore/2.0.0/com/google/cloud/firestore/TransactionOptions.html)
has been refactored to provide the ability to configure options for read-only 
transactions along with the existing configuration for read-write transactions.

This new ability is provided via the new [`TransactionOptions.createReadOnlyOptionsBuilder()`](https://googleapis.dev/java/google-cloud-firestore/2.0.0/com/google/cloud/firestore/TransactionOptions.html#createReadOnlyOptionsBuilder--) 
type safe builder.

Along with the new type safe builder for read-only options, there is a new type 
safe builder for read-write options as well accessible via [`TransactionOptions.createReadWriteOptionsBuilder()`](https://googleapis.dev/java/google-cloud-firestore/2.0.0/com/google/cloud/firestore/TransactionOptions.html#createReadWriteOptionsBuilder--). Each of the existing `TransactionOptions.create(...)`
methods for configuring read-write options has been deprecated in favor of the new builder.

#### EmulatorCredentials

`com.google.cloud.firestore.FirestoreOptions.Builder.FakeCredentials` has been
made static and renamed to `com.google.cloud.firestore.FirestoreOptions.EmulatorCredentials`
allowing instantiation outside `FirestoreOptions.Builder`.

When connecting to the Cloud Firestore Emulator via `FirestoreOptions` rather than
the environment variable `FIRESTORE_EMULATOR_HOST`, a custom credential implementation
must be specified to allow various admin operations in the emulator. Previously
this required users to create their own implementation due to it not being 
possible to construct a `FakeCredential`. As part of this change, `EmulatorCredentials`
is static and therefore able to be constructed from any location.

### Breaking Changes

#### New Firestore Admin Client API Artifact

The Cloud Firestore Admin Client has been migrated to its own maven artifact `com.google.cloud:google-cloud-firestore-admin`
rather than being bundled in `com.google.cloud:google-cloud-firestore`. All 
packages and classes have retained their existing names.

The new artifact is included in the `com.google.cloud:google-cloud-firestore-bom`, 
`com.google.cloud:google-cloud-bom` and `com.google.cloud:libraries-bom` 
artifacts and is accessible by adding the new dependency to your `pom.xml` file:

```xml
<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-firestore-admin</artifactId>
</dependency>
```

#### Removal of v1beta1

Cloud Firestore has been GA for some time now, and the `google-cloud-firestore` 
code base has been using the protos and generated classes for the v1 api since 
that time. As such, we will no longer be publishing artifacts for the deprecated
v1beta1 protos. All functionality from v1beta1 is present in v1, and all users
should update any code to use v1.

#### Removal of support for `java.util.Date` in Snapshots

It is no longer possible to configure the ability for `java.util.Date` to be
returned from `DocumentSnapshot.get(FieldPath)` or `DocumentSnapshot.getData()`
for properties which are stored as Timestamps in Cloud Firestore.

The default behavior has been to return `com.google.cloud.Timestamp` by default
for some time, and is now the only option. Any code that is dependent on the old
behavior must be updated to use Timestamps instead of Date.

### Laundry List of Pull Requests

#### ⚠ BREAKING CHANGES

* add support for the Query Partition API (#202)
  * `Firestore#collectionGroup(...)` has a new return type `CollectionGroup` 
    which requires any code that previously used the method be re-compiled to
    pick up the new signature. `CollectionGroup` extends `Query` and as such 
    does not require your code to be updated, only the compiled class files.
* move FirestoreAdminClient and associated classes to new artifact google-cloud-firestore-admin (#311)
* remove deprecated v1beta1 protos and grpc client (#305)
* remove deprecated FirestoreOptions#setTimestampsInSnapshotsEnabled (#308)
* remove deprecated getCollections() methods (#307)
* various renames due to generator changes

#### Features

* add support for read-only transactions in TransactionOptions ([#320](https://www.github.com/googleapis/java-firestore/issues/320)) ([c25dca3](https://www.github.com/googleapis/java-firestore/commit/c25dca3ed6ca0c156ec60569ebc9f3a481bd4fee))
* add support for the Query Partition API ([#202](https://www.github.com/googleapis/java-firestore/issues/202)) ([3996548](https://www.github.com/googleapis/java-firestore/commit/39965489cbc836af573e500d57007c88241d7eb6))


#### Bug Fixes

* refactor FakeCredentials ([#325](https://www.github.com/googleapis/java-firestore/issues/325)) ([269e62c](https://www.github.com/googleapis/java-firestore/commit/269e62c6b8031d48e7f2e282b09b5ffcfadae547)), closes [#190](https://www.github.com/googleapis/java-firestore/issues/190)


#### Dependencies

* update dependency com.google.cloud:google-cloud-shared-dependencies to v0.8.5 ([#322](https://www.github.com/googleapis/java-firestore/issues/322)) ([1b21350](https://www.github.com/googleapis/java-firestore/commit/1b21350c0bc4a21cee2b281f944cbd061b1f8898))
* update dependency com.google.cloud:google-cloud-shared-dependencies to v0.8.6 ([#324](https://www.github.com/googleapis/java-firestore/issues/324)) ([b945fdb](https://www.github.com/googleapis/java-firestore/commit/b945fdb04da76a1e007d012c809449c5a43bb990))
* update jackson dependencies to v2.11.2 ([#314](https://www.github.com/googleapis/java-firestore/issues/314)) ([15d68cd](https://www.github.com/googleapis/java-firestore/commit/15d68cd93ac1fd206895fd37155a9ba82b9196ca))


#### Miscellaneous Chores

* enable gapicv2 ([#188](https://www.github.com/googleapis/java-firestore/issues/188)) ([92224bc](https://www.github.com/googleapis/java-firestore/commit/92224bcd52aa88cc6eb1da28747de0535d776a0f))
* move FirestoreAdminClient and associated classes to new artifact google-cloud-firestore-admin ([#311](https://www.github.com/googleapis/java-firestore/issues/311)) ([03ef755](https://www.github.com/googleapis/java-firestore/commit/03ef755dd164e6f1ec749f3f985b913b5ae23d14))
* remove deprecated FirestoreOptions#setTimestampsInSnapshotsEnabled ([#308](https://www.github.com/googleapis/java-firestore/issues/308)) ([7255a42](https://www.github.com/googleapis/java-firestore/commit/7255a42bcee3a6938dd5fafaef3465f948f39600))
* remove deprecated getCollections() methods ([#307](https://www.github.com/googleapis/java-firestore/issues/307)) ([bb4ddf1](https://www.github.com/googleapis/java-firestore/commit/bb4ddf1ce3cc3bd2e06a4ad5097bd18060e4467b))
* remove deprecated v1beta1 protos and grpc client ([#305](https://www.github.com/googleapis/java-firestore/issues/305)) ([96adacb](https://www.github.com/googleapis/java-firestore/commit/96adacbf52ace27e54b7a210d7c73b46922fbcbd))
* add BulkWriter ([#323](https://www.github.com/googleapis/java-firestore/issues/323)) ([e7054df](https://www.github.com/googleapis/java-firestore/commit/e7054df79b4139fdfd0cc6aa0620fbfa1a10a6b0))
* make BulkWriter package private ([#330](#330)) ([ef0869a](ef0869a))

---


This PR was generated with [Release Please](https://github.com/googleapis/release-please).
@schmidt-sebastian schmidt-sebastian mentioned this pull request Oct 2, 2020
Merged
@quartzmo quartzmo mentioned this pull request May 22, 2021
Merged
@crwilcox crwilcox mentioned this pull request Jun 3, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@elharo elharo elharo left review comments

@BenWhitehead BenWhitehead BenWhitehead approved these changes

Assignees

@BenWhitehead BenWhitehead

Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Milestone
v2
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@schmidt-sebastian @BenWhitehead @elharo @googlebot @yoshi-kokoro