Merge pull request #162 from erkanyildiz/master

For 20.04.1

Author: erkanyildiz

CHANGELOG.md

@@ -1,3 +1,27 @@
+## 20.04.1
+- Added Application Performance Monitoring (Phase 1)
+    - Manual network traces
+    - Manual custom traces
+    - Semi-automatic app start time trace
+    - Automatic app foreground time trace
+    - Automatic app background time trace
+    - Consent handling for Application Performance Monitoring
+- Added `COUNTLY_EXCLUDE_PUSHNOTIFICATIONS` flag to disable push notifications altogether in order to avoid App Store Connect warnings (thanks @grundleborg)
+- Fixed an incorrect internal logging on SDK start
+- Fixed location consent order to avoid some legacy Countly Server issue with location info being unavailable even after giving consent
+- Improved `UIApplicationWillTerminateNotification` behaviour
+- Prevented recording empty string as `city`, `ISOCountryCode` and `IP` for location info
+- Applied `alwaysUsePOST` flag to feedback widget check requests
+- Applied `alwaysUsePOST` flag to remote config requests
+
+- Other various improvements
+    - Deleted some unnecessary imports
+    - Updated HeaderDocs, internal logs, inline notes and pragma marks 
+    - Added missing frameworks to CocoaPods podspec
+    - Added ability to override SDK name and version for bridge SDKs
+
+
+
 ## 20.04
 - Added crash reporting feature for tvOS
 - Added crash reporting feature for macOS

Countly.h

@@ -60,7 +60,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /**
  * Flushes request and event queues.
- * @discussion Flushes persistenly stored request queue and events recorded but not converted to a request so far.
+ * @discussion Flushes persistently stored request queue and events recorded but not converted to a request so far.
  * @discussion Started timed events will not be affected.
  */
 - (void)flushQueues;
@@ -202,7 +202,7 @@ NS_ASSUME_NONNULL_BEGIN
  * Records event with given key and segmentation.
  * @discussion Segmentation should be an @c NSDictionary, with keys and values are both @c NSString's only.
  * @discussion Custom objects in segmentation will cause events not to be sent to Countly Server.
- * @discussion Nested values in segmentation will be ignored by Counly Server event segmentation section.
+ * @discussion Nested values in segmentation will be ignored by Countly Server event segmentation section.
  * @param key Event key, a non-zero length valid string
  * @param segmentation Segmentation key-value pairs of event
  */
@@ -212,7 +212,7 @@ NS_ASSUME_NONNULL_BEGIN
  * Records event with given key, segmentation and count.
  * @discussion Segmentation should be an @c NSDictionary, with keys and values are both @c NSString's only.
  * @discussion Custom objects in segmentation will cause events not to be sent to Countly Server.
- * @discussion Nested values in segmentation will be ignored by Counly Server event segmentation section.
+ * @discussion Nested values in segmentation will be ignored by Countly Server event segmentation section.
  * @param key Event key, a non-zero length valid string
  * @param segmentation Segmentation key-value pairs of event
  * @param count Count of event occurrences
@@ -223,7 +223,7 @@ NS_ASSUME_NONNULL_BEGIN
  * Records event with given key, segmentation, count and sum.
  * @discussion Segmentation should be an @c NSDictionary, with keys and values are both @c NSString's only.
  * @discussion Custom objects in segmentation will cause events not to be sent to Countly Server.
- * @discussion Nested values in segmentation will be ignored by Counly Server event segmentation section.
+ * @discussion Nested values in segmentation will be ignored by Countly Server event segmentation section.
  * @param key Event key, a non-zero length valid string
  * @param segmentation Segmentation key-value pairs of event
  * @param count Count of event occurrences
@@ -235,7 +235,7 @@ NS_ASSUME_NONNULL_BEGIN
  * Records event with given key, segmentation, count, sum and duration.
  * @discussion Segmentation should be an @c NSDictionary, with keys and values are both @c NSString's only.
  * @discussion Custom objects in segmentation will cause events not to be sent to Countly Server.
- * @discussion Nested values in segmentation will be ignored by Counly Server event segmentation section.
+ * @discussion Nested values in segmentation will be ignored by Countly Server event segmentation section.
  * @param key Event key, a non-zero length valid string
  * @param segmentation Segmentation key-value pairs of event
  * @param count Count of event occurrences
@@ -263,7 +263,7 @@ NS_ASSUME_NONNULL_BEGIN
  * @discussion Trying to end an event with already ended (or not yet started) key will have no effect.
  * @discussion Segmentation should be an @c NSDictionary, with keys and values are both @c NSString's only.
  * @discussion Custom objects in segmentation will cause events not to be sent to Countly Server.
