2222#import " Core/FSTDatabaseInfo.h"
2323#import " FSTHelpers.h"
2424#import " FSTIntegrationTestCase.h"
25+ #import " FSTTestDispatchQueue.h"
2526#import " Model/FSTDatabaseID.h"
2627#import " Remote/FSTDatastore.h"
2728#import " Util/FSTAssert.h"
28- #import " Util/FSTDispatchQueue.h"
2929
3030/* * Exposes otherwise private methods for testing. */
3131@interface FSTStream (Testing)
@@ -79,14 +79,14 @@ - (void)writeStreamDidCompleteHandshake {
7979 _expectation = nil ;
8080}
8181
82- - (void )writeStreamDidClose : ( NSError *_Nullable )error {
83- [_states addObject: @" writeStreamDidClose "
82+ - (void )writeStreamWasInterruptedWithError : (nullable NSError *)error {
83+ [_states addObject: @" writeStreamWasInterrupted "
8484 [_expectation fulfill ];
8585 _expectation = nil ;
8686}
8787
88- - (void )watchStreamDidClose : ( NSError *_Nullable )error {
89- [_states addObject: @" watchStreamDidClose "
88+ - (void )watchStreamWasInterruptedWithError : (nullable NSError *)error {
89+ [_states addObject: @" watchStreamWasInterrupted "
9090 [_expectation fulfill ];
9191 _expectation = nil ;
9292}
@@ -126,10 +126,10 @@ @interface FSTStreamTests : XCTestCase
126126
127127@implementation FSTStreamTests {
128128 dispatch_queue_t _testQueue;
129+ FSTTestDispatchQueue *_workerDispatchQueue;
129130 FSTDatabaseInfo *_databaseInfo;
130131 FSTEmptyCredentialsProvider *_credentials;
131132 FSTStreamStatusDelegate *_delegate;
132- FSTDispatchQueue *_workerDispatchQueue;
133133
134134 /* * Single mutation to send to the write stream. */
135135 NSArray <FSTMutation *> *_mutations;
@@ -138,38 +138,37 @@ @implementation FSTStreamTests {
138138- (void )setUp {
139139 [super setUp ];
140140
141- _mutations = @[ FSTTestSetMutation (@" foo/bar"
142-
143141 FIRFirestoreSettings *settings = [FSTIntegrationTestCase settings ];
144142 FSTDatabaseID *databaseID =
145143 [FSTDatabaseID databaseIDWithProject: [FSTIntegrationTestCase projectID ]
146144 database: kDefaultDatabaseID ];
147145
146+ _testQueue = dispatch_queue_create (" FSTStreamTestWorkerQueue"
147+ _workerDispatchQueue = [[FSTTestDispatchQueue alloc ] initWithQueue: _testQueue];
148+
148149 _databaseInfo = [FSTDatabaseInfo databaseInfoWithDatabaseID: databaseID
149150 persistenceKey: @" test-key"
150151 host: settings.host
151152 sslEnabled: settings.sslEnabled];
152- _testQueue = dispatch_queue_create (" FSTStreamTestWorkerQueue"
153- _workerDispatchQueue = [FSTDispatchQueue queueWith: _testQueue];
154153 _credentials = [[FSTEmptyCredentialsProvider alloc ] init ];
154+
155+ _delegate = [[FSTStreamStatusDelegate alloc ] initWithTestCase: self queue: _workerDispatchQueue];
156+
157+ _mutations = @[ FSTTestSetMutation (@" foo/bar"
155158}
156159
157160- (FSTWriteStream *)setUpWriteStream {
158161 FSTDatastore *datastore = [[FSTDatastore alloc ] initWithDatabaseInfo: _databaseInfo
159162 workerDispatchQueue: _workerDispatchQueue
160163 credentials: _credentials];
161-
162- _delegate = [[FSTStreamStatusDelegate alloc ] initWithTestCase: self queue: _workerDispatchQueue];
163- return [datastore createWriteStreamWithDelegate: _delegate];
164+ return [datastore createWriteStream ];
164165}
165166
166167- (FSTWatchStream *)setUpWatchStream {
167168 FSTDatastore *datastore = [[FSTDatastore alloc ] initWithDatabaseInfo: _databaseInfo
168169 workerDispatchQueue: _workerDispatchQueue
169170 credentials: _credentials];
170-
171- _delegate = [[FSTStreamStatusDelegate alloc ] initWithTestCase: self queue: _workerDispatchQueue];
172- return [datastore createWatchStreamWithDelegate: _delegate];
171+ return [datastore createWatchStream ];
173172}
174173
175174/* *
@@ -190,7 +189,7 @@ - (void)testWatchStreamStopBeforeHandshake {
190189 FSTWatchStream *watchStream = [self setUpWatchStream ];
191190
192191 [_delegate awaitNotificationFromBlock: ^{
193- [watchStream start ];
192+ [watchStream startWithDelegate: _delegate ];
194193 }];
195194
196195 // Stop must not call watchStreamDidClose because the full implementation of the delegate could
@@ -210,7 +209,7 @@ - (void)testWriteStreamStopBeforeHandshake {
210209 FSTWriteStream *writeStream = [self setUpWriteStream ];
211210
212211 [_delegate awaitNotificationFromBlock: ^{
213- [writeStream start ];
212+ [writeStream startWithDelegate: _delegate ];
214213 }];
215214
216215 // Don't start the handshake.
@@ -231,7 +230,7 @@ - (void)testWriteStreamStopAfterHandshake {
231230 FSTWriteStream *writeStream = [self setUpWriteStream ];
232231
233232 [_delegate awaitNotificationFromBlock: ^{
234- [writeStream start ];
233+ [writeStream startWithDelegate: _delegate ];
235234 }];
236235
237236 // Writing before the handshake should throw
@@ -258,4 +257,55 @@ - (void)testWriteStreamStopAfterHandshake {
258257 ]];
259258}
260259
260+ - (void )testStreamClosesWhenIdle {
261+ FSTWriteStream *writeStream = [self setUpWriteStream ];
262+
263+ [_delegate awaitNotificationFromBlock: ^{
264+ [writeStream startWithDelegate: _delegate];
265+ }];
266+
267+ [_delegate awaitNotificationFromBlock: ^{
268+ [writeStream writeHandshake ];
269+ }];
270+
271+ [_delegate awaitNotificationFromBlock: ^{
272+ [writeStream markIdle ];
273+ }];
274+
275+ dispatch_sync (_testQueue, ^{
276+ XCTAssertFalse ([writeStream isOpen ]);
277+ });
278+
279+ [self verifyDelegateObservedStates: @[
280+ @" writeStreamDidOpen" @" writeStreamDidCompleteHandshake" @" writeStreamWasInterrupted"
281+ ]];
282+ }
283+
284+ - (void )testStreamCancelsIdleOnWrite {
285+ FSTWriteStream *writeStream = [self setUpWriteStream ];
286+
287+ [_delegate awaitNotificationFromBlock: ^{
288+ [writeStream startWithDelegate: _delegate];
289+ }];
290+
291+ [_delegate awaitNotificationFromBlock: ^{
292+ [writeStream writeHandshake ];
293+ }];
294+
295+ // Mark the stream idle, but immediately cancel the idle timer by issuing another write.
296+ [_delegate awaitNotificationFromBlock: ^{
297+ [writeStream markIdle ];
298+ [writeStream writeMutations: _mutations];
299+ }];
300+
301+ dispatch_sync (_testQueue, ^{
302+ XCTAssertTrue ([writeStream isOpen ]);
303+ });
304+
305+ [self verifyDelegateObservedStates: @[
306+ @" writeStreamDidOpen" @" writeStreamDidCompleteHandshake"
307+ @" writeStreamDidReceiveResponseWithVersion"
308+ ]];
309+ }
310+
261311@end
0 commit comments