updated underlying iOS SDK with latest changes (#127)

Author: ijunaid

ios/Classes/CountlyiOS/CHANGELOG.md

@@ -18,6 +18,8 @@
 - Added `enableAutomaticViewTracking` config for automatic track views
 - Added `automaticViewTrackingExclusionList` config for automatic view tracking exclusion list
 - Added `globalViewSegmentation` config to add set global view segmentation.
+- Added `enrollABOnRCDownload` config method to auto enroll users to AB tests when downloading RC values.
+- Added `enableManualSessionControlHybridMode` config. With this mode 'updateSession' calls will automatically be handled by SDK for manual session handling.
 - Deprecated `giveConsentForAllFeatures` method
 - Deprecated `CLYAutoViewTracking` in config
 - Deprecated existing view tracking methods and variables:  

ios/Classes/CountlyiOS/Countly-PL.podspec

@@ -17,7 +17,7 @@ Pod::Spec.new do |s|
 
   s.subspec 'Core' do |core|
     core.source_files = '*.{h,m}'
-    core.public_header_files = 'Countly.h', 'CountlyUserDetails.h', 'CountlyConfig.h', 'CountlyFeedbackWidget.h', 'CountlyRCData.h', 'CountlyRemoteConfig.h'
+    core.public_header_files = 'Countly.h', 'CountlyUserDetails.h', 'CountlyConfig.h', 'CountlyFeedbackWidget.h', 'CountlyRCData.h', 'CountlyRemoteConfig.h', 'CountlyViewTracking.h'
     core.preserve_path = 'countly_dsym_uploader.sh'
     core.ios.frameworks = ['Foundation', 'UIKit', 'UserNotifications', 'CoreLocation', 'WebKit', 'CoreTelephony', 'WatchConnectivity']
   end

ios/Classes/CountlyiOS/Countly.h

@@ -625,6 +625,24 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (void)presentRatingWidgetWithID:(NSString *)widgetID completionHandler:(void (^)(NSError * __nullable error))completionHandler;
 
+/**
+ * Presents rating widget with given ID in a WKWebView placed in a UIViewController.
+ * @discussion First, the availability of the rating widget will be checked asynchronously.
+ * @discussion If the rating widget with given ID is available, it will be modally presented.
+ * @discussion Otherwise, @c completionHandler will be executed with an @c NSError.
+ * @discussion @c completionHandler will also be executed with @c nil when the rating widget is dismissed by user.
+ * @discussion Calls to this method will be ignored and @c completionHandler will not be executed if:
+ * @discussion - Consent for @c CLYConsentFeedback is not given, while @c requiresConsent flag is set on initial configuration.
+ * @discussion - Current device ID is @c CLYTemporaryDeviceID.
+ * @discussion - @c widgetID is not a non-zero length valid string.
+ * @discussion This is a legacy method for presenting Rating type feedback widgets only.
+ * @discussion Passing widget ID's of Survey or NPS type feedback widgets will not work.
+ * @param widgetID ID of the rating widget created on Countly Server.
+ * @param closeButtonText text for close button
+ * @param completionHandler A completion handler block to be executed when the rating widget is dismissed by user or there is an error.
+ */
+//- (void)presentRatingWidgetWithID:(NSString *)widgetID closeButtonText:(NSString * _Nullable)closeButtonText  completionHandler:(void (^)(NSError * __nullable error))completionHandler;
+
 /**
  * Manually records rating widget result with given ID and other info.
  * @discussion Calls to this method will be ignored if:

ios/Classes/CountlyiOS/Countly.m

@@ -124,6 +124,7 @@ - (void)startWithConfig:(CountlyConfig *)config
     CountlyPersistency.sharedInstance.storedRequestsLimit = MAX(1, config.storedRequestsLimit);
 
     CountlyCommon.sharedInstance.manualSessionHandling = config.manualSessionHandling;
+    CountlyCommon.sharedInstance.enableManualSessionControlHybridMode = config.enableManualSessionControlHybridMode;
 
     CountlyCommon.sharedInstance.attributionID = config.attributionID;
 
@@ -209,6 +210,9 @@ - (void)startWithConfig:(CountlyConfig *)config
     if(config.getRemoteConfigGlobalCallbacks) {
         CountlyRemoteConfigInternal.sharedInstance.remoteConfigGlobalCallbacks = config.getRemoteConfigGlobalCallbacks;
     }
+    if(config.enrollABOnRCDownload) {
+        CountlyRemoteConfigInternal.sharedInstance.enrollABOnRCDownload = config.enrollABOnRCDownload;
+    }
     [CountlyRemoteConfigInternal.sharedInstance downloadRemoteConfigAutomatically];
 
     CountlyPerformanceMonitoring.sharedInstance.isEnabledOnInitialConfig = config.enablePerformanceMonitoring;
@@ -240,7 +244,14 @@ - (void)onTimer:(NSTimer *)timer
         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 sendEvents];
 }
@@ -1037,15 +1048,23 @@ - (void)askForStarRating:(void(^)(NSInteger rating))completion
 - (void)presentFeedbackWidgetWithID:(NSString *)widgetID completionHandler:(void (^)(NSError * error))completionHandler
 {
     CLY_LOG_I(@"%s %@ %@", __FUNCTION__, widgetID, completionHandler);
-
-    [CountlyFeedbacks.sharedInstance checkFeedbackWidgetWithID:widgetID completionHandler:completionHandler];
+    
+    [self presentRatingWidgetWithID:widgetID closeButtonText:nil completionHandler:completionHandler];
 }
 
 - (void)presentRatingWidgetWithID:(NSString *)widgetID completionHandler:(void (^)(NSError * error))completionHandler
 {
     CLY_LOG_I(@"%s %@ %@", __FUNCTION__, widgetID, completionHandler);
+    
+    [self presentRatingWidgetWithID:widgetID closeButtonText:nil completionHandler:completionHandler];
+}
 
-    [CountlyFeedbacks.sharedInstance checkFeedbackWidgetWithID:widgetID completionHandler:completionHandler];
+- (void)presentRatingWidgetWithID:(NSString *)widgetID closeButtonText:(NSString * _Nullable)closeButtonText  completionHandler:(void (^)(NSError * __nullable error))completionHandler
+{
+    
+    CLY_LOG_I(@"%s %@ %@ %@", __FUNCTION__, widgetID, closeButtonText, completionHandler);
+    
+    [CountlyFeedbacks.sharedInstance presentRatingWidgetWithID:widgetID closeButtonText:closeButtonText completionHandler:completionHandler];
 }
 
 - (void)recordRatingWidgetWithID:(NSString *)widgetID rating:(NSInteger)rating email:(NSString * _Nullable)email comment:(NSString * _Nullable)comment userCanBeContacted:(BOOL)userCanBeContacted

ios/Classes/CountlyiOS/Countly.podspec

@@ -17,7 +17,7 @@ Pod::Spec.new do |s|
 
   s.subspec 'Core' do |core|
     core.source_files = '*.{h,m}'
-    core.public_header_files = 'Countly.h', 'CountlyUserDetails.h', 'CountlyConfig.h', 'CountlyFeedbackWidget.h', 'CountlyRCData.h', 'CountlyRemoteConfig.h'
+    core.public_header_files = 'Countly.h', 'CountlyUserDetails.h', 'CountlyConfig.h', 'CountlyFeedbackWidget.h', 'CountlyRCData.h', 'CountlyRemoteConfig.h', 'CountlyViewTracking.h'
     core.preserve_path = 'countly_dsym_uploader.sh'
     core.ios.frameworks = ['Foundation', 'UIKit', 'UserNotifications', 'CoreLocation', 'WebKit', 'CoreTelephony', 'WatchConnectivity']
   end

ios/Classes/CountlyiOS/CountlyCommon.h

@@ -80,6 +80,7 @@ extern NSString* const kCountlySDKName;
 @property (nonatomic) CLYInternalLogLevel internalLogLevel;
 @property (nonatomic, copy) NSString* attributionID;
 @property (nonatomic) BOOL manualSessionHandling;
+@property (nonatomic) BOOL enableManualSessionControlHybridMode;
 @property (nonatomic) BOOL enableOrientationTracking;
 @property (nonatomic) BOOL enableServerConfiguration;
 
@@ -122,6 +123,7 @@ void CountlyPrint(NSString *stringToPrint);
 @interface CLYButton : UIButton
 @property (nonatomic, copy) void (^onClick)(id sender);
 + (CLYButton *)dismissAlertButton;
++ (CLYButton *)dismissAlertButton:(NSString * _Nullable)closeButtonText;
 - (void)positionToTopRight;
 - (void)positionToTopRightConsideringStatusBar;
 @end

ios/Classes/CountlyiOS/CountlyCommon.m

@@ -351,21 +351,29 @@ - (void)touchUpInside:(id)sender
         self.onClick(self);
 }
 
-+ (CLYButton *)dismissAlertButton
++ (CLYButton *)dismissAlertButton:(NSString * _Nullable)closeButtonText
 {
+    if(!closeButtonText) {
+        closeButtonText = @"x";
+    }
     CLYButton* dismissButton = [CLYButton buttonWithType:UIButtonTypeCustom];
     dismissButton.frame = (CGRect){CGPointZero, kCountlyDismissButtonSize, kCountlyDismissButtonSize};
-    [dismissButton setTitle:@"✕" forState:UIControlStateNormal];
+    [dismissButton setTitle:closeButtonText forState:UIControlStateNormal];
     [dismissButton setTitleColor:UIColor.whiteColor forState:UIControlStateNormal];
     dismissButton.backgroundColor = [UIColor.blackColor colorWithAlphaComponent:0.5];
     dismissButton.layer.cornerRadius = dismissButton.bounds.size.width * 0.5;
     dismissButton.layer.borderColor = [UIColor.blackColor colorWithAlphaComponent:0.7].CGColor;
     dismissButton.layer.borderWidth = 1.0;
     dismissButton.autoresizingMask = UIViewAutoresizingFlexibleLeftMargin | UIViewAutoresizingFlexibleBottomMargin;
-
+    
     return dismissButton;
 }
 
++ (CLYButton *)dismissAlertButton
+{
+    return [CLYButton dismissAlertButton:nil];
+}
+
 - (void)positionToTopRight
 {
     [self positionToTopRight:NO];

ios/Classes/CountlyiOS/CountlyConfig.h

@@ -403,6 +403,14 @@ typedef enum : NSUInteger
  */
 @property (nonatomic) BOOL manualSessionHandling;
 
+/**
+ * For handling start and stop sessions manually.
+ * @discussion If set, SDK does not handle beginning and ending sessions automatically. Methods @c beginSession and @c endSession need to be called manually.
+ * update session will handle auto automatically, no need to call @c updateSession when hybrid mode is enabled.
+ * NOTE: It will work only when manualSessionHandling is enabled.
+ */
+@property (nonatomic) BOOL enableManualSessionControlHybridMode;
+
 #pragma mark -
 
 /**
@@ -575,6 +583,13 @@ typedef enum : NSUInteger
  */
 - (NSMutableArray<RCDownloadCallback> *) getRemoteConfigGlobalCallbacks;
 
+/**
+ * For enabling automatic AB enrolling on download.
+ * @discussion If set, user will will automatically be enrolled in relevant AB tests when downloading RC values.
+ */
+@property (nonatomic) BOOL enrollABOnRCDownload;
+
+
 #pragma mark -
 
 /**

ios/Classes/CountlyiOS/CountlyFeedbacks.h

@@ -20,7 +20,7 @@ extern NSString* const kCountlyReservedEventStarRating;
 + (instancetype)sharedInstance;
 
 - (void)showDialog:(void(^)(NSInteger rating))completion;
-- (void)checkFeedbackWidgetWithID:(NSString *)widgetID completionHandler:(void (^)(NSError * error))completionHandler;
+- (void)presentRatingWidgetWithID:(NSString *)widgetID closeButtonText:(NSString *)closeButtonText completionHandler:(void (^)(NSError * error))completionHandler;
 - (void)recordRatingWidgetWithID:(NSString *)widgetID rating:(NSInteger)rating email:(NSString *)email comment:(NSString *)comment userCanBeContacted:(BOOL)userCanBeContacted;
 - (void)checkForStarRatingAutoAsk;
 

ios/Classes/CountlyiOS/CountlyFeedbacks.m

@@ -234,11 +234,11 @@ - (UIColor *)passiveStarColor
 
 #pragma mark - Feedbacks (Ratings) (Legacy Feedback Widget)
 
-- (void)checkFeedbackWidgetWithID:(NSString *)widgetID completionHandler:(void (^)(NSError * error))completionHandler
+- (void)presentRatingWidgetWithID:(NSString *)widgetID closeButtonText:(NSString *)closeButtonText completionHandler:(void (^)(NSError * error))completionHandler
 {
     if (!CountlyServerConfig.sharedInstance.networkingEnabled)
     {
-        CLY_LOG_D(@"'checkFeedbackWidgetWithID' is aborted: SDK Networking is disabled from server config!");
+        CLY_LOG_D(@"'presentRatingWidgetWithID' is aborted: SDK Networking is disabled from server config!");
         return;
     }
 
@@ -289,14 +289,14 @@ - (void)checkFeedbackWidgetWithID:(NSString *)widgetID completionHandler:(void (
 
         dispatch_async(dispatch_get_main_queue(), ^
         {
-            [self presentFeedbackWidgetWithID:widgetID completionHandler:completionHandler];
+            [self presentRatingWidgetInternal:widgetID closeButtonText:closeButtonText completionHandler:completionHandler];
         });
     }];
 
     [task resume];
 }
 
-- (void)presentFeedbackWidgetWithID:(NSString *)widgetID completionHandler:(void (^)(NSError * error))completionHandler
+- (void)presentRatingWidgetInternal:(NSString *)widgetID closeButtonText:(NSString *)closeButtonText  completionHandler:(void (^)(NSError * error))completionHandler
 {
     __block CLYInternalViewController* webVC = CLYInternalViewController.new;
     webVC.view.backgroundColor = UIColor.whiteColor;
@@ -309,7 +309,7 @@ - (void)presentFeedbackWidgetWithID:(NSString *)widgetID completionHandler:(void
     NSURL* widgetDisplayURL = [self widgetDisplayURL:widgetID];
     [webView loadRequest:[NSURLRequest requestWithURL:widgetDisplayURL]];
 
-    CLYButton* dismissButton = [CLYButton dismissAlertButton];
+    CLYButton* dismissButton = [CLYButton dismissAlertButton:closeButtonText];
     dismissButton.onClick = ^(id sender)
     {
         [webVC dismissViewControllerAnimated:YES completion:^