Merge pull request #135 from erkanyildiz/master

For 19.02

Author: erkanyildiz

CHANGELOG.md

@@ -1,3 +1,25 @@
+## 19.02
+- Added push notification support for macOS
+- Added provisional push notification permission support for iOS12
+- Added remote config feature
+- Added `recordPushNotificationToken` method to be used after device ID changes
+- Added `clearPushNotificationToken` method to be used after device ID changes
+- Discarded `Push Open` event and replaced it with `Push Action` event
+- Fixed push notification token not being sent on some iOS12 devices
+- Fixed device ID change request delaying issue by discarding delay altogether
+- Fixed internal view controller presenting failure when root view controller is not ready yet
+- Fixed `openURL` freeze caused by iOS
+- Fixed wrong `kCountlyQSKeyLocationIP` key in location info requests
+- Fixed missing app key in feedback widget requests
+- Fixed feedback widget dismiss button position
+
+- Other various improvements
+    - Discarded separate UIWindow usage for presenting feedback widgets
+    - Added checksum to feedback widget requests
+    - Improved internal logging for request queue
+
+
+
 ## 18.08
 - Added feedback widgets support
 - Added limit for number of custom crash logs (100 logs)

Countly.h

@@ -8,7 +8,7 @@
 #import <CoreLocation/CoreLocation.h>
 #import "CountlyUserDetails.h"
 #import "CountlyConfig.h"
-#if TARGET_OS_IOS
+#if (TARGET_OS_IOS || TARGET_OS_OSX)
 #import <UserNotifications/UserNotifications.h>
 #endif
 
@@ -246,7 +246,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 
 #pragma mark - Push Notification
-#if TARGET_OS_IOS
+#if (TARGET_OS_IOS || TARGET_OS_OSX)
 /**
  * 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.
@@ -261,7 +261,7 @@ NS_ASSUME_NONNULL_BEGIN
  * @param options Bitwise combination of notification types (badge, sound or alert) the app wants to display
  * @param completionHandler A completion handler block to be executed when user answers notification permission dialog
  */
-- (void)askForNotificationPermissionWithOptions:(UNAuthorizationOptions)options completionHandler:(void (^)(BOOL granted, NSError * error))completionHandler API_AVAILABLE(ios(10.0));
+- (void)askForNotificationPermissionWithOptions:(UNAuthorizationOptions)options completionHandler:(void (^)(BOOL granted, NSError * error))completionHandler API_AVAILABLE(ios(10.0), macos(10.14));
 
 /**
  * Records action event for a manually presented push notification with custom action buttons.
@@ -273,6 +273,18 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (void)recordActionForNotification:(NSDictionary *)userInfo clickedButtonIndex:(NSInteger)buttonIndex;
 
+/**
+ * Records push notification token to Countly Server for current device ID.
+ * @discussion Can be used to re-send push notification token for current device ID, after a new user logs in and device ID changes, without waiting for the app to be restarted.
+ * @discussion In general, push notification token is handled automatically and this method does not need to be called manually.
+ */
+- (void)recordPushNotificationToken;
+
+/**
+ * Clears push notification token on Countly Server for current device ID.
+ * @discussion Can be used to clear push notification token for current device ID, before the current user logs out and device ID changes, without waiting for the app to be restarted.
+ */
+- (void)clearPushNotificationToken;
 #endif
 
 
@@ -477,6 +489,41 @@ NS_ASSUME_NONNULL_BEGIN
 
 #endif
 
