aboutsummaryrefslogtreecommitdiffhomepage
path: root/Example/Messaging/Tests/FIRMessagingDataMessageManagerTest.m
blob: 8aaad512ebed439b23f273460f331660c807df1c (plain)
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
/*
 * 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 <XCTest/XCTest.h>

#import <OCMock/OCMock.h>

#import "Protos/GtalkCore.pbobjc.h"

#import "FIRMessaging.h"
#import "FIRMessagingClient.h"
#import "FIRMessagingConnection.h"
#import "FIRMessagingDataMessageManager.h"
#import "FIRMessagingReceiver.h"
#import "FIRMessagingRmqManager.h"
#import "FIRMessagingSyncMessageManager.h"
#import "FIRMessagingUtilities.h"
#import "FIRMessaging_Private.h"
#import "FIRMessagingConstants.h"
#import "FIRMessagingDefines.h"
#import "NSError+FIRMessaging.h"

static NSString *const kFIRMessagingUserDefaultsSuite = @"FIRMessagingClientTestUserDefaultsSuite";

static NSString *const kFIRMessagingAppIDToken = @"1234abcdef789";

static NSString *const kMessagePersistentID = @"abcdef123";
static NSString *const kMessageFrom = @"com.example.gcm";
static NSString *const kMessageTo = @"123456789";
static NSString *const kCollapseKey = @"collapse-1";
static NSString *const kAppDataItemKey = @"hello";
static NSString *const kAppDataItemValue = @"world";
static NSString *const kAppDataItemInvalidKey = @"google.hello";

static NSString *const kRmqDatabaseName = @"gcm-dmm-test";

@interface FIRMessagingDataMessageManager()

@property(nonatomic, readwrite, weak) FIRMessagingRmqManager *rmq2Manager;

- (NSString *)categoryForUpstreamMessages;

@end

@interface FIRMessagingDataMessageManagerTest : XCTestCase

@property(nonatomic, readwrite, strong) id mockClient;
@property(nonatomic, readwrite, strong) id mockRmqManager;
@property(nonatomic, readwrite, strong) id mockReceiver;
@property(nonatomic, readwrite, strong) id mockSyncMessageManager;
@property(nonatomic, readwrite, strong) FIRMessagingDataMessageManager *dataMessageManager;
@property(nonatomic, readwrite, strong) id mockDataMessageManager;

@end

@implementation FIRMessagingDataMessageManagerTest

- (void)setUp {
  [super setUp];
  _mockClient = OCMClassMock([FIRMessagingClient class]);
  _mockReceiver = OCMClassMock([FIRMessagingReceiver class]);
  _mockRmqManager = OCMClassMock([FIRMessagingRmqManager class]);
  _mockSyncMessageManager = OCMClassMock([FIRMessagingSyncMessageManager class]);
  _dataMessageManager = [[FIRMessagingDataMessageManager alloc]
        initWithDelegate:_mockReceiver
                  client:_mockClient
             rmq2Manager:_mockRmqManager
      syncMessageManager:_mockSyncMessageManager];
  [_dataMessageManager refreshDelayedMessages];
  _mockDataMessageManager = OCMPartialMock(_dataMessageManager);
}


- (void)testSendValidMessage_withNoConnection {
  // mock no connection initially
  NSString *messageID = @"1";
  BOOL mockConnectionActive = NO;
  [[[self.mockClient stub] andDo:^(NSInvocation *invocation) {
    NSValue *returnValue = [NSValue valueWithBytes:&mockConnectionActive
                                          objCType:@encode(BOOL)];
    [invocation setReturnValue:&returnValue];
  }] isConnectionActive];

  BOOL(^isValidStanza)(id obj) = ^BOOL(id obj) {
    if ([obj isKindOfClass:[GtalkDataMessageStanza class]]) {
      GtalkDataMessageStanza *message = (GtalkDataMessageStanza *)obj;
      return ([message.id_p isEqualToString:messageID] && [message.to isEqualToString:kMessageTo]);
    }
    return NO;
  };
  OCMExpect([self.mockReceiver willSendDataMessageWithID:[OCMArg isEqual:messageID]
                                                   error:[OCMArg isNil]]);
  [[[self.mockRmqManager stub] andReturnValue:@YES]
      saveRmqMessage:[OCMArg checkWithBlock:isValidStanza]
               error:[OCMArg anyObjectRef]];

  // should be logged into the service
  [self addFakeFIRMessagingRegistrationToken];
  [self.dataMessageManager setDeviceAuthID:@"auth-id" secretToken:@"secret-token"];
  // try to send messages with no connection should be queued into RMQ
  NSMutableDictionary *message = [self upstreamMessageWithID:messageID ttl:-1 delay:0];
  [self.dataMessageManager sendDataMessageStanza:message];

  OCMVerifyAll(self.mockReceiver);
  OCMVerifyAll(self.mockRmqManager);
}

- (void)testSendValidMessage_withoutCheckinAuthentication {
  NSString *messageID = @"1";
  NSMutableDictionary *message = [self standardFIRMessagingMessageWithMessageID:messageID];

  OCMExpect([self.mockReceiver
      willSendDataMessageWithID:[OCMArg isEqual:messageID]
                          error:[OCMArg checkWithBlock:^BOOL(id obj) {
                            if ([obj isKindOfClass:[NSError class]]) {
                              NSError *error = (NSError *)obj;
                              return error.code == kFIRMessagingErrorCodeMissingDeviceID;
                            }
                            return NO;
                          }]]);

  // do not log into checkin service
  [self.dataMessageManager sendDataMessageStanza:message];

  OCMVerifyAll(self.mockReceiver);
}

- (void)testSendInvalidMessage_withNoTo {
  NSString *messageID = @"1";
  NSMutableDictionary *message =
      [FIRMessaging createFIRMessagingMessageWithMessage:@{ kAppDataItemKey : kAppDataItemValue}
                                                      to:@""
                                                  withID:messageID
                                              timeToLive:-1
                                                   delay:0];

  OCMExpect([self.mockReceiver
      willSendDataMessageWithID:[OCMArg isEqual:messageID]
                          error:[OCMArg checkWithBlock:^BOOL(id obj) {
                            if ([obj isKindOfClass:[NSError class]]) {
                              NSError *error = (NSError *)obj;
                              return error.code == kFIRMessagingErrorMissingTo;
                            }
                            return NO;
                          }]]);

  // should be logged into the service
  [self addFakeFIRMessagingRegistrationToken];
  [self.dataMessageManager setDeviceAuthID:@"auth-id" secretToken:@"secret-token"];
  [self.dataMessageManager sendDataMessageStanza:message];

  OCMVerifyAll(self.mockReceiver);
}

- (void)testSendInvalidMessage_withSizeExceeded {
  NSString *messageID = @"1";
  NSString *veryLargeString = [@"a" stringByPaddingToLength:4 * 1024 // 4kB
                                                 withString:@"b"
                                            startingAtIndex:0];
  NSMutableDictionary *message =
      [FIRMessaging createFIRMessagingMessageWithMessage:@{ kAppDataItemKey : veryLargeString }
                                                      to:kMessageTo
                                                  withID:messageID
                                              timeToLive:-1
                                                   delay:0];

  OCMExpect([self.mockReceiver
      willSendDataMessageWithID:[OCMArg isEqual:messageID]
                          error:[OCMArg checkWithBlock:^BOOL(id obj) {
                            if ([obj isKindOfClass:[NSError class]]) {
                              NSError *error = (NSError *)obj;
                              return error.code == kFIRMessagingErrorSizeExceeded;
                            }
                            return NO;
                          }]]);

  [self addFakeFIRMessagingRegistrationToken];
  // should be logged into the service
  [self.dataMessageManager setDeviceAuthID:@"auth-id" secretToken:@"secret-token"];
  [self.dataMessageManager sendDataMessageStanza:message];

  OCMVerifyAll(self.mockReceiver);
}

// TODO: Add test with rawData exceeding 4KB in size

- (void)testSendValidMessage_withRmqSaveError {
  NSString *messageID = @"1";
  NSMutableDictionary *message = [self standardFIRMessagingMessageWithMessageID:messageID];
  [[[self.mockRmqManager stub] andReturnValue:@NO]
      saveRmqMessage:[OCMArg any] error:[OCMArg anyObjectRef]];

  OCMExpect([self.mockReceiver
      willSendDataMessageWithID:[OCMArg isEqual:messageID]
                          error:[OCMArg checkWithBlock:^BOOL(id obj) {
                            if ([obj isKindOfClass:[NSError class]]) {
                              NSError *error = (NSError *)obj;
                              return error.code == kFIRMessagingErrorSave;
                            }
                            return NO;
                          }]]);

  // should be logged into the service
  [self.dataMessageManager setDeviceAuthID:@"auth-id" secretToken:@"secret-token"];
  [self addFakeFIRMessagingRegistrationToken];
  [self.dataMessageManager sendDataMessageStanza:message];

  OCMVerifyAll(self.mockReceiver);
}

- (void)testSendValidMessage_withTTL0 {
  // simulate a valid connection
  [[[self.mockClient stub] andReturnValue:@YES] isConnectionActive];
  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;
      return ([stanza.id_p isEqualToString:messageID] &&
              [stanza.to isEqualToString:kMessageTo] &&
              stanza.ttl == 0);
    }
    return NO;
  };

  OCMExpect([self.mockClient sendMessage:[OCMArg checkWithBlock:isValidStanza]]);

  [self.dataMessageManager setDeviceAuthID:@"auth-id" secretToken:@"secret-token"];
  [self addFakeFIRMessagingRegistrationToken];
  [self.dataMessageManager sendDataMessageStanza:message];

  OCMVerifyAll(self.mockClient);
}

// TODO: This is failing on simulator 7.1 & 8.2, take this out temporarily
- (void)XXX_testSendValidMessage_withTTL0AndNoFIRMessagingConnection {
  // simulate a invalid connection
  [[[self.mockClient stub] andReturnValue:@NO] isConnectionActive];

  // simulate network reachability
  FIRMessaging *service = [FIRMessaging messaging];
  id mockService = OCMPartialMock(service);
  [[[mockService stub] andReturnValue:@YES] isNetworkAvailable];

  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;
      return ([stanza.id_p isEqualToString:messageID] &&
              [stanza.to isEqualToString:kMessageTo] &&
              stanza.ttl == 0);
    }
    return NO;
  };

  // should save the message to be sent when we reconnect the next time
  OCMExpect([self.mockClient sendOnConnectOrDrop:[OCMArg checkWithBlock:isValidStanza]]);
  // should also try to reconnect immediately
  OCMExpect([self.mockClient retryConnectionImmediately:[OCMArg isEqual:@YES]]);

  [self.dataMessageManager setDeviceAuthID:@"auth-id" secretToken:@"secret-token"];
  [self addFakeFIRMessagingRegistrationToken];
  [self.dataMessageManager sendDataMessageStanza:message];

  OCMVerifyAll(self.mockClient);
}

// TODO: Investigate why this test is flaky
- (void)xxx_testSendValidMessage_withTTL0AndNoNetwork {
  // simulate a invalid connection
  [[[self.mockClient stub] andReturnValue:@NO] isConnectionActive];

  NSString *messageID = @"1";
  NSMutableDictionary *message = [self upstreamMessageWithID:messageID ttl:0 delay:0];


  // should drop the message since there is no network
  OCMExpect([self.mockReceiver willSendDataMessageWithID:[OCMArg isEqual:messageID]
                                                   error:[OCMArg checkWithBlock:^BOOL(id obj) {
    if ([obj isKindOfClass:[NSError class]]) {
      NSError *error = (NSError *)obj;
      return error.code == kFIRMessagingErrorCodeNetwork;
    }
    return NO;
  }]]);

  [self.dataMessageManager setDeviceAuthID:@"auth-id" secretToken:@"secret-token"];
  [self addFakeFIRMessagingRegistrationToken];
  [self.dataMessageManager sendDataMessageStanza:message];

  OCMVerifyAll(self.mockReceiver);
}

// TODO: This failed on simulator 7.1 & 8.2, take this out temporarily
- (void)XXX_testDelayedMessagesBeingResentOnReconnect {
  static BOOL isConnectionActive = NO;
  OCMStub([self.mockClient isConnectionActive]).andDo(^(NSInvocation *invocation) {
    [invocation setReturnValue:&isConnectionActive];
  });

  // message that lives for 2 seconds
  NSString *messageID = @"1";
  int ttl = 2;
  NSMutableDictionary *message = [self upstreamMessageWithID:messageID ttl:ttl delay:1];

  __block GtalkDataMessageStanza *firstMessageStanza;

  OCMStub([self.mockRmqManager saveRmqMessage:[OCMArg any]
                                        error:[OCMArg anyObjectRef]]).andReturn(YES);

  OCMExpect([self.mockReceiver willSendDataMessageWithID:[OCMArg isEqual:messageID]
                                                   error:[OCMArg isNil]]);

  [self.dataMessageManager setDeviceAuthID:@"auth-id" secretToken:@"secret-token"];
  [self addFakeFIRMessagingRegistrationToken];
  [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;
             }]];

  // expect both 1 and 2 messages to be sent once we regain connection
  __block BOOL firstMessageSent = NO;
  __block BOOL secondMessageSent = NO;
  XCTestExpectation *didSendAllMessages =
      [self expectationWithDescription:@"Did send all messages"];
  OCMExpect([self.mockClient sendMessage:[OCMArg checkWithBlock:^BOOL(id obj) {
    // [didSendAllMessages fulfill];
    if ([obj isKindOfClass:[GtalkDataMessageStanza class]]) {
      GtalkDataMessageStanza *message = (GtalkDataMessageStanza *)obj;
      if ([@"1" isEqualToString:message.id_p]) {
        firstMessageSent = YES;
      } else if ([@"2" isEqualToString:message.id_p]) {
        secondMessageSent = YES;
      }
      if (firstMessageSent && secondMessageSent) {
        [didSendAllMessages fulfill];
      }
      return firstMessageSent || secondMessageSent;
    }
    return NO;
  }]]);

  // send the second message after some delay
  [NSThread sleepForTimeInterval:2.0];

  isConnectionActive = YES;
  // simulate active connection
  NSString *newMessageID = @"2";
  NSMutableDictionary *newMessage = [self upstreamMessageWithID:newMessageID
                                                            ttl:0
                                                          delay:0];
  // send another message to resend not sent messages
  [self.dataMessageManager sendDataMessageStanza:newMessage];

  [self waitForExpectationsWithTimeout:5.0 handler:^(NSError *error) {
    XCTAssertNil(error);
    OCMVerifyAll(self.mockClient);
    OCMVerifyAll(self.mockReceiver);
  }];
}

- (void)testSendDelayedMessage_shouldNotSend {
  // should not send a delayed message even with an active connection
  // simulate active connection
  [[[self.mockClient stub] andReturnValue:OCMOCK_VALUE(YES)] isConnectionActive];
  [[self.mockClient reject] sendMessage:[OCMArg any]];

  [[self.mockReceiver reject] didSendDataMessageWithID:[OCMArg any]];

  // delayed message
  NSString *messageID = @"1";
  [self.dataMessageManager setDeviceAuthID:@"auth-id" secretToken:@"secret-token"];
  NSMutableDictionary *message = [self upstreamMessageWithID:messageID ttl:0 delay:1];
  [self.dataMessageManager sendDataMessageStanza:message];

  OCMVerifyAll(self.mockClient);
  OCMVerifyAll(self.mockReceiver);
}

- (void)testProcessPacket_withValidPacket {
  GtalkDataMessageStanza *message = [self validDataMessagePacket];
  NSDictionary *parsedMessage = [self.dataMessageManager processPacket:message];
  XCTAssertEqualObjects(parsedMessage[kFIRMessagingFromKey], message.from);
  XCTAssertEqualObjects(parsedMessage[kFIRMessagingCollapseKey], message.token);
  XCTAssertEqualObjects(parsedMessage[kFIRMessagingMessageIDKey], kMessagePersistentID);
  XCTAssertEqualObjects(parsedMessage[kAppDataItemKey], kAppDataItemValue);
  XCTAssertEqual(4, parsedMessage.count);
}

- (void)testProcessPacket_withOnlyFrom {
  GtalkDataMessageStanza *message = [self validDataMessageWithOnlyFrom];
  NSDictionary *parsedMessage = [self.dataMessageManager processPacket:message];
  XCTAssertEqualObjects(parsedMessage[kFIRMessagingFromKey], message.from);
  XCTAssertEqualObjects(parsedMessage[kFIRMessagingMessageIDKey], kMessagePersistentID);
  XCTAssertEqual(2, parsedMessage.count);
}

- (void)testProcessPacket_withInvalidPacket {
  GtalkDataMessageStanza *message = [self invalidDataMessageUsingReservedKeyword];
  NSDictionary *parsedMessage = [self.dataMessageManager processPacket:message];
  XCTAssertEqualObjects(parsedMessage[kFIRMessagingFromKey], message.from);
  XCTAssertEqualObjects(parsedMessage[kFIRMessagingMessageIDKey], kMessagePersistentID);
  XCTAssertEqual(2, parsedMessage.count);
}

/**
 *  Test parsing a duplex message.
 */
