[cloud_firestore] Fix crashes when using DocumentReference with Query (…

…firebase#1955) * Encode values using in Query#where
serhatkrc · Feb 9, 2020 · 35ae59e · 35ae59e
1 parent 1b45082
commit 35ae59e
Show file tree

Hide file tree

Showing 4 changed files with 78 additions and 10 deletions.
diff --git a/packages/cloud_firestore/cloud_firestore/CHANGELOG.md b/packages/cloud_firestore/cloud_firestore/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.13.1+1
+
+* Fixed crashes when using `Query#where` with `DocumentReference` objects
+
 ## 0.13.1
 
 * Migrate to `cloud_firestore_platform_interface`.

diff --git a/packages/cloud_firestore/cloud_firestore/example/test_driver/cloud_firestore.dart b/packages/cloud_firestore/cloud_firestore/example/test_driver/cloud_firestore.dart
@@ -372,5 +372,67 @@ void main() {
       expect(snapshot1.documentID, 'la');
       expect(snapshot2.documentID, 'tokyo');
     });
+
+    test('Query.whereArrayContainsAny using DocumentReference', () async {
+      final CollectionReference ref = firestore.collection('messages');
+      await ref.document('test-docRef-1').setData({"message": "1"});
+      await ref.document('test-docRef-2').setData({"message": "2"});
+
+      await ref.document('test-docRef').setData(<String, dynamic>{
+        'children': <DocumentReference>[
+          ref.document("test-docRef-1"),
+          ref.document("test-docRef-2")
+        ],
+      });
+
+      final QuerySnapshot snapshot = await ref.where('children',
+          arrayContainsAny: <DocumentReference>[
+            ref.document("test-docRef-1"),
+            ref.document("test-docRef-2")
+          ]).getDocuments();
+      final List<DocumentSnapshot> results = snapshot.documents;
+      expect(results.length, 1);
+      final DocumentSnapshot actual = results[0];
+      expect(actual.documentID, 'test-docRef');
+    });
+
+    test('Query.whereIn using DocumentReference', () async {
+      final CollectionReference ref = firestore.collection('messages');
+      await ref.document('test-docRef-1').setData({"message": "1"});
+      await ref.document('test-docRef-2').setData({"message": "2"});
+
+      final QuerySnapshot snapshot = await ref.where(FieldPath.documentId,
+          whereIn: <DocumentReference>[
+            ref.document("test-docRef-1"),
+            ref.document("test-docRef-2")
+          ]).getDocuments();
+      final List<DocumentSnapshot> results = snapshot.documents;
+      expect(results.length, 2);
+      expect(results.where((item) => item.documentID == "test-docRef-1").length,
+          equals(1));
+      expect(results.where((item) => item.documentID == "test-docRef-2").length,
+          equals(1));
+    });
+
+    test('Query.arrayContains using DocumentReference', () async {
+      final CollectionReference ref = firestore.collection('messages');
+      await ref.document('test-docRef-1').setData({"message": "1"});
+      await ref.document('test-docRef-2').setData({"message": "2"});
+
+      await ref.document('test-docRef').setData(<String, dynamic>{
+        'children': <DocumentReference>[
+          ref.document("test-docRef-1"),
+          ref.document("test-docRef-2")
+        ],
+      });
+
+      final QuerySnapshot snapshot = await ref
+          .where('children', arrayContains: ref.document("test-docRef-1"))
+          .getDocuments();
+      final List<DocumentSnapshot> results = snapshot.documents;
+      expect(results.length, 1);
+      final DocumentSnapshot actual = results[0];
+      expect(actual.documentID, 'test-docRef');
+    });
   });
 }
diff --git a/packages/cloud_firestore/cloud_firestore/lib/src/query.dart b/packages/cloud_firestore/cloud_firestore/lib/src/query.dart
@@ -66,15 +66,17 @@ class Query {
     bool isNull,
   }) =>
       Query._(
-          _delegate.where(field,
-              isEqualTo: isEqualTo,
-              isLessThan: isLessThan,
-              isLessThanOrEqualTo: isLessThanOrEqualTo,
-              isGreaterThan: isGreaterThan,
-              isGreaterThanOrEqualTo: isGreaterThanOrEqualTo,
-              arrayContainsAny: arrayContainsAny,
-              arrayContains: arrayContains,
-              whereIn: whereIn,
+          _delegate.where(_CodecUtility.valueEncode(field),
+              isEqualTo: _CodecUtility.valueEncode(isEqualTo),
+              isLessThan: _CodecUtility.valueEncode(isLessThan),
+              isLessThanOrEqualTo:
+                  _CodecUtility.valueEncode(isLessThanOrEqualTo),
+              isGreaterThan: _CodecUtility.valueEncode(isGreaterThan),
+              isGreaterThanOrEqualTo:
+                  _CodecUtility.valueEncode(isGreaterThanOrEqualTo),
+              arrayContainsAny: _CodecUtility.valueEncode(arrayContainsAny),
+              arrayContains: _CodecUtility.valueEncode(arrayContains),
+              whereIn: _CodecUtility.valueEncode(whereIn),
               isNull: isNull),
           firestore);
 

diff --git a/packages/cloud_firestore/cloud_firestore/pubspec.yaml b/packages/cloud_firestore/cloud_firestore/pubspec.yaml
@@ -3,7 +3,7 @@ description:
   Flutter plugin for Cloud Firestore, a cloud-hosted, noSQL database with
   live synchronization and offline support on Android and iOS.
 homepage: https://github.com/FirebaseExtended/flutterfire/tree/master/packages/cloud_firestore/cloud_firestore
-version: 0.13.1
+version: 0.13.1+1
 
 flutter:
   plugin: