Merge pull request #411 from Countly/staging

turtledreams · web-flow · commit 4d897b5b6743 · 2025-09-19T21:19:57.000+09:00
Staging 25.4.5
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+## 25.4.5
+* Added "requestTimeoutDuration" init config parameter to change request timeout duration in seconds.
+* Added a new function "sendMetricsRequest: metricsOverride" to send a manual metrics request, accessible through the instance.
+* Added a new Consent option "CLYConsentMetrics" for controlling "sendMetricsRequest" method. (This has no effect on Session metrics.)
+
+* Mitigated a possible health check recording issue.
+
 ## 25.4.4
 * Improved Health Check metric information.
 * Improved Content display mechanics.
diff --git a/Countly-PL.podspec b/Countly-PL.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name = 'Countly-PL'
-  s.version = '25.4.4'
+  s.version = '25.4.5'
   s.license = { :type => 'MIT', :file => 'LICENSE' }
   s.summary  = 'Countly is an innovative, real-time, open source mobile analytics platform.'
   s.homepage = 'https://github.com/Countly/countly-sdk-ios'
diff --git a/Countly.h b/Countly.h
@@ -100,6 +100,12 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (void)addDirectRequest:(NSDictionary<NSString *, NSString *> * _Nullable)requestParameters;
 
+/**
+ * Records current device metrics and puts them into the request queue.
+ * @discussion Optionally, provide a dictionary to override detected metrics.
+ * @param metricsOverride Dictionary of metrics to override.
+ */
+- (void)recordMetrics:(NSDictionary<NSString *, NSString *> *_Nullable)metricsOverride;
 
 
 #pragma mark - Sessions
diff --git a/Countly.m b/Countly.m
@@ -548,6 +548,12 @@ - (void)setNewAppKey:(NSString *)newAppKey
 
 #pragma mark - Queue Operations
 
+- (void)recordMetrics:(NSDictionary<NSString *, NSString *> * _Nullable)metricsOverride
+{
+    CLY_LOG_I(@"%s %@", __FUNCTION__, metricsOverride);
+    [CountlyConnectionManager.sharedInstance recordMetrics:metricsOverride];
+}
+
 - (void)flushQueues
 {
     CLY_LOG_I(@"%s", __FUNCTION__);
diff --git a/Countly.podspec b/Countly.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name = 'Countly'
-  s.version = '25.4.4'
+  s.version = '25.4.5'
   s.license = { :type => 'MIT', :file => 'LICENSE' }
   s.summary  = 'Countly is an innovative, real-time, open source mobile analytics platform.'
   s.homepage = 'https://github.com/Countly/countly-sdk-ios'
diff --git a/Countly.xcodeproj/project.pbxproj b/Countly.xcodeproj/project.pbxproj
@@ -768,7 +768,7 @@
 					"@loader_path/Frameworks",
 				);
 				MACOSX_DEPLOYMENT_TARGET = 10.14;
-				MARKETING_VERSION = 25.4.4;
+				MARKETING_VERSION = 25.4.5;
 				PRODUCT_BUNDLE_IDENTIFIER = ly.count.CountlyiOSSDK;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				PROVISIONING_PROFILE_SPECIFIER = "";
@@ -800,7 +800,7 @@
 					"@loader_path/Frameworks",
 				);
 				MACOSX_DEPLOYMENT_TARGET = 10.14;
-				MARKETING_VERSION = 25.4.4;
+				MARKETING_VERSION = 25.4.5;
 				PRODUCT_BUNDLE_IDENTIFIER = ly.count.CountlyiOSSDK;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				PROVISIONING_PROFILE_SPECIFIER = "";
diff --git a/CountlyCommon.m b/CountlyCommon.m
@@ -29,7 +29,7 @@ @interface CountlyCommon ()
 #endif
 @end
 
-NSString* const kCountlySDKVersion = @"25.4.4";
+NSString* const kCountlySDKVersion = @"25.4.5";
 NSString* const kCountlySDKName = @"objc-native-ios";
 
 NSString* const kCountlyErrorDomain = @"ly.count.ErrorDomain";
diff --git a/CountlyConfig.h b/CountlyConfig.h
@@ -88,6 +88,7 @@ extern CLYConsent const CLYConsentPerformanceMonitoring;
 extern CLYConsent const CLYConsentFeedback;
 extern CLYConsent const CLYConsentRemoteConfig;
 extern CLYConsent const CLYConsentContent;