- * @discussion Nested values in segmentation will be ignored by Counly Server event segmentation section.
+ * @discussion Nested values in segmentation will be ignored by Countly Server event segmentation section.
  * @param key Event key, a non-zero length valid string
  * @param segmentation Segmentation key-value pairs of event
  * @param count Count of event occurrences
@@ -282,6 +282,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 #pragma mark - Push Notification
 #if (TARGET_OS_IOS || TARGET_OS_OSX)
+#ifndef COUNTLY_EXCLUDE_PUSHNOTIFICATIONS
 /**
  * Shows default system dialog that asks for user's permission to display notifications.
  * @discussion A unified convenience method that handles asking for notification permission on both iOS10 and older iOS versions with badge, sound and alert notification types.
@@ -321,6 +322,7 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (void)clearPushNotificationToken;
 #endif
+#endif
 
 
 
@@ -355,7 +357,7 @@ NS_ASSUME_NONNULL_BEGIN
 - (void)recordIP:(NSString *)IP;
 
 /**
- * Disables geo-location based push notifications by clearing all exsisting location info.
+ * Disables geo-location based push notifications by clearing all existing location info.
  * @discussion Once disabled, geo-location based push notifications can be enabled again by calling @c recordLocation: or @c recordCity:andISOCountryCode: or @c recordIP: method.
  */
 - (void)disableLocationInfo;
@@ -400,7 +402,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /**
  * @c crashLog: method is deprecated. Please use @c recordCrashLog: method instead.
- * @discussion Be advised, parameter type chenged to plain @c NSString from string format, for better Swift compatibility.
+ * @discussion Be advised, parameter type changed to plain @c NSString from string format, for better Swift compatibility.
  * @discussion Calling this method will have no effect.
  */
 - (void)crashLog:(NSString *)format, ... NS_FORMAT_FUNCTION(1,2) DEPRECATED_MSG_ATTRIBUTE("Use 'recordCrashLog:' method instead!");
@@ -419,12 +421,12 @@ NS_ASSUME_NONNULL_BEGIN
 
 /**
  * Records a visited view with given name and custom segmentation.
- * @discussion This is an extendened version of @c recordView: method.
+ * @discussion This is an extended version of @c recordView: method.
  * @discussion If segmentation has any of Countly reserved keys, they will be ignored:
  * @discussion @c name, @c segment, @c visit, @c start, @c bounce, @c exit, @c view, @c domain, @c dur
  * @discussion Segmentation should be an @c NSDictionary, with keys and values are both @c NSString's only.
  * @discussion Custom objects in segmentation will cause events not to be sent to Countly Server.
- * @discussion Nested values in segmentation will be ignored by Counly Server event segmentation section.
+ * @discussion Nested values in segmentation will be ignored by Countly Server event segmentation section.
  * @param viewName Name of the view visited, a non-zero length valid string
  * @param segmentation Custom segmentation key-value pairs
  */
@@ -558,6 +560,64 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (void)updateRemoteConfigExceptForKeys:(NSArray *)omitKeys completionHandler:(void (^)(NSError * error))completionHandler;
 
+
+
+#pragma mark - Performance Monitoring
+
+/**
+ * Manually records a network trace for performance monitoring.
+ * @discussion A network trace is a collection of measured information about a network request.
+ * @discussion When a network request is completed, a network trace can be recorded manually to be analyzed in Performance Monitoring feature.
+ * @discussion Trace name needs to be a non-zero length string, otherwise it is ignored.
+ * @param traceName Trace name, a non-zero length valid string
+ * @param requestPayloadSize Size of the request's payload in bytes
+ * @param responsePayloadSize Size of the received response's payload in bytes
+ * @param responseStatusCode HTTP status code of the received response
+ * @param startTime UNIX time stamp in milliseconds for the starting time of the request
+ * @param endTime UNIX time stamp in milliseconds for the ending time of the request
+ */
+- (void)recordNetworkTrace:(NSString *)traceName requestPayloadSize:(NSInteger)requestPayloadSize responsePayloadSize:(NSInteger)responsePayloadSize responseStatusCode:(NSInteger)responseStatusCode startTime:(long long)startTime endTime:(long long)endTime;
+
+/**
+ * Starts a performance monitoring custom trace with given name to be ended later.
+ * @discussion Duration of custom trace will be calculated on ending.
+ * @discussion Trying to start a custom trace with already started name will have no effect.
+ * @param traceName Trace name, a non-zero length valid string
+ */
+- (void)startCustomTrace:(NSString *)traceName;
+
+/**
+ * Ends a previously started performance monitoring custom trace with given name and metrics.
+ * @discussion Trying to end a custom trace with already ended (or not yet started) name will have no effect.
+ * @param traceName Trace name, a non-zero length valid string
+ * @param metrics Metrics key-value pairs
+ */
+- (void)endCustomTrace:(NSString *)traceName metrics:(NSDictionary * _Nullable)metrics;
+
+/**
+ * Cancels a previously started performance monitoring custom trace with given name.
+ * @discussion Trying to cancel a custom trace with already cancelled (or ended or not yet started) name will have no effect.
+ * @param traceName Trace name, a non-zero length valid string
+ */
+- (void)cancelCustomTrace:(NSString *)traceName;
+
+/**
+ * Clears all previously started performance monitoring custom traces.
+ * @discussion All previously started performance monitoring custom traces are automatically cleaned when:
+ * @discussion - Consent for @c CLYConsentPerformanceMonitoring is cancelled
+ * @discussion - A new app key is set using @c setNewAppKey: method
+ */
+- (void)clearAllCustomTraces;
+
+/**
+ * Calculates and records app launch time for performance monitoring.
+ * @discussion This method should be called when the app is loaded and displayed its first user facing view successfully.
+ * @discussion e.g. @c viewDidAppear: method of the root view controller or whatever place is suitable for the app's flow.
+ * @discussion Time passed since the app started to launch will be automatically calculated and recorded for performance monitoring.
+ * @discussion App launch time can be recorded only once per app launch. So, second and following calls to this method will be ignored.
+ */
+- (void)appLoadingFinished;
+
 NS_ASSUME_NONNULL_END
 
 @end

