Merge pull request #341 from Countly/server_config

feat: server config

Author: turtledreams

CHANGELOG.md

@@ -1,3 +1,6 @@
+## XX.XX.XX
+* Extended server configuration capabilities of the SDK.
+
 ## 25.1.1
 * Removed Android v1 embedding support
 

android/src/main/java/ly/count/dart/countly_flutter/CountlyFlutterPlugin.java

@@ -1636,6 +1636,11 @@ private void populateConfig(JSONObject _config) throws JSONException {
         if (_config.has("starRatingTextDismiss")) {
             this.config.setStarRatingTextDismiss(_config.getString("starRatingTextDismiss"));
         }
+        
+        if (_config.has("sdkBehaviorSettings")) {
+            this.config.setSDKBehaviorSettings(_config.getString("sdkBehaviorSettings"));
+        }
+
         // APM ------------------------------------------------
         if (_config.has("trackAppStartTime")) {
             this.config.apm.enableAppStartTimeTracking();

ios/Classes/CountlyFlutterPlugin.m

@@ -1644,6 +1644,11 @@ - (void)populateConfig:(NSDictionary *)_config {
             [config.apm setAppStartTimestampOverride:[startTSOverride longLongValue]];
         }
 
+        NSString *sdkBehaviorSettings = _config[@"sdkBehaviorSettings"];
+        if(sdkBehaviorSettings) {
+            config.sdkBehaviorSettings = sdkBehaviorSettings;
+        }
+
         // Internal Limits ---------------------
         NSNumber *maxKeyLength = _config[@"maxKeyLength"];
         if (maxKeyLength) {

ios/Classes/CountlyiOS/CHANGELOG.md

@@ -1,3 +1,11 @@
+## XX.XX.XX
+* Deprecated the experimental configuration function enableServerConfiguration and it will do nothing. It is now enabled by default and can be controlled directly from the server.
+
+* Extended server configuration capabilities of the SDK.
+
+## 25.1.2
+* Mitigated an issue where the safe area resolution was not correctly calculated for the content zone on certain iOS devices.
+
 ## 25.1.1
 * Mitigated an issue while setting zone timer interval for content.
 

ios/Classes/CountlyiOS/Countly.m

@@ -92,6 +92,8 @@ - (void)startWithConfig:(CountlyConfig *)config
 
     config = [self checkAndFixInternalLimitsConfig:config];
 
+    [CountlyServerConfig.sharedInstance retrieveServerConfigFromStorage: config.serverConfiguration];
+    
     CountlyCommon.sharedInstance.maxKeyLength = config.sdkInternalLimits.getMaxKeyLength;
     CountlyCommon.sharedInstance.maxValueLength = config.sdkInternalLimits.getMaxValueSize;
     CountlyCommon.sharedInstance.maxSegmentationValues = config.sdkInternalLimits.getMaxSegmentationValues;
@@ -165,14 +167,8 @@ - (void)startWithConfig:(CountlyConfig *)config
     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 something added related to server config, make sure to check CountlyServerConfig.notifySdkConfigChange
+    [CountlyServerConfig.sharedInstance fetchServerConfig: config];
 
 #if (TARGET_OS_IOS)
     CountlyFeedbacksInternal.sharedInstance.message = config.starRatingMessage;
@@ -231,14 +227,20 @@ - (void)startWithConfig:(CountlyConfig *)config
     if ([config.features containsObject:CLYCrashReporting])
     {
         CountlyCrashReporter.sharedInstance.isEnabledOnInitialConfig = YES;
-        [CountlyCrashReporter.sharedInstance startCrashReporting];
+        
+        if (CountlyServerConfig.sharedInstance.crashReportingEnabled) {
+            [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;
+        if (CountlyServerConfig.sharedInstance.viewTrackingEnabled) {
+            [CountlyViewTrackingInternal.sharedInstance startAutoViewTracking];
+        }
         [CountlyViewTrackingInternal.sharedInstance startAutoViewTracking];
     }
     if (config.automaticViewTrackingExclusionList) {
@@ -255,6 +257,7 @@ - (void)startWithConfig:(CountlyConfig *)config
     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];
 
@@ -444,6 +447,7 @@ - (void)resume
 - (void)applicationDidBecomeActive:(NSNotification *)notification
 {
     CLY_LOG_D(@"App enters foreground");
+    [CountlyServerConfig.sharedInstance fetchServerConfigIfTimeIsUp];
     [self resume];
 }
 
@@ -857,6 +861,12 @@ - (void)recordEvent:(NSString *)key segmentation:(NSDictionary *)segmentation co
         CLY_LOG_W(@"A reserved event detected for key: '%@', event will not be recorded.", key);
         return;
     }
+
+    if (!CountlyServerConfig.sharedInstance.customEventTrackingEnabled)
+    {
+        CLY_LOG_D(@"'recordEvent' is aborted: Custom Event Tracking is disabled from server config!");
+        return;
+    }
 
     NSDictionary* truncated = [segmentation cly_truncated:@"Event segmentation"];
     segmentation = [truncated cly_limited:@"Event segmentation"];

ios/Classes/CountlyiOS/CountlyCommon.h

@@ -88,7 +88,6 @@ extern NSString* const kCountlySDKName;
 @property (nonatomic) BOOL manualSessionHandling;
 @property (nonatomic) BOOL enableManualSessionControlHybridMode;
 @property (nonatomic) BOOL enableOrientationTracking;
-@property (nonatomic) BOOL enableServerConfiguration;
 
 @property (nonatomic) BOOL enableVisibiltyTracking;
 

ios/Classes/CountlyiOS/CountlyConfig.h

@@ -662,13 +662,21 @@ typedef enum : NSUInteger
  */
 @property (nonatomic) BOOL enableOrientationTracking;
 
+#pragma mark -
+
 /**
  * This is an experimental feature and it can have breaking changes
  * For enabling fetching and application of server config values.
  * @discussion If set, Server Config values from Countly Server will be fetched at the beginning of a session.
+ * @deprecated and will do nothing
  */
 @property (nonatomic) BOOL enableServerConfiguration;
 
+/**
+ * Set the server configuration to be set while initializing the SDK
+ */
+@property (nonatomic, copy) NSString* serverConfiguration;
+
 #if (TARGET_OS_IOS)
 /**
  * Variable to access content configurations.

ios/Classes/CountlyiOS/CountlyConfig.m

@@ -76,7 +76,6 @@ - (instancetype)init
         self.internalLogLevel = CLYInternalLogLevelDebug;
 
         self.enableOrientationTracking = YES;
-        self.enableServerConfiguration = NO;
         self.remoteConfigGlobalCallbacks = NSMutableArray.new;
     }
 

ios/Classes/CountlyiOS/CountlyConnectionManager.m

@@ -356,6 +356,9 @@ - (void)beginSession
     if (!CountlyConsentManager.sharedInstance.consentForSessions)
         return;
 
+    if(!CountlyServerConfig.sharedInstance.sessionTrackingEnabled)
+        return;
+    
     if (isSessionStarted) {
         CLY_LOG_W(@"%s A session is already running, this 'beginSession' will be ignored", __FUNCTION__);
         return;
@@ -387,9 +390,11 @@ - (void)beginSession
                              kCountlyQSKeySessionBegin, @"1",
                              kCountlyQSKeyMetrics, [CountlyDeviceInfo metrics]];
 
-    NSString* locationRelatedInfoQueryString = [self locationRelatedInfoQueryString];
-    if (locationRelatedInfoQueryString)
-        queryString = [queryString stringByAppendingString:locationRelatedInfoQueryString];
+    if(CountlyServerConfig.sharedInstance.locationTrackingEnabled) {
+        NSString* locationRelatedInfoQueryString = [self locationRelatedInfoQueryString];
+        if (locationRelatedInfoQueryString)
+            queryString = [queryString stringByAppendingString:locationRelatedInfoQueryString];
+    }
 
     NSString* attributionQueryString = [self attributionQueryString];
     if (attributionQueryString)
@@ -407,6 +412,9 @@ - (void)updateSession
     if (!CountlyConsentManager.sharedInstance.consentForSessions)
         return;
 
+    if(!CountlyServerConfig.sharedInstance.sessionTrackingEnabled)
+        return;
+    
     if (!isSessionStarted) {
         CLY_LOG_W(@"%s No session is running, this 'updateSession' will be ignored", __FUNCTION__);
         return;
@@ -425,6 +433,9 @@ - (void)endSession
     if (!CountlyConsentManager.sharedInstance.consentForSessions)
         return;
 
+    if(!CountlyServerConfig.sharedInstance.sessionTrackingEnabled)
+        return;
+    
     if (!isSessionStarted) {
         CLY_LOG_W(@"%s No session is running, this 'endSession' will be ignored", __FUNCTION__);
         return;

ios/Classes/CountlyiOS/CountlyContentBuilderInternal.m

@@ -48,7 +48,7 @@ - (void)enterContentZone:(NSArray<NSString *> *)tags {
         return;
 
     if(_requestTimer != nil) {
-        CLY_LOG_I(@"Already entered for content zone, please exit from content zone first to start again");
+        CLY_LOG_I(@"%s, Already entered for content zone, please exit from content zone first to start again", __FUNCTION__);
         return;
     }
 
@@ -97,7 +97,7 @@ - (void)fetchContents {
 
     NSURLSessionTask *dataTask = [[NSURLSession sharedSession] dataTaskWithRequest:[self fetchContentsRequest] completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
         if (error) {
-            CLY_LOG_I(@"Fetch content details failed: %@", error);
+            CLY_LOG_I(@"%s, Fetch content details failed: %@", __FUNCTION__, error);
             self->_isRequestQueueLocked = NO;
             return;
         }
@@ -106,13 +106,13 @@ - (void)fetchContents {
         NSDictionary *jsonResponse = [NSJSONSerialization JSONObjectWithData:data options:0 error:&jsonError];
 
         if (jsonError) {
-            CLY_LOG_I(@"Failed to parse JSON: %@", jsonError);
+            CLY_LOG_I(@"%s, Failed to parse JSON: %@", __FUNCTION__, jsonError);
             self->_isRequestQueueLocked = NO;
             return;
         }
 
         if (!jsonResponse) {
-            CLY_LOG_I(@"Received empty or null response.");
+            CLY_LOG_I(@"%s, Received empty or null response.", __FUNCTION__);
             self->_isRequestQueueLocked = NO;
             return;
         }
@@ -152,30 +152,38 @@ - (NSURLRequest *)fetchContentsRequest
 }
 
 - (CGSize)getWindowSize {
-    CGSize size = CGSizeZero;
+    UIWindow *window = nil;
 
-    // Attempt to retrieve the size from the connected scenes (for modern apps)
     if (@available(iOS 13.0, *)) {
-        NSSet<UIScene *> *scenes = [[UIApplication sharedApplication] connectedScenes];
-        for (UIScene *scene in scenes) {
+        for (UIScene *scene in [UIApplication sharedApplication].connectedScenes) {
             if ([scene isKindOfClass:[UIWindowScene class]]) {
-                UIWindowScene *windowScene = (UIWindowScene *)scene;
-                UIWindow *window = windowScene.windows.firstObject;
-                if (window) {
-                    size = window.bounds.size;
-                    return size; // Return immediately if we find a valid size
-                }
+                window = ((UIWindowScene *)scene).windows.firstObject;
+                break;
             }
         }
+    } else {
+        window = [[UIApplication sharedApplication].delegate window];
     }
 
-    // Fallback for legacy apps using AppDelegate
-    id<UIApplicationDelegate> appDelegate = [[UIApplication sharedApplication] delegate];
-    if ([appDelegate respondsToSelector:@selector(window)]) {
-        UIWindow *legacyWindow = [appDelegate performSelector:@selector(window)];
-        if (legacyWindow) {
-            size = legacyWindow.bounds.size;
-        }
+    if (!window) return CGSizeZero;
+    
+    UIEdgeInsets safeArea = UIEdgeInsetsZero;
+    CGFloat screenScale = [UIScreen mainScreen].scale;
+    if (@available(iOS 11.0, *)) {
+        safeArea = window.safeAreaInsets;
+        safeArea.left /= screenScale;
+        safeArea.bottom /= screenScale;
+        safeArea.right /= screenScale;
+    }
+    
+    UIInterfaceOrientation orientation = [UIApplication sharedApplication].statusBarOrientation;
+    BOOL isLandscape = UIInterfaceOrientationIsLandscape(orientation);
+    
+    CGSize size = CGSizeMake(window.bounds.size.width, window.bounds.size.height);
+    
+    if(!isLandscape){
+        size.width -= safeArea.left + safeArea.right;
+        size.height -= safeArea.top + safeArea.bottom;
     }
 
     return size;
@@ -196,6 +204,8 @@ - (NSString *)resolutionJson {
         @"landscape": @{@"height": @(lHpW), @"width": @(lWpH)}
     };
 
+    CLY_LOG_D(@"%s, %@", __FUNCTION__, resolutionDict);
+    
     NSData *jsonData = [NSJSONSerialization dataWithJSONObject:resolutionDict options:0 error:nil];
     return [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding];
 }
@@ -205,7 +215,7 @@ - (void)showContentWithHtmlPath:(NSString *)urlString placementCoordinates:(NSDi
     NSURL *url = [NSURL URLWithString:urlString];
 
     if (!url || !url.scheme || !url.host) {
-        NSLog(@"The URL is not valid: %@", urlString);
+        CLY_LOG_E(@"%s, The URL is not valid: %@", __FUNCTION__, urlString);
         return;
     }
 
@@ -227,17 +237,17 @@ - (void)showContentWithHtmlPath:(NSString *)urlString placementCoordinates:(NSDi
     CGRect frame = CGRectMake(x, y, width, height);
 
     // Log the URL and the frame
-    CLY_LOG_I(@"Showing content from URL: %@", url);
-    CLY_LOG_I(@"Placement frame: %@", NSStringFromCGRect(frame));
+    CLY_LOG_I(@"%s, Showing content from URL: %@", __FUNCTION__, url);
+    CLY_LOG_I(@"%s, Placement frame: %@", __FUNCTION__, NSStringFromCGRect(frame));
 
     CountlyWebViewManager* webViewManager =  CountlyWebViewManager.new;
         [webViewManager createWebViewWithURL:url frame:frame appearBlock:^
          {
-            CLY_LOG_I(@"Webview appeared");
+            CLY_LOG_I(@"%s, Webview appeared", __FUNCTION__);
             [self clearContentState];
         } dismissBlock:^
          {
-            CLY_LOG_I(@"Webview dismissed");
+            CLY_LOG_I(@"%s, Webview dismissed", __FUNCTION__);
             self->_minuteTimer = [NSTimer scheduledTimerWithTimeInterval:60.0
                                                              target:self
                                                            selector:@selector(enterContentZone)