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.

Sign up for GitHub

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

fix: Remove DocumentReference special case in cursor #1396

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

fix: Remove DocumentReference special case in cursor #1396

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
674a7ed
remove DocumentReference special case
milaGGL Aug 15, 2023
57eaf46
Merge branch 'main' into mila/fix-DocumentReference-in-Cursor
milaGGL Oct 5, 2023
b9c5f98
remove previously added warning message
milaGGL Oct 5, 2023
24d51c4
import DOCUMENT_PATH
milaGGL Oct 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 4 additions & 41 deletions google-cloud-firestore/src/main/java/com/google/cloud/firestore/Query.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@
import java.util.TreeSet;
import java.util.concurrent.Executor;
import java.util.concurrent.atomic.AtomicReference;
import java.util.logging.Logger;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.threeten.bp.Duration;
Expand All @@ -87,8 +86,6 @@ public class Query {
final FirestoreRpcContext<?> rpcContext;
final QueryOptions options;

private static final Logger LOGGER = Logger.getLogger(Query.class.getName());

/** The direction of a sort. */
public enum Direction {
ASCENDING(StructuredQuery.Direction.ASCENDING),
Expand Down Expand Up @@ -1143,13 +1140,7 @@ public Query startAt(@Nonnull DocumentSnapshot snapshot) {
*/
@Nonnull
public Query startAt(Object... fieldValues) {
// TODO(b/296435819): Remove this warning message.
warningOnSingleDocumentReference(fieldValues);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

remove previously added warning message.


ImmutableList<FieldOrder> fieldOrders =
Copy link
Contributor Author

Choose a reason for hiding this comment

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

remove the special treatment for DocumentReference type

fieldValues.length == 1 && fieldValues[0] instanceof DocumentReference
? createImplicitOrderBy()
: options.getFieldOrders();
ImmutableList<FieldOrder> fieldOrders = options.getFieldOrders();
Cursor cursor = createCursor(fieldOrders, fieldValues, true);

Builder newOptions = options.toBuilder();
Expand Down Expand Up @@ -1232,13 +1223,7 @@ public Query startAfter(@Nonnull DocumentSnapshot snapshot) {
* @return The created Query.
*/
public Query startAfter(Object... fieldValues) {
// TODO(b/296435819): Remove this warning message.
warningOnSingleDocumentReference(fieldValues);

ImmutableList<FieldOrder> fieldOrders =
fieldValues.length == 1 && fieldValues[0] instanceof DocumentReference
? createImplicitOrderBy()
: options.getFieldOrders();
ImmutableList<FieldOrder> fieldOrders = options.getFieldOrders();
Cursor cursor = createCursor(fieldOrders, fieldValues, false);

Builder newOptions = options.toBuilder();
Expand Down Expand Up @@ -1276,13 +1261,7 @@ public Query endBefore(@Nonnull DocumentSnapshot snapshot) {
*/
@Nonnull
public Query endBefore(Object... fieldValues) {
// TODO(b/296435819): Remove this warning message.
warningOnSingleDocumentReference(fieldValues);

ImmutableList<FieldOrder> fieldOrders =
fieldValues.length == 1 && fieldValues[0] instanceof DocumentReference
? createImplicitOrderBy()
: options.getFieldOrders();
ImmutableList<FieldOrder> fieldOrders = options.getFieldOrders();
Cursor cursor = createCursor(fieldOrders, fieldValues, true);

Builder newOptions = options.toBuilder();
Expand All @@ -1300,13 +1279,7 @@ public Query endBefore(Object... fieldValues) {
*/
@Nonnull
public Query endAt(Object... fieldValues) {
// TODO(b/296435819): Remove this warning message.
warningOnSingleDocumentReference(fieldValues);

ImmutableList<FieldOrder> fieldOrders =
fieldValues.length == 1 && fieldValues[0] instanceof DocumentReference
? createImplicitOrderBy()
: options.getFieldOrders();
ImmutableList<FieldOrder> fieldOrders = options.getFieldOrders();
Cursor cursor = createCursor(fieldOrders, fieldValues, false);

Builder newOptions = options.toBuilder();
Expand All @@ -1315,16 +1288,6 @@ public Query endAt(Object... fieldValues) {
return new Query(rpcContext, newOptions.build());
}

private void warningOnSingleDocumentReference(Object... fieldValues) {
if (options.getFieldOrders().isEmpty()
&& fieldValues.length == 1
&& fieldValues[0] instanceof DocumentReference) {
LOGGER.warning(
"Warning: Passing DocumentReference into a cursor without orderBy clause is not an intended "
+ "behavior. Please use DocumentSnapshot or add an explicit orderBy on document key field.");
}
}

/**
* Creates and returns a new Query that ends at the provided document (inclusive). The end
* position is relative to the order of the query. The document must contain all of the fields
Expand Down
18 changes: 0 additions & 18 deletions google-cloud-firestore/src/test/java/com/google/cloud/firestore/QueryTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
import static com.google.cloud.firestore.Filter.*;
import static com.google.cloud.firestore.LocalFirestoreHelper.COLLECTION_ID;
import static com.google.cloud.firestore.LocalFirestoreHelper.DOCUMENT_NAME;
import static com.google.cloud.firestore.LocalFirestoreHelper.DOCUMENT_PATH;
import static com.google.cloud.firestore.LocalFirestoreHelper.SINGLE_FIELD_SNAPSHOT;
import static com.google.cloud.firestore.LocalFirestoreHelper.andFilters;
import static com.google.cloud.firestore.LocalFirestoreHelper.endAt;
Expand Down Expand Up @@ -599,23 +598,6 @@ public void withDocumentIdAndDocumentSnapshotCursor() {
assertEquals(queryRequest, runQuery.getValue());
}

@Test
public void withDocumentReferenceCursor() {
doAnswer(queryResponse())
.when(firestoreMock)
.streamRequest(runQuery.capture(), streamObserverCapture.capture(), any());

DocumentReference documentCursor = firestoreMock.document(DOCUMENT_PATH);
Value documentValue = reference(DOCUMENT_NAME);

query.startAt(documentCursor).get();

RunQueryRequest queryRequest =
query(order("__name__", StructuredQuery.Direction.ASCENDING), startAt(documentValue, true));

assertEquals(queryRequest, runQuery.getValue());
}

@Test
public void withDocumentIdAndDocumentReferenceCursor() {
doAnswer(queryResponse())
Expand Down
4 changes: 3 additions & 1 deletion google-cloud-firestore/src/test/java/com/google/cloud/firestore/it/ITSystemTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -581,7 +581,9 @@ public void startAfterAddsAnImplicitOrderByForDocumentReferences() throws Except
doc1.set(map("foo", 1)).get();
doc2.set(map("foo", 1)).get();

QuerySnapshot querySnapshot = randomColl.startAfter(doc1).get().get();
DocumentSnapshot docSnap = doc1.get().get();

QuerySnapshot querySnapshot = randomColl.startAfter(docSnap).get().get();
assertEquals(1, querySnapshot.size());
Iterator<QueryDocumentSnapshot> documents = querySnapshot.iterator();
assertEquals(doc2, documents.next().getReference());
Expand Down
Loading