Merge pull request #500 from CleverTap/SDK-5392-7.4.1

SDK-5392: Variants and bug fixes

Author: akashvercetti

CleverTapSDK/CTConstants.h

@@ -86,6 +86,7 @@ extern NSString *const kSessionId;
 #define CLTAP_PRODUCT_CONFIG_JSON_RESPONSE_KEY @"pc_notifs"
 #define CLTAP_GEOFENCES_JSON_RESPONSE_KEY @"geofences"
 #define CLTAP_PE_VARS_RESPONSE_KEY @"vars"
+#define CLTAP_PE_VARIANTS_RESPONSE_KEY @"abVariantInfo"
 #define CLTAP_DISCARDED_EVENT_JSON_KEY @"d_e"
 #define CLTAP_INAPP_CLOSE_IV_WIDTH 40
 #define CLTAP_NOTIFICATION_ID_TAG @"wzrk_id"
@@ -138,6 +139,7 @@ extern NSString *CT_KIND_BOOLEAN;
 extern NSString *CT_KIND_DICTIONARY;
 extern NSString *CT_KIND_FILE;
 extern NSString *CLEVERTAP_DEFAULTS_VARIABLES_KEY;
+extern NSString *CLEVERTAP_DEFAULTS_VARIANTS_KEY;
 extern NSString *CLEVERTAP_DEFAULTS_VARS_JSON_KEY;
 
 extern NSString *CT_PE_VARS_PAYLOAD_TYPE;

CleverTapSDK/CTConstants.m

@@ -25,6 +25,7 @@
 NSString *CT_KIND_FILE = @"file";
 NSString *CT_KIND_DICTIONARY = @"group";
 NSString *CLEVERTAP_DEFAULTS_VARIABLES_KEY = @"__clevertap_variables";
+NSString *CLEVERTAP_DEFAULTS_VARIANTS_KEY = @"__clevertap_variants";
 NSString *CLEVERTAP_DEFAULTS_VARS_JSON_KEY = @"__clevertap_variables_json";
 
 NSString *CT_PE_VARS_PAYLOAD_TYPE = @"varsPayload";

CleverTapSDK/CleverTap.h

@@ -1531,6 +1531,19 @@ extern NSString * _Nonnull const CleverTapProfileDidInitializeNotification;
  */
 - (id _Nullable)getVariableValue:(NSString * _Nonnull)name;
 
