Merge pull request #421 from Countly/user_props

Refactor user properties

Author: turtledreams

CHANGELOG.md

@@ -1,13 +1,25 @@
 ## XX.XX.XX
+* Added a new user properties functions on `CountlyUserDetails`:
+  * `setProperty:value:` for setting a single predefined or custom user property.
+  * `setProperties:` for setting multiple predefined and custom properties in one call.
+* Added `providedUserProperties` to `CountlyConfig` to set initial user properties that are applied and saved automatically right after `start`.
+* Added `setMaxValueSizePicture:` to `CountlySDKLimitsConfig` to control the maximum size of picture URLs and picture paths independently of other value limits (default 4096).
+* Improved `$push` / `$pull` / `$addToSet` wire format: values are now always sent as arrays so multiple consecutive calls on the same key accumulate correctly.
 * Updated resolution extraction to accommodate iOS 26 deprecations.
 
+* Mitigated a race condition in the request queue that could drop or duplicate requests.
 * Mitigated an issue where non-queued requests were affected from request timeout settings.
 * Mitigated a race condition for tests in the request queue that could drop or duplicate requests.
 * Mitigated an issue where server config defaults overrode user-provided SDK limits.
 * Mitigated an issue where invalid or unknown `sdkBehaviorSettings` keys were persisted.
 * Mitigated an issue where listing-filter conflicts cleared keys across unrelated categories.
 * Mitigated an issue where consent could be sent twice during initialization.
 
+* Deprecated the direct property setters on `CountlyUserDetails`: `name`, `username`, `email`, `organization`, `phone`, `gender`, `pictureURL`, `pictureLocalPath`, `birthYear`, `custom`. Use `setProperty:value:` or `setProperties:` instead.
+* Deprecated `set:value:`, `set:numberValue:`, `set:boolValue:` on `CountlyUserDetails`. Use `setProperty:value:` instead.
+* Deprecated `unSet:` on `CountlyUserDetails`. Use `setProperty:value:` with an empty string `@""` to clear a property on the server.
+* Deprecated the `+ user` class accessor on `Countly`. Use `Countly.sharedInstance.userProfile` instead.
+
 ## 26.1.1
 * Added POST method support for contents. 
 * Added robust resource loading checks before displaying content

Countly.h

@@ -602,7 +602,7 @@ NS_ASSUME_NONNULL_BEGIN
  * Returns @c CountlyUserDetails singleton to be used throughout the app.
  * @return The shared @c CountlyUserDetails object
  */
-+ (CountlyUserDetails *)user;
++ (CountlyUserDetails *)user DEPRECATED_MSG_ATTRIBUTE("Use -userProfile via Countly.sharedInstance instead (e.g., Countly.sharedInstance.userProfile).");
 
 
 
@@ -705,6 +705,8 @@ NS_ASSUME_NONNULL_BEGIN
  * @discussion Feedback widget  interface for developer to interact with SDK.
  */
 - (CountlyFeedbacks *) feedback;
+
+- (CountlyUserDetails *) userProfile;
 #endif
 
 

Countly.m

@@ -111,6 +111,7 @@ - (void)startWithConfig:(CountlyConfig *)config
 
     CountlyCommon.sharedInstance.maxKeyLength = config.sdkInternalLimits.getMaxKeyLength;
     CountlyCommon.sharedInstance.maxValueLength = config.sdkInternalLimits.getMaxValueSize;
+    CountlyCommon.sharedInstance.maxValueLengthPicture = config.sdkInternalLimits.getMaxValueSizePicture;
     CountlyCommon.sharedInstance.maxSegmentationValues = config.sdkInternalLimits.getMaxSegmentationValues;
 
     // For backward compatibility, deprecated values are only set incase new values are not provided using sdkInternalLimits interface
@@ -165,8 +166,13 @@ - (void)startWithConfig:(CountlyConfig *)config
 
     NSDictionary* customMetricsTruncated = [config.customMetrics cly_truncated:@"Custom metric"];
     CountlyDeviceInfo.sharedInstance.customMetrics = [customMetricsTruncated cly_limited:@"Custom metric"];