+
+
+#pragma mark - Remote Config
+/**
+ * Returns last retrieved remote config value for given key, if exists.
+ * @discussion If remote config is never retrieved from Countly Server before, this method will return @c nil.
+ * @discussion If @c key is not defined in remote config on Countly Server, this method will return @c nil.
+ * @discussion If Countly Server is not reachable, this method will return the last retrieved value which is stored on device.
+ * @param key Remote config key specified on Countly Server
+ */
+- (id)remoteConfigValueForKey:(NSString *)key;
+
+/**
+ * Manually updates all locally stored remote config values by fetching latest values from Countly Server, and executes completion handler.
+ * @discussion @c completionHandler has an @c NSError parameter that will be either @ nil or an @c NSError object, depending on result.
+ * @param completionHandler A completion handler block to be executed when updating of remote config is completed, either with success or failure.
+ */
+- (void)updateRemoteConfigWithCompletionHandler:(void (^)(NSError * error))completionHandler;
+
+/**
+ * Manually updates locally stored remote config values only for specified keys, by fetching latest values from Countly Server, and executes completion handler.
+ * @discussion @c completionHandler has an @c NSError parameter that will be either @ nil or an @c NSError object, depending on result.
+ * @param keys An array of remote config keys to update
+ * @param completionHandler A completion handler block to be executed when updating of remote config is completed, either with success or failure
+ */
+- (void)updateRemoteConfigOnlyForKeys:(NSArray *)keys completionHandler:(void (^)(NSError * error))completionHandler;
+
+/**
+ * Manually updates locally stored remote config values except for specified keys, by fetching latest values from Countly Server, and executes completion handler.
+ * @discussion @c completionHandler has an @c NSError parameter that will be either @ nil or an @c NSError object, depending on result.
+ * @param omitKeys An array of remote config keys to omit from updating
+ * @param completionHandler A completion handler block to be executed when updating of remote config is completed, either with success or failure
+ */
+- (void)updateRemoteConfigExceptForKeys:(NSArray *)omitKeys completionHandler:(void (^)(NSError * error))completionHandler;
+
 NS_ASSUME_NONNULL_END
 
 @end

Countly.m

@@ -108,22 +108,25 @@ - (void)startWithConfig:(CountlyConfig *)config
     CountlyLocationManager.sharedInstance.IP = config.IP;
     [CountlyLocationManager.sharedInstance sendLocationInfo];
 
+    CountlyCrashReporter.sharedInstance.crashSegmentation = config.crashSegmentation;
+    CountlyCrashReporter.sharedInstance.crashLogLimit = MAX(1, config.crashLogLimit);
+    if ([config.features containsObject:CLYCrashReporting])
+    {
+        CountlyCrashReporter.sharedInstance.isEnabledOnInitialConfig = YES;
+        [CountlyCrashReporter.sharedInstance startCrashReporting];
+    }
+#endif
+
+#if (TARGET_OS_IOS || TARGET_OS_OSX)
     if ([config.features containsObject:CLYPushNotifications])
     {
         CountlyPushNotifications.sharedInstance.isEnabledOnInitialConfig = YES;
         CountlyPushNotifications.sharedInstance.isTestDevice = config.isTestDevice;
         CountlyPushNotifications.sharedInstance.sendPushTokenAlways = config.sendPushTokenAlways;
         CountlyPushNotifications.sharedInstance.doNotShowAlertForNotifications = config.doNotShowAlertForNotifications;
+        CountlyPushNotifications.sharedInstance.launchNotification = config.launchNotification;
         [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 startCrashReporting];
-    }
 #endif
 
 #if (TARGET_OS_IOS || TARGET_OS_TV)
@@ -145,6 +148,10 @@ - (void)startWithConfig:(CountlyConfig *)config
 
     [CountlyCommon.sharedInstance startAttribution];
 
+    CountlyRemoteConfig.sharedInstance.isEnabledOnInitialConfig = config.enableRemoteConfig;
+    CountlyRemoteConfig.sharedInstance.remoteConfigCompletionHandler = config.remoteConfigCompletionHandler;
+    [CountlyRemoteConfig.sharedInstance startRemoteConfig];
+
     [CountlyConnectionManager.sharedInstance proceedOnQueue];
 }
 
@@ -194,6 +201,9 @@ - (void)setNewDeviceID:(NSString *)deviceID onServer:(BOOL)onServer
 
         [CountlyPersistency.sharedInstance clearAllTimedEvents];
     }
+
+    [CountlyRemoteConfig.sharedInstance clearCachedRemoteConfig];
+    [CountlyRemoteConfig.sharedInstance startRemoteConfig];
 }
 
 - (void)setCustomHeaderFieldValue:(NSString *)customHeaderFieldValue
@@ -502,7 +512,7 @@ - (void)cancelEvent:(NSString *)key
 
 
 #pragma mark - Push Notifications
-#if TARGET_OS_IOS
+#if (TARGET_OS_IOS || TARGET_OS_OSX)
 
 - (void)askForNotificationPermission
 {
@@ -518,6 +528,16 @@ - (void)recordActionForNotification:(NSDictionary *)userInfo clickedButtonIndex:
 {
     [CountlyPushNotifications.sharedInstance recordActionForNotification:userInfo clickedButtonIndex:buttonIndex];
 }
+
+- (void)recordPushNotificationToken
+{
+    [CountlyPushNotifications.sharedInstance sendToken];
+}
+
+- (void)clearPushNotificationToken
+{
+    [CountlyPushNotifications.sharedInstance clearToken];
+}
 #endif
 
 
@@ -662,4 +682,29 @@ - (void)presentFeedbackWidgetWithID:(NSString *)widgetID completionHandler:(void
 
 #endif
 
+
+
+#pragma mark - Remote Config
+
+- (id)remoteConfigValueForKey:(NSString *)key
+{
+    return [CountlyRemoteConfig.sharedInstance remoteConfigValueForKey:key];
+}
+
+- (void)updateRemoteConfigWithCompletionHandler:(void (^)(NSError * error))completionHandler
+{
+    [CountlyRemoteConfig.sharedInstance updateRemoteConfigForForKeys:nil omitKeys:nil completionHandler:completionHandler];
+}
+
+- (void)updateRemoteConfigOnlyForKeys:(NSArray *)keys completionHandler:(void (^)(NSError * error))completionHandler
+{
+    [CountlyRemoteConfig.sharedInstance updateRemoteConfigForForKeys:keys omitKeys:nil completionHandler:completionHandler];
+}
+
+- (void)updateRemoteConfigExceptForKeys:(NSArray *)omitKeys completionHandler:(void (^)(NSError * error))completionHandler
+{
+    [CountlyRemoteConfig.sharedInstance updateRemoteConfigForForKeys:nil omitKeys:omitKeys completionHandler:completionHandler];
+}
+
+
 @end

Countly.podspec

@@ -1,13 +1,13 @@
 Pod::Spec.new do |s|
   s.name = 'Countly'
-  s.version = '18.08'
+  s.version = '19.02'
   s.license = {
     :type => 'COMMUNITY',
     :text => <<-LICENSE
               COUNTLY MOBILE ANALYTICS COMMUNITY EDITION LICENSE
               --------------------------------------------------
 
-              Copyright (c) 2012, 2018 Countly
+              Copyright (c) 2012, 2019 Countly
 
               Permission is hereby granted, free of charge, to any person obtaining a copy
               of this software and associated documentation files (the "Software"), to deal

CountlyCommon.h

@@ -22,6 +22,7 @@
 #import "CountlyNotificationService.h"
 #import "CountlyConsentManager.h"
 #import "CountlyLocationManager.h"
+#import "CountlyRemoteConfig.h"
 
 #if DEBUG
 #define COUNTLY_LOG(fmt, ...) CountlyInternalLog(fmt, ##__VA_ARGS__)
@@ -64,6 +65,7 @@ NS_ERROR_ENUM(kCountlyErrorDomain)
 {
     CLYErrorFeedbackWidgetNotAvailable = 10001,
     CLYErrorFeedbackWidgetNotTargetedForDevice = 10002,
+    CLYErrorRemoteConfigGeneralAPIError = 10011,
 };
 
 @interface CountlyCommon : NSObject
@@ -88,6 +90,7 @@ void CountlyInternalLog(NSString *format, ...) NS_FORMAT_FUNCTION(1,2);
 
 #if (TARGET_OS_IOS || TARGET_OS_TV)
 - (UIViewController *)topViewController;
+- (void)tryPresentingViewController:(UIViewController *)viewController;
 #endif
 
 - (void)startAppleWatchMatching;

CountlyCommon.m

@@ -18,7 +18,7 @@ @interface CountlyCommon ()
 #endif
 @end
 
-NSString* const kCountlySDKVersion = @"18.08";
+NSString* const kCountlySDKVersion = @"19.02";
 NSString* const kCountlySDKName = @"objc-native-ios";
 
 NSString* const kCountlyParentDeviceIDTransferKey = @"kCountlyParentDeviceIDTransferKey";
@@ -222,6 +222,19 @@ - (UIViewController *)topViewController
 
     return topVC;
 }
+
+- (void)tryPresentingViewController:(UIViewController *)viewController
+{
+    UIViewController* topVC = self.topViewController;
+
+    if (topVC)
+    {
+        [topVC presentViewController:viewController animated:YES completion:nil];
+        return;
+    }
+
+    [self performSelector:@selector(tryPresentingViewController:) withObject:viewController afterDelay:1.0];
+}
 #endif
 
 @end

CountlyConfig.h

@@ -15,6 +15,8 @@ extern NSString* const CLYCrashReporting;
 extern NSString* const CLYAutoViewTracking;
 #elif TARGET_OS_TV
 extern NSString* const CLYAutoViewTracking;
+#elif TARGET_OS_OSX
+extern NSString* const CLYPushNotifications;
 #endif
 //NOTE: Disable APM feature until Countly Server completely supports it
 // extern NSString* const CLYAPM;
@@ -105,6 +107,12 @@ extern NSString* const CLYConsentAppleWatch;
  */
 @property (nonatomic) BOOL doNotShowAlertForNotifications;
 
+/**
+ * For handling push notifications for macOS apps on launch.
+ * @discussion Needs to be set in @c applicationDidFinishLaunching: method of macOS apps that uses @c CLYPushNotifications feature, in order to handle app launches by push notification click.
+ */
+@property (nonatomic) NSNotification* launchNotification;
+
 #pragma mark -
 
 /**
@@ -276,6 +284,24 @@ extern NSString* const CLYConsentAppleWatch;
  */
 @property (nonatomic, copy) void (^starRatingCompletion)(NSInteger rating);
 
+#pragma mark -
+
+/**
+ * For enabling automatic fetching of remote config values.
+ * @discussion If set, Remote Config values specified on Countly Server will be fetched on beginning of sessions.
+ */
+@property (nonatomic) BOOL enableRemoteConfig;
+
+/**
+ * Completion block to be executed after remote config is fetched from Countly Server, on start or device ID change.
+ * @discussion This completion block can be used to detect updating of remote config values is completed, either with success or failure.
+ * @discussion It has an @c NSError parameter that will be either @ nil or an @c NSError object, depending of request result.
+ * @discussion If there is no error, it will be executed with an @c nil, which means latest remote config values are ready to be used.
+ * @discussion If Countly Server is not reachable or if there is another error, it will be executed with an @c NSError indicating the problem.
+ * @discussion If @c enableRemoteConfig flag is not set on initial config, it will never be executed.
+ */
+@property (nonatomic, copy) void (^remoteConfigCompletionHandler)(NSError * _Nullable error);
+
 NS_ASSUME_NONNULL_END
 
 @end

CountlyConfig.m

@@ -15,6 +15,8 @@ @implementation CountlyConfig
     NSString* const CLYAutoViewTracking = @"CLYAutoViewTracking";
 #elif TARGET_OS_TV
     NSString* const CLYAutoViewTracking = @"CLYAutoViewTracking";
+#elif TARGET_OS_OSX
+    NSString* const CLYPushNotifications = @"CLYPushNotifications";
 #endif
 //NOTE: Disable APM feature until Countly Server completely supports it
 // NSString* const CLYAPM = @"CLYAPM";

CountlyConnectionManager.h

@@ -38,4 +38,8 @@
 - (void)sendConsentChanges:(NSString *)consentChanges;
 
 - (void)proceedOnQueue;
+
+- (NSString *)queryEssentials;
+- (NSString *)appendChecksum:(NSString *)queryString;
+
 @end