Add warning message when passing DcoumentReference in cursor (#1883)

googleapis · Aug 17, 2023 · cc622fc · cc622fc
1 parent ac35b37
commit cc622fc
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/dev/src/reference.ts b/dev/src/reference.ts
@@ -1845,6 +1845,15 @@ export class Query<T = firestore.DocumentData> implements firestore.Query<T> {
       return this._queryOptions.fieldOrders;
     }
 
+    // TODO(b/296435819): Remove this warning message.
+    if (cursorValuesOrDocumentSnapshot[0] instanceof DocumentReference) {
+      // eslint-disable-next-line no-console
+      console.warn(
+        `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.`
+      );
+    }
+
     const fieldOrders = this._queryOptions.fieldOrders.slice();
 
     // If no explicit ordering is specified, use the first inequality to