-
Notifications
You must be signed in to change notification settings - Fork 244
/
Copy pathCountly.m
1508 lines (1146 loc) · 52 KB
/
Countly.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
// Countly.m
//
// This code is provided under the MIT License.
//
// Please visit www.count.ly for more information.
#import "CountlyCommon.h"
@interface Countly ()
{
NSTimer* timer;
BOOL isSuspended;
}
@end
long long appLoadStartTime;
// It holds the event id of previous recorded custom event.
NSString* previousEventID;
// It holds the event name of previous recorded custom event.
NSString* previousEventName;
@implementation Countly
#pragma mark - Core
+ (void)load
{
[super load];
appLoadStartTime = floor(NSDate.date.timeIntervalSince1970 * 1000);
}
static Countly *s_sharedCountly = nil;
static dispatch_once_t onceToken;
+ (instancetype)sharedInstance
{
dispatch_once(&onceToken, ^{s_sharedCountly = self.new;});
return s_sharedCountly;
}
- (void)resetInstance {
CLY_LOG_I(@"%s", __FUNCTION__);
onceToken = 0;
s_sharedCountly = nil;
}
- (instancetype)init
{
if (self = [super init])
{
#if (TARGET_OS_IOS || TARGET_OS_VISION || TARGET_OS_TV )
[NSNotificationCenter.defaultCenter addObserver:self
selector:@selector(applicationDidEnterBackground:)
name:UIApplicationDidEnterBackgroundNotification
object:nil];
[NSNotificationCenter.defaultCenter addObserver:self
selector:@selector(applicationWillEnterForeground:)
name:UIApplicationWillEnterForegroundNotification
object:nil];
[NSNotificationCenter.defaultCenter addObserver:self
selector:@selector(applicationWillTerminate:)
name:UIApplicationWillTerminateNotification
object:nil];
[NSNotificationCenter.defaultCenter addObserver:self
selector:@selector(applicationDidBecomeActive:) name:UIApplicationDidBecomeActiveNotification
object:nil];
[NSNotificationCenter.defaultCenter addObserver:self
selector:@selector(applicationWillResignActive:) name:UIApplicationWillResignActiveNotification
object:nil];
#elif (TARGET_OS_OSX)
[NSNotificationCenter.defaultCenter addObserver:self
selector:@selector(applicationWillTerminate:)
name:NSApplicationWillTerminateNotification
object:nil];
#endif
}
return self;
}
- (void)startWithConfig:(CountlyConfig *)config
{
if (CountlyCommon.sharedInstance.hasStarted_)
return;
CountlyCommon.sharedInstance.hasStarted = YES;
CountlyCommon.sharedInstance.enableDebug = config.enableDebug;
CountlyCommon.sharedInstance.shouldIgnoreTrustCheck = config.shouldIgnoreTrustCheck;
CountlyCommon.sharedInstance.loggerDelegate = config.loggerDelegate;
CountlyCommon.sharedInstance.internalLogLevel = config.internalLogLevel;
config = [self checkAndFixInternalLimitsConfig:config];
CountlyCommon.sharedInstance.maxKeyLength = config.sdkInternalLimits.getMaxKeyLength;
CountlyCommon.sharedInstance.maxValueLength = config.sdkInternalLimits.getMaxValueSize;
CountlyCommon.sharedInstance.maxSegmentationValues = config.sdkInternalLimits.getMaxSegmentationValues;
// For backward compatibility, deprecated values are only set incase new values are not provided using sdkInternalLimits interface
if(CountlyCommon.sharedInstance.maxKeyLength == kCountlyMaxKeyLength && config.maxKeyLength != kCountlyMaxKeyLength) {
CountlyCommon.sharedInstance.maxKeyLength = config.maxKeyLength;
CLY_LOG_I(@"%s provided 'maxKeyLength' override:[ %lu ]", __FUNCTION__, (unsigned long)config.maxKeyLength);
}
if(CountlyCommon.sharedInstance.maxValueLength == kCountlyMaxValueSize && config.maxValueLength != kCountlyMaxValueSize) {
CountlyCommon.sharedInstance.maxValueLength = config.maxValueLength;
CLY_LOG_I(@"%s provided 'maxValueLength' override:[ %lu ]", __FUNCTION__, (unsigned long)config.maxValueLength);
}
if(CountlyCommon.sharedInstance.maxSegmentationValues == kCountlyMaxSegmentationValues && config.maxSegmentationValues != kCountlyMaxSegmentationValues) {
CountlyCommon.sharedInstance.maxSegmentationValues = config.maxSegmentationValues;
CLY_LOG_I(@"%s provided 'maxSegmentationValues' override:[ %lu ]", __FUNCTION__, (unsigned long)config.maxSegmentationValues);
}
CountlyConsentManager.sharedInstance.requiresConsent = config.requiresConsent;
if (!config.appKey.length || [config.appKey isEqualToString:@"YOUR_APP_KEY"])
[NSException raise:@"CountlyAppKeyNotSetException" format:@"appKey property on CountlyConfig object is not set"];
if (!config.host.length || [config.host isEqualToString:@"https://YOUR_COUNTLY_SERVER"])
[NSException raise:@"CountlyHostNotSetException" format:@"host property on CountlyConfig object is not set"];
if ([CountlyCommon.sharedInstance.SDKName isEqualToString:kCountlySDKName] && [CountlyCommon.sharedInstance.SDKVersion isEqualToString:kCountlySDKVersion])
{
CLY_LOG_I(@"Initializing with %@ SDK v%@ on %@ with %@ %@",
CountlyCommon.sharedInstance.SDKName,
CountlyCommon.sharedInstance.SDKVersion,
CountlyDeviceInfo.device,
CountlyDeviceInfo.osName,
CountlyDeviceInfo.osVersion);
}
else {
CLY_LOG_I(@"Initializing with %@ SDK v%@ on %@ with %@ %@ default SDK name %@ default SDK version %@",
CountlyCommon.sharedInstance.SDKName,
CountlyCommon.sharedInstance.SDKVersion,
CountlyDeviceInfo.device,
CountlyDeviceInfo.osName,
CountlyDeviceInfo.osVersion,
kCountlySDKName,
kCountlySDKVersion);
}
if (!CountlyDeviceInfo.sharedInstance.deviceID || config.resetStoredDeviceID)
{
[self storeCustomDeviceIDState:config.deviceID];
[CountlyDeviceInfo.sharedInstance initializeDeviceID:config.deviceID];
}
CountlyConnectionManager.sharedInstance.appKey = config.appKey;
CountlyConnectionManager.sharedInstance.host = config.host;
CountlyConnectionManager.sharedInstance.alwaysUsePOST = config.alwaysUsePOST;
CountlyConnectionManager.sharedInstance.pinnedCertificates = config.pinnedCertificates;
CountlyConnectionManager.sharedInstance.secretSalt = config.secretSalt;
CountlyConnectionManager.sharedInstance.URLSessionConfiguration = config.URLSessionConfiguration;
CountlyPersistency.sharedInstance.eventSendThreshold = config.eventSendThreshold;
CountlyPersistency.sharedInstance.requestDropAgeHours = config.requestDropAgeHours;
CountlyPersistency.sharedInstance.storedRequestsLimit = MAX(1, config.storedRequestsLimit);
CountlyCommon.sharedInstance.manualSessionHandling = config.manualSessionHandling;
CountlyCommon.sharedInstance.enableManualSessionControlHybridMode = config.enableManualSessionControlHybridMode;
CountlyCommon.sharedInstance.attributionID = config.attributionID;
NSDictionary* customMetricsTruncated = [config.customMetrics cly_truncated:@"Custom metric"];
CountlyDeviceInfo.sharedInstance.customMetrics = [customMetricsTruncated cly_limited:@"Custom metric"];
[Countly.user save];
CountlyCommon.sharedInstance.enableServerConfiguration = config.enableServerConfiguration;
// Fetch server configs if 'enableServerConfiguration' is true.
if (config.enableServerConfiguration)
{
[CountlyServerConfig.sharedInstance fetchServerConfig];
}
#if (TARGET_OS_IOS)
CountlyFeedbacksInternal.sharedInstance.message = config.starRatingMessage;
CountlyFeedbacksInternal.sharedInstance.sessionCount = config.starRatingSessionCount;
CountlyFeedbacksInternal.sharedInstance.disableAskingForEachAppVersion = config.starRatingDisableAskingForEachAppVersion;
CountlyFeedbacksInternal.sharedInstance.ratingCompletionForAutoAsk = config.starRatingCompletion;
[CountlyFeedbacksInternal.sharedInstance checkForStarRatingAutoAsk];
#endif
if(config.disableLocation)
{
[CountlyLocationManager.sharedInstance disableLocation];
}
else
{
[CountlyLocationManager.sharedInstance updateLocation:config.location city:config.city ISOCountryCode:config.ISOCountryCode IP:config.IP];
}
if (!CountlyCommon.sharedInstance.manualSessionHandling)
[CountlyConnectionManager.sharedInstance beginSession];
else
[CountlyCommon.sharedInstance recordOrientation];
//NOTE: If there is no consent for sessions, location info and attribution should be sent separately, as they cannot be sent with begin_session request.
#if (TARGET_OS_IOS || TARGET_OS_VISION || TARGET_OS_OSX )
#ifndef COUNTLY_EXCLUDE_PUSHNOTIFICATIONS
if ([config.features containsObject:CLYPushNotifications])
{
CountlyPushNotifications.sharedInstance.isEnabledOnInitialConfig = YES;
CountlyPushNotifications.sharedInstance.pushTestMode = config.pushTestMode;
CountlyPushNotifications.sharedInstance.sendPushTokenAlways = config.sendPushTokenAlways;
CountlyPushNotifications.sharedInstance.doNotShowAlertForNotifications = config.doNotShowAlertForNotifications;
CountlyPushNotifications.sharedInstance.launchNotification = config.launchNotification;
[CountlyPushNotifications.sharedInstance startPushNotifications];
}
#endif
#endif
if(config.crashes.crashFilterCallback) {
[CountlyCrashReporter.sharedInstance setCrashFilterCallback:config.crashes.crashFilterCallback];
}
CountlyCrashReporter.sharedInstance.crashSegmentation = config.crashSegmentation;
CountlyCrashReporter.sharedInstance.crashLogLimit = config.sdkInternalLimits.getMaxBreadcrumbCount;
// For backward compatibility, deprecated values are only set incase new values are not provided using sdkInternalLimits interface
if(CountlyCrashReporter.sharedInstance.crashLogLimit == kCountlyMaxBreadcrumbCount && config.crashLogLimit != kCountlyMaxBreadcrumbCount) {
CountlyCrashReporter.sharedInstance.crashLogLimit = MAX(1, config.crashLogLimit);
CLY_LOG_W(@"%s provided 'maxBreadcrumbCount' override:[ %lu ]", __FUNCTION__, (unsigned long)config.crashLogLimit);
}
CountlyCrashReporter.sharedInstance.crashFilter = config.crashFilter;
CountlyCrashReporter.sharedInstance.shouldUsePLCrashReporter = config.shouldUsePLCrashReporter;
CountlyCrashReporter.sharedInstance.shouldUseMachSignalHandler = config.shouldUseMachSignalHandler;
CountlyCrashReporter.sharedInstance.crashOccuredOnPreviousSessionCallback = config.crashOccuredOnPreviousSessionCallback;
CountlyCrashReporter.sharedInstance.shouldSendCrashReportCallback = config.shouldSendCrashReportCallback;
if ([config.features containsObject:CLYCrashReporting])
{
CountlyCrashReporter.sharedInstance.isEnabledOnInitialConfig = YES;
[CountlyCrashReporter.sharedInstance startCrashReporting];
}
#if (TARGET_OS_IOS || TARGET_OS_TV )
if (config.enableAutomaticViewTracking || [config.features containsObject:CLYAutoViewTracking])
{
// Print deprecation flag for feature
CountlyViewTrackingInternal.sharedInstance.isEnabledOnInitialConfig = YES;
[CountlyViewTrackingInternal.sharedInstance startAutoViewTracking];
}
if (config.automaticViewTrackingExclusionList) {
[CountlyViewTrackingInternal.sharedInstance addAutoViewTrackingExclutionList:config.automaticViewTrackingExclusionList];
}
#endif
if(config.experimental.enablePreviousNameRecording) {
CountlyViewTrackingInternal.sharedInstance.enablePreviousNameRecording = YES;
}
if(config.experimental.enableVisibiltyTracking) {
CountlyCommon.sharedInstance.enableVisibiltyTracking = YES;
}
if (config.globalViewSegmentation) {
[CountlyViewTrackingInternal.sharedInstance setGlobalViewSegmentation:config.globalViewSegmentation];
}
timer = [NSTimer timerWithTimeInterval:config.updateSessionPeriod target:self selector:@selector(onTimer:) userInfo:nil repeats:YES];
[NSRunLoop.mainRunLoop addTimer:timer forMode:NSRunLoopCommonModes];
CountlyRemoteConfigInternal.sharedInstance.isRCAutomaticTriggersEnabled = config.enableRemoteConfigAutomaticTriggers || config.enableRemoteConfig;
CountlyRemoteConfigInternal.sharedInstance.isRCValueCachingEnabled = config.enableRemoteConfigValueCaching;
CountlyRemoteConfigInternal.sharedInstance.remoteConfigCompletionHandler = config.remoteConfigCompletionHandler;
if (config.getRemoteConfigGlobalCallbacks) {
CountlyRemoteConfigInternal.sharedInstance.remoteConfigGlobalCallbacks = config.getRemoteConfigGlobalCallbacks;
}
if (config.enrollABOnRCDownload) {
CountlyRemoteConfigInternal.sharedInstance.enrollABOnRCDownload = config.enrollABOnRCDownload;
}
[CountlyRemoteConfigInternal.sharedInstance downloadRemoteConfigAutomatically];
if (config.apm.getAppStartTimestampOverride) {
appLoadStartTime = config.apm.getAppStartTimestampOverride;
}
#if (TARGET_OS_IOS)
if(config.content.getGlobalContentCallback) {
CountlyContentBuilderInternal.sharedInstance.contentCallback = config.content.getGlobalContentCallback;
}
if(config.content.getZoneTimerInterval){
CountlyContentBuilderInternal.sharedInstance.zoneTimerInterval = config.content.getZoneTimerInterval;
}
#endif
[CountlyPerformanceMonitoring.sharedInstance startWithConfig:config.apm];
CountlyCommon.sharedInstance.enableOrientationTracking = config.enableOrientationTracking;
[CountlyCommon.sharedInstance observeDeviceOrientationChanges];
[CountlyConnectionManager.sharedInstance proceedOnQueue];
//TODO: Should move at the top after checking the the edge cases of current implementation
if (config.enableAllConsents)
[self giveAllConsents];
else if (config.consents)
[self giveConsentForFeatures:config.consents];
else if (config.requiresConsent)
[CountlyConsentManager.sharedInstance sendConsents];
if (!CountlyConsentManager.sharedInstance.consentForSessions)
{
//Send an empty location if location is disabled or location consent is not given, without checking for location consent.
if (!CountlyConsentManager.sharedInstance.consentForLocation || CountlyLocationManager.sharedInstance.isLocationInfoDisabled)
{
[CountlyConnectionManager.sharedInstance sendLocationInfo];
}
else
{
[CountlyLocationManager.sharedInstance sendLocationInfo];
}
[CountlyConnectionManager.sharedInstance sendAttribution];
}
if (config.campaignType && config.campaignData)
[self recordDirectAttributionWithCampaignType:config.campaignType andCampaignData:config.campaignData];
if (config.indirectAttribution)
[self recordIndirectAttribution:config.indirectAttribution];
}
- (CountlyConfig *) checkAndFixInternalLimitsConfig:(CountlyConfig *)config
{
if (config.sdkInternalLimits.getMaxKeyLength == 0) {
[config.sdkInternalLimits setMaxKeyLength:kCountlyMaxKeyLength];
CLY_LOG_W(@"%s Ignoring provided value of %lu for 'maxKeyLength' because it's less than 1", __FUNCTION__, (unsigned long)config.sdkInternalLimits.getMaxKeyLength);
}
else if(config.sdkInternalLimits.getMaxKeyLength != kCountlyMaxKeyLength)
{
CLY_LOG_I(@"%s provided 'maxKeyLength' override:[ %lu ]", __FUNCTION__, (unsigned long)config.sdkInternalLimits.getMaxKeyLength);
}
if (config.sdkInternalLimits.getMaxValueSize == 0) {
[config.sdkInternalLimits setMaxValueSize:kCountlyMaxValueSize];
CLY_LOG_W(@"%s Ignoring provided value of %lu for 'maxValueSize' because it's less than 1", __FUNCTION__, (unsigned long)config.sdkInternalLimits.getMaxValueSize);
}
else if(config.sdkInternalLimits.getMaxValueSize != kCountlyMaxValueSize)
{
CLY_LOG_I(@"%s provided 'maxValueSize' override:[ %lu ]", __FUNCTION__, (unsigned long)config.sdkInternalLimits.getMaxValueSize);
}
if (config.sdkInternalLimits.getMaxSegmentationValues == 0) {
[config.sdkInternalLimits setMaxSegmentationValues:kCountlyMaxSegmentationValues];
CLY_LOG_W(@"%s Ignoring provided value of %lu for 'maxSegmentationValues' because it's less than 1", __FUNCTION__, (unsigned long)config.sdkInternalLimits.getMaxSegmentationValues);
}
else if(config.sdkInternalLimits.getMaxSegmentationValues != kCountlyMaxSegmentationValues)
{
CLY_LOG_I(@"%s provided 'maxSegmentationValues' override:[ %lu ]", __FUNCTION__, (unsigned long)config.sdkInternalLimits.getMaxSegmentationValues);
}
if (config.sdkInternalLimits.getMaxBreadcrumbCount == 0) {
[config.sdkInternalLimits setMaxBreadcrumbCount:kCountlyMaxBreadcrumbCount];
CLY_LOG_W(@"%s Ignoring provided value of %lu for 'maxBreadcrumbCount' because it's less than 1", __FUNCTION__, (unsigned long)config.sdkInternalLimits.getMaxBreadcrumbCount);
}
else if(config.sdkInternalLimits.getMaxBreadcrumbCount != kCountlyMaxBreadcrumbCount)
{
CLY_LOG_I(@"%s provided 'maxBreadcrumbCount' override:[ %lu ]", __FUNCTION__, (unsigned long)config.sdkInternalLimits.getMaxBreadcrumbCount);
}
if(config.sdkInternalLimits.getMaxStackTraceLineLength != kCountlyMaxStackTraceLinesPerThread)
{
CLY_LOG_W(@"%s 'maxStackTraceLineLength' is currently a placeholder and doesn't actively utilize the set values.", __FUNCTION__);
}
if(config.sdkInternalLimits.getMaxStackTraceLinesPerThread != kCountlyMaxStackTraceLineLength)
{
CLY_LOG_I(@"%s 'maxStackTraceLinesPerThread' is currently a placeholder and doesn't actively utilize the set values.", __FUNCTION__);
}
return config;
}
#pragma mark -
- (void)onTimer:(NSTimer *)timer
{
if (isSuspended)
return;
if (!CountlyCommon.sharedInstance.manualSessionHandling)
{
[CountlyConnectionManager.sharedInstance updateSession];
}
// this condtion is called only when both manual session handling and hybrid mode is enabled.
else if (CountlyCommon.sharedInstance.enableManualSessionControlHybridMode)
{
[CountlyConnectionManager.sharedInstance updateSession];
}
[CountlyConnectionManager.sharedInstance sendEventsWithSaveIfNeeded];
}
- (void)suspend
{
#if (TARGET_OS_WATCH)
CLY_LOG_I(@"%s", __FUNCTION__);
#endif
if (!CountlyCommon.sharedInstance.hasStarted)
return;
if (isSuspended)
return;
CLY_LOG_D(@"Suspending...");
isSuspended = YES;
[CountlyViewTrackingInternal.sharedInstance applicationDidEnterBackground];
[CountlyConnectionManager.sharedInstance sendEventsWithSaveIfNeeded];
if (!CountlyCommon.sharedInstance.manualSessionHandling)
[CountlyConnectionManager.sharedInstance endSession];
[CountlyPersistency.sharedInstance saveToFile];
}
- (void)resume
{
#if (TARGET_OS_WATCH)
CLY_LOG_I(@"%s", __FUNCTION__);
#endif
if (!CountlyCommon.sharedInstance.hasStarted)
return;
#if (TARGET_OS_WATCH)
//NOTE: Skip first time to prevent double begin session because of applicationDidBecomeActive call on launch of watchOS apps
static BOOL isFirstCall = YES;
if (isFirstCall)
{
isFirstCall = NO;
return;
}
#endif
if (!CountlyCommon.sharedInstance.manualSessionHandling)
[CountlyConnectionManager.sharedInstance beginSession];
[CountlyViewTrackingInternal.sharedInstance applicationWillEnterForeground];
isSuspended = NO;
}
- (void)applicationDidBecomeActive:(NSNotification *)notification
{
CLY_LOG_D(@"App enters foreground");
[self resume];
}
- (void)applicationWillResignActive:(NSNotification *)notification
{
CLY_LOG_D(@"App enters background");
}
- (void)applicationDidEnterBackground:(NSNotification *)notification
{
CLY_LOG_D(@"App did enter background.");
[self suspend];
}
- (void)applicationWillEnterForeground:(NSNotification *)notification
{
CLY_LOG_D(@"App will enter foreground.");
}
- (void)applicationWillTerminate:(NSNotification *)notification
{
CLY_LOG_D(@"App will terminate.");
CountlyConnectionManager.sharedInstance.isTerminating = YES;
[CountlyViewTrackingInternal.sharedInstance applicationWillTerminate];
[CountlyConnectionManager.sharedInstance sendEventsWithSaveIfNeeded];
[CountlyPerformanceMonitoring.sharedInstance endBackgroundTrace];
[CountlyPersistency.sharedInstance saveToFileSync];
}
- (void)dealloc
{
[NSNotificationCenter.defaultCenter removeObserver:self];
if (timer)
{
[timer invalidate];
timer = nil;
}
}
#pragma mark - Override Configuration
- (void)setNewHost:(NSString *)newHost
{
CLY_LOG_I(@"%s %@", __FUNCTION__, newHost);
if (!newHost.length)
{
CLY_LOG_W(@"New host is invalid!");
return;
}
CountlyConnectionManager.sharedInstance.host = newHost;
}
- (void)setNewURLSessionConfiguration:(NSURLSessionConfiguration *)newURLSessionConfiguration
{
CLY_LOG_I(@"%s %@", __FUNCTION__, newURLSessionConfiguration);
CountlyConnectionManager.sharedInstance.URLSessionConfiguration = newURLSessionConfiguration;
}
- (void)setNewAppKey:(NSString *)newAppKey
{
CLY_LOG_I(@"%s %@", __FUNCTION__, newAppKey);
if (!newAppKey.length)
{
CLY_LOG_W(@"New app key is invalid!");
return;
}
[self suspend];
[CountlyPerformanceMonitoring.sharedInstance clearAllCustomTraces];
CountlyConnectionManager.sharedInstance.appKey = newAppKey;
[self resume];
}
#pragma mark - Queue Operations
- (void)flushQueues
{
CLY_LOG_I(@"%s", __FUNCTION__);
[CountlyPersistency.sharedInstance flushEvents];
[CountlyPersistency.sharedInstance flushQueue];
}
- (void)replaceAllAppKeysInQueueWithCurrentAppKey
{
CLY_LOG_I(@"%s", __FUNCTION__);
[CountlyPersistency.sharedInstance replaceAllAppKeysInQueueWithCurrentAppKey];
}
- (void)removeDifferentAppKeysFromQueue
{
CLY_LOG_I(@"%s", __FUNCTION__);
[CountlyPersistency.sharedInstance removeDifferentAppKeysFromQueue];
}
- (void)addDirectRequest:(NSDictionary<NSString *, NSString *> * _Nullable)requestParameters
{
CLY_LOG_I(@"%s %@", __FUNCTION__, requestParameters);
[CountlyConnectionManager.sharedInstance addDirectRequest:requestParameters];
}
#pragma mark - Sessions
- (void)beginSession
{
CLY_LOG_I(@"%s", __FUNCTION__);
if (CountlyCommon.sharedInstance.manualSessionHandling)
[CountlyConnectionManager.sharedInstance beginSession];
}
- (void)updateSession
{
CLY_LOG_I(@"%s", __FUNCTION__);
if (CountlyCommon.sharedInstance.manualSessionHandling)
[CountlyConnectionManager.sharedInstance updateSession];
}
- (void)endSession
{
CLY_LOG_I(@"%s", __FUNCTION__);
if (CountlyCommon.sharedInstance.manualSessionHandling)
{
[CountlyConnectionManager.sharedInstance sendEventsWithSaveIfNeeded];
[CountlyConnectionManager.sharedInstance endSession];
}
}
#pragma mark - Device ID
- (NSString *)deviceID
{
CLY_LOG_I(@"%s", __FUNCTION__);
return CountlyDeviceInfo.sharedInstance.deviceID.cly_URLEscaped;
}
- (CLYDeviceIDType)deviceIDType
{
CLY_LOG_I(@"%s", __FUNCTION__);
if (CountlyDeviceInfo.sharedInstance.isDeviceIDTemporary)
return CLYDeviceIDTypeTemporary;
if ([CountlyPersistency.sharedInstance retrieveIsCustomDeviceID])
return CLYDeviceIDTypeCustom;
#if (TARGET_OS_IOS || TARGET_OS_VISION || TARGET_OS_TV )
return CLYDeviceIDTypeIDFV;
#else
return CLYDeviceIDTypeNSUUID;
#endif
}
- (void)setID:(NSString *)deviceID;
{
if (deviceID == nil || !deviceID.length)
{
CLY_LOG_W(@"Passing `nil` or empty string as devie ID is not allowed.");
return;
}
CLYDeviceIDType deviceIDType = [Countly.sharedInstance deviceIDType];
if([deviceIDType isEqualToString:CLYDeviceIDTypeCustom])
{
[Countly.sharedInstance setIDInternal:deviceID onServer: NO];
}
else
{
[Countly.sharedInstance setIDInternal:deviceID onServer: YES];
}
}
- (void)changeDeviceIDWithMerge:(NSString * _Nullable)deviceID {
[self setIDInternal:deviceID onServer:YES];
}
- (void)changeDeviceIDWithoutMerge:(NSString * _Nullable)deviceID {
[self setIDInternal:deviceID onServer:NO];
}
- (void)enableTemporaryDeviceIDMode
{
[Countly.sharedInstance setIDInternal:CLYTemporaryDeviceID onServer:NO];
}
- (void)setNewDeviceID:(NSString *)deviceID onServer:(BOOL)onServer
{
[Countly.sharedInstance setIDInternal:deviceID onServer:onServer];
}
- (void)setIDInternal:(NSString *)deviceID onServer:(BOOL)onServer
{
CLY_LOG_I(@"%s %@ %d", __FUNCTION__, deviceID, onServer);
if (!CountlyCommon.sharedInstance.hasStarted)
return;
if (!deviceID.length)
{
CLY_LOG_W(@"Passing `CLYDefaultDeviceID` or `nil` or empty string as devie ID is deprecated, and will not be allowed in the future.");
}
[self storeCustomDeviceIDState:deviceID];
deviceID = [CountlyDeviceInfo.sharedInstance ensafeDeviceID:deviceID];
if ([deviceID isEqualToString:CountlyDeviceInfo.sharedInstance.deviceID])
{
CLY_LOG_W(@"Attempted to set the same device ID again. So, setting new device ID is aborted.");
return;
}
if (CountlyDeviceInfo.sharedInstance.isDeviceIDTemporary)
{
CLY_LOG_I(@"Going out of CLYTemporaryDeviceID mode and switching back to normal mode.");
[CountlyDeviceInfo.sharedInstance initializeDeviceID:deviceID];
[CountlyPersistency.sharedInstance replaceAllTemporaryDeviceIDsInQueueWithDeviceID:deviceID];
[CountlyConnectionManager.sharedInstance proceedOnQueue];
[CountlyRemoteConfigInternal.sharedInstance downloadRemoteConfigAutomatically];
return;
}
if ([deviceID isEqualToString:CLYTemporaryDeviceID] && onServer)
{
CLY_LOG_W(@"Attempted to set device ID as CLYTemporaryDeviceID with onServer option. So, onServer value is overridden as NO.");
onServer = NO;
}
if (onServer)
{
NSString* oldDeviceID = CountlyDeviceInfo.sharedInstance.deviceID;
[CountlyDeviceInfo.sharedInstance initializeDeviceID:deviceID];
[CountlyConnectionManager.sharedInstance sendOldDeviceID:oldDeviceID];
}
else
{
[self suspend];
[CountlyDeviceInfo.sharedInstance initializeDeviceID:deviceID];
[CountlyConsentManager.sharedInstance cancelConsentForAllFeaturesWithoutSendingConsentsRequest];
[self resume];
[CountlyPersistency.sharedInstance clearAllTimedEvents];
}
[CountlyRemoteConfigInternal.sharedInstance clearCachedRemoteConfig];
if (![deviceID isEqualToString:CLYTemporaryDeviceID] )
{
[CountlyRemoteConfigInternal.sharedInstance downloadRemoteConfigAutomatically];
}
}
- (void)storeCustomDeviceIDState:(NSString *)deviceID
{
BOOL isCustomDeviceID = deviceID.length && ![deviceID isEqualToString:CLYTemporaryDeviceID];
[CountlyPersistency.sharedInstance storeIsCustomDeviceID:isCustomDeviceID];
}
#pragma mark - Consents
- (void)giveConsentForFeature:(NSString *)featureName
{
CLY_LOG_I(@"%s %@", __FUNCTION__, featureName);
if (!featureName.length)
return;
[CountlyConsentManager.sharedInstance giveConsentForFeatures:@[featureName]];
}
- (void)giveConsentForFeatures:(NSArray *)features
{
CLY_LOG_I(@"%s %@", __FUNCTION__, features);
[CountlyConsentManager.sharedInstance giveConsentForFeatures:features];
}
- (void)giveConsentForAllFeatures
{
CLY_LOG_I(@"%s", __FUNCTION__);
[CountlyConsentManager.sharedInstance giveAllConsents];
}
- (void)giveAllConsents
{
CLY_LOG_I(@"%s", __FUNCTION__);
[CountlyConsentManager.sharedInstance giveAllConsents];
}
- (void)cancelConsentForFeature:(NSString *)featureName
{
CLY_LOG_I(@"%s %@", __FUNCTION__, featureName);
if (!featureName.length)
return;
[CountlyConsentManager.sharedInstance cancelConsentForFeatures:@[featureName]];
}
- (void)cancelConsentForFeatures:(NSArray *)features
{
CLY_LOG_I(@"%s %@", __FUNCTION__, features);
[CountlyConsentManager.sharedInstance cancelConsentForFeatures:features];
}
- (void)cancelConsentForAllFeatures
{
CLY_LOG_I(@"%s", __FUNCTION__);
[CountlyConsentManager.sharedInstance cancelConsentForAllFeatures];
}
#pragma mark - Events
- (void)recordEvent:(NSString *)key
{
[self recordEvent:key segmentation:nil count:1 sum:0 duration:0];
}
- (void)recordEvent:(NSString *)key count:(NSUInteger)count
{
[self recordEvent:key segmentation:nil count:count sum:0 duration:0];
}
- (void)recordEvent:(NSString *)key sum:(double)sum
{
[self recordEvent:key segmentation:nil count:1 sum:sum duration:0];
}
- (void)recordEvent:(NSString *)key duration:(NSTimeInterval)duration
{
[self recordEvent:key segmentation:nil count:1 sum:0 duration:duration];
}
- (void)recordEvent:(NSString *)key count:(NSUInteger)count sum:(double)sum
{
[self recordEvent:key segmentation:nil count:count sum:sum duration:0];
}
- (void)recordEvent:(NSString *)key segmentation:(NSDictionary *)segmentation
{
[self recordEvent:key segmentation:segmentation count:1 sum:0 duration:0];
}
- (void)recordEvent:(NSString *)key segmentation:(NSDictionary *)segmentation count:(NSUInteger)count
{
[self recordEvent:key segmentation:segmentation count:count sum:0 duration:0];
}
- (void)recordEvent:(NSString *)key segmentation:(NSDictionary *)segmentation count:(NSUInteger)count sum:(double)sum
{
[self recordEvent:key segmentation:segmentation count:count sum:sum duration:0];
}
- (void)recordEvent:(NSString *)key segmentation:(NSDictionary *)segmentation count:(NSUInteger)count sum:(double)sum duration:(NSTimeInterval)duration
{
CLY_LOG_I(@"%s %@ %@ %lu %f %f", __FUNCTION__, key, segmentation, (unsigned long)count, sum, duration);
if (!CountlyConsentManager.sharedInstance.consentForEvents)
{
CLY_LOG_W(@"Consent for events not given! Event will not be recorded.");
return;
}
BOOL isReservedEvent = [self isReservedEvent:key];
if (isReservedEvent)
{
CLY_LOG_W(@"A reserved event detected for key: '%@', event will not be recorded.", key);
return;
}
NSDictionary* truncated = [segmentation cly_truncated:@"Event segmentation"];
segmentation = [truncated cly_limited:@"Event segmentation"];
[self recordEvent:key segmentation:segmentation count:count sum:sum duration:duration ID:nil timestamp:CountlyCommon.sharedInstance.uniqueTimestamp];
}
#pragma mark -
- (void)recordReservedEvent:(NSString *)key segmentation:(NSDictionary *)segmentation
{
[self recordEvent:key segmentation:segmentation count:1 sum:0 duration:0 ID:nil timestamp:CountlyCommon.sharedInstance.uniqueTimestamp];
}
- (void)recordReservedEvent:(NSString *)key segmentation:(NSDictionary *)segmentation ID:(NSString *)ID
{
[self recordEvent:key segmentation:segmentation count:1 sum:0 duration:0 ID:ID timestamp:CountlyCommon.sharedInstance.uniqueTimestamp];
}
- (void)recordReservedEvent:(NSString *)key segmentation:(NSDictionary *)segmentation count:(NSUInteger)count sum:(double)sum duration:(NSTimeInterval)duration ID:(NSString *)ID timestamp:(NSTimeInterval)timestamp
{
[self recordEvent:key segmentation:segmentation count:count sum:sum duration:duration ID:ID timestamp:timestamp];
}
#pragma mark -
- (void)recordEvent:(NSString *)key segmentation:(NSDictionary *)segmentation count:(NSUInteger)count sum:(double)sum duration:(NSTimeInterval)duration ID:(NSString *)ID timestamp:(NSTimeInterval)timestamp
{
if (key.length == 0)
return;
CountlyEvent *event = CountlyEvent.new;
event.ID = ID;
if (!event.ID.length)
{
event.ID = CountlyCommon.sharedInstance.randomEventID;
}
if ([key isEqualToString:kCountlyReservedEventView])
{
event.PVID = CountlyViewTrackingInternal.sharedInstance.previousViewID ?: @"";
}
else
{
event.CVID = CountlyViewTrackingInternal.sharedInstance.currentViewID ?: @"";
}
// Check if the event is a reserved event
BOOL isReservedEvent = [self isReservedEvent:key];
NSMutableDictionary *filteredSegmentations = segmentation.cly_filterSupportedDataTypes;
if(filteredSegmentations == nil)
filteredSegmentations = NSMutableDictionary.new;
// If the event is not reserved, assign the previous event ID and Name to the current event's PEID property, or an empty string if previousEventID is nil. Then, update previousEventID to the current event's ID.
if (!isReservedEvent)
{
key = [key cly_truncatedKey:@"Event key"];
event.PEID = previousEventID ?: @"";
previousEventID = event.ID;
if(CountlyViewTrackingInternal.sharedInstance.enablePreviousNameRecording) {
filteredSegmentations[kCountlyPreviousEventName] = previousEventName ?: @"";
previousEventName = key;
filteredSegmentations[kCountlyCurrentView] = CountlyViewTrackingInternal.sharedInstance.currentViewName ?: @"";
}
}
event.key = key;
event.segmentation = [self processSegmentation:filteredSegmentations eventKey:key];
event.count = MAX(count, 1);
event.sum = sum;
event.timestamp = timestamp;
event.hourOfDay = CountlyCommon.sharedInstance.hourOfDay;
event.dayOfWeek = CountlyCommon.sharedInstance.dayOfWeek;
event.duration = duration;
[CountlyPersistency.sharedInstance recordEvent:event];
}
- (NSDictionary *)processSegmentation:(NSMutableDictionary *)segmentation eventKey:(NSString *)eventKey {
BOOL isViewEvent = [eventKey isEqualToString:kCountlyReservedEventView];
// Add previous view name if enabled and the event is a view event
if (isViewEvent && CountlyViewTrackingInternal.sharedInstance.enablePreviousNameRecording) {
segmentation[kCountlyPreviousView] = CountlyViewTrackingInternal.sharedInstance.previousViewName ?: @"";
}
// Add visibility tracking information if enabled
if (CountlyCommon.sharedInstance.enableVisibiltyTracking) {
BOOL isViewStart = [segmentation[kCountlyVTKeyVisit] isEqual:@1];
// Add visibility if it's not a view event or it's a view start event
if (!isViewEvent || isViewStart) {
segmentation[kCountlyVisibility] = @([self isAppInForeground] ? 1 : 0);
}
}
// Return segmentation dictionary if not empty, otherwise return nil
return segmentation.count > 0 ? segmentation : nil;
}
- (BOOL)isAppInForeground {
#if TARGET_OS_IOS || TARGET_OS_TV
UIApplicationState state = [UIApplication sharedApplication].applicationState;
return state == UIApplicationStateActive;
#elif TARGET_OS_OSX
NSApplication *app = [NSApplication sharedApplication];
return app.isActive;
#elif TARGET_OS_WATCH
WKExtension *extension = [WKExtension sharedExtension];
return extension.applicationState == WKApplicationStateActive;
#else
return NO;
#endif
}
- (BOOL)isReservedEvent:(NSString *)key
{
NSArray<NSString *>* reservedEvents =
@[
kCountlyReservedEventOrientation,
kCountlyReservedEventStarRating,
kCountlyReservedEventSurvey,
kCountlyReservedEventNPS,
kCountlyReservedEventPushAction,
kCountlyReservedEventView,
];
return [reservedEvents containsObject:key];
}
#pragma mark -
- (void)startEvent:(NSString *)key
{
CLY_LOG_I(@"%s %@", __FUNCTION__, key);
if (!CountlyConsentManager.sharedInstance.consentForEvents)
return;
CountlyEvent *event = CountlyEvent.new;