Merge pull request #130 from erkanyildiz/master

For 18.08

Author: erkanyildiz

CHANGELOG.md

@@ -1,3 +1,26 @@
+## 18.08
+- Added feedback widgets support
+- Added limit for number of custom crash logs (100 logs)
+- Added limit for each custom crash log length (1000 chars)
+- Added support for cancelling timed events
+- Added support for recording fatal exceptions manually
+- Added `userInfo` to crash report custom property
+- Added delay before sending change device ID request (server requirement)
+- Renamed `isAutoViewTrackingEnabled` as `isAutoViewTrackingActive`
+- Fixed Xcode warnings for `askForNotificationPermission` method 
+- Fixed `UIAlertController` leak in push notification manager
+- Fixed `crashSegmentation` availability for manually recorded crashes
+- Fixed `openURL:` call thread as main thread
+- Updated minimum supported `macOS` version as `10.10`
+
+- Other various improvements
+  - Discarded separate `UIWindow` for presenting `UIAlertControllers`
+  - Refactored `buildUUID` and `executableName` as properties
+  - Refactored custom crash log array and date formatter
+  - Updated HeaderDocs, inline notes, pragma marks 
+
+
+
 ## 18.04
 - Added consent management for GDPR compliance
 - Exposed device ID to be used for data export and/or removal requests

Countly.h

@@ -236,6 +236,13 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (void)endEvent:(NSString *)key segmentation:(NSDictionary * _Nullable)segmentation count:(NSUInteger)count sum:(double)sum;
 
+/**
+ * Cancels a previously started timed event with given key.
+ * @discussion Trying to cancel an event with already cancelled (or ended or not yet started) key will have no effect.
+ * @param key Event key
+ */
+- (void)cancelEvent:(NSString *)key;
+
 
 
 #pragma mark - Push Notification
@@ -308,6 +315,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /**
  * @c isGeoLocationEnabled property is deprecated. Please use @c disableLocationInfo method instead.
+ * @discussion Using this property will have no effect.
  */
 @property (nonatomic) BOOL isGeoLocationEnabled DEPRECATED_MSG_ATTRIBUTE("Use 'disableLocationInfo' method instead!");
 
@@ -328,6 +336,14 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (void)recordHandledException:(NSException *)exception withStackTrace:(NSArray * _Nullable)stackTrace;
 
+/**
+ * Records an unhandled exception and given stack trace manually.
+ * @discussion For recording non-native level fatal exceptions, where the app keeps running at native level and can recover.
+ * @param exception Exception to be reported
+ * @param stackTrace Stack trace to be reported
+ */
+- (void)recordUnhandledException:(NSException *)exception withStackTrace:(NSArray * _Nullable)stackTrace;
+
 /**
  * Records custom logs to be delivered with crash report.
  * @discussion Logs recorded by this method are stored in a non-persistent structure, and delivered to Countly Server only in case of a crash.
@@ -370,7 +386,7 @@ NS_ASSUME_NONNULL_BEGIN
 /**
  * Records a visited view with given name.
  * @discussion Total duration of the view will be calculated on next @c recordView: call.
- * @discussion If AutoViewTracking feature is activated on initial configuration, this method does not need to be called manually.
+ * @discussion If AutoViewTracking feature is enabled on initial configuration, this method does not need to be called manually.
  * @param viewName Name of the view visited
  */
 - (void)recordView:(NSString *)viewName;
@@ -398,10 +414,17 @@ NS_ASSUME_NONNULL_BEGIN
 - (void)removeExceptionForAutoViewTracking:(NSString *)exception;
 
 /**
- * Enables or disables AutoViewTracking, if AutoViewTracking feature is activated on initial configuration.
- * @discussion If AutoViewTracking feature is not activated on initial configuration, this property has no effect on enabling or disabling it later.
+ * Temporarily activates or deactivates AutoViewTracking, if AutoViewTracking feature is enabled on initial configuration.
+ * @discussion If AutoViewTracking feature is not enabled on initial configuration, this property has no effect.
  */
-@property (nonatomic) BOOL isAutoViewTrackingEnabled;
+@property (nonatomic) BOOL isAutoViewTrackingActive;
+
+/**
+ * @c isAutoViewTrackingEnabled property is deprecated. Please use @c isAutoViewTrackingActive property instead.
+ * @discussion Using this property will have no effect.
+ */
+@property (nonatomic) BOOL isAutoViewTrackingEnabled DEPRECATED_MSG_ATTRIBUTE("Use 'isAutoViewTrackingActive' property instead!");
+
 #endif
 
 
@@ -440,6 +463,18 @@ NS_ASSUME_NONNULL_BEGIN
  * @param completion A block object to be executed when user gives a star-rating or dismisses dialog without rating
  */
 - (void)askForStarRating:(void(^)(NSInteger rating))completion;
+
+/**
+ * Presents feedback widget with given ID in a WKWebView placed in a UIViewController.
+ * @discussion First, the availability of the feedback widget will be checked asynchronously.
+ * @discussion If the feedback widget with given ID is available, it will be modally presented.
+ * @discussion Otherwise, @c completionHandler will be called with an @c NSError.
+ * @discussion @c completionHandler will also be called with @c nil when feedback widget is dismissed by user.
+ * @param widgetID ID of the feedback widget created on Countly Server.
+ * @param completionHandler A completion handler block to be executed when feedback widget is dismissed by user or there is an error.
+ */
+- (void)presentFeedbackWidgetWithID:(NSString *)widgetID completionHandler:(void (^)(NSError * error))completionHandler;
+
 #endif
 
 NS_ASSUME_NONNULL_END

Countly.m

@@ -117,10 +117,11 @@ - (void)startWithConfig:(CountlyConfig *)config
         [CountlyPushNotifications.sharedInstance startPushNotifications];
     }
 
+    CountlyCrashReporter.sharedInstance.crashSegmentation = config.crashSegmentation;
+    CountlyCrashReporter.sharedInstance.crashLogLimit = MAX(1, config.crashLogLimit);
     if ([config.features containsObject:CLYCrashReporting])
     {
         CountlyCrashReporter.sharedInstance.isEnabledOnInitialConfig = YES;
-        CountlyCrashReporter.sharedInstance.crashSegmentation = config.crashSegmentation;
         [CountlyCrashReporter.sharedInstance startCrashReporting];
     }
 #endif
@@ -471,7 +472,7 @@ - (void)endEvent:(NSString *)key segmentation:(NSDictionary *)segmentation count
 
     if (!event)
     {
-        COUNTLY_LOG(@"Event with key '%@' not started before!", key);
+        COUNTLY_LOG(@"Event with key '%@' not started yet or cancelled/ended before!", key);
         return;
     }
 
@@ -483,20 +484,29 @@ - (void)endEvent:(NSString *)key segmentation:(NSDictionary *)segmentation count
     [CountlyPersistency.sharedInstance recordEvent:event];
 }
 
+- (void)cancelEvent:(NSString *)key
+{
+    if (!CountlyConsentManager.sharedInstance.consentForEvents)
+        return;
+
+    CountlyEvent *event = [CountlyPersistency.sharedInstance timedEventForKey:key];
+
+    if (!event)
+    {
+        COUNTLY_LOG(@"Event with key '%@' not started yet or cancelled/ended before!", key);
+        return;
+    }
+
+    COUNTLY_LOG(@"Event with key '%@' cancelled!", key);
+}
 
 
 #pragma mark - Push Notifications
 #if TARGET_OS_IOS
 
 - (void)askForNotificationPermission
 {
-    NSUInteger options = 0;
-    if (@available(iOS 10.0, *))
-        options = UNAuthorizationOptionBadge | UNAuthorizationOptionSound | UNAuthorizationOptionAlert;
-    else
-        options = UIUserNotificationTypeBadge | UIUserNotificationTypeSound | UIUserNotificationTypeAlert;
-
-    [CountlyPushNotifications.sharedInstance askForNotificationPermissionWithOptions:options completionHandler:nil];
+    [CountlyPushNotifications.sharedInstance askForNotificationPermissionWithOptions:0 completionHandler:nil];
 }
 
 - (void)askForNotificationPermissionWithOptions:(UNAuthorizationOptions)options completionHandler:(void (^)(BOOL granted, NSError * error))completionHandler;
@@ -541,12 +551,17 @@ - (void)disableLocationInfo
 #if TARGET_OS_IOS
 - (void)recordHandledException:(NSException *)exception
 {
-    [CountlyCrashReporter.sharedInstance recordHandledException:exception withStackTrace:nil];
+    [CountlyCrashReporter.sharedInstance recordException:exception withStackTrace:nil isFatal:NO];
 }
 
 - (void)recordHandledException:(NSException *)exception withStackTrace:(NSArray *)stackTrace
 {
-    [CountlyCrashReporter.sharedInstance recordHandledException:exception withStackTrace:stackTrace];
+    [CountlyCrashReporter.sharedInstance recordException:exception withStackTrace:stackTrace isFatal:NO];
+}
+
+- (void)recordUnhandledException:(NSException *)exception withStackTrace:(NSArray * _Nullable)stackTrace
+{
+    [CountlyCrashReporter.sharedInstance recordException:exception withStackTrace:stackTrace isFatal:YES];
 }
 
 - (void)recordCrashLog:(NSString *)log
@@ -600,14 +615,14 @@ - (void)removeExceptionForAutoViewTracking:(NSString *)exception
     [CountlyViewTracking.sharedInstance removeExceptionForAutoViewTracking:exception.copy];
 }
 
-- (void)setIsAutoViewTrackingEnabled:(BOOL)isAutoViewTrackingEnabled
+- (void)setIsAutoViewTrackingActive:(BOOL)isAutoViewTrackingActive
 {
-    CountlyViewTracking.sharedInstance.isAutoViewTrackingEnabled = isAutoViewTrackingEnabled;
+    CountlyViewTracking.sharedInstance.isAutoViewTrackingActive = isAutoViewTrackingActive;
 }
 
-- (BOOL)isAutoViewTrackingEnabled
+- (BOOL)isAutoViewTrackingActive
 {
-    return CountlyViewTracking.sharedInstance.isAutoViewTrackingEnabled;
+    return CountlyViewTracking.sharedInstance.isAutoViewTrackingActive;
 }
 #endif
 
@@ -639,6 +654,12 @@ - (void)askForStarRating:(void(^)(NSInteger rating))completion
 {
     [CountlyStarRating.sharedInstance showDialog:completion];
 }
+
+- (void)presentFeedbackWidgetWithID:(NSString *)widgetID completionHandler:(void (^)(NSError * error))completionHandler
+{
+    [CountlyStarRating.sharedInstance checkFeedbackWidgetWithID:widgetID completionHandler:completionHandler];
+}
+
 #endif
 
 @end

