-
Notifications
You must be signed in to change notification settings - Fork 93
/
fake_cloud_firestore_test.dart
1772 lines (1571 loc) · 60.1 KB
/
fake_cloud_firestore_test.dart
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import 'package:clock/clock.dart';
import 'package:cloud_firestore/cloud_firestore.dart';
import 'package:fake_cloud_firestore/fake_cloud_firestore.dart';
import 'package:flutter/services.dart';
import 'package:mock_exceptions/mock_exceptions.dart';
import 'package:test/test.dart';
import 'document_snapshot_matcher.dart';
import 'query_snapshot_matcher.dart';
const uid = 'abc';
final from =
(DocumentSnapshot<Map<String, dynamic>> snapshot, _) => snapshot.exists
? (Movie()
..title = snapshot['title']
..crew = snapshot['crew'])
: null;
final to = (Movie? movie, _) => movie == null
? <String, Object?>{}
: {
'title': movie.title,
'crew': movie.crew,
};
void main() {
group('dump', () {
const expectedDumpAfterset = '''{
"users": {
"abc": {
"name": "Bob",
"location": {
"latitude": 35.680407336326056,
"longitude": 139.76917235721484
}
}
}
}''';
const expectedDumpAfterDelete = '''{
"users": {}
}''';
const expectedDumpAfterDeleteWithSubCollections = '''{
"users": {
"abc": {
"rooms": {
"abc": {
"name": "Room A"
}
}
}
}
}''';
test('deletes document within collection', () async {
final instance = FakeFirebaseFirestore();
final user = instance.collection('users').doc(uid);
await user.set({
'name': 'Bob',
'location': GeoPoint(35.680407336326056, 139.76917235721484)
});
await user.delete();
expect(instance.dump(), expectedDumpAfterDelete);
});
test('deletes document within collection while preserving sub collections',
() async {
final instance = FakeFirebaseFirestore();
final user = instance.collection('users').doc(uid);
await user.set({
'name': 'Bob',
'location': GeoPoint(35.680407336326056, 139.76917235721484)
});
await user.collection('rooms').doc('abc').set({'name': 'Room A'});
await user.delete();
expect(instance.dump(), expectedDumpAfterDeleteWithSubCollections);
});
test('Sets data for a document within a collection', () async {
final instance = FakeFirebaseFirestore();
await instance.collection('users').doc(uid).set({
'name': 'Bob',
'location': GeoPoint(35.680407336326056, 139.76917235721484)
});
expect(instance.dump(), equals(expectedDumpAfterset));
});
test('Updates docs', () async {
final instance = FakeFirebaseFirestore();
final doc = instance.collection('users').doc(uid);
await doc.set({'name': 'Bob'});
await doc.update({'name': 'Chris'});
expect((await doc.get()).get('name'), equals('Chris'));
});
test('docReference.set({}) followed by docReference.get() should return {}',
() async {
final instance = FakeFirebaseFirestore();
/// Create an empty document
final documentReference = instance.collection('docs').doc('1');
await documentReference.set(<String, dynamic>{});
expect((await documentReference.get()).data(), isEmpty);
/// Set empty content to a composite key.
await documentReference.set(<String, dynamic>{
'traits': {'name': {}},
});
expect((await documentReference.get()).get('traits.name'), isEmpty);
});
test('DocumentReference.set throws exceptions', () async {
final instance = FakeFirebaseFirestore();
final doc = instance.collection('users').doc(uid);
whenCalling(Invocation.method(#set, null))
.on(doc)
.thenThrow(FirebaseException(plugin: 'firestore'));
// Works on the same reference.
expect(() => doc.set({'name': 'Bob'}), throwsA(isA<FirebaseException>()));
// Works on a different reference of the same document.
expect(() => instance.collection('users').doc(uid).set({'name': 'Bob'}),
throwsA(isA<FirebaseException>()));
// Does not affect other documents.
expect(
() => instance
.collection('users')
.doc(uid + 'abc')
.set({'name': 'Alice'}),
returnsNormally);
});
test('DocumentReference.get throws exceptions', () async {
final instance = FakeFirebaseFirestore();
final doc = instance.collection('users').doc(uid);
whenCalling(Invocation.method(#get, null))
.on(doc)
.thenThrow(FirebaseException(plugin: 'firestore'));
expect(() => doc.get(), throwsA(isA<FirebaseException>()));
});
test('DocumentReference.delete throws exceptions', () async {
final instance = FakeFirebaseFirestore();
final doc = instance.collection('users').doc(uid);
whenCalling(Invocation.method(#delete, null))
.on(doc)
.thenThrow(FirebaseException(plugin: 'firestore'));
expect(() => doc.delete(), throwsA(isA<FirebaseException>()));
});
test('DocumentReference.update throws exceptions', () async {
final instance = FakeFirebaseFirestore();
final doc = instance.collection('users').doc(uid);
whenCalling(Invocation.method(#update, null))
.on(doc)
.thenThrow(FirebaseException(plugin: 'firestore'));
expect(
() => doc.update({'data': 'new'}), throwsA(isA<FirebaseException>()));
});
test('DocumentReference.set throws exceptions on certain conditions',
() async {
final instance = FakeFirebaseFirestore();
final doc = instance.collection('users').doc(uid);
whenCalling(Invocation.method(#set, [
{'name': 'Bob'}
])).on(doc).thenThrow(FirebaseException(plugin: 'firestore'));
expect(() => doc.set({'name': 'Alice'}), returnsNormally);
expect(() => doc.set({'name': 'Bob'}), throwsA(isA<FirebaseException>()));
});
test('Update fails on non-existent docs', () async {
final instance = FakeFirebaseFirestore();
expect(
instance.collection('messages').doc('newID').update({'name': 'A'}),
throwsA(isA<FirebaseException>()),
);
});
test('Add adds data', () async {
final instance = FakeFirebaseFirestore();
final doc1 = await instance.collection('messages').add({
'content': 'hello!',
'uid': uid,
});
expect(doc1.id.length, greaterThanOrEqualTo(20));
expect(instance.dump(), equals('''{
"messages": {
"${doc1.id}": {
"content": "hello!",
"uid": "abc"
}
}
}'''));
final doc2 = await instance.collection('messages').add({
'content': 'there!',
'uid': uid,
});
expect(instance.dump(), equals('''{
"messages": {
"${doc1.id}": {
"content": "hello!",
"uid": "abc"
},
"${doc2.id}": {
"content": "there!",
"uid": "abc"
}
}
}'''));
});
});
test('brackets to read a field', () async {
final instance = FakeFirebaseFirestore();
final docRef = instance.doc('users/alice');
await docRef.set({'name': 'Alice'});
expect((await docRef.get())['name'], equals('Alice'));
});
group('adding data through collection reference', () {
late FakeFirebaseFirestore instance;
setUp(() {
instance = FakeFirebaseFirestore();
});
test('data with server timestamp', () async {
// arrange
final collectionRef = instance.collection('users');
final data = {
'username': 'johndoe',
'joined': FieldValue.serverTimestamp(),
};
// act
final docId = await collectionRef.add(data);
// assert
final docSnap = await instance.collection('users').doc(docId.id).get();
expect(docSnap.get('username'), 'johndoe');
expect(docSnap.get('joined'), isA<Timestamp>());
});
});
test('nested calls to set work', () async {
final firestore = FakeFirebaseFirestore();
await firestore
.collection('userProfiles')
.doc('a')
.collection('relationship')
.doc('1')
.set({'label': 'relationship1'});
await firestore
.collection('userProfiles')
.doc('a')
.collection('relationship')
.doc('2')
.set({'label': 'relationship2'});
expect(
firestore
.collection('userProfiles')
.doc('a')
.collection('relationship')
.snapshots(),
emits(QuerySnapshotMatcher([
DocumentSnapshotMatcher('1', {
'label': 'relationship1',
}),
DocumentSnapshotMatcher('2', {
'label': 'relationship2',
})
])));
});
test('Snapshots fire on listen even after the latest modification', () async {
final instance = FakeFirebaseFirestore();
final collectionsRef = instance
.collection('users')
.doc(uid)
.collection('datasets')
.withConverter(
fromFirestore: (_, __) => 'Something', toFirestore: (_, __) => {});
final snapshots = collectionsRef.snapshots();
await collectionsRef.add('hello');
await Future.delayed(Duration(milliseconds: 300));
// Listen long after adding the data. We should still expect to get the
// latest state on listen.
snapshots.listen(expectAsync1((snap) {
expect(snap.size, equals(1));
}));
});
group('Document Snapshots fires on deletion', () {
test('without converter', () async {
final instance = FakeFirebaseFirestore();
final collectionRef = instance.collection('users');
final docRef = collectionRef.doc(uid);
// Set document data. This does not fire an update since there is no
// listener yet.
await docRef.set({'name': 'Alice'});
// snapshots() fires once, some time after it returns a stream.
final allSnapshots = docRef.snapshots();
// We forcefully await the doc snapshot with data. Without this, there is a
// race condition where docRef.delete() runs before, and so snapshots()
// fires the first snapshot with no data.
expect(
allSnapshots,
emitsInOrder(
[
predicate<DocumentSnapshot>(
(d) => equals({'name': 'Alice'}).matches(
d.data(),
{},
),
),
predicate<DocumentSnapshot>((s) => !s.exists),
],
),
);
//Await the first snapshot to start the stream
await allSnapshots.first;
// Delete the document.
await docRef.delete();
});
test('with converter and does not call converter with null data', () async {
final instance = FakeFirebaseFirestore();
final collectionRef = instance.collection('movies').withConverter(
fromFirestore: (docSnapshot, options) {
// Make sure that MockDocumentReference does not try to convert with
// null data.
expect(docSnapshot.data(), isNotNull);
return Movie()..title = docSnapshot.data()!['title'];
},
toFirestore: to);
final docRef = collectionRef.doc(uid);
// Set document data. This does not fire an update since there is no
// listener yet.
await docRef.set(Movie()..title = 'Lawrence of Agrabah');
// snapshots() fires once, some time after it returns a stream.
final allSnapshots = docRef.snapshots();
// We forcefully await the doc snapshot with data. Without this, there is a
// race condition where docRef.delete() runs before, and so snapshots()
// fires the first snapshot with no data.
expect(
allSnapshots,
emitsInOrder(
[
predicate<DocumentSnapshot<Movie>>(
(d) => equals('Lawrence of Agrabah').matches(d.data()?.title, {}),
),
predicate<DocumentSnapshot<Movie>>(
(snap) {
return isNull.matches(snap.data(), {}) &&
isFalse.matches(snap.exists, {});
},
),
],
),
);
//Await the first snapshot to start the stream
await allSnapshots.first;
// Delete the document.
await docRef.delete();
});
});
test('Snapshots fire an empty array for empty collections', () async {
final instance = FakeFirebaseFirestore();
final collectionsRef = instance
.collection('users')
.doc(uid)
.collection('datasets')
.withConverter(
fromFirestore: (_, __) => 'Something', toFirestore: (_, __) => {});
collectionsRef.snapshots().listen(expectAsync1((snap) {
expect(snap.size, equals(0));
}));
});
test('Snapshots returns a Stream of Snapshots', () async {
final instance = FakeFirebaseFirestore();
await instance.collection('users').doc(uid).set({
'name': 'Bob',
});
expect(
instance.collection('users').snapshots(),
emits(QuerySnapshotMatcher([
DocumentSnapshotMatcher('abc', {
'name': 'Bob',
})
])));
});
test('Snapshots returns a Stream of Snapshot', () async {
final instance = FakeFirebaseFirestore();
// await instance.collection('users').doc(uid).set({
// 'name': 'Bob',
// });
expect(
instance.collection('users').doc(uid).snapshots(),
emitsInOrder([
DocumentSnapshotMatcher('abc', null),
DocumentSnapshotMatcher('abc', {
'name': 'Bob',
}),
DocumentSnapshotMatcher('abc', {
'name': 'Frank',
}),
]));
await instance.collection('users').doc(uid).set({
'name': 'Bob',
});
await instance.collection('users').doc(uid).update({
'name': 'Frank',
});
});
test('Snapshots returns a Stream of Snapshot changes', () async {
final instance = FakeFirebaseFirestore();
const data = {'name': 'Bob'};
await instance.collection('users').doc(uid).set(data);
instance.collection('users').snapshots().listen(expectAsync1((snap) {
expect(snap.docChanges.length, 1);
expect(snap.docChanges.first.doc.data(), data);
expect(snap.docChanges[0].type, DocumentChangeType.added);
expect(snap.docChanges[0].oldIndex, -1);
expect(snap.docChanges[0].newIndex, 0);
}));
});
test('Snapshots sets exists property to false if the document does not exist',
() async {
final instance = FakeFirebaseFirestore();
await instance.collection('users').doc(uid).set({
'name': 'Bob',
});
instance
.collection('users')
.doc('doesnotexist')
.snapshots()
.listen(expectAsync1((document) {
expect(document.exists, equals(false));
}));
});
test('Snapshots sets exists property to true if the document does exist',
() async {
final instance = FakeFirebaseFirestore();
await instance.collection('users').doc(uid).set({
'name': 'Bob',
});
instance
.collection('users')
.doc(uid)
.snapshots()
.listen(expectAsync1((document) {
expect(document.exists, equals(true));
}));
});
test('Snapshots fire on a non-root collection if a child is updated',
() async {
final instance = FakeFirebaseFirestore();
await instance
.collection('users')
.doc(uid)
.collection('friends')
.doc('bob')
.set({
'name': 'Bob',
});
final friends = instance.collection('users').doc(uid).collection('friends');
await friends.doc('bob').update({'name': 'Bobby'});
friends.snapshots().listen(expectAsync1((snapshot) {
expect(snapshot.size, equals(1));
expect(snapshot.docs.first.get('name'), equals('Bobby'));
}));
});
group('Document reference path', () {
test('collection(...).doc(...).path', () async {
final instance = FakeFirebaseFirestore();
final documentReference = instance
.collection('users')
.doc('aaa')
.collection('friends')
.doc('bbb')
.collection('friends-friends')
.doc('ccc');
expect(
documentReference.path, 'users/aaa/friends/bbb/friends-friends/ccc');
expect(documentReference.parent.path,
'users/aaa/friends/bbb/friends-friends');
});
test('firestore.(Absolute doc reference).path', () async {
final instance = FakeFirebaseFirestore();
// Both should return 'users/abc'.
expect(instance.doc('/users/abc').path, 'users/abc');
expect(instance.doc('users/abc').path, 'users/abc');
});
test('Document and collection parent', () async {
final instance = FakeFirebaseFirestore();
final documentReference = instance
.collection('users')
.doc('aaa')
.collection('friends')
.doc('bbb')
.collection('friends-friends')
.doc('ccc');
final friendsFriends = documentReference.parent;
final bbb = friendsFriends.parent;
expect(bbb, isNotNull);
final friends = bbb!.parent;
final bbbSibling = friends.doc('bbb-sibling');
expect(bbbSibling.path, 'users/aaa/friends/bbb-sibling');
});
});
test('firestore field', () async {
final instance = FakeFirebaseFirestore();
final documentReference =
instance.collection('users').doc('aaa').collection('friends');
expect(documentReference.firestore, instance);
final parent = documentReference.parent;
expect(parent, isNotNull);
expect(parent!.firestore, instance);
});
test('Document reference equality', () async {
final instance = FakeFirebaseFirestore();
final documentReference1 = instance
.collection('users')
.doc('aaa')
.collection('friends')
.doc('xyz');
final documentReference2 = instance.doc('users/aaa/friends/xyz');
expect(documentReference1, equals(documentReference2));
});
test('Creating document reference should not save the document', () async {
final instance = FakeFirebaseFirestore();
await instance.collection('users').add(<String, dynamic>{'name': 'Foo'});
final documentReference = instance.collection('users').doc(uid);
var querySnapshot = await instance.collection('users').get();
expect(querySnapshot.docs, hasLength(1));
// Only after set, the document is available for get
await documentReference.set({'name': 'Bar'});
querySnapshot = await instance.collection('users').get();
expect(querySnapshot.docs, hasLength(2));
});
test('Saving docs in subcollection', () async {
final instance = FakeFirebaseFirestore();
// Creates 1st document in "users/abc/friends/<id>"
await instance
.collection('users')
.doc(uid)
.collection('friends')
.add(<String, dynamic>{'name': 'Foo'});
// The command above does not create a document at "users/abc"
final intermediateDocument =
await instance.collection('users').doc(uid).get();
expect(intermediateDocument.exists, false);
// Gets a reference to an unsaved document.
// This shouldn't appear in get
final documentReference =
instance.collection('users').doc(uid).collection('friends').doc('xyz');
expect(documentReference.path, 'users/$uid/friends/xyz');
var subcollection =
instance.collection('users').doc(uid).collection('friends');
var querySnapshot = await subcollection.get();
expect(querySnapshot.docs, hasLength(1));
// Only after set, the document is available for get
await documentReference.set({'name': 'Bar'});
// TODO: Remove the line below once MockQuery defers query execution.
// https://github.com/atn832/fake_cloud_firestore/issues/31
subcollection = instance.collection('users').doc(uid).collection('friends');
querySnapshot = await subcollection.get();
expect(querySnapshot.docs, hasLength(2));
});
test('Saving docs through FirestoreInstance.doc()', () async {
final instance = FakeFirebaseFirestore();
await instance.doc('users/$uid/friends/xyz').set({
'name': 'Foo',
'nested': {
'k1': 'v1',
}
});
final documentReference =
instance.collection('users').doc(uid).collection('friends').doc('xyz');
final snapshot = await documentReference.get();
expect(snapshot.get('name'), 'Foo');
final nested = snapshot.get('nested') as Map<String, dynamic>;
expect(nested['k1'], 'v1');
});
test('Nonexistent document should have null data', () async {
final nonExistentId = 'nonExistentId';
final instance = FakeFirebaseFirestore();
final snapshot1 =
await instance.collection('users').doc(nonExistentId).get();
expect(snapshot1, isNotNull);
expect(snapshot1.id, nonExistentId);
// data field should be null before the document is saved
expect(snapshot1.data(), isNull);
});
test('Snapshots returns a Stream of Snapshots upon each change', () async {
final instance = FakeFirebaseFirestore();
expect(
instance.collection('users').snapshots(),
emitsInOrder([
// First it should emit an empty array.
QuerySnapshotMatcher([]),
// Then it emits a snapshot with the single added document.
QuerySnapshotMatcher([
DocumentSnapshotMatcher.onData({
'name': 'Bob',
})
])
]));
await instance.collection('users').add({
'name': 'Bob',
});
});
test('Stores DateTime and returns Timestamps', () async {
// As per Firebase's implementation.
final instance = FakeFirebaseFirestore();
final now = DateTime.now();
// Store a DateTime.
await instance.collection('messages').add({
'content': 'hello!',
'uid': uid,
'timestamp': now,
});
// Expect a Timestamp.
expect(
instance.collection('messages').snapshots(),
emits(QuerySnapshotMatcher([
DocumentSnapshotMatcher.onData({
'content': 'hello!',
'uid': uid,
'timestamp': Timestamp.fromDate(now),
})
])));
});
test('delete', () async {
final instance = FakeFirebaseFirestore();
await instance.collection('users').doc(uid).set({
'username': 'Bob',
});
await instance.collection('users').doc(uid).delete();
final users = await instance.collection('users').get();
expect(users.docs.isEmpty, equals(true));
expect(instance.hasSavedDocument('users/abc'), false);
});
group('FieldValue', () {
// The following test is based on
// https://github.com/firebase/flutterfire/blob/26087bb2d1747eb5db82c98424b6d63071137529/packages/cloud_firestore/cloud_firestore/test/field_value_test.dart
// Make sure to update this test if the source changes.
test('Equality', () {
// This is needed, so that the FieldValueFactoryPlatform.instance
// is replaced with MockFieldValueFactoryPlatform
FakeFirebaseFirestore();
expect(FieldValue.delete() == FieldValue.delete(), isTrue);
expect(
FieldValue.serverTimestamp() == FieldValue.serverTimestamp(), isTrue);
expect(FieldValue.delete() == FieldValue.serverTimestamp(), isFalse);
});
test('FieldValue.delete() deletes key values', () async {
final firestore = FakeFirebaseFirestore();
await firestore.doc('root/foo').set({'flower': 'rose'});
await firestore.doc('root/foo').set({'flower': FieldValue.delete()});
final document = await firestore.doc('root/foo').get();
final data = document.data();
expect(data, isNotNull);
expect(data!.isEmpty, equals(true));
});
test('FieldValue.serverTimestamp() sets the time', () async {
final firestore = FakeFirebaseFirestore();
await firestore.collection('users').doc(uid).set({
'created': FieldValue.serverTimestamp(),
});
final users = await firestore.collection('users').get();
final bob = users.docs.first;
expect(bob.get('created'), isNotNull);
final bobCreated = bob.get('created') as Timestamp; // Not DateTime
final timeDiff = Timestamp.now().millisecondsSinceEpoch -
bobCreated.millisecondsSinceEpoch;
// Mock is fast it shouldn't take more than 1000 milliseconds to execute the code above
expect(timeDiff, lessThan(1000));
});
test('FieldValue.serverTimestamp() sets the time using Clock', () async {
final fixedTimestamp = Timestamp.fromMicrosecondsSinceEpoch(100);
final fakeClock = Clock.fixed(fixedTimestamp.toDate());
final firestore = FakeFirebaseFirestore(clock: fakeClock);
await firestore.collection('users').doc(uid).set({
'created': FieldValue.serverTimestamp(),
});
final users = await firestore.collection('users').get();
final bob = users.docs.first;
expect(bob.get('created'), fixedTimestamp);
});
test('FieldValue.increment() increments number', () async {
final firestore = FakeFirebaseFirestore();
// Empty document before update
await firestore.collection('messages').doc(uid).set({
'int': 0,
'double': 1.3,
'previously String': 'foo',
});
await firestore.collection('messages').doc(uid).update({
'user.counter': 5,
});
await firestore.collection('messages').doc(uid).update({
'user.counter': FieldValue.increment(2),
'double': FieldValue.increment(3.3),
'int': FieldValue.increment(7),
'previously String': FieldValue.increment(1),
'previously absent': FieldValue.increment(8),
});
final messages = await firestore.collection('messages').get();
final message = messages.docs.first;
expect(message.get('double'), 1.3 + 3.3);
expect(message.get('int'), 7);
final map = message.get('user') as Map<String, dynamic>;
expect(map['counter'], 5 + 2);
expect(message.get('previously String'), 1);
expect(message.get('previously absent'), 8);
});
test('FieldValue.arrayUnion() adds unique items', () async {
final firestore = FakeFirebaseFirestore();
// Empty document before update
await firestore.collection('messages').doc(uid).set({
'array': [1, 2, 3],
'previously String': 'foo',
});
await firestore.collection('messages').doc(uid).update({
'nested.array': ['a', 'b']
});
await firestore.collection('messages').doc(uid).update({
'array': FieldValue.arrayUnion([3, 4, 5]),
'nested.array': FieldValue.arrayUnion(['b', 'c']),
'previously String': FieldValue.arrayUnion([6, 7]),
'previously absent': FieldValue.arrayUnion([8, 9]),
});
final messages = await firestore.collection('messages').get();
final snapshot = messages.docs.first;
expect(snapshot.get('array'), [1, 2, 3, 4, 5]);
final map = snapshot.get('nested') as Map<String, dynamic>;
expect(map['array'], ['a', 'b', 'c']);
expect(snapshot.get('previously String'), [6, 7]);
expect(snapshot.get('previously absent'), [8, 9]);
});
test('FieldValue.arrayUnion() should add unique Maps', () async {
final firestore = FakeFirebaseFirestore();
final docRef = firestore.collection('test').doc(uid);
await docRef.set({
'maps': [
{'a': 1},
{'b': 2}
],
});
await docRef.update({
'maps': FieldValue.arrayUnion([
{'a': 1},
{'c': 3}
]),
});
final snapshot = await docRef.get();
final maps = snapshot.get('maps');
expect(maps, [
{'a': 1},
{'b': 2},
{'c': 3}
]);
});
test('FieldValue.arrayUnion() should add unique dates', () async {
final firestore = FakeFirebaseFirestore();
final docRef = firestore.collection('test').doc(uid);
await docRef.set({
'dates': [DateTime(2022, 1, 1)],
});
await docRef.update({
'dates':
FieldValue.arrayUnion([DateTime(2022, 1, 1), DateTime(2022, 1, 2)]),
});
final snapshot = await docRef.get();
final dates = (snapshot.get('dates') as List<dynamic>)
.cast<Timestamp>()
.map((e) => e.toDate())
.toList();
expect(dates, [DateTime(2022, 1, 1), DateTime(2022, 1, 2)]);
});
test('FieldValue.arrayRemove() removes items', () async {
final firestore = FakeFirebaseFirestore();
// Empty document before update
await firestore.collection('messages').doc(uid).set({
'array': [1, 2, 3],
'previously String': 'foo',
'untouched': [3],
});
await firestore.collection('messages').doc(uid).update({
'nested.array': ['a', 'b', 'c']
});
await firestore.collection('messages').doc(uid).update({
'array': FieldValue.arrayRemove([3, 4]),
'nested.array': FieldValue.arrayRemove(['b', 'd']),
'previously String': FieldValue.arrayRemove([8, 9]),
'previously absent': FieldValue.arrayRemove([8, 9]),
});
final messages = await firestore.collection('messages').get();
final snapshot = messages.docs.first;
expect(snapshot.get('array'), [1, 2]);
final map = snapshot.get('nested') as Map<String, dynamic>;
expect(map['array'], ['a', 'c']);
expect(snapshot.get('untouched'), [3]);
expect(snapshot.get('previously String'), []);
expect(snapshot.get('previously absent'), []);
});
test('FieldValue.arrayRemove() should remove Maps', () async {
final firestore = FakeFirebaseFirestore();
final docRef = firestore.collection('test').doc(uid);
await docRef.set({
'maps': [
{'a': 1},
{'b': 2},
{'c': 3},
],
});
await docRef.update({
'maps': FieldValue.arrayRemove([
{'b': 2},
{'d': 4}
]),
});
final snapshot = await docRef.get();
final maps = snapshot.get('maps');
expect(maps, [
{'a': 1},
{'c': 3}
]);
});
test('FieldValue.arrayRemove() should remove dates', () async {
final firestore = FakeFirebaseFirestore();
final docRef = firestore.collection('test').doc(uid);
await docRef.set({
'dates': [
DateTime(2022, 1, 1),
DateTime(2022, 1, 2),
DateTime(2022, 1, 3),
],
});
await docRef.update({
'dates': FieldValue.arrayRemove(
[DateTime(2022, 1, 2), DateTime(2022, 1, 4)],
),
});
final snapshot = await docRef.get();
final dates = (snapshot.get('dates') as List<dynamic>)
.cast<Timestamp>()
.map((e) => e.toDate())
.toList();
expect(dates, [DateTime(2022, 1, 1), DateTime(2022, 1, 3)]);
});
test('FieldValue in nested objects', () async {
final firestore = FakeFirebaseFirestore();
final docRef = firestore.collection('MyCollection').doc('MyDocument');
final batch = firestore.batch();
batch.set(
docRef,
{
'testme': FieldValue.increment(1),
'updated': FieldValue.serverTimestamp(),
'Nested': {'testnestedfield': FieldValue.increment(1)}
},
SetOptions(merge: true));
await batch.commit();
final myDocs = await firestore.collection('MyCollection').get();
expect(myDocs.docs.length, 1);
final today = DateTime.now();
final myDoc = myDocs.docs.first;
final Timestamp updatedTimestamp = myDoc.get('updated');
final updated = updatedTimestamp.toDate();
expect(updated.month, today.month);
expect(updated.day, today.day);
expect(updated.year, today.year);
expect(updated.hour, today.hour);
expect(myDoc.get('testme'), 1);
final count = myDoc.get('Nested')['testnestedfield'];
expect(count, 1);
});
});
group('Field paths', () {
test('Get "a.b" type paths', () async {
final firestore = FakeFirebaseFirestore();
await firestore.doc('root/foo').set({
'a': {'b': 'c'}
});
final document = await firestore.doc('root/foo').get();
expect(document.get('a.b'), 'c');
});
test('Get FieldPath type paths', () async {
final firestore = FakeFirebaseFirestore();
await firestore.doc('root/foo').set({
'a': {'I.have.dots': 'c'}
});
final document = await firestore.doc('root/foo').get();
// this FieldPath can't be done "a.b" style because the field has dots in it
expect(document.get(FieldPath(['a', 'I.have.dots'])), 'c');
});
test('Update FieldPath array', () async {
final firestore = FakeFirebaseFirestore();
const id = 'someId';
await firestore.collection('users').doc(id).set({
'foo': {'bar': []}
});
await firestore.collection('users').doc(id).update({
FieldPath(['foo', 'bar']): FieldValue.arrayUnion(['baz']),
});
var snapshot = await firestore.collection('users').doc(id).get();
expect(snapshot, isNotNull);
expect(snapshot.data()?['foo']['bar'], ['baz']);
await firestore.collection('users').doc(id).update({
FieldPath(['foo', 'bar', 'baz']): {'qux': 'quux'},
});
snapshot = await firestore.collection('users').doc(id).get();
expect(snapshot, isNotNull);
expect(snapshot.data()?['foo']['bar']['baz'], {'qux': 'quux'});
});
test('Should throw StateError if field does not exist', () async {
final firestore = FakeFirebaseFirestore();
final collection = firestore.collection('test');
final doc = collection.doc('test');
await doc.set({
'nested': {'field': 3}
});
final snapshot = await doc.get();
expect(() => snapshot.get('foo'), throwsA(isA<StateError>()));
expect(() => snapshot.get('nested.foo'), throwsA(isA<StateError>()));
});
test('Should not throw StateError if value at field is null', () async {
final firestore = FakeFirebaseFirestore();