- (void)testProcessPacket_withDuplexMessage {
  GtalkDataMessageStanza *stanza = [self validDuplexmessage];
  NSDictionary *parsedMessage = [self.dataMessageManager processPacket:stanza];
  XCTAssertEqual(5, parsedMessage.count);
  XCTAssertEqualObjects(parsedMessage[kFIRMessagingFromKey], stanza.from);
  XCTAssertEqualObjects(parsedMessage[kFIRMessagingCollapseKey], stanza.token);
  XCTAssertEqualObjects(parsedMessage[kFIRMessagingMessageIDKey], kMessagePersistentID);
  XCTAssertEqualObjects(parsedMessage[kAppDataItemKey], kAppDataItemValue);
  XCTAssertTrue([parsedMessage[kFIRMessagingMessageSyncViaMCSKey] boolValue]);
}

- (void)testReceivingParsedMessage {
  NSDictionary *message = @{ @"hello" : @"world" };
  OCMStub([self.mockReceiver didReceiveMessage:[OCMArg isEqual:message] withIdentifier:[OCMArg any]]);
  [self.dataMessageManager didReceiveParsedMessage:message];
  OCMVerify([self.mockReceiver didReceiveMessage:message withIdentifier:[OCMArg any]]);
}

/**
 *  Test receiving a new duplex message notifies the receiver callback.
 */
