move database operation off main thread (#4053)

Author: charlotteliang

Example/Messaging/Tests/FIRMessagingDataMessageManagerTest.m

@@ -73,7 +73,10 @@ - (void)setUp {
   [super setUp];
   _mockClient = OCMClassMock([FIRMessagingClient class]);
   _mockReceiver = OCMClassMock([FIRMessagingReceiver class]);
-  _mockRmqManager = OCMClassMock([FIRMessagingRmqManager class]);
+  FIRMessagingRmqManager *newRmqManager =
+      [[FIRMessagingRmqManager alloc] initWithDatabaseName:kRmqDatabaseName];
+  [newRmqManager loadRmqId];
+  _mockRmqManager = OCMPartialMock(newRmqManager);
   _mockSyncMessageManager = OCMClassMock([FIRMessagingSyncMessageManager class]);
   _dataMessageManager = [[FIRMessagingDataMessageManager alloc]
         initWithDelegate:_mockReceiver
@@ -110,9 +113,8 @@ - (void)testSendValidMessage_withNoConnection {
   };
   OCMExpect([self.mockReceiver willSendDataMessageWithID:[OCMArg isEqual:messageID]
                                                    error:[OCMArg isNil]]);
-  [[[self.mockRmqManager stub] andReturnValue:@YES]
-      saveRmqMessage:[OCMArg checkWithBlock:isValidStanza]
-               error:[OCMArg anyObjectRef]];
+  [[self.mockRmqManager stub] saveRmqMessage:[OCMArg checkWithBlock:isValidStanza]
+                       withCompletionHandler:[OCMArg invokeBlockWithArgs:@(YES), nil]];
 
   // should be logged into the service
   [self.dataMessageManager setDeviceAuthID:@"auth-id" secretToken:@"secret-token"];
@@ -204,8 +206,8 @@ - (void)testSendInvalidMessage_withSizeExceeded {
 - (void)testSendValidMessage_withRmqSaveError {
   NSString *messageID = @"1";
   NSMutableDictionary *message = [self standardFIRMessagingMessageWithMessageID:messageID];
-  [[[self.mockRmqManager stub] andReturnValue:@NO]
-      saveRmqMessage:[OCMArg any] error:[OCMArg anyObjectRef]];
+  [[self.mockRmqManager stub] saveRmqMessage:[OCMArg any]
+                       withCompletionHandler:[OCMArg invokeBlockWithArgs:@(NO), nil]];
 
   OCMExpect([self.mockReceiver
       willSendDataMessageWithID:[OCMArg isEqual:messageID]
@@ -261,7 +263,6 @@ - (void)XXX_testSendValidMessage_withTTL0AndNoFIRMessagingConnection {
   NSString *messageID = @"1";
   NSMutableDictionary *message = [self upstreamMessageWithID:messageID ttl:0 delay:0];
 
-
   BOOL(^isValidStanza)(id obj) = ^BOOL(id obj) {
     if ([obj isKindOfClass:[GtalkDataMessageStanza class]]) {
       GtalkDataMessageStanza *stanza = (GtalkDataMessageStanza *)obj;
@@ -283,8 +284,7 @@ - (void)XXX_testSendValidMessage_withTTL0AndNoFIRMessagingConnection {
   OCMVerifyAll(self.mockClient);
 }
 
-// TODO: Investigate why this test is flaky
-- (void)xxx_testSendValidMessage_withTTL0AndNoNetwork {
+- (void)testSendValidMessage_withTTL0AndNoNetwork {
   // simulate a invalid connection
   [[[self.mockClient stub] andReturnValue:@NO] isConnectionActive];
 
@@ -321,27 +321,17 @@ - (void)XXX_testDelayedMessagesBeingResentOnReconnect {
   NSMutableDictionary *message = [self upstreamMessageWithID:messageID ttl:ttl delay:1];
 
   __block GtalkDataMessageStanza *firstMessageStanza;
-
-  OCMStub([self.mockRmqManager saveRmqMessage:[OCMArg any]
-                                        error:[OCMArg anyObjectRef]]).andReturn(YES);
+  [[self.mockRmqManager stub] saveRmqMessage:[OCMArg any]
+                       withCompletionHandler:[OCMArg invokeBlockWithArgs:@(YES), nil]];
 
   OCMExpect([self.mockReceiver willSendDataMessageWithID:[OCMArg isEqual:messageID]
                                                    error:[OCMArg isNil]]);
 
   [self.dataMessageManager setDeviceAuthID:@"auth-id" secretToken:@"secret-token"];
   [self.dataMessageManager sendDataMessageStanza:message];
 
-  __block FIRMessagingDataMessageHandler dataMessageHandler;
-
-  [[[self.mockRmqManager stub] andDo:^(NSInvocation *invocation) {
-    dataMessageHandler([FIRMessagingGetRmq2Id(firstMessageStanza) longLongValue],
-                       firstMessageStanza);
-  }]
-      scanWithRmqMessageHandler:[OCMArg isNil]
-             dataMessageHandler:[OCMArg checkWithBlock:^BOOL(id obj) {
-               dataMessageHandler = obj;
-               return YES;
-             }]];
+  [[self.mockRmqManager stub] scanWithRmqMessageHandler:
+   [OCMArg invokeBlockWithArgs:@{FIRMessagingGetRmq2Id(firstMessageStanza): firstMessageStanza}, nil]];
 
   // expect both 1 and 2 messages to be sent once we regain connection
   __block BOOL firstMessageSent = NO;
@@ -481,20 +471,12 @@ - (void)testReceivingDuplicateDuplexMessage {
  *  the client receives a Streaming ACK which should result in resending RMQ messages.
  */
 - (void)testResendSavedMessages {
-  static BOOL isClientConnected = NO;
-  [[[self.mockClient stub] andDo:^(NSInvocation *invocation) {
-    [invocation setReturnValue:&isClientConnected];
-  }] isConnectionActive];
+  XCTestExpectation *expectation = [self expectationWithDescription:@"scan is complete"];
 
+  static BOOL isClientConnected = NO;
+  [[[self.mockClient stub] andReturnValue:@(isClientConnected)] isConnectionActive];
   // Set a fake, valid bundle identifier
   [[[self.mockDataMessageManager stub] andReturn:@"gcm-dmm-test"] categoryForUpstreamMessages];
-
-  FIRMessagingRmqManager *newRmqManager =
-      [[FIRMessagingRmqManager alloc] initWithDatabaseName:kRmqDatabaseName];
-  [newRmqManager loadRmqId];
-  // have a real RMQ store
-  [self.dataMessageManager setRmq2Manager:newRmqManager];
-
   [self.dataMessageManager setDeviceAuthID:@"auth-id" secretToken:@"secret-token"];
 
   // send a couple of message with no connection should be saved to RMQ
@@ -517,23 +499,25 @@ - (void)testResendSavedMessages {
       NSLog(@"hello resending %@, %d", message.id_p, didRecieveMessages);
       if ([@"1" isEqualToString:message.id_p]) {
         didRecieveMessages |= 1; // right most bit for 1st message
-        return YES;
       } else if ([@"2" isEqualToString:message.id_p]) {
         didRecieveMessages |= (1<<1); // second from RMB for 2nd message
-        return YES;
+      } else {
+        return NO;
+      }
+      if (didRecieveMessages == 3) {
+        [expectation fulfill];
       }
+      return YES;
     }
     return NO;
   };
-  [[[mockConnection stub] andDo:^(NSInvocation *invocation) {
-    // pass
-  }] sendProto:[OCMArg checkWithBlock:resendMessageBlock]];
-
+  [[mockConnection stub] sendProto:[OCMArg checkWithBlock:resendMessageBlock]];
   [self.dataMessageManager resendMessagesWithConnection:mockConnection];
 
   // should send both messages
-  XCTAssert(didRecieveMessages == 3);
   OCMVerifyAll(mockConnection);
+
+  [self waitForExpectationsWithTimeout:5.0 handler:nil];
 }
 
 - (void)testResendingExpiredMessagesFails {
@@ -546,12 +530,6 @@ - (void)testResendingExpiredMessagesFails {
   // Set a fake, valid bundle identifier
   [[[self.mockDataMessageManager stub] andReturn:@"gcm-dmm-test"] categoryForUpstreamMessages];
 
-  FIRMessagingRmqManager *newRmqManager =
-      [[FIRMessagingRmqManager alloc] initWithDatabaseName:kRmqDatabaseName];
-  [newRmqManager loadRmqId];
-  // have a real RMQ store
-  [self.dataMessageManager setRmq2Manager:newRmqManager];
-
   [self.dataMessageManager setDeviceAuthID:@"auth-id" secretToken:@"secret-token"];
   // send a message that expires in 1 sec
   [self.dataMessageManager sendDataMessageStanza:
@@ -562,15 +540,13 @@ - (void)testResendingExpiredMessagesFails {
   isClientConnected = YES;
 
   id mockConnection = OCMClassMock([FIRMessagingConnection class]);
-
   [[mockConnection reject] sendProto:[OCMArg any]];
-  [self.dataMessageManager resendMessagesWithConnection:mockConnection];
+  [[self.mockRmqManager stub] scanWithRmqMessageHandler:[OCMArg checkWithBlock:^BOOL(id obj) {
+        return YES;
+    }]];
 
-  // rmq should not have any pending messages
-  [newRmqManager scanWithRmqMessageHandler:^(int64_t rmqId, int8_t tag, NSData *data) {
-    XCTFail(@"RMQ should not have any message");
-  }
-                        dataMessageHandler:nil];
+  [self.dataMessageManager resendMessagesWithConnection:mockConnection];
+  OCMVerifyAll(self.mockRmqManager);
 }
 
 #pragma mark - Create Packet