-    
-    [Countly.user save];
+
+    if (config.providedUserProperties.count > 0) {
+        CLY_LOG_I(@"%s applying providedUserProperties at init [%lu]", __FUNCTION__, (unsigned long)config.providedUserProperties.count);
+        [Countly.sharedInstance.userProfile setProperties:config.providedUserProperties];
+    }
+
+    [Countly.sharedInstance.userProfile save];
     // If something added related to server config, make sure to check CountlyServerConfig.notifySdkConfigChange
     [CountlyServerConfig.sharedInstance fetchServerConfig:config];
 
@@ -1613,4 +1619,9 @@ - (CountlyRemoteConfig *) remoteConfig {
     return CountlyRemoteConfig.sharedInstance;
 }
 
+- (CountlyUserDetails *) userProfile
+{
+    return CountlyUserDetails.sharedInstance;
+}
+
 @end

CountlyCommon.h

@@ -96,6 +96,7 @@ extern NSString* const kCountlySDKName;
 
 @property (nonatomic) NSUInteger maxKeyLength;
 @property (nonatomic) NSUInteger maxValueLength;
+@property (nonatomic) NSUInteger maxValueLengthPicture;
 @property (nonatomic) NSUInteger maxSegmentationValues;
 
 void CountlyInternalLog(CLYInternalLogLevel level, NSString *format, ...) NS_FORMAT_FUNCTION(2, 3);
@@ -157,6 +158,7 @@ void CountlyPrint(NSString *stringToPrint);
 - (NSString *)cly_valueForQueryStringKey:(NSString *)key;
 - (NSString *)cly_truncatedKey:(NSString *)explanation;
 - (NSString *)cly_truncatedValue:(NSString *)explanation;
+- (NSString *)cly_truncatedPictureValue:(NSString *)explanation;
 @end
 
 @interface NSArray (Countly)

CountlyCommon.m

@@ -73,6 +73,7 @@ - (void)resetInstance {
     _hasFinishedInit       = false;
     _maxKeyLength = kCountlyMaxKeyLength;
     _maxValueLength = kCountlyMaxValueSize;
+    _maxValueLengthPicture = kCountlyMaxValueSizePicture;
     _maxSegmentationValues = kCountlyMaxSegmentationValues;
     onceToken = 0;
     s_sharedInstance = nil;
@@ -648,6 +649,17 @@ - (NSString *)cly_truncatedKey:(NSString *)explanation
     return self;
 }
 