- (void)testReceivingNewDuplexMessage {
  GtalkDataMessageStanza *message = [self validDuplexmessage];
  NSDictionary *parsedMessage = [self.dataMessageManager processPacket:message];
  [[[self.mockSyncMessageManager stub] andReturnValue:@(NO)]
      didReceiveMCSSyncMessage:parsedMessage];
  OCMStub([self.mockReceiver didReceiveMessage:[OCMArg isEqual:message] withIdentifier:[OCMArg any]]);
  [self.dataMessageManager didReceiveParsedMessage:parsedMessage];
  OCMVerify([self.mockReceiver didReceiveMessage:[OCMArg any] withIdentifier:[OCMArg any]]);
}

/**
 *  Test receiving a duplicated duplex message does not notify the receiver callback.
 */
- (void)testReceivingDuplicateDuplexMessage {
  GtalkDataMessageStanza *message = [self validDuplexmessage];
  NSDictionary *parsedMessage = [self.dataMessageManager processPacket:message];
  [[[self.mockSyncMessageManager stub] andReturnValue:@(YES)]
      didReceiveMCSSyncMessage:parsedMessage];
  [[self.mockReceiver reject] didReceiveMessage:[OCMArg any] withIdentifier:[OCMArg any]];
  [self.dataMessageManager didReceiveParsedMessage:parsedMessage];
}

