-
Notifications
You must be signed in to change notification settings - Fork 192
/
Amplitude.m
1970 lines (1704 loc) · 77.7 KB
/
Amplitude.m
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
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//
// Amplitude.m
// Copyright (c) 2013 Amplitude Inc. (https://amplitude.com/)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
#ifndef AMPLITUDE_DEBUG
#define AMPLITUDE_DEBUG 0
#endif
#ifndef AMPLITUDE_LOG
#if AMPLITUDE_DEBUG
# define AMPLITUDE_LOG(fmt, ...) NSLog(fmt, ##__VA_ARGS__)
#else
# define AMPLITUDE_LOG(...)
#endif
#endif
#ifndef AMPLITUDE_LOG_ERRORS
#define AMPLITUDE_LOG_ERRORS 1
#endif
#ifndef AMPLITUDE_ERROR
#if AMPLITUDE_LOG_ERRORS
# define AMPLITUDE_ERROR(fmt, ...) NSLog(fmt, ##__VA_ARGS__)
#else
# define AMPLITUDE_ERROR(...)
#endif
#endif
#import "Amplitude.h"
#import "AmplitudePrivate.h"
#import "AMPBackgroundNotifier.h"
#import "AMPConstants.h"
#import "AMPConfigManager.h"
#import "AMPDeviceInfo.h"
#import "AMPURLSession.h"
#import "AMPDatabaseHelper.h"
#import "AMPUtils.h"
#import "AMPIdentify.h"
#import "AMPRevenue.h"
#import "AMPTrackingOptions.h"
#import "AMPPlan.h"
#import "AMPIngestionMetadata.h"
#import "AMPServerZone.h"
#import "AMPServerZoneUtil.h"
#import "AMPMiddleware.h"
#import "AMPMiddlewareRunner.h"
#import "AMPIdentifyInterceptor.h"
#import "AMPEventUtils.h"
#if !TARGET_OS_OSX && !TARGET_OS_WATCH
#import "UIViewController+AMPScreen.h"
#endif
#import <math.h>
#import <CommonCrypto/CommonDigest.h>
#import <net/if.h>
#import <net/if_dl.h>
#import <sys/socket.h>
#import <sys/sysctl.h>
#import <sys/types.h>
#if TARGET_OS_WATCH
#import <WatchKit/WatchKit.h>
#elif !TARGET_OS_OSX
#import <UIKit/UIKit.h>
#else
#import <Cocoa/Cocoa.h>
#endif
@import AnalyticsConnector;
@interface Amplitude ()
@property (nonatomic, strong) NSOperationQueue *backgroundQueue;
@property (nonatomic, strong) NSOperationQueue *initializerQueue;
@property (nonatomic, strong) AMPDatabaseHelper *dbHelper;
@property (nonatomic, strong) AMPIdentifyInterceptor *identifyInterceptor;
@property (nonatomic, assign) BOOL initialized;
@property (nonatomic, assign) BOOL sslPinningEnabled;
@property (nonatomic, assign) long long sessionId;
@property (nonatomic, assign) BOOL backoffUpload;
@property (nonatomic, assign) int backoffUploadBatchSize;
@property (nonatomic, copy, readwrite, nullable) NSString *userId;
@property (nonatomic, copy, readwrite) NSString *deviceId;
@property (nonatomic, copy, readwrite) NSString *contentTypeHeader;
@end
static NSString *const BACKGROUND_QUEUE_NAME = @"BACKGROUND";
static NSString *const DATABASE_VERSION = @"database_version";
static NSString *const DEVICE_ID = @"device_id";
static NSString *const EVENTS = @"events";
static NSString *const EVENT_ID = @"event_id";
static NSString *const PREVIOUS_SESSION_ID = @"previous_session_id";
static NSString *const PREVIOUS_SESSION_TIME = @"previous_session_time";
static NSString *const MAX_EVENT_ID = @"max_event_id";
static NSString *const MAX_IDENTIFY_ID = @"max_identify_id";
static NSString *const OPT_OUT = @"opt_out";
static NSString *const USER_ID = @"user_id";
static NSString *const SEQUENCE_NUMBER = @"sequence_number";
// for app lifecycle events
static NSString *const APP_VERSION = @"app_version";
static NSString *const APP_BUILD = @"app_build";
@implementation Amplitude {
NSString *_eventsDataPath;
NSMutableDictionary *_propertyList;
BOOL _updateScheduled;
BOOL _updatingCurrently;
#if !TARGET_OS_OSX && !TARGET_OS_WATCH
UIBackgroundTaskIdentifier _uploadTaskID;
#endif
AMPDeviceInfo *_deviceInfo;
BOOL _useAdvertisingIdForDeviceId;
AMPTrackingOptions *_inputTrackingOptions;
AMPTrackingOptions *_appliedTrackingOptions;
NSDictionary *_apiPropertiesTrackingOptions;
BOOL _coppaControlEnabled;
BOOL _inForeground;
BOOL _offline;
int _numRetries;
int _maxRetries;
int _originalUploadPeriodsInSeconds;
NSString *_serverUrl;
NSString *_token;
AMPPlan *_plan;
AMPIngestionMetadata *_ingestionMetadata;
AMPServerZone _serverZone;
AMPMiddlewareRunner *_middlewareRunner;
AMPIdentifyInterceptor *_identifyInterceptor;
}
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
#pragma mark - Static methods
+ (Amplitude *)instance {
return [Amplitude instanceWithName:nil];
}
+ (Amplitude *)instanceWithName:(NSString *)instanceName {
static NSMutableDictionary *_instances = nil;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
_instances = [[NSMutableDictionary alloc] init];
});
// compiler wants explicit key nil check even though AMPUtils isEmptyString already has one
if (instanceName == nil || [AMPUtils isEmptyString:instanceName]) {
instanceName = kAMPDefaultInstance;
}
instanceName = [instanceName lowercaseString];
Amplitude *client = nil;
@synchronized(_instances) {
client = [_instances objectForKey:instanceName];
if (client == nil) {
client = [[self alloc] initWithInstanceName:instanceName];
[_instances setObject:client forKey:instanceName];
}
}
return client;
}
#pragma mark - Main class methods
- (instancetype)init {
return [self initWithInstanceName:nil];
}
- (instancetype)initWithInstanceName:(NSString *)instanceName {
if ([AMPUtils isEmptyString:instanceName]) {
instanceName = kAMPDefaultInstance;
}
instanceName = [instanceName lowercaseString];
if ((self = [super init])) {
#if AMPLITUDE_SSL_PINNING
_sslPinningEnabled = YES;
#else
_sslPinningEnabled = NO;
#endif
_initialized = NO;
_sessionId = -1;
_updateScheduled = NO;
_updatingCurrently = NO;
_useAdvertisingIdForDeviceId = NO;
_backoffUpload = NO;
_offline = NO;
_serverUrl = kAMPEventLogUrl;
_serverZone = US;
self.libraryName = kAMPLibrary;
self.libraryVersion = kAMPVersion;
self.contentTypeHeader = kAMPContentTypeHeader;
_inputTrackingOptions = [AMPTrackingOptions options];
_appliedTrackingOptions = [AMPTrackingOptions copyOf:_inputTrackingOptions];
_apiPropertiesTrackingOptions = [NSDictionary dictionary];
_coppaControlEnabled = NO;
self.instanceName = instanceName;
_dbHelper = [AMPDatabaseHelper getDatabaseHelper:instanceName];
_middlewareRunner = [AMPMiddlewareRunner middleRunner];
self.eventUploadThreshold = kAMPEventUploadThreshold;
self.eventMaxCount = kAMPEventMaxCount;
self.eventUploadMaxBatchSize = kAMPEventUploadMaxBatchSize;
self.eventUploadPeriodSeconds = kAMPEventUploadPeriodSeconds;
self.minTimeBetweenSessionsMillis = kAMPMinTimeBetweenSessionsMillis;
_backoffUploadBatchSize = self.eventUploadMaxBatchSize;
_originalUploadPeriodsInSeconds = self.eventUploadPeriodSeconds;
_numRetries = 0;
_maxRetries = 5;
// Set the event receiver to forward events generated by Experiment SDK
[[[AnalyticsConnector getInstance:self.instanceName] eventBridge] setEventReceiver:^(AnalyticsEvent * _Nonnull event) {
[self logEvent:[event eventType] withEventProperties:[event eventProperties] withApiProperties:nil withUserProperties:[event userProperties] withGroups:nil withGroupProperties:nil withTimestamp:nil outOfSession:false];
}];
self.defaultTracking = [[AMPDefaultTrackingOptions alloc] init];
_initializerQueue = [[NSOperationQueue alloc] init];
_backgroundQueue = [[NSOperationQueue alloc] init];
// Force method calls to happen in FIFO order by only allowing 1 concurrent operation
[_backgroundQueue setMaxConcurrentOperationCount:1];
// Ensure initialize finishes running asynchronously before other calls are run
[_backgroundQueue setSuspended:YES];
// Name the queue so runOnBackgroundQueue can tell which queue an operation is running
_backgroundQueue.name = BACKGROUND_QUEUE_NAME;
[_initializerQueue addOperationWithBlock:^{
#if !TARGET_OS_OSX && !TARGET_OS_WATCH
self->_uploadTaskID = UIBackgroundTaskInvalid;
#endif
NSString *eventsDataDirectory = [AMPUtils platformDataDirectory];
NSString *propertyListPath = [eventsDataDirectory stringByAppendingPathComponent:@"com.amplitude.plist"];
if (![self.instanceName isEqualToString:kAMPDefaultInstance]) {
propertyListPath = [NSString stringWithFormat:@"%@_%@", propertyListPath, self.instanceName]; // namespace pList with instance name
}
self->_propertyListPath = propertyListPath;
self->_eventsDataPath = [eventsDataDirectory stringByAppendingPathComponent:@"com.amplitude.archiveDict"];
[self upgradePrefs];
// Load propertyList object
self->_propertyList = [self deserializePList:self->_propertyListPath];
if (!self->_propertyList) {
self->_propertyList = [NSMutableDictionary dictionary];
[self->_propertyList setObject:[NSNumber numberWithInt:1] forKey:DATABASE_VERSION];
BOOL success = [self savePropertyList];
if (!success) {
AMPLITUDE_ERROR(@"ERROR: Unable to save propertyList to file on initialization");
}
} else {
AMPLITUDE_LOG(@"Loaded from %@", _propertyListPath);
}
// update database if necessary
int oldDBVersion = 1;
NSNumber *oldDBVersionSaved = [self->_propertyList objectForKey:DATABASE_VERSION];
if (oldDBVersionSaved != nil) {
oldDBVersion = [oldDBVersionSaved intValue];
}
// update the database
if (oldDBVersion < kAMPDBVersion) {
if ([self.dbHelper upgrade:oldDBVersion newVersion:kAMPDBVersion]) {
[self->_propertyList setObject:[NSNumber numberWithInt:kAMPDBVersion] forKey:DATABASE_VERSION];
[self savePropertyList];
}
}
// only on default instance, migrate all of old _eventsData object to database store if database just created
if ([self.instanceName isEqualToString:kAMPDefaultInstance] && oldDBVersion < kAMPDBFirstVersion) {
if ([self migrateEventsDataToDB]) {
// delete events data so don't need to migrate next time
if ([[NSFileManager defaultManager] fileExistsAtPath:self->_eventsDataPath]) {
[[NSFileManager defaultManager] removeItemAtPath:self->_eventsDataPath error:NULL];
}
}
}
// try to restore previous session
long long previousSessionId = [self previousSessionId];
if (previousSessionId >= 0) {
self->_sessionId = previousSessionId;
}
[self->_backgroundQueue setSuspended:NO];
}];
_identifyInterceptor = [AMPIdentifyInterceptor getIdentifyInterceptor:_dbHelper
backgroundQueue:_backgroundQueue];
[self addObservers];
}
return self;
}
// maintain backwards compatibility on default instance
- (BOOL)migrateEventsDataToDB {
NSDictionary *eventsData = [self unarchive:_eventsDataPath];
if (eventsData == nil) {
return NO;
}
AMPDatabaseHelper *defaultDbHelper = [AMPDatabaseHelper getDatabaseHelper];
BOOL success = YES;
// migrate events
NSArray *events = [eventsData objectForKey:EVENTS];
for (id event in events) {
NSError *error = nil;
NSData *jsonData = nil;
jsonData = [NSJSONSerialization dataWithJSONObject:[AMPUtils makeJSONSerializable:event] options:0 error:&error];
if (error != nil) {
AMPLITUDE_ERROR(@"ERROR: NSJSONSerialization error: %@", error);
continue;
}
NSString *jsonString = [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding];
if ([AMPUtils isEmptyString:jsonString]) {
AMPLITUDE_ERROR(@"ERROR: NSJSONSerialization resulted in a null string, skipping this event");
continue;
}
success &= [defaultDbHelper addEvent:jsonString];
}
// migrate remaining properties
NSString *userId = [eventsData objectForKey:USER_ID];
if (userId != nil) {
success &= [defaultDbHelper insertOrReplaceKeyValue:USER_ID value:userId];
}
NSNumber *optOut = [eventsData objectForKey:OPT_OUT];
if (optOut != nil) {
success &= [defaultDbHelper insertOrReplaceKeyLongValue:OPT_OUT value:optOut];
}
NSString *deviceId = [eventsData objectForKey:DEVICE_ID];
if (deviceId != nil) {
success &= [defaultDbHelper insertOrReplaceKeyValue:DEVICE_ID value:deviceId];
}
NSNumber *previousSessionId = [eventsData objectForKey:PREVIOUS_SESSION_ID];
if (previousSessionId != nil) {
success &= [defaultDbHelper insertOrReplaceKeyLongValue:PREVIOUS_SESSION_ID value:previousSessionId];
}
NSNumber *previousSessionTime = [eventsData objectForKey:PREVIOUS_SESSION_TIME];
if (previousSessionTime != nil) {
success &= [defaultDbHelper insertOrReplaceKeyLongValue:PREVIOUS_SESSION_TIME value:previousSessionTime];
}
return success;
}
- (void)addObservers {
NSNotificationCenter *center = [NSNotificationCenter defaultCenter];
#if TARGET_OS_WATCH
[center addObserver:self
selector:@selector(enterForeground)
name:AMPAppWillEnterForegroundNotification
object:nil];
[center addObserver:self
selector:@selector(enterBackground)
name:AMPAppDidEnterBackgroundNotification
object:nil];
#elif !TARGET_OS_OSX
[center addObserver:self
selector:@selector(enterForeground)
name:UIApplicationWillEnterForegroundNotification
object:nil];
[center addObserver:self
selector:@selector(enterBackground)
name:UIApplicationDidEnterBackgroundNotification
object:nil];
#else
[center addObserver:self
selector:@selector(enterForeground)
name:NSApplicationDidBecomeActiveNotification
object:nil];
[center addObserver:self
selector:@selector(enterBackground)
name:NSApplicationDidResignActiveNotification
object:nil];
#endif
#if !TARGET_OS_OSX && !TARGET_OS_WATCH
// mount the default events handler
UIApplication *app = [AMPUtils getSharedApplication];
if (app) {
for (NSString *name in @[UIApplicationDidEnterBackgroundNotification,
UIApplicationDidFinishLaunchingNotification,
UIApplicationWillEnterForegroundNotification]) {
[center addObserver:self selector:@selector(handleAppStateUpdates:) name:name object:app];
}
}
#endif
}
#if !TARGET_OS_OSX && !TARGET_OS_WATCH
- (void)handleAppStateUpdates:(NSNotification *)notification {
// lazy checking the settings here to avoid early init with false value
if (!self.defaultTracking.appLifecycles) {
return;
}
if ([notification.name isEqualToString:UIApplicationDidFinishLaunchingNotification]) {
NSString *previousBuild = [_dbHelper getValue:APP_BUILD];
NSString *previousVersion = [_dbHelper getValue:APP_VERSION];
NSString *currentBuild = [[NSBundle mainBundle] infoDictionary][@"CFBundleVersion"];
NSString *currentVersion = [[NSBundle mainBundle] infoDictionary][@"CFBundleShortVersionString"];
if (!previousBuild) {
[self logEvent:kAMPApplicationInstalled withEventProperties:@{
kAMPEventPropBuild: currentBuild ?: @"",
kAMPEventPropVersion: currentVersion ?: @"",
}];
} else if (![currentBuild isEqualToString:previousBuild]) {
[self logEvent:kAMPApplicationUpdated withEventProperties:@{
kAMPEventPropBuild: currentBuild ?: @"",
kAMPEventPropVersion: currentVersion ?: @"",
kAMPEventPropPreviousBuild: previousBuild ?: @"",
kAMPEventPropPreviousVersion: previousVersion ?: @"",
}];
}
[self logEvent:kAMPApplicationOpened withEventProperties:@{
kAMPEventPropBuild: currentBuild ?: @"",
kAMPEventPropVersion: currentVersion ?: @"",
kAMPEventPropFromBackground: @NO,
}];
// persist the build/version when changed
if (currentBuild ? ![currentBuild isEqualToString:previousBuild] : (previousBuild != nil)) {
[_dbHelper insertOrReplaceKeyValue:APP_BUILD value:currentBuild];
}
if (currentVersion ? ![currentVersion isEqualToString:previousVersion] : (previousVersion != nil)) {
[_dbHelper insertOrReplaceKeyValue:APP_VERSION value:currentVersion];
}
} else if ([notification.name isEqualToString:UIApplicationWillEnterForegroundNotification]) {
NSString *currentBuild = [[NSBundle mainBundle] infoDictionary][@"CFBundleVersion"];
NSString *currentVersion = [[NSBundle mainBundle] infoDictionary][@"CFBundleShortVersionString"];
[self logEvent:kAMPApplicationOpened withEventProperties:@{
kAMPEventPropBuild: currentBuild ?: @"",
kAMPEventPropVersion: currentVersion ?: @"",
kAMPEventPropFromBackground: @YES,
}];
} else if ([notification.name isEqualToString:UIApplicationDidEnterBackgroundNotification]) {
[self logEvent:kAMPApplicationBackgrounded];
}
}
#endif
- (void)removeObservers {
NSNotificationCenter *center = [NSNotificationCenter defaultCenter];
// unregister all observers added by addObservers method
[center removeObserver:self];
}
- (void)dealloc {
[self removeObservers];
}
- (void)initializeApiKey:(NSString *)apiKey {
[self initializeApiKey:apiKey userId:nil setUserId:NO];
}
/**
* Initialize Amplitude with a given apiKey and userId.
*/
- (void)initializeApiKey:(NSString *)apiKey
userId:(NSString *)userId {
[self initializeApiKey:apiKey userId:userId setUserId:YES];
}
/**
* SetUserId: client explicitly initialized with a userId (can be nil).
* If setUserId is NO, then attempt to load userId from saved eventsData.
*/
- (void)initializeApiKey:(NSString *)apiKey
userId:(NSString *)userId
setUserId:(BOOL)setUserId {
if (apiKey == nil) {
AMPLITUDE_ERROR(@"ERROR: apiKey cannot be nil in initializeApiKey:");
return;
}
if (![self isArgument:apiKey validType:[NSString class] methodName:@"initializeApiKey:"]) {
return;
}
if (userId != nil && ![self isArgument:userId validType:[NSString class] methodName:@"initializeApiKey:"]) {
return;
}
if ([apiKey length] == 0) {
AMPLITUDE_ERROR(@"ERROR: apiKey cannot be blank in initializeApiKey:");
return;
}
if (!_initialized) {
self.apiKey = apiKey;
[self runOnBackgroundQueue:^{
self->_deviceInfo = [[AMPDeviceInfo alloc] init];
[self initializeDeviceId];
if (setUserId) {
[self setUserId:userId];
} else {
self.userId = [self.dbHelper getValue:USER_ID];
}
// Set the user ID and device ID in the amplitude core instance. This is used to share user identity and user properties
// between Analytics and Experiment SDKs.
id<IdentityStoreEditor> identityStoreEditor = [[[AnalyticsConnector getInstance:self.instanceName] identityStore] editIdentity];
[[[identityStoreEditor setUserId:self.userId] setDeviceId:self.deviceId] commit];
if (self.initCompletionBlock != nil) {
self.initCompletionBlock();
}
#if !TARGET_OS_OSX && !TARGET_OS_WATCH
// Unlike other default events options that can be evaluated later, screenViews has to be evaluated during the actual initialization
if (self.defaultTracking.screenViews) {
[UIViewController amp_swizzleViewDidAppear];
}
#endif
}];
if (!self.deferCheckInForeground) {
[self checkInForeground];
}
}
}
- (void) checkInForeground {
// Normally _inForeground is set by the enterForeground callback, but initializeWithApiKey will be called after the app's enterForeground
// notification is already triggered, so we need to manually check and set it now.
// UIApplication methods are only allowed on the main thread so need to dispatch this synchronously to the main thread.
void (^checkInForeground)(void) = ^{
#if !TARGET_OS_OSX && !TARGET_OS_WATCH
UIApplication *app = [AMPUtils getSharedApplication];
if (app != nil) {
UIApplicationState state = app.applicationState;
if (state != UIApplicationStateBackground) {
self->_inForeground = YES;
[self runOnBackgroundQueue:^{
#else
self->_inForeground = YES;
#endif
// The earliest time to fetch dynamic config
[self refreshDynamicConfig];
NSNumber *now = [NSNumber numberWithLongLong:[[self currentTime] timeIntervalSince1970] * 1000];
[self startOrContinueSessionNSNumber:now inForeground:NO];
#if !TARGET_OS_OSX && !TARGET_OS_WATCH
}];
}
}
#endif
};
[self runSynchronouslyOnMainQueue:checkInForeground];
_initialized = YES;
}
/**
* Run a block in the background. If already in the background, run immediately.
*/
- (BOOL)runOnBackgroundQueue:(void (^)(void))block {
if ([[NSOperationQueue currentQueue].name isEqualToString:BACKGROUND_QUEUE_NAME]) {
AMPLITUDE_LOG(@"Already running in the background.");
block();
return NO;
} else {
[_backgroundQueue addOperationWithBlock:block];
return YES;
}
}
/**
* Run a block on the main thread. If already on the main thread, run immediately.
*/
- (void)runSynchronouslyOnMainQueue:(void (^)(void))block {
if ([NSThread isMainThread]) {
block();
} else {
dispatch_sync(dispatch_get_main_queue(), block);
}
}
#pragma mark - logEvent
- (void)logEvent:(NSString *)eventType {
[self logEvent:eventType withEventProperties:nil];
}
- (void)logEvent:(NSString *)eventType withEventProperties:(NSDictionary *)eventProperties {
[self logEvent:eventType withEventProperties:eventProperties withGroups:nil];
}
- (void)logEvent:(NSString *)eventType withEventProperties:(nullable NSDictionary *)eventProperties withMiddlewareExtra: (nullable NSMutableDictionary *) extra {
[self logEvent:eventType withEventProperties:eventProperties withApiProperties:nil withUserProperties:nil withGroups:nil withGroupProperties:nil withTimestamp:nil outOfSession:NO withMiddlewareExtra:extra];
}
- (void)logEvent:(NSString *)eventType withEventProperties:(nullable NSDictionary *)eventProperties withUserProperties:(NSDictionary *)userProperties {
[self logEvent:eventType withEventProperties:eventProperties withApiProperties:nil withUserProperties:userProperties withGroups:nil withGroupProperties:nil withTimestamp:nil outOfSession:NO withMiddlewareExtra:nil];
}
- (void)logEvent:(NSString *)eventType withEventProperties:(nullable NSDictionary *)eventProperties withUserProperties:(NSDictionary *)userProperties withMiddlewareExtra: (nullable NSMutableDictionary *) extra{
[self logEvent:eventType withEventProperties:eventProperties withApiProperties:nil withUserProperties:userProperties withGroups:nil withGroupProperties:nil withTimestamp:nil outOfSession:NO withMiddlewareExtra:extra];
}
- (void)logEvent:(NSString *)eventType withEventProperties:(NSDictionary *)eventProperties outOfSession:(BOOL)outOfSession {
[self logEvent:eventType withEventProperties:eventProperties withGroups:nil outOfSession:outOfSession];
}
- (void)logEvent:(NSString *)eventType withEventProperties:(NSDictionary *)eventProperties withGroups:(NSDictionary *)groups {
[self logEvent:eventType withEventProperties:eventProperties withGroups:groups outOfSession:NO];
}
- (void)logEvent:(NSString *)eventType withEventProperties:(NSDictionary *)eventProperties withGroups:(NSDictionary *)groups outOfSession:(BOOL)outOfSession {
[self logEvent:eventType withEventProperties:eventProperties withApiProperties:nil withUserProperties:nil withGroups:groups withGroupProperties:nil withTimestamp:nil outOfSession:outOfSession];
}
- (void)logEvent:(NSString *)eventType withEventProperties:(NSDictionary *)eventProperties withGroups:(NSDictionary *)groups withLongLongTimestamp:(long long)timestamp outOfSession:(BOOL)outOfSession {
[self logEvent:eventType withEventProperties:eventProperties withApiProperties:nil withUserProperties:nil withGroups:groups withGroupProperties:nil withTimestamp:[NSNumber numberWithLongLong:timestamp] outOfSession:outOfSession];
}
- (void)logEvent:(NSString *)eventType withEventProperties:(NSDictionary *)eventProperties withGroups:(NSDictionary *)groups withTimestamp:(NSNumber *)timestamp outOfSession:(BOOL)outOfSession {
[self logEvent:eventType withEventProperties:eventProperties withApiProperties:nil withUserProperties:nil withGroups:groups withGroupProperties:nil withTimestamp:timestamp outOfSession:outOfSession];
}
- (void)logEvent:(NSString *)eventType withEventProperties:(NSDictionary *)eventProperties withApiProperties:(NSDictionary *)apiProperties withUserProperties:(NSDictionary *)userProperties withGroups:(NSDictionary *)groups withGroupProperties:(NSDictionary *)groupProperties withTimestamp:(NSNumber *)timestamp outOfSession:(BOOL)outOfSession {
[self logEvent:eventType withEventProperties:eventProperties withApiProperties:apiProperties withUserProperties:userProperties withGroups:groups withGroupProperties:groupProperties withTimestamp:timestamp outOfSession:outOfSession withMiddlewareExtra:nil];
}
- (void)logEvent:(NSString *)eventType withEventProperties:(NSDictionary *)eventProperties withApiProperties:(NSDictionary *)apiProperties withUserProperties:(NSDictionary *)userProperties withGroups:(NSDictionary *)groups withGroupProperties:(NSDictionary *)groupProperties withTimestamp:(NSNumber *)timestamp outOfSession:(BOOL)outOfSession withMiddlewareExtra: (nullable NSMutableDictionary *) extra {
if (self.apiKey == nil) {
AMPLITUDE_ERROR(@"ERROR: apiKey cannot be nil or empty, set apiKey with initializeApiKey: before calling logEvent");
return;
}
if (![self isArgument:eventType validType:[NSString class] methodName:@"logEvent"]) {
AMPLITUDE_ERROR(@"ERROR: eventType must be an NSString");
return;
}
if (eventProperties != nil && ![self isArgument:eventProperties validType:[NSDictionary class] methodName:@"logEvent"]) {
AMPLITUDE_ERROR(@"ERROR: eventProperties must by a NSDictionary");
return;
}
if (timestamp == nil) {
timestamp = [NSNumber numberWithLongLong:[[self currentTime] timeIntervalSince1970] * 1000];
}
// Create snapshot of all event json objects, to prevent deallocation crash
eventProperties = [eventProperties copy];
apiProperties = [apiProperties mutableCopy];
userProperties = [userProperties copy];
groups = [groups copy];
groupProperties = [groupProperties copy];
BOOL inForeground = _inForeground;
[self runOnBackgroundQueue:^{
// Respect the opt-out setting by not sending or storing any events.
if ([self optOut]) {
AMPLITUDE_LOG(@"User has opted out of tracking. Event %@ not logged.", eventType);
return;
}
// skip session check if logging start_session or end_session events
BOOL loggingSessionEvent = (self->_trackingSessionEvents || self.defaultTracking.sessions) && ([eventType isEqualToString:kAMPSessionStartEvent] || [eventType isEqualToString:kAMPSessionEndEvent]);
if (!loggingSessionEvent && !outOfSession) {
[self startOrContinueSessionNSNumber:timestamp inForeground:inForeground];
}
NSMutableDictionary *event = [NSMutableDictionary dictionary];
[event setValue:eventType forKey:@"event_type"];
[event setValue:[self truncate:[AMPUtils makeJSONSerializable:[self replaceWithEmptyJSON:eventProperties]]] forKey:@"event_properties"];
[event setValue:[self replaceWithEmptyJSON:apiProperties] forKey:@"api_properties"];
[event setValue:[self truncate:[AMPUtils makeJSONSerializable:[self replaceWithEmptyJSON:userProperties]]] forKey:@"user_properties"];
[event setValue:[self truncate:[AMPUtils validateGroups:[self replaceWithEmptyJSON:groups]]] forKey:@"groups"];
[event setValue:[self truncate:[AMPUtils makeJSONSerializable:[self replaceWithEmptyJSON:groupProperties]]] forKey:@"group_properties"];
[event setValue:[NSNumber numberWithLongLong:outOfSession ? -1 : self->_sessionId] forKey:@"session_id"];
[event setValue:timestamp forKey:@"timestamp"];
[self annotateEvent:event];
AMPMiddlewarePayload * middlewarePayload = [[AMPMiddlewarePayload alloc] initWithEvent:event withExtra:extra];
__block BOOL middlewareCompleted = NO;
[self->_middlewareRunner run:middlewarePayload next:^(AMPMiddlewarePayload *_Nullable newPayload){
middlewareCompleted = YES;
}];
if (!middlewareCompleted) {
AMPLITUDE_LOG(@"Middleware chain skipped logEvent action. Event %@ not logged.", eventType);
return;
}
// Apply identify events to amplitude core to notify experiment SDK that user properties have changed.
if ([eventType isEqualToString:IDENTIFY_EVENT]) {
id<IdentityStoreEditor> editor = [[[AnalyticsConnector getInstance:self.instanceName] identityStore] editIdentity];
[[editor updateUserProperties:[event valueForKey:@"user_properties"]] commit];
}
event = [self->_identifyInterceptor intercept:event];
if (event != nil) {
// convert event dictionary to JSON String
NSError *error = nil;
NSData *jsonData = [NSJSONSerialization dataWithJSONObject:[AMPUtils makeJSONSerializable:event] options:0 error:&error];
if (error != nil) {
AMPLITUDE_ERROR(@"ERROR: could not JSONSerialize event type %@: %@", eventType, error);
return;
}
NSString *jsonString = [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding];
if ([AMPUtils isEmptyString:jsonString]) {
AMPLITUDE_ERROR(@"ERROR: JSONSerializing event type %@ resulted in an NULL string", eventType);
return;
}
if ([eventType isEqualToString:IDENTIFY_EVENT] || [eventType isEqualToString:GROUP_IDENTIFY_EVENT]) {
(void) [self.dbHelper addIdentify:jsonString];
} else {
(void) [self.dbHelper addEvent:jsonString];
}
}
AMPLITUDE_LOG(@"Logged %@ Event", event[@"event_type"]);
[self truncateEventQueues];
int eventCount = [self.dbHelper getTotalEventCount]; // refetch since events may have been deleted
if ((eventCount % self.eventUploadThreshold) == 0 && eventCount >= self.eventUploadThreshold) {
[self uploadEvents];
} else {
[self uploadEventsWithDelay:self.eventUploadPeriodSeconds];
}
}];
}
- (void)truncateEventQueues {
int numEventsToRemove = MIN(MAX(1, self.eventMaxCount/10), kAMPEventRemoveBatchSize);
int eventCount = [self.dbHelper getEventCount];
if (eventCount > self.eventMaxCount) {
[self.dbHelper removeEvents:([self.dbHelper getNthEventId:numEventsToRemove])];
}
int identifyCount = [self.dbHelper getIdentifyCount];
if (identifyCount > self.eventMaxCount) {
[self.dbHelper removeIdentifys:([self.dbHelper getNthIdentifyId:numEventsToRemove])];
}
int interceptedIdentifyCount = [self.dbHelper getInterceptedIdentifyCount];
if (interceptedIdentifyCount > self.eventMaxCount) {
[self.dbHelper removeInterceptedIdentifys:([self.dbHelper getNthInterceptedIdentifyId:numEventsToRemove])];
}
}
- (void)annotateEvent:(NSMutableDictionary *)event {
[event setValue:self.userId forKey:@"user_id"];
[event setValue:self.deviceId forKey:@"device_id"];
if ([_appliedTrackingOptions shouldTrackPlatform]) {
[event setValue:kAMPPlatform forKey:@"platform"];
}
if ([_appliedTrackingOptions shouldTrackVersionName]) {
[event setValue:_deviceInfo.appVersion forKey:@"version_name"];
}
if ([_appliedTrackingOptions shouldTrackOSName]) {
[event setValue:_deviceInfo.osName forKey:@"os_name"];
}
if ([_appliedTrackingOptions shouldTrackOSVersion]) {
[event setValue:_deviceInfo.osVersion forKey:@"os_version"];
}
if ([_appliedTrackingOptions shouldTrackDeviceModel]) {
[event setValue:_deviceInfo.model forKey:@"device_model"];
}
if ([_appliedTrackingOptions shouldTrackDeviceManufacturer]) {
[event setValue:_deviceInfo.manufacturer forKey:@"device_manufacturer"];
}
if ([_appliedTrackingOptions shouldTrackCarrier]) {
[event setValue:_deviceInfo.carrier forKey:@"carrier"];
}
if ([_appliedTrackingOptions shouldTrackCountry]) {
[event setValue:_deviceInfo.country forKey:@"country"];
}
if ([_appliedTrackingOptions shouldTrackLanguage]) {
[event setValue:_deviceInfo.language forKey:@"language"];
}
NSDictionary *library = @{
@"name": self.libraryName == nil ? kAMPUnknownLibrary : self.libraryName,
@"version": self.libraryVersion == nil ? kAMPUnknownVersion : self.libraryVersion
};
[event setValue:library forKey:@"library"];
[event setValue:[AMPUtils generateUUID] forKey:@"uuid"];
[event setValue:[NSNumber numberWithLongLong:[self.dbHelper getNextSequenceNumber]] forKey:@"sequence_number"];
if (_plan) {
[event setValue:[_plan toNSDictionary] forKey:@"plan"];
}
if (_ingestionMetadata) {
[event setValue:[_ingestionMetadata toNSDictionary] forKey:@"ingestion_metadata"];
}
NSMutableDictionary *apiProperties = [event valueForKey:@"api_properties"];
if ([_appliedTrackingOptions shouldTrackIDFA]) {
NSString *advertiserID = [self getAdSupportID];
if (advertiserID != nil) {
[apiProperties setValue:advertiserID forKey:@"ios_idfa"];
}
}
NSString *vendorID = _deviceInfo.vendorID;
if ([_appliedTrackingOptions shouldTrackIDFV] && vendorID) {
[apiProperties setValue:vendorID forKey:@"ios_idfv"];
}
if ([_appliedTrackingOptions shouldTrackLatLng] && self.locationInfoBlock != nil) {
NSDictionary *location = self.locationInfoBlock();
if (location != nil) {
[apiProperties setValue:location forKey:@"location"];
}
}
if (self->_apiPropertiesTrackingOptions.count > 0) {
[apiProperties setValue:self->_apiPropertiesTrackingOptions forKey:@"tracking_options"];
}
}
#pragma mark - logRevenue
// amount is a double in units of dollars
// ex. $3.99 would be passed as [NSNumber numberWithDouble:3.99]
- (void)logRevenue:(NSNumber *)amount
{
[self logRevenue:nil quantity:1 price:amount];
}
- (void)logRevenue:(NSString *)productIdentifier quantity:(NSInteger)quantity price:(NSNumber *)price
{
[self logRevenue:productIdentifier quantity:quantity price:price receipt:nil];
}
- (void)logRevenue:(NSString *)productIdentifier quantity:(NSInteger)quantity price:(NSNumber *)price receipt:(NSData *)receipt
{
if (self.apiKey == nil) {
AMPLITUDE_ERROR(@"ERROR: apiKey cannot be nil or empty, set apiKey with initializeApiKey: before calling logRevenue:");
return;
}
if (![self isArgument:price validType:[NSNumber class] methodName:@"logRevenue:"]) {
return;
}
NSDictionary *apiProperties = [NSMutableDictionary dictionary];
[apiProperties setValue:kAMPRevenueEvent forKey:@"special"];
[apiProperties setValue:productIdentifier forKey:@"productId"];
[apiProperties setValue:[NSNumber numberWithInteger:quantity] forKey:@"quantity"];
[apiProperties setValue:price forKey:@"price"];
if ([receipt respondsToSelector:@selector(base64EncodedStringWithOptions:)]) {
[apiProperties setValue:[receipt base64EncodedStringWithOptions:0] forKey:@"receipt"];
} else {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated"
[apiProperties setValue:[receipt base64Encoding] forKey:@"receipt"];
#pragma clang diagnostic pop
}
[self logEvent:kAMPRevenueEvent withEventProperties:nil withApiProperties:apiProperties withUserProperties:nil withGroups:nil withGroupProperties:nil withTimestamp:nil outOfSession:NO];
}
- (void)logRevenueV2:(AMPRevenue *)revenue {
if (self.apiKey == nil) {
AMPLITUDE_ERROR(@"ERROR: apiKey cannot be nil or empty, set apiKey with initializeApiKey: before calling logRevenueV2");
return;
}
if (revenue == nil || ![revenue isValidRevenue]) {
return;
}
[self logEvent:kAMPRevenueEvent withEventProperties:[revenue toNSDictionary]];
}
#pragma mark - Deep link methods
- (void)continueUserActivity:(NSUserActivity *)activity {
if (!self.defaultTracking.deepLinks) {
return;
}
if ([activity.activityType isEqualToString:NSUserActivityTypeBrowsingWeb]) {
NSString *urlString = activity.webpageURL.absoluteString;
NSString *referrerString = nil;
if (@available(iOS 11, tvOS 11.0, macOS 10.13, watchOS 4.0, *)) {
referrerString = activity.referrerURL.absoluteString;
}
[self logEvent:kAMPDeepLinkOpened withEventProperties:@{
kAMPEventPropLinkUrl: urlString ?: @"",
kAMPEventPropLinkReferrer: referrerString ?: @"",
}];
}
}
- (void)openURL:(NSURL *)url {
if (!self.defaultTracking.deepLinks) {
return;
}
NSString *urlString = url.absoluteString;
[self logEvent:kAMPDeepLinkOpened withEventProperties:@{
kAMPEventPropLinkUrl: urlString ?: @"",
}];
}
#pragma mark - Upload events
- (void)uploadEventsWithDelay:(int)delay {
if (!_updateScheduled) {
_updateScheduled = YES;
__block __weak Amplitude *weakSelf = self;
[_backgroundQueue addOperationWithBlock:^{
dispatch_async(dispatch_get_main_queue(), ^{
[weakSelf performSelector:@selector(uploadEventsInBackground) withObject:nil afterDelay:delay];
});
}];
}
}
- (void)uploadEventsInBackground {
_updateScheduled = NO;
[self uploadEvents];
}
- (void)uploadEvents {
int limit = _backoffUpload ? _backoffUploadBatchSize : self.eventUploadMaxBatchSize;
[self uploadEventsWithLimit:limit];
}
- (void)uploadEventsWithLimit:(int)limit {
if (self.apiKey == nil) {
AMPLITUDE_ERROR(@"ERROR: apiKey cannot be nil or empty, set apiKey with initializeApiKey: before calling uploadEvents:");
return;
}
@synchronized (self) {
if (_updatingCurrently) {
return;
}
_updatingCurrently = YES;
}
[self runOnBackgroundQueue:^{
// Don't communicate with the server if the user has opted out.
if ([self optOut] || self->_offline) {
self->_updatingCurrently = NO;
[self endBackgroundTaskIfNeeded];
return;
}
// Include any pending Identify operations
[self->_identifyInterceptor transferInterceptedIdentify];
long eventCount = [self.dbHelper getTotalEventCount];
long numEvents = limit > 0 ? fminl(eventCount, limit) : eventCount;
if (numEvents == 0) {
self->_updatingCurrently = NO;
[self endBackgroundTaskIfNeeded];
return;
}
NSMutableArray *events = [self.dbHelper getEvents:-1 limit:numEvents];
NSMutableArray *identifys = [self.dbHelper getIdentifys:-1 limit:numEvents];
NSDictionary *merged = [self mergeEventsAndIdentifys:events identifys:identifys numEvents:numEvents];
NSMutableArray *uploadEvents = [merged objectForKey:EVENTS];
long long maxEventId = [[merged objectForKey:MAX_EVENT_ID] longLongValue];
long long maxIdentifyId = [[merged objectForKey:MAX_IDENTIFY_ID] longLongValue];
NSError *error = nil;
NSData *eventsDataLocal = nil;
eventsDataLocal = [NSJSONSerialization dataWithJSONObject:uploadEvents options:0 error:&error];