+- (NSString *)cly_truncatedPictureValue:(NSString *)explanation
+{
+    NSUInteger limit = CountlyCommon.sharedInstance.maxValueLengthPicture;
+    if (self.length > limit)
+    {
+        CLY_LOG_W(@"%@ length is more than the picture limit (%ld)! So, it will be truncated: %@.", explanation, (long)limit, self);
+        return [self substringToIndex:limit];
+    }
+    return self;
+}
+
 - (NSString *)cly_truncatedValue:(NSString *)explanation
 {
     if (self.length > CountlyCommon.sharedInstance.maxValueLength)
@@ -738,7 +750,7 @@ - (NSMutableDictionary *) cly_filterSupportedDataTypes
 
         if ([value isKindOfClass:[NSNumber class]] ||
             [value isKindOfClass:[NSString class]] ||
-            ([value isKindOfClass:[NSArray class]] && (value = [value cly_filterSupportedDataTypes]))) {
+            ([value isKindOfClass:[NSArray class]] && (value = [(NSArray *)value cly_filterSupportedDataTypes]))) {
             [filteredDictionary setObject:value forKey:key];
         } else {
             CLY_LOG_W(@"%s, Removed invalid type for key %@: %@", __FUNCTION__, key, [value class]);

CountlyConfig.h

@@ -440,6 +440,14 @@ typedef enum : NSUInteger
  */
 - (CountlySDKLimitsConfig *)sdkInternalLimits;
 
+/**
+ * User properties to set automatically right after SDK init.
+ * @discussion Equivalent to calling @c [Countly.user setProperties:data] followed by @c save once the SDK has started.
+ * @discussion Keys matching predefined fields (name, username, email, organization, phone, gender, picture, picturePath, byear)
+ * are routed to the corresponding top-level user-detail field. All other keys are stored as custom user properties.
+ */
+@property (nonatomic, copy) NSDictionary<NSString *, id> * _Nullable providedUserProperties;
+
 /**
  * For sending all requests using HTTP POST method.
  * @discussion If set, all requests will be sent using HTTP POST method. Otherwise; only the requests with a file upload or data size more than 2048 bytes will be sent using HTTP POST method.

CountlyConnectionManager.m

@@ -612,9 +612,9 @@ - (void)beginSession
     }
 #endif
 
-    if([Countly.user hasUnsyncedChanges])
+    if ([CountlyUserDetails.sharedInstance hasUnsyncedChanges])
     {
-        [Countly.user save];
+        [CountlyUserDetails.sharedInstance save];
     }
 
     isSessionStarted = YES;
@@ -655,9 +655,9 @@ - (void)updateSession
         return;
     }
 
-    if([Countly.user hasUnsyncedChanges])
+    if ([CountlyUserDetails.sharedInstance hasUnsyncedChanges])
     {
-        [Countly.user save];
+        [CountlyUserDetails.sharedInstance save];
     }
 
     NSString* queryString = [[self queryEssentials] stringByAppendingFormat:@"&%@=%d",
@@ -697,9 +697,9 @@ - (void)endSession
 
 - (void)sendEventsWithSaveIfNeeded
 {
-    if([Countly.user hasUnsyncedChanges])
+    if ([CountlyUserDetails.sharedInstance hasUnsyncedChanges])
     {
-        [Countly.user save];
+        [CountlyUserDetails.sharedInstance save];
     }
     else
     {

CountlyConsentManager.m

@@ -309,7 +309,7 @@ - (void)setConsentForUserDetails:(BOOL)consentForUserDetails
     {
         CLY_LOG_D(@"Consent for UserDetails is given.");
         [CountlyCommon.sharedInstance recordOrientation];
-        [Countly.user save];
+        [CountlyUserDetails.sharedInstance save];
     }
     else
     {

CountlyPersistency.m

@@ -271,9 +271,9 @@ - (void)recordEvent:(CountlyEvent *)event callback:(CLYRequestCallback)callback
 {
     @synchronized (self.recordedEvents)
     {
-        if([Countly.user hasUnsyncedChanges])
+        if ([CountlyUserDetails.sharedInstance hasUnsyncedChanges])
         {
-            [Countly.user save];
+            [CountlyUserDetails.sharedInstance save];
         }
 
         [self.recordedEvents addObject:event];

CountlySDKLimitsConfig.h

@@ -9,6 +9,7 @@
 
 extern const NSUInteger kCountlyMaxKeyLength;
 extern const NSUInteger kCountlyMaxValueSize;
+extern const NSUInteger kCountlyMaxValueSizePicture;
 extern const NSUInteger kCountlyMaxBreadcrumbCount;
 extern const NSUInteger kCountlyMaxSegmentationValues;
 extern const NSUInteger kCountlyMaxStackTraceLineLength;
@@ -19,13 +20,15 @@ extern const NSUInteger kCountlyMaxStackTraceLinesPerThread;
 
 - (void)setMaxKeyLength:(NSUInteger)maxKeyLength;
 - (void)setMaxValueSize:(NSUInteger)maxValueSize;
+- (void)setMaxValueSizePicture:(NSUInteger)maxValueSizePicture;
 - (void)setMaxBreadcrumbCount:(NSUInteger)maxBreadcrumbCount;
 - (void)setMaxSegmentationValues:(NSUInteger)maxSegmentationValues;
 - (void)setMaxStackTraceLineLength:(NSUInteger)maxStackTraceLineLength;
 - (void)setMaxStackTraceLinesPerThread:(NSUInteger)maxStackTraceLinesPerThread;
 
 - (NSUInteger)getMaxKeyLength;
 - (NSUInteger)getMaxValueSize;
+- (NSUInteger)getMaxValueSizePicture;
 - (NSUInteger)getMaxBreadcrumbCount;
 - (NSUInteger)getMaxSegmentationValues;
 - (NSUInteger)getMaxStackTraceLineLength;