Countly.m

@@ -15,8 +15,17 @@ @interface Countly ()
 }
 @end
 
+long long appLoadStartTime;
+
 @implementation Countly
 
++ (void)load
+{
+    [super load];
+
+    appLoadStartTime = floor(NSDate.date.timeIntervalSince1970 * 1000);
+}
+
 + (instancetype)sharedInstance
 {
     static Countly *s_sharedCountly = nil;
@@ -57,7 +66,7 @@ - (instancetype)init
 
 - (void)startWithConfig:(CountlyConfig *)config
 {
-    if (CountlyCommon.sharedInstance.hasStarted)
+    if (CountlyCommon.sharedInstance.hasStarted_)
         return;
 
     CountlyCommon.sharedInstance.hasStarted = YES;
@@ -70,7 +79,7 @@ - (void)startWithConfig:(CountlyConfig *)config
     if (!config.host.length || [config.host isEqualToString:@"https://YOUR_COUNTLY_SERVER"])
         [NSException raise:@"CountlyHostNotSetException" format:@"host property on CountlyConfig object is not set"];
 
-    COUNTLY_LOG(@"Initializing with %@ SDK v%@", kCountlySDKName, kCountlySDKVersion);
+    COUNTLY_LOG(@"Initializing with %@ SDK v%@", CountlyCommon.sharedInstance.SDKName, CountlyCommon.sharedInstance.SDKVersion);
 
     if (!CountlyDeviceInfo.sharedInstance.deviceID || config.resetStoredDeviceID)
         [CountlyDeviceInfo.sharedInstance initializeDeviceID:config.deviceID];
@@ -110,6 +119,7 @@ - (void)startWithConfig:(CountlyConfig *)config
 #endif
 
 #if (TARGET_OS_IOS || TARGET_OS_OSX)
+#ifndef COUNTLY_EXCLUDE_PUSHNOTIFICATIONS
     if ([config.features containsObject:CLYPushNotifications])
     {
         CountlyPushNotifications.sharedInstance.isEnabledOnInitialConfig = YES;
@@ -119,6 +129,7 @@ - (void)startWithConfig:(CountlyConfig *)config
         CountlyPushNotifications.sharedInstance.launchNotification = config.launchNotification;
         [CountlyPushNotifications.sharedInstance startPushNotifications];
     }
+#endif
 #endif
 
     CountlyCrashReporter.sharedInstance.crashSegmentation = config.crashSegmentation;
@@ -152,6 +163,9 @@ - (void)startWithConfig:(CountlyConfig *)config
     CountlyRemoteConfig.sharedInstance.isEnabledOnInitialConfig = config.enableRemoteConfig;
     CountlyRemoteConfig.sharedInstance.remoteConfigCompletionHandler = config.remoteConfigCompletionHandler;
     [CountlyRemoteConfig.sharedInstance startRemoteConfig];
+    
+    CountlyPerformanceMonitoring.sharedInstance.isEnabledOnInitialConfig = config.enablePerformanceMonitoring;
+    [CountlyPerformanceMonitoring.sharedInstance startPerformanceMonitoring];
 
     [CountlyCommon.sharedInstance observeDeviceOrientationChanges];
 
@@ -225,6 +239,8 @@ - (void)setNewAppKey:(NSString *)newAppKey
 
     [self suspend];
 
+    [CountlyPerformanceMonitoring.sharedInstance clearAllCustomTraces];
+
     CountlyConnectionManager.sharedInstance.appKey = newAppKey;
 
     [self resume];
@@ -339,9 +355,15 @@ - (void)willTerminateCallBack:(NSNotification *)notification
 {
     COUNTLY_LOG(@"App will terminate.");
 
+    CountlyConnectionManager.sharedInstance.isTerminating = YES;
+
     [CountlyViewTracking.sharedInstance endView];
 
-    [self suspend];
+    [CountlyConnectionManager.sharedInstance sendEvents];
+
+    [CountlyPerformanceMonitoring.sharedInstance endBackgroundTrace];
+
+    [CountlyPersistency.sharedInstance saveToFileSync];
 }
 
 - (void)dealloc
@@ -543,6 +565,7 @@ - (void)cancelEvent:(NSString *)key
 
 #pragma mark - Push Notifications
 #if (TARGET_OS_IOS || TARGET_OS_OSX)
+#ifndef COUNTLY_EXCLUDE_PUSHNOTIFICATIONS
 
 - (void)askForNotificationPermission
 {
@@ -569,6 +592,7 @@ - (void)clearPushNotificationToken
     [CountlyPushNotifications.sharedInstance clearToken];
 }
 #endif
+#endif
 
 
 
@@ -581,11 +605,17 @@ - (void)recordLocation:(CLLocationCoordinate2D)location
 
 - (void)recordCity:(NSString *)city andISOCountryCode:(NSString *)ISOCountryCode
 {
+    if (!city.length && !ISOCountryCode.length)
+        return;
+
     [CountlyLocationManager.sharedInstance recordLocationInfo:kCLLocationCoordinate2DInvalid city:city ISOCountryCode:ISOCountryCode andIP:nil];
 }
 
 - (void)recordIP:(NSString *)IP
 {
+    if (!IP.length)
+        return;
+
     [CountlyLocationManager.sharedInstance recordLocationInfo:kCLLocationCoordinate2DInvalid city:nil ISOCountryCode:nil andIP:IP];
 }
 
@@ -720,4 +750,39 @@ - (void)updateRemoteConfigExceptForKeys:(NSArray *)omitKeys completionHandler:(v
 }
 
 
+
+#pragma mark - Performance Monitoring
+
+- (void)recordNetworkTrace:(NSString *)traceName requestPayloadSize:(NSInteger)requestPayloadSize responsePayloadSize:(NSInteger)responsePayloadSize responseStatusCode:(NSInteger)responseStatusCode startTime:(long long)startTime endTime:(long long)endTime
+{
+    [CountlyPerformanceMonitoring.sharedInstance recordNetworkTrace:traceName requestPayloadSize:requestPayloadSize responsePayloadSize:responsePayloadSize responseStatusCode:responseStatusCode startTime:startTime endTime:endTime];
+}
+
+- (void)startCustomTrace:(NSString *)traceName
+{
+    [CountlyPerformanceMonitoring.sharedInstance startCustomTrace:traceName];
+}
+
+- (void)endCustomTrace:(NSString *)traceName metrics:(NSDictionary * _Nullable)metrics
+{
+    [CountlyPerformanceMonitoring.sharedInstance endCustomTrace:traceName metrics:metrics];
+}
+
+- (void)cancelCustomTrace:(NSString *)traceName
+{
+    [CountlyPerformanceMonitoring.sharedInstance cancelCustomTrace:traceName];
+}
+
+- (void)clearAllCustomTraces
+{
+    [CountlyPerformanceMonitoring.sharedInstance clearAllCustomTraces];
+}
+
+- (void)appLoadingFinished
+{
+    long long appLoadEndTime = floor(NSDate.date.timeIntervalSince1970 * 1000);
+
+    [CountlyPerformanceMonitoring.sharedInstance recordAppStartDurationTraceWithStartTime:appLoadStartTime endTime:appLoadEndTime];
+}
+
 @end

Countly.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name = 'Countly'
-  s.version = '20.04'
+  s.version = '20.04.1'
   s.license = { :type => 'MIT', :file => 'LICENSE.md' }
   s.summary  = 'Countly is an innovative, real-time, open source mobile analytics platform.'
   s.homepage = 'https://github.com/Countly/countly-sdk-ios'
@@ -19,6 +19,7 @@ Pod::Spec.new do |s|
     core.source_files = '*.{h,m}'
     core.public_header_files = 'Countly.h', 'CountlyUserDetails.h', 'CountlyConfig.h'
     core.preserve_path = 'countly_dsym_uploader.sh'
+    core.ios.frameworks = ['Foundation', 'UIKit', 'UserNotifications', 'CoreLocation', 'WebKit', 'CoreTelephony', 'AdSupport', 'WatchConnectivity']
   end
 
   s.subspec 'NotificationService' do |ns|