+extern CLYConsent const CLYConsentMetrics;
 
 //NOTE: Push Notification Test Modes
 typedef NSString* CLYPushTestMode NS_EXTENSIBLE_STRING_ENUM;
@@ -389,6 +390,13 @@ typedef enum : NSUInteger
  */
 @property (nonatomic) NSUInteger requestDropAgeHours;
 
+/**
+ * Set the request timeout duration in seconds
+ * Minimum value is "1" second
+ * Default value is "30" seconds
+ */
+@property (nonatomic) NSInteger requestTimeoutDuration;
+
 /**
  * Limit for the length of all string keys.
  * @discussion It affects:
diff --git a/CountlyConfig.m b/CountlyConfig.m
@@ -77,6 +77,7 @@ - (instancetype)init
         
         self.enableOrientationTracking = YES;
         self.remoteConfigGlobalCallbacks = NSMutableArray.new;
+        self.requestTimeoutDuration = 30;
     }
     
     return self;
diff --git a/CountlyConnectionManager.h b/CountlyConnectionManager.h
@@ -40,6 +40,8 @@ extern const NSInteger kCountlyGETRequestMaxLength;
 
 + (instancetype)sharedInstance;
 
+- (void)recordMetrics:(nullable NSDictionary *)metricsOverride;
+
 - (void)beginSession;
 - (void)updateSession;
 - (void)endSession;
diff --git a/CountlyConnectionManager.m b/CountlyConnectionManager.m
@@ -85,7 +85,6 @@ @interface CountlyConnectionManager ()
 NSString* const kCountlyEndpointSurveys = @"/surveys";
 
 const NSInteger kCountlyGETRequestMaxLength = 2048;
-static const NSTimeInterval CONNECTION_TIMEOUT = 30.0;
 
 @implementation CountlyConnectionManager : NSObject
 
@@ -223,8 +222,8 @@ - (void)proceedOnQueue
         return;
     }
 
-    _URLSessionConfiguration.timeoutIntervalForRequest = CONNECTION_TIMEOUT;
-    _URLSessionConfiguration.timeoutIntervalForResource = CONNECTION_TIMEOUT;
+    _URLSessionConfiguration.timeoutIntervalForRequest = [CountlyServerConfig.sharedInstance requestTimeoutDuration];
+    _URLSessionConfiguration.timeoutIntervalForResource = [CountlyServerConfig.sharedInstance requestTimeoutDuration];
     NSString* queryString = firstItemInQueue;
     NSString* endPoint = kCountlyEndpointI;
     
@@ -341,6 +340,36 @@ - (void)proceedOnQueue
     [self logRequest:request];
 }
 
+- (void)recordMetrics:(nullable NSDictionary *)metricsOverride
+{
+    CLY_LOG_I(@"%s", __FUNCTION__, metricsOverride);
+    if (!CountlyConsentManager.sharedInstance.consentForMetrics)
+    return;
+    
+    NSDictionary *defaultMetrics = [CountlyDeviceInfo metricsDictionary];
+    if (!defaultMetrics) {
+        CLY_LOG_W(@"%s Default metrics is nil, aborting", __FUNCTION__);
+        return;
+    }
+    CLY_LOG_I(@"%s default metrics:[%@]", __FUNCTION__, defaultMetrics);
+    
+    NSDictionary *finalMetrics;
+    if (metricsOverride && metricsOverride.count > 0) {
+        NSMutableDictionary *mutableMetrics = [defaultMetrics mutableCopy];
+        [mutableMetrics addEntriesFromDictionary:metricsOverride];
+        finalMetrics = [mutableMetrics copy];
+    } else {
+        finalMetrics = defaultMetrics;
+    }
+    CLY_LOG_I(@"%s final metrics:[%@]", __FUNCTION__, finalMetrics);
+    
+    NSString* queryString = [[self queryEssentials] stringByAppendingFormat:@"&%@=%@",
+                             kCountlyQSKeyMetrics, [finalMetrics cly_JSONify]];
+    
+    [CountlyPersistency.sharedInstance addToQueue:queryString];
+    [self proceedOnQueue];
+}
+
 - (BOOL)backoff:(long)responseTimeSeconds queryString:(NSString *)queryString
 {
     BOOL result = NO;
diff --git a/CountlyConsentManager.h b/CountlyConsentManager.h
@@ -23,6 +23,7 @@
 @property (nonatomic, readonly) BOOL consentForFeedback;
 @property (nonatomic, readonly) BOOL consentForRemoteConfig;
 @property (nonatomic, readonly) BOOL consentForContent;
+@property (nonatomic, readonly) BOOL consentForMetrics;
 
 
 + (instancetype)sharedInstance;
diff --git a/CountlyConsentManager.m b/CountlyConsentManager.m
@@ -18,6 +18,7 @@
 CLYConsent const CLYConsentFeedback             = @"feedback";
 CLYConsent const CLYConsentRemoteConfig         = @"remote-config";
 CLYConsent const CLYConsentContent              = @"content";
+CLYConsent const CLYConsentMetrics              = @"metrics";
 
 
 @implementation CountlyConsentManager
@@ -34,6 +35,7 @@ @implementation CountlyConsentManager
 @synthesize consentForFeedback = _consentForFeedback;
 @synthesize consentForRemoteConfig = _consentForRemoteConfig;
 @synthesize consentForContent = _consentForContent;
+@synthesize consentForMetrics = _consentForMetrics;
 
 #pragma mark -
 
@@ -119,6 +121,9 @@ - (void)giveConsentForFeatures:(NSArray *)features
     
     if ([features containsObject:CLYConsentContent] && !self.consentForContent)
         self.consentForContent = YES;
+    
+    if ([features containsObject:CLYConsentMetrics] && !self.consentForMetrics)
+        self.consentForMetrics = YES;
 
     [self sendConsents];
 }
@@ -186,6 +191,9 @@ - (void)cancelConsentForFeatures:(NSArray *)features shouldSkipSendingConsentsRe
     if ([features containsObject:CLYConsentContent] && self.consentForContent)
         self.consentForContent = NO;
 
+    if ([features containsObject:CLYConsentMetrics] && self.consentForMetrics)
+        self.consentForMetrics = NO;
+
     if (!shouldSkipSendingConsentsRequest)
         [self sendConsents];
 }
@@ -207,6 +215,7 @@ - (void)sendConsents
         CLYConsentFeedback: @(self.consentForFeedback),
         CLYConsentRemoteConfig: @(self.consentForRemoteConfig),
         CLYConsentContent: @(self.consentForContent),
+        CLYConsentMetrics: @(self.consentForMetrics),
     };
 
     [CountlyConnectionManager.sharedInstance sendConsents:[consents cly_JSONify]];
@@ -247,7 +256,8 @@ - (BOOL)hasAnyConsent
     self.consentForPerformanceMonitoring ||
     self.consentForFeedback ||
     self.consentForRemoteConfig ||
-    self.consentForContent;
+    self.consentForContent ||
+    self.consentForMetrics;
 }
 
 
@@ -463,6 +473,20 @@ - (void)setConsentForRemoteConfig:(BOOL)consentForRemoteConfig
     }
 }
 
+- (void)setConsentForMetrics:(BOOL)consentForMetrics
+{
+    _consentForMetrics = consentForMetrics;
+
+    if (consentForMetrics)
+    {
+        CLY_LOG_D(@"Consent for Metrics is given.");
+    }
+    else
+    {
+        CLY_LOG_D(@"Consent for Metrics is cancelled.");
+    }
+}
+
 - (void)setConsentForContent:(BOOL)consentForContent
 {
     _consentForContent = consentForContent;
@@ -586,4 +610,12 @@ - (BOOL)consentForContent
     return _consentForContent;
 }
 
+- (BOOL)consentForMetrics
+{
+    if (!self.requiresConsent)
+        return YES;
+    
+    return _consentForMetrics;
+}
+
 @end
diff --git a/CountlyDeviceInfo.h b/CountlyDeviceInfo.h
@@ -38,6 +38,7 @@ typedef enum : NSUInteger
 + (NSString *)appVersion;
 + (NSString *)appBuild;
 
++ (NSDictionary *)metricsDictionary;
 + (NSString *)metrics;
 
 + (NSUInteger)connectionType;
diff --git a/CountlyDeviceInfo.m b/CountlyDeviceInfo.m
@@ -308,7 +308,7 @@ + (NSString *)appBuild
     return [NSBundle.mainBundle objectForInfoDictionaryKey:(NSString*)kCFBundleVersionKey];
 }
 
-+ (NSString *)metrics
++ (NSDictionary *)metricsDictionary
 {
     NSMutableDictionary* metricsDictionary = NSMutableDictionary.new;
     metricsDictionary[CLYMetricKeyDevice] = CountlyDeviceInfo.device;
@@ -327,7 +327,12 @@ + (NSString *)metrics
 
     [metricsDictionary addEntriesFromDictionary:CountlyDeviceInfo.sharedInstance.customMetrics];
 
-    return [metricsDictionary cly_JSONify];
+    return metricsDictionary;
+}
+
++ (NSString *)metrics
+{
+    return [[CountlyDeviceInfo metricsDictionary] cly_JSONify];
 }
 
 #pragma mark -
diff --git a/CountlyHealthTracker.m b/CountlyHealthTracker.m
@@ -212,7 +212,9 @@ - (NSURLRequest *)healthCheckRequest {
         requestKeyConsecutiveBackoffRequest: @(self.consecutiveBackoffRequest)
     }]];
     
-    queryString = [queryString stringByAppendingFormat:@"&%@=%@", kCountlyQSKeyMetrics, [CountlyDeviceInfo metrics]];
+    queryString = [queryString stringByAppendingFormat:@"&%@=%@", @"metrics", [self dictionaryToJsonString:@{
+        CLYMetricKeyAppVersion: CountlyDeviceInfo.appVersion
+     }]];
 
 
     queryString = [CountlyConnectionManager.sharedInstance appendChecksum:queryString];
diff --git a/CountlyPersistency.m b/CountlyPersistency.m
@@ -620,8 +620,14 @@ - (NSDictionary *)retrieveHealthCheckTrackerState
 
 - (void)storeHealthCheckTrackerState:(NSDictionary *)healthCheckTrackerState
 {
-    [NSUserDefaults.standardUserDefaults setObject:healthCheckTrackerState forKey:kCountlyHealthCheckStatePersistencyKey];
-    [NSUserDefaults.standardUserDefaults synchronize];
+    @try {
+        [NSUserDefaults.standardUserDefaults setObject:healthCheckTrackerState forKey:kCountlyHealthCheckStatePersistencyKey];
+        [NSUserDefaults.standardUserDefaults synchronize];
+    }
+    @catch (NSException *exception) {
+        CLY_LOG_E(@"%s, Exception while storing health check tracker state: %@, reason: %@", __FUNCTION__,
+                  exception.name, exception.reason);
+    }
 }
 
 @end
diff --git a/CountlyServerConfig.h b/CountlyServerConfig.h
@@ -44,5 +44,6 @@ extern NSString* const kCountlySCKeySC;
 - (double)bomRQPercentage;
 - (NSInteger)bomRequestAge;
 - (NSInteger)bomDuration;
+- (NSInteger)requestTimeoutDuration;
 @end
 
diff --git a/CountlyServerConfig.m b/CountlyServerConfig.m
@@ -41,6 +41,8 @@ @interface CountlyServerConfig () {
 @property (nonatomic) NSInteger bomRequestAge;
 @property (nonatomic) NSInteger bomDuration;
 
+@property (nonatomic) NSInteger requestTimeoutDuration;
+
 @property (nonatomic) NSInteger version;
 @property (nonatomic) long long timestamp;
 @property (nonatomic) long long lastFetchTimestamp;
@@ -109,6 +111,7 @@ - (instancetype)init
         _currentServerConfigUpdateInterval = 4;
         _requestTimer = nil;
         _serverConfigUpdatesDisabled = NO;
+        _requestTimeoutDuration = 30;
         [self setDefaultValues];
     }
     return self;
@@ -211,6 +214,12 @@ - (void)setDoubleProperty:(double *)property fromDictionary:(NSDictionary *)dict
 
 - (void)populateServerConfig:(NSDictionary *)serverConfig withConfig:(CountlyConfig *)config
 {
+    if(config.requestTimeoutDuration <= 0) {
+        config.requestTimeoutDuration = 1;
+    }
+    
+    _requestTimeoutDuration = config.requestTimeoutDuration;
+    
     if (!serverConfig[kRConfig])
     {
         CLY_LOG_D(@"%s, config key is missing in the server configuration omitting", __FUNCTION__);
@@ -627,4 +636,9 @@ - (NSInteger)bomDuration
     return _bomDuration;
 }
 
+- (NSInteger)requestTimeoutDuration
+{
+    return _requestTimeoutDuration;
+}
+
 @end

Original file line number	Diff line number	Diff line change
`@@ -77,6 +77,7 @@ - (instancetype)init`
`77`	`77`
`78`	`78`	`self.enableOrientationTracking = YES;`
`79`	`79`	`self.remoteConfigGlobalCallbacks = NSMutableArray.new;`
	`80`	`+ self.requestTimeoutDuration = 30;`
`80`	`81`	`}`
`81`	`82`
`82`	`83`	`return self;`