Countly.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name = 'Countly'
-  s.version = '18.04'
+  s.version = '18.08'
   s.license = {
     :type => 'COMMUNITY',
     :text => <<-LICENSE
@@ -37,7 +37,7 @@ Pod::Spec.new do |s|
   s.public_header_files = 'Countly.h', 'CountlyUserDetails.h', 'CountlyConfig.h'
   s.requires_arc = true
   s.ios.deployment_target = '8.0'
-  s.osx.deployment_target = '10.9'
+  s.osx.deployment_target = '10.10'
   s.watchos.deployment_target = '2.0'
   s.tvos.deployment_target = '9.0'
 

CountlyCommon.h

@@ -58,6 +58,14 @@
 extern NSString* const kCountlySDKVersion;
 extern NSString* const kCountlySDKName;
 
+extern NSString* const kCountlyErrorDomain;
+
+NS_ERROR_ENUM(kCountlyErrorDomain)
+{
+    CLYErrorFeedbackWidgetNotAvailable = 10001,
+    CLYErrorFeedbackWidgetNotTargetedForDevice = 10002,
+};
+
 @interface CountlyCommon : NSObject
 
 @property (nonatomic) BOOL hasStarted;

CountlyCommon.m

@@ -18,12 +18,14 @@ @interface CountlyCommon ()
 #endif
 @end
 
-NSString* const kCountlySDKVersion = @"18.04";
+NSString* const kCountlySDKVersion = @"18.08";
 NSString* const kCountlySDKName = @"objc-native-ios";
 
 NSString* const kCountlyParentDeviceIDTransferKey = @"kCountlyParentDeviceIDTransferKey";
 NSString* const kCountlyAttributionIDFAKey = @"idfa";
 
+NSString* const kCountlyErrorDomain = @"ly.count.ErrorDomain";
+
 @implementation CountlyCommon
 
 + (instancetype)sharedInstance
@@ -229,25 +231,6 @@ - (UIViewController *)topViewController
 #if TARGET_OS_IOS
 @implementation CLYInternalViewController : UIViewController
 
-//NOTE: Use the same status bar preferences as the currently displayed view controller, when a Countly triggered alert is displayed in a separate window
-- (UIStatusBarStyle)preferredStatusBarStyle
-{
-    UIViewController* topVC = [CountlyCommon.sharedInstance topViewController];
-    if (topVC == self)
-        return UIStatusBarStyleDefault;
-
-    return [topVC preferredStatusBarStyle];
-}
-
-- (BOOL)prefersStatusBarHidden
-{
-    UIViewController* topVC = [CountlyCommon.sharedInstance topViewController];
-    if (topVC == self)
-        return NO;
-
-    return [topVC prefersStatusBarHidden];
-}
-
 @end
 
 

CountlyConfig.h

@@ -174,9 +174,9 @@ extern NSString* const CLYConsentAppleWatch;
 @property (nonatomic) NSUInteger eventSendThreshold;
 
 /**
- * Stored requests limit is used for limiting the number of request to be stored on the device, in case of a Countly Server connection problem.
+ * Stored requests limit is used for limiting the number of request to be stored on the device, in case Countly Server is not reachable.
  * @discussion In case Countly Server is down or unreachable for a very long time, queued request may reach excessive numbers, and this may cause problems with requests being sent to Countly Server and being stored on the device. To prevent this, SDK will only store requests up to @c storedRequestsLimit.
- * @discussion If number of stored requests reach @c storedRequestsLimit, SDK will start to drop oldest request while inserting the newest one instead.
+ * @discussion If number of stored requests reaches @c storedRequestsLimit, SDK will start to drop oldest request while appending the newest one.
  * @discussion If not set, it will be 1000 by default.
  */
 @property (nonatomic) NSUInteger storedRequestsLimit;
@@ -214,6 +214,13 @@ extern NSString* const CLYConsentAppleWatch;
  */
 @property (nonatomic, copy) NSDictionary* crashSegmentation;
 
+/**
+ * Crash log limit is used for limiting the number of crash logs to be stored on the device.
+ * @discussion If number of stored crash logs reaches @c crashLogLimit, SDK will start to drop oldest crash log while appending the newest one.
+ * @discussion If not set, it will be 100 by default.
+ */
+@property (nonatomic) NSUInteger crashLogLimit;
+
 #pragma mark -
 
 /**

CountlyConfig.m

@@ -43,6 +43,7 @@ - (instancetype)init
         self.eventSendThreshold = 10;
 #endif
         self.storedRequestsLimit = 1000;
+        self.crashLogLimit = 100;
 
         self.location = kCLLocationCoordinate2DInvalid;
     }

CountlyConnectionManager.m

@@ -11,6 +11,8 @@ @interface CountlyConnectionManager ()
     NSTimeInterval unsentSessionLength;
     NSTimeInterval lastSessionStartTime;
     BOOL isCrashing;
+    BOOL isDelayingDeviceIDChange;
+    BOOL hasAlreadyDelayedDeviceIDChange;
 }
 @end
 
@@ -78,7 +80,7 @@ - (instancetype)init
 
 - (void)proceedOnQueue
 {
-    if (self.connection || isCrashing)
+    if (self.connection || isCrashing || isDelayingDeviceIDChange)
         return;
 
     if (self.customHeaderFieldName && !self.customHeaderFieldValue)
@@ -100,6 +102,20 @@ - (void)proceedOnQueue
         return;
     }
 
+    if ([firstItemInQueue containsString:[NSString stringWithFormat:@"&%@=", kCountlyQSKeyDeviceIDOld]] && !hasAlreadyDelayedDeviceIDChange)
+    {
+        COUNTLY_LOG(@"Server needs changing device ID request to be delayed 10 sec");
+
+        isDelayingDeviceIDChange = YES;
+        hasAlreadyDelayedDeviceIDChange = YES;
+
+        [NSObject cancelPreviousPerformRequestsWithTarget:self selector:@selector(endDelayingDeviceIDChange) object:nil];
+        [self performSelector:@selector(endDelayingDeviceIDChange) withObject:nil afterDelay:10];
+        return;
+    }
+
+    hasAlreadyDelayedDeviceIDChange = NO;
+
     [CountlyCommon.sharedInstance startBackgroundTask];
 
     NSString* queryString = firstItemInQueue;
@@ -534,6 +550,12 @@ - (BOOL)isRequestSuccessful:(NSURLResponse *)response
     return (code >= 200 && code < 300);
 }
 
+- (void)endDelayingDeviceIDChange
+{
+    isDelayingDeviceIDChange = NO;
+    [self proceedOnQueue];
+}
+
 #pragma mark ---
 
 - (NSURLSession *)URLSession

CountlyCrashReporter.h

@@ -10,11 +10,12 @@
 #if TARGET_OS_IOS
 @property (nonatomic) BOOL isEnabledOnInitialConfig;
 @property (nonatomic) NSDictionary* crashSegmentation;
+@property (nonatomic) NSUInteger crashLogLimit;
 
 + (instancetype)sharedInstance;
 - (void)startCrashReporting;
 - (void)stopCrashReporting;
-- (void)recordHandledException:(NSException *)exception withStackTrace:(NSArray *)stackTrace;
+- (void)recordException:(NSException *)exception withStackTrace:(NSArray *)stackTrace isFatal:(BOOL)isFatal;
 - (void)log:(NSString *)log;
 #endif
 @end