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
|
/*
* Copyright 2017 Google
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#import "Firestore/Example/Tests/Util/FSTEventAccumulator.h"
#import <XCTest/XCTest.h>
#import "Firestore/Source/Public/FIRDocumentSnapshot.h"
#import "Firestore/Source/Public/FIRQuerySnapshot.h"
#import "Firestore/Source/Public/FIRSnapshotMetadata.h"
#import "Firestore/Source/Util/FSTAssert.h"
#import "Firestore/Example/Tests/Util/XCTestCase+Await.h"
NS_ASSUME_NONNULL_BEGIN
@interface FSTEventAccumulator ()
- (instancetype)initForTest:(XCTestCase *)testCase NS_DESIGNATED_INITIALIZER;
@property(nonatomic, weak, readonly) XCTestCase *testCase;
@property(nonatomic, assign) NSUInteger maxEvents;
@property(nonatomic, strong, nullable) XCTestExpectation *expectation;
@end
@implementation FSTEventAccumulator {
NSMutableArray<id> *_events;
}
+ (instancetype)accumulatorForTest:(XCTestCase *)testCase {
return [[FSTEventAccumulator alloc] initForTest:testCase];
}
- (instancetype)initForTest:(XCTestCase *)testCase {
if (self = [super init]) {
_testCase = testCase;
_events = [NSMutableArray array];
}
return self;
}
- (NSArray<id> *)awaitEvents:(NSUInteger)events name:(NSString *)name {
@synchronized(self) {
FSTAssert(!self.expectation, @"Existing expectation still pending?");
self.expectation = [self.testCase expectationWithDescription:name];
self.maxEvents = self.maxEvents + events;
[self checkFulfilled];
}
// Don't await within @synchronized block to avoid deadlocking.
[self.testCase awaitExpectations];
return [_events subarrayWithRange:NSMakeRange(self.maxEvents - events, events)];
}
- (id)awaitEventWithName:(NSString *)name {
NSArray<id> *events = [self awaitEvents:1 name:name];
return events[0];
}
- (id)awaitLocalEvent {
id event;
do {
event = [self awaitEventWithName:@"Local Event"];
} while (![self hasPendingWrites:event]);
return event;
}
- (id)awaitRemoteEvent {
id event;
do {
event = [self awaitEventWithName:@"Remote Event"];
} while ([self hasPendingWrites:event]);
return event;
}
- (BOOL)hasPendingWrites:(id)event {
if ([event isKindOfClass:[FIRDocumentSnapshot class]]) {
return ((FIRDocumentSnapshot *)event).metadata.hasPendingWrites;
} else {
FSTAssert([event isKindOfClass:[FIRQuerySnapshot class]], @"Unexpected event: %@", event);
return ((FIRQuerySnapshot *)event).metadata.hasPendingWrites;
}
}
- (void (^)(id _Nullable, NSError *_Nullable))valueEventHandler {
return ^void(id _Nullable value, NSError *_Nullable error) {
// We can't store nil in the _events array, but these are still interesting to tests so store
// NSNull instead.
id event = value ? value : [NSNull null];
@synchronized(self) {
[self->_events addObject:event];
[self checkFulfilled];
}
};
}
- (void)checkFulfilled {
if (_events.count >= self.maxEvents) {
[self.expectation fulfill];
self.expectation = nil;
}
}
@end
NS_ASSUME_NONNULL_END
|