+/**
+ * Returns experiment variant information for the current user.
+ *
+ * Each dictionary contains details about an assigned A/B test variant.
+ * Common keys include:
+ *   - "name": Variant name
+ *   - "abTestId": Experiment identifier
+ *   - "abTestName": Experiment name
+ *
+ * @return Array of variant dictionaries with string keys. Returns empty array if no variants assigned.
+ */
+- (NSArray<NSDictionary<NSString *, id> *> * _Nonnull)variants;
+
 /*!
  @method
  

CleverTapSDK/CleverTap.m

@@ -1128,16 +1128,24 @@ - (void)_appEnteredForegroundWithLaunchingOptions:(NSDictionary *)launchOptions
 
 - (void)_appEnteredForeground {
     if ([CTUIUtils runningInsideAppExtension]) return;
+    
+    // Check application state
+    UIApplication *application = [CTUIUtils getSharedApplication];
+    BOOL isActuallyInForeground = (application.applicationState == UIApplicationStateActive);
     [self.sessionManager updateSessionStateOnLaunch];
-    if (!self.isAppForeground) {
+    
+    // Only record app launched if app is transitioning to foreground and app is active
+    if (!self.isAppForeground && isActuallyInForeground) {
         [self recordAppLaunched:@"appEnteredForeground"];
         [self scheduleQueueFlush];
         CleverTapLogInternal(self.config.logLevel, @"%@: app is in foreground", self);
     }
-    self.isAppForeground = YES;
+    
+    // Set flag based on actual state
+    self.isAppForeground = isActuallyInForeground;
 
 #if !CLEVERTAP_NO_INAPP_SUPPORT
-    if (!_config.analyticsOnly && ![CTUIUtils runningInsideAppExtension]) {
+    if (isActuallyInForeground && !_config.analyticsOnly && ![CTUIUtils runningInsideAppExtension]) {
         [self.inAppFCManager checkUpdateDailyLimits];
     }
 #endif
@@ -1189,6 +1197,7 @@ - (void)recordAppLaunched:(NSString *)caller {
 
     // Load Vars from cache before App Launched
     [self.variables.varCache loadDiffs];
+    [self.variables.varCache loadVariants];
 
     self.sessionManager.appLaunchProcessed = YES;
 
@@ -2553,6 +2562,17 @@ - (void)parseResponse:(NSData *)responseData responseEncrypted:(BOOL)responseEnc
                     }
                 }
 
+                // Handle Variants
+                NSArray *variantsResponse = jsonResp[CLTAP_PE_VARIANTS_RESPONSE_KEY];
+                if (variantsResponse) {
+                    if (!self.isUserSwitching) {
+                        [[self variables] handleVariantsResponse:variantsResponse];
+                    }
+                    else {
+                        CleverTapLogDebug(self.config.logLevel, @"%@: Variants will not be handled due to user switch", self);
+                    }
+                }
+                
                 // Handle events/profiles sync data
                 @try {
                     NSDictionary *evpr = jsonResp[@"evpr"];
@@ -4645,6 +4665,17 @@ - (id _Nullable)getVariableValue:(NSString * _Nonnull)name {
     return [[self.variables varCache] getMergedValue:name];
 }
 
+- (NSArray<NSDictionary<NSString *, id> *> *)variants
+{
+    CT_TRY
+    NSArray *variants = [self.variables.varCache variants];
+    if (variants) {
+        return [variants copy];
+    }
+    CT_END_TRY
+    return [NSArray array];
+}
+
 - (void)onVariablesChangedAndNoDownloadsPending:(CleverTapVariablesChangedBlock _Nonnull )block {
     [[self variables] onVariablesChangedAndNoDownloadsPending:block];
 }

CleverTapSDK/InApps/resources/image_interstitial.html

@@ -27,10 +27,13 @@ NS_SWIFT_NAME(VarCache)
 @property (assign, nonatomic) BOOL hasVarsRequestCompleted;
 @property (assign, nonatomic) BOOL hasPendingDownloads;
 @property (nonatomic, weak) id<CTFileVarDelegate> delegate;
+@property (nonatomic, strong) NSArray<NSDictionary<NSString *, id> *> *variants;
 
 - (nullable NSDictionary<NSString *, id> *)diffs;
 - (void)loadDiffs;
+- (void)loadVariants;
 - (void)applyVariableDiffs:(nullable NSDictionary<NSString *, id> *)diffs_;
+- (void)handleVariantsData:(NSArray<NSDictionary<NSString *, id> *> *)variantsData;
 
 - (void)registerVariable:(CTVar *)var;
 - (nullable CTVar *)getVariable:(NSString *)name;

CleverTapSDK/ProductExperiences/CTVarCache.h

@@ -242,10 +242,63 @@ - (void)saveDiffs {
     }
 }
 
+- (void)loadVariants {
+    @try {
+        NSString *fileName = [self dataArchiveVariantsFileName];
+        NSString *filePath = [CTPreferences filePathfromFileName:fileName];
+        NSData *variantsData = [NSData dataWithContentsOfFile:filePath];
+        
+        if (!variantsData) {
+            @synchronized (self) {
+                self.variants = @[];
+            }
+            CleverTapLogDebug(self.config.logLevel, @"%@: No cached variants found", self);
+            return;
+        }
+        
+        NSKeyedUnarchiver *unarchiver;
+        if (@available(iOS 12.0, tvOS 11.0, *)) {
+            NSError *error = nil;
+            unarchiver = [[NSKeyedUnarchiver alloc] initForReadingFromData:variantsData error:&error];
+            if (error != nil) {
+                CleverTapLogDebug(self.config.logLevel, @"%@: Error loading variants: %@", self, error.localizedDescription);
+                @synchronized (self) {
+                    self.variants = @[];
+                }
+                return;
+            }
+            unarchiver.requiresSecureCoding = NO;
+        } else {
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+            unarchiver = [[NSKeyedUnarchiver alloc] initForReadingWithData:variantsData];
+#pragma clang diagnostic pop
+        }
+        
+        NSArray *loadedVariants = (NSArray *)[unarchiver decodeObjectForKey:CLEVERTAP_DEFAULTS_VARIANTS_KEY];
+        
+        @synchronized (self) {
+            self.variants = loadedVariants ?: @[];
+        }
+        
+        CleverTapLogDebug(self.config.logLevel, @"%@: Loaded %lu variants from cache", self, (unsigned long)[self.variants count]);
+        
+    } @catch (NSException *exception) {
+        CleverTapLogDebug(self.config.logLevel, @"%@: Exception loading variants: %@", self, exception.debugDescription);
+        @synchronized (self) {
+            self.variants = @[];
+        }
+    }
+}
+
 - (NSString*)dataArchiveFileName {
     return [NSString stringWithFormat:@"clevertap-%@-%@-pe-vars.plist", _config.accountId, _deviceInfo.deviceId];
 }
 
+- (NSString*)dataArchiveVariantsFileName {
+    return [NSString stringWithFormat:@"clevertap-%@-%@-pe-variants.plist", _config.accountId, _deviceInfo.deviceId];
+}
+
 - (void)applyVariableDiffs:(NSDictionary *)diffs_ {
     CleverTapLogDebug(self.config.logLevel, @"%@: Applying Variables: %@", self, diffs_);
     @synchronized (self.vars) {
@@ -291,9 +344,39 @@ - (void)applyVariableDiffs:(NSDictionary *)diffs_ {
     }
 }
 
+- (void)handleVariantsData:(NSArray<NSDictionary<NSString *, id> *> *)variantsData {
+    @synchronized (self) {
+        self.variants = variantsData;
+    }
+    
+    NSMutableData *diffsData = [[NSMutableData alloc] init];
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+    NSKeyedArchiver *archiver = [[NSKeyedArchiver alloc] initForWritingWithMutableData:diffsData];
+#pragma clang diagnostic pop
+    [archiver encodeObject:variantsData forKey:CLEVERTAP_DEFAULTS_VARIANTS_KEY];
+    [archiver finishEncoding];
+    
+    NSError *writeError = nil;
+    NSString *variantsFileName = [self dataArchiveVariantsFileName];
+    NSString *filePath = [CTPreferences filePathfromFileName:variantsFileName];
+    NSDataWritingOptions fileProtectionOption = _config.enableFileProtection ?
+    NSDataWritingFileProtectionComplete : NSDataWritingAtomic;
+    [diffsData writeToFile:filePath options:fileProtectionOption error:&writeError];
+    if (writeError) {
+        CleverTapLogStaticInternal(@"%@ failed to write data at %@: %@", self, filePath, writeError);
+    }
+}
+
 - (void)clearUserContent {
     // Disable callbacks and wait until fetch is finished
     [self setHasVarsRequestCompleted:NO];
+    
+    // Clear variants for the old user
+    @synchronized (self) {
+        self.variants = @[];
+    }
+    
     // Clear Var state to allow callback invocation when server values are downloaded
     [self.vars enumerateKeysAndObjectsUsingBlock:^(NSString * _Nonnull key, id  _Nonnull obj, BOOL * _Nonnull stop) {
         CTVar *var = (CTVar *)obj;

CleverTapSDK/ProductExperiences/CTVarCache.m

@@ -29,6 +29,7 @@ NS_ASSUME_NONNULL_BEGIN
 NS_SWIFT_NAME(define(name:value:kind:));
 
 - (void)handleVariablesResponse:(NSDictionary *)varsResponse;
+- (void)handleVariantsResponse:(NSArray<NSDictionary<NSString *, id> *> *)variantsResponse;
 - (void)handleVariablesError;
 - (void)triggerFetchVariables:(BOOL)success;
 - (void)onVariablesChanged:(CleverTapVariablesChangedBlock _Nonnull)block;

CleverTapSDK/ProductExperiences/CTVariables.h

@@ -73,6 +73,13 @@ - (void)handleVariablesResponse:(NSDictionary *)varsResponse {
     }
 }
 
+- (void)handleVariantsResponse:(NSArray<NSDictionary<NSString *, id> *> *)variantsResponse {
+    if (variantsResponse && variantsResponse.count >= 0) {
+        CleverTapLogDebug(self.config.logLevel, @"%@: Handle Variants Response with: %@", self, variantsResponse);
+        [[self varCache] handleVariantsData:variantsResponse];
+    }
+}
+
 - (void)handleVariablesError {
     CleverTapLogDebug(self.config.logLevel, @"%@: Handle Variables Error", self);
     if (![[self varCache] hasVarsRequestCompleted]) {