/**
 *  In this test we simulate a real RMQ manager and send messages simulating no
 *  active connection. Then we simulate a new connection being established and
 *  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];

  // Set a fake, valid bundle identifier
  [[[self.mockDataMessageManager stub] andReturn:@"gcm-dmm-test"] categoryForUpstreamMessages];

  [FIRMessagingRmqManager removeDatabaseWithName:kRmqDatabaseName];
  FIRMessagingRmqManager *newRmqManager =
      [[FIRMessagingRmqManager alloc] initWithDatabaseName:kRmqDatabaseName];
  [newRmqManager loadRmqId];
  // have a real RMQ store
  [self.dataMessageManager setRmq2Manager:newRmqManager];

  [self addFakeFIRMessagingRegistrationToken];
  [self.dataMessageManager setDeviceAuthID:@"auth-id" secretToken:@"secret-token"];

  // send a couple of message with no connection should be saved to RMQ
  [self.dataMessageManager sendDataMessageStanza:
      [self upstreamMessageWithID:@"1" ttl:20000 delay:0]];
  [self.dataMessageManager sendDataMessageStanza:
      [self upstreamMessageWithID:@"2" ttl:20000 delay:0]];

  [NSThread sleepForTimeInterval:1.0];
  isClientConnected = YES;
  // after the usual version, login assertion we would receive a SelectiveAck
  // assuming we we weren't able to send any messages we won't delete anything
  // from the RMQ but try to resend whatever is there
  __block int didRecieveMessages = 0;
  id mockConnection = OCMClassMock([FIRMessagingConnection class]);

  BOOL (^resendMessageBlock)(id obj) = ^BOOL(id obj) {
    if ([obj isKindOfClass:[GtalkDataMessageStanza class]]) {
      GtalkDataMessageStanza *message = (GtalkDataMessageStanza *)obj;
      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;
      }
    }
    return NO;
  };
  [[[mockConnection stub] andDo:^(NSInvocation *invocation) {
    // pass
  }] sendProto:[OCMArg checkWithBlock:resendMessageBlock]];

  [self.dataMessageManager resendMessagesWithConnection:mockConnection];

  // should send both messages
  XCTAssert(didRecieveMessages == 3);
  OCMVerifyAll(mockConnection);
}

- (void)testResendingExpiredMessagesFails {
  // TODO: Test that expired messages should not be sent on resend
  static BOOL isClientConnected = NO;
  [[[self.mockClient stub] andDo:^(NSInvocation *invocation) {
    [invocation setReturnValue:&isClientConnected];
  }] isConnectionActive];

  // Set a fake, valid bundle identifier
  [[[self.mockDataMessageManager stub] andReturn:@"gcm-dmm-test"] categoryForUpstreamMessages];

  [FIRMessagingRmqManager removeDatabaseWithName:kRmqDatabaseName];
  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:
      [self upstreamMessageWithID:@"1" ttl:1 delay:0]];

  // wait for 2 seconds (let the above message expire)
  [NSThread sleepForTimeInterval:2.0];
  isClientConnected = YES;

  id mockConnection = OCMClassMock([FIRMessagingConnection class]);

  [[mockConnection reject] sendProto:[OCMArg any]];
  [self.dataMessageManager resendMessagesWithConnection:mockConnection];

  // 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];
}

#pragma mark - Private

- (void)addFakeFIRMessagingRegistrationToken {
  // [[FIRMessagingDefaultsManager sharedInstance] saveAppIDToken:kFIRMessagingAppIDToken];
}

#pragma mark - Create Packet

- (GtalkDataMessageStanza *)validDataMessagePacket {
  GtalkDataMessageStanza *message = [[GtalkDataMessageStanza alloc] init];
  message.from = kMessageFrom;
  message.token = kCollapseKey;
  message.persistentId = kMessagePersistentID;
  GtalkAppData *item = [[GtalkAppData alloc] init];
  item.key = kAppDataItemKey;
  item.value = kAppDataItemValue;
  message.appDataArray = [NSMutableArray arrayWithObject:item];
  return message;
}

- (GtalkDataMessageStanza *)validDataMessageWithOnlyFrom {
  GtalkDataMessageStanza *message = [[GtalkDataMessageStanza alloc] init];
  message.from = kMessageFrom;
  message.persistentId = kMessagePersistentID;
  return message;
}

- (GtalkDataMessageStanza *)invalidDataMessageUsingReservedKeyword {
  GtalkDataMessageStanza *message = [[GtalkDataMessageStanza alloc] init];
  message.from = kMessageFrom;
  message.persistentId = kMessagePersistentID;
  GtalkAppData *item = [[GtalkAppData alloc] init];
  item.key = kAppDataItemInvalidKey;
  item.value = kAppDataItemValue;
  message.appDataArray = [NSMutableArray arrayWithObject:item];
  return message;
}

- (GtalkDataMessageStanza *)validDataMessageForFIRMessaging {
  GtalkDataMessageStanza *message = [[GtalkDataMessageStanza alloc] init];
  message.from = kMessageFrom;
  message.token = @"com.google.gcm";
  return message;
}

- (GtalkDataMessageStanza *)validDuplexmessage {
  GtalkDataMessageStanza *message = [[GtalkDataMessageStanza alloc] init];
  message.from = kMessageFrom;
  message.token = kCollapseKey;
  message.persistentId = kMessagePersistentID;
  GtalkAppData *item = [[GtalkAppData alloc] init];
  item.key = kAppDataItemKey;
  item.value = kAppDataItemValue;
  GtalkAppData *duplexItem = [[GtalkAppData alloc] init];
  duplexItem.key = @"gcm.duplex";
  duplexItem.value = @"1";
  message.appDataArray = [NSMutableArray arrayWithObjects:item, duplexItem, nil];
  return message;
}

#pragma mark - Create Message

- (NSMutableDictionary *)standardFIRMessagingMessageWithMessageID:(NSString *)messageID {
  NSDictionary *message = @{ kAppDataItemKey : kAppDataItemValue };
  return [FIRMessaging createFIRMessagingMessageWithMessage:message
                                                         to:kMessageTo
                                                     withID:messageID
                                                 timeToLive:-1
                                                      delay:0];
}

- (NSMutableDictionary *)upstreamMessageWithID:(NSString *)messageID
                                           ttl:(int64_t)ttl
                                         delay:(int)delay {
  NSDictionary *message = @{ kAppDataItemInvalidKey : kAppDataItemValue };
  return [FIRMessaging createFIRMessagingMessageWithMessage:message
                                                         to:kMessageTo
                                                     withID:messageID
                                                 timeToLive:ttl
                                                      delay:delay];
}

@end