aboutsummaryrefslogtreecommitdiffhomepage
path: root/Example/Messaging/Tests/FIRMessagingSyncMessageManagerTest.m
blob: e40e1f2e3cdbd2e73b08327593c61abb178ed8c3 (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
/*
 * 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 "FIRMessagingPersistentSyncMessage.h"
#import "FIRMessagingRmqManager.h"
#import "FIRMessagingSyncMessageManager.h"
#import "FIRMessagingUtilities.h"
#import "FIRMessagingConstants.h"

static NSString *const kRmqSqliteFilename = @"rmq-sync-manager-test";

@interface FIRMessagingSyncMessageManagerTest : XCTestCase

@property(nonatomic, readwrite, strong) FIRMessagingRmqManager *rmqManager;
@property(nonatomic, readwrite, strong) FIRMessagingSyncMessageManager *syncMessageManager;

@end

@implementation FIRMessagingSyncMessageManagerTest

- (void)setUp {
  [super setUp];
  // Make sure the db state is clean before we begin.
  [FIRMessagingRmqManager removeDatabaseWithName:kRmqSqliteFilename];
  self.rmqManager = [[FIRMessagingRmqManager alloc] initWithDatabaseName:kRmqSqliteFilename];
  self.syncMessageManager = [[FIRMessagingSyncMessageManager alloc] initWithRmqManager:self.rmqManager];
}

- (void)tearDown {
  [[self.rmqManager class] removeDatabaseWithName:kRmqSqliteFilename];
  [super tearDown];
}

/**
 *  Test receiving a new sync message via APNS should be added to SYNC_RMQ.
 */
- (void)testNewAPNSMessage {
  int64_t expirationTime = FIRMessagingCurrentTimestampInSeconds() + 86400;  // 1 day in future

  NSDictionary *oldMessage = @{
    kFIRMessagingMessageIDKey : @"fake-rmq-1",
    kFIRMessagingMessageSyncViaMCSKey : @(expirationTime),
    @"hello" : @"world",
  };
  XCTAssertFalse([self.syncMessageManager didReceiveAPNSSyncMessage:oldMessage]);

  NSDictionary *newMessage = @{
    kFIRMessagingMessageIDKey : @"fake-rmq-2",
    kFIRMessagingMessageSyncViaMCSKey : @(expirationTime),
    @"hello" : @"world",
  };

  XCTAssertFalse([self.syncMessageManager didReceiveAPNSSyncMessage:newMessage]);
}

/**
 *  Test receiving a new sync message via MCS should be added to SYNC_RMQ.
 */
- (void)testNewMCSMessage {
  int64_t expirationTime = FIRMessagingCurrentTimestampInSeconds() + 86400;  // 1 day in future
  NSDictionary *oldMessage = @{
    kFIRMessagingMessageIDKey : @"fake-rmq-1",
    kFIRMessagingMessageSyncViaMCSKey : @(expirationTime),
    @"hello" : @"world",
  };
  XCTAssertFalse([self.syncMessageManager didReceiveMCSSyncMessage:oldMessage]);

  NSDictionary *newMessage = @{
    kFIRMessagingMessageIDKey : @"fake-rmq-2",
    kFIRMessagingMessageSyncViaMCSKey : @(expirationTime),
    @"hello" : @"world",
  };

  XCTAssertFalse([self.syncMessageManager didReceiveAPNSSyncMessage:newMessage]);
}

/**
 *  Test receiving a duplicate message via APNS.
 */
- (void)testDuplicateAPNSMessage {
  NSString *messageID = @"fake-rmq-1";
  int64_t expirationTime = FIRMessagingCurrentTimestampInSeconds() + 86400;  // 1 day in future
  NSDictionary *newMessage = @{
    kFIRMessagingMessageIDKey : messageID,
    kFIRMessagingMessageSyncViaMCSKey : @(expirationTime),
    @"hello" : @"world",
  };

  XCTAssertFalse([self.syncMessageManager didReceiveAPNSSyncMessage:newMessage]);

  // The message is a duplicate
  XCTAssertTrue([self.syncMessageManager didReceiveAPNSSyncMessage:newMessage]);

  FIRMessagingPersistentSyncMessage *persistentMessage =
      [self.rmqManager querySyncMessageWithRmqID:messageID];
  XCTAssertTrue(persistentMessage.apnsReceived);
  XCTAssertFalse(persistentMessage.mcsReceived);
}

/**
 *  Test receiving a duplicate message via MCS.
 */
- (void)testDuplicateMCSMessage {
  NSString *messageID = @"fake-rmq-1";
  int64_t expirationTime = FIRMessagingCurrentTimestampInSeconds() + 86400;  // 1 day in future
  NSDictionary *newMessage = @{
    kFIRMessagingMessageIDKey : messageID,
    kFIRMessagingMessageSyncViaMCSKey : @(expirationTime),
    @"hello" : @"world",
  };

  XCTAssertFalse([self.syncMessageManager didReceiveMCSSyncMessage:newMessage]);

  // The message is a duplicate
  XCTAssertTrue([self.syncMessageManager didReceiveMCSSyncMessage:newMessage]);

  FIRMessagingPersistentSyncMessage *persistentMessage =
      [self.rmqManager querySyncMessageWithRmqID:messageID];
  XCTAssertFalse(persistentMessage.apnsReceived);
  XCTAssertTrue(persistentMessage.mcsReceived);
}

/**
 *  Test receiving a sync message both via APNS and MCS.
 */
- (void)testMessageReceivedBothViaAPNSAndMCS {
  NSString *messageID = @"fake-rmq-1";
  int64_t expirationTime = FIRMessagingCurrentTimestampInSeconds() + 86400;  // 1 day in future
  NSDictionary *newMessage = @{
    kFIRMessagingMessageIDKey : messageID,
    kFIRMessagingMessageSyncViaMCSKey : @(expirationTime),
    @"hello" : @"world",
  };

  XCTAssertFalse([self.syncMessageManager didReceiveAPNSSyncMessage:newMessage]);
  // Duplicate of the above received APNS message
  XCTAssertTrue([self.syncMessageManager didReceiveMCSSyncMessage:newMessage]);

  // Since we've received both APNS and MCS messages we should have deleted them from SYNC_RMQ
  FIRMessagingPersistentSyncMessage *persistentMessage =
      [self.rmqManager querySyncMessageWithRmqID:messageID];
  XCTAssertNil(persistentMessage);
}

- (void)testDeletingExpiredMessages {
  NSString *unexpiredMessageID = @"fake-not-expired-rmqID";
  int64_t futureExpirationTime = 86400;  // 1 day in future
  NSDictionary *unexpiredMessage = @{
    kFIRMessagingMessageIDKey : unexpiredMessageID,
    kFIRMessagingMessageSyncMessageTTLKey : @(futureExpirationTime),
    @"hello" : @"world",
  };
  XCTAssertFalse([self.syncMessageManager didReceiveAPNSSyncMessage:unexpiredMessage]);

  NSString *expiredMessageID = @"fake-expired-rmqID";
  int64_t past = -86400;  // 1 day in past
  NSDictionary *expiredMessage = @{
    kFIRMessagingMessageIDKey : expiredMessageID,
    kFIRMessagingMessageSyncMessageTTLKey : @(past),
    @"hello" : @"world",
  };
  XCTAssertFalse([self.syncMessageManager didReceiveAPNSSyncMessage:expiredMessage]);

  NSString *noTTLMessageID = @"no-ttl-rmqID"; // no TTL specified should be 4 weeks
  NSDictionary *noTTLMessage = @{
    kFIRMessagingMessageIDKey : noTTLMessageID,
    @"hello" : @"world",
  };
  XCTAssertFalse([self.syncMessageManager didReceiveAPNSSyncMessage:noTTLMessage]);

  [self.syncMessageManager removeExpiredSyncMessages];

  XCTAssertNotNil([self.rmqManager querySyncMessageWithRmqID:unexpiredMessageID]);
  XCTAssertNil([self.rmqManager querySyncMessageWithRmqID:expiredMessageID]);
  XCTAssertNotNil([self.rmqManager querySyncMessageWithRmqID:noTTLMessageID]);
}

- (void)testDeleteFinishedMessages {
  NSString *unexpiredMessageID = @"fake-not-expired-rmqID";
  int64_t futureExpirationTime = 86400;  // 1 day in future
  NSDictionary *unexpiredMessage = @{
    kFIRMessagingMessageIDKey : unexpiredMessageID,
    kFIRMessagingMessageSyncMessageTTLKey : @(futureExpirationTime),
    @"hello" : @"world",
  };
  XCTAssertFalse([self.syncMessageManager didReceiveAPNSSyncMessage:unexpiredMessage]);

  NSString *noTTLMessageID = @"no-ttl-rmqID"; // no TTL specified should be 4 weeks
  NSDictionary *noTTLMessage = @{
                                 kFIRMessagingMessageIDKey : noTTLMessageID,
                                 @"hello" : @"world",
                                 };
  XCTAssertFalse([self.syncMessageManager didReceiveAPNSSyncMessage:noTTLMessage]);

  // Mark the no-TTL message as received via MCS too
  XCTAssertTrue([self.rmqManager updateSyncMessageViaMCSWithRmqID:noTTLMessageID error:nil]);

  [self.syncMessageManager removeExpiredSyncMessages];

  XCTAssertNotNil([self.rmqManager querySyncMessageWithRmqID:unexpiredMessageID]);
  XCTAssertNil([self.rmqManager querySyncMessageWithRmqID:noTTLMessageID]);
}

- (void)testDeleteFinishedAndExpiredMessages {
  NSString *unexpiredMessageID = @"fake-not-expired-rmqID";
  int64_t futureExpirationTime = 86400;  // 1 day in future
  NSDictionary *unexpiredMessage = @{
    kFIRMessagingMessageIDKey : unexpiredMessageID,
    kFIRMessagingMessageSyncMessageTTLKey : @(futureExpirationTime),
    @"hello" : @"world",
  };
  XCTAssertFalse([self.syncMessageManager didReceiveAPNSSyncMessage:unexpiredMessage]);

  NSString *expiredMessageID = @"fake-expired-rmqID";
  int64_t past = -86400;  // 1 day in past
  NSDictionary *expiredMessage = @{
    kFIRMessagingMessageIDKey : expiredMessageID,
    kFIRMessagingMessageSyncMessageTTLKey : @(past),
    @"hello" : @"world",
  };
  XCTAssertFalse([self.syncMessageManager didReceiveAPNSSyncMessage:expiredMessage]);

  NSString *noTTLMessageID = @"no-ttl-rmqID"; // no TTL specified should be 4 weeks
  NSDictionary *noTTLMessage = @{
    kFIRMessagingMessageIDKey : noTTLMessageID,
    @"hello" : @"world",
  };
  XCTAssertFalse([self.syncMessageManager didReceiveAPNSSyncMessage:noTTLMessage]);

  // Mark the no-TTL message as received via MCS too
  XCTAssertTrue([self.rmqManager updateSyncMessageViaMCSWithRmqID:noTTLMessageID error:nil]);

  // Remove expired or finished sync messages.
  [self.syncMessageManager removeExpiredSyncMessages];

  XCTAssertNotNil([self.rmqManager querySyncMessageWithRmqID:unexpiredMessageID]);
  XCTAssertNil([self.rmqManager querySyncMessageWithRmqID:expiredMessageID]);
  XCTAssertNil([self.rmqManager querySyncMessageWithRmqID:noTTLMessageID]);
}

@end