fix: Rokt User Attribute Mapping

Author: BrandonStalnaker

UnitTests/ObjCTests/MPRoktTests.m

@@ -293,17 +293,19 @@ - (void)testGetRoktPlacementAttributesMapping {
     self.mockInstance = OCMPartialMock(instance);
     self.mockContainer = OCMClassMock([MPKitContainer_PRIVATE class]);
     NSArray *kitConfig = @[@{
-        @"AllowJavaScriptResponse": @"True",
-        @"accountId": @12345,
-        @"onboardingExpProvider": @"None",
-        kMPPlacementAttributesMapping: @"[{\"jsmap\":null,\"map\":\"f.name\",\"maptype\":\"UserAttributeClass.Name\",\"value\":\"firstname\"},{\"jsmap\":null,\"map\":\"zip\",\"maptype\":\"UserAttributeClass.Name\",\"value\":\"billingzipcode\"},{\"jsmap\":null,\"map\":\"l.name\",\"maptype\":\"UserAttributeClass.Name\",\"value\":\"lastname\"}]",
-        @"sandboxMode": @"True",
-        @"eau": @0,
-        @"hs": @{
-            @"pur": @{},
-            @"reg": @{}
-        },
-        @"id": @181
+        @"id": @181,
+        kMPRemoteConfigKitConfigurationKey: @{
+            @"AllowJavaScriptResponse": @"True",
+            @"accountId": @12345,
+            @"onboardingExpProvider": @"None",
+            kMPPlacementAttributesMapping: @"[{\"jsmap\":null,\"map\":\"f.name\",\"maptype\":\"UserAttributeClass.Name\",\"value\":\"firstname\"},{\"jsmap\":null,\"map\":\"zip\",\"maptype\":\"UserAttributeClass.Name\",\"value\":\"billingzipcode\"},{\"jsmap\":null,\"map\":\"l.name\",\"maptype\":\"UserAttributeClass.Name\",\"value\":\"lastname\"}]",
+            @"sandboxMode": @"True",
+            @"eau": @0,
+            @"hs": @{
+                @"pur": @{},
+                @"reg": @{}
+            }
+        }
     }];
     [[[self.mockContainer stub] andReturn:kitConfig] originalConfig];
     [[[self.mockInstance stub] andReturn:self.mockContainer] kitContainer_PRIVATE];
@@ -315,6 +317,49 @@ - (void)testGetRoktPlacementAttributesMapping {
     XCTAssertEqualObjects(testResult, expectedResult, @"Mapping does not match .");
 }
 
+- (void)testGetRoktHashedEmailUserIdentityType {
+    MParticle *instance = [MParticle sharedInstance];
+    self.mockInstance = OCMPartialMock(instance);
+    self.mockContainer = OCMClassMock([MPKitContainer_PRIVATE class]);
+    NSArray *kitConfig = @[@{
+        @"id": @181,
+        kMPRemoteConfigKitConfigurationKey: @{
+            @"AllowJavaScriptResponse": @"True",
+            @"accountId": @12345,
+            kMPHashedEmailUserIdentityType: @"other3",
+            @"sandboxMode": @"True"
+        }
+    }];
+    [[[self.mockContainer stub] andReturn:kitConfig] originalConfig];
+    [[[self.mockInstance stub] andReturn:self.mockContainer] kitContainer_PRIVATE];
+    [[[self.mockInstance stub] andReturn:self.mockInstance] sharedInstance];
+    
+    NSNumber *testResult = [self.rokt getRoktHashedEmailUserIdentityType];
+    
+    XCTAssertEqualObjects(testResult, @(MPIdentityOther3), @"Hashed email identity type does not match.");
+}
+
+- (void)testGetRoktHashedEmailUserIdentityTypeReturnsNilWhenNotConfigured {
+    MParticle *instance = [MParticle sharedInstance];
+    self.mockInstance = OCMPartialMock(instance);
+    self.mockContainer = OCMClassMock([MPKitContainer_PRIVATE class]);
+    NSArray *kitConfig = @[@{
+        @"id": @181,
+        kMPRemoteConfigKitConfigurationKey: @{
+            @"AllowJavaScriptResponse": @"True",
+            @"accountId": @12345,
+            @"sandboxMode": @"True"
+        }
+    }];
+    [[[self.mockContainer stub] andReturn:kitConfig] originalConfig];
+    [[[self.mockInstance stub] andReturn:self.mockContainer] kitContainer_PRIVATE];
+    [[[self.mockInstance stub] andReturn:self.mockInstance] sharedInstance];
+    
+    NSNumber *testResult = [self.rokt getRoktHashedEmailUserIdentityType];
+    
+    XCTAssertNil(testResult, @"Hashed email identity type should be nil when not configured.");
+}
+
 - (void)testSelectPlacementsIdentifyUser {
     [[[self.mockRokt stub] andReturn:@[]] getRoktPlacementAttributesMapping];
     MParticle *instance = [MParticle sharedInstance];

mParticle-Apple-SDK/MPIConstants.h

@@ -241,6 +241,7 @@ extern NSString * _Nonnull const kMPRemoteConfigAppDefined;
 extern NSString * _Nonnull const kMPRemoteConfigForceTrue;
 extern NSString * _Nonnull const kMPRemoteConfigForceFalse;
 extern NSString * _Nonnull const kMPRemoteConfigKitsKey;
+extern NSString * _Nonnull const kMPRemoteConfigKitConfigurationKey;
 extern NSString * _Nonnull const kMPRemoteConfigKitHashesKey;
 extern NSString * _Nonnull const kMPRemoteConfigConsumerInfoKey;
 extern NSString * _Nonnull const kMPRemoteConfigCookiesKey;

mParticle-Apple-SDK/MPIConstants.m

@@ -194,6 +194,7 @@
 NSString *const kMPRemoteConfigForceTrue = @"forcetrue";
 NSString *const kMPRemoteConfigForceFalse = @"forcefalse";
 NSString *const kMPRemoteConfigKitsKey = @"eks";
+NSString *const kMPRemoteConfigKitConfigurationKey = @"as";
 NSString *const kMPRemoteConfigKitHashesKey = @"hs";
 NSString *const kMPRemoteConfigConsumerInfoKey = @"ci";
 NSString *const kMPRemoteConfigCookiesKey = @"ck";

mParticle-Apple-SDK/MPRokt.m

@@ -155,8 +155,9 @@ - (void)close {
     NSData *dataAttributeMap;
     // Rokt Kit is available though there may not be an attribute map
     attributeMap = @[];
-    if (roktKitConfig[kMPPlacementAttributesMapping] != [NSNull null]) {
-        strAttributeMap = [roktKitConfig[kMPPlacementAttributesMapping] stringByRemovingPercentEncoding];
+    id configJSONString = roktKitConfig[kMPRemoteConfigKitConfigurationKey][kMPPlacementAttributesMapping];
+    if (configJSONString != nil && configJSONString != [NSNull null]) {
+        strAttributeMap = [configJSONString stringByRemovingPercentEncoding];
         dataAttributeMap = [strAttributeMap dataUsingEncoding:NSUTF8StringEncoding];
     }
 
@@ -167,12 +168,13 @@ - (void)close {
         @try {
             attributeMap = [NSJSONSerialization JSONObjectWithData:dataAttributeMap options:kNilOptions error:&error];
         } @catch (NSException *exception) {
+            MPILogVerbose(@"Exception parsing placement attribute map: %@", exception);
         }
 
         if (attributeMap && !error) {
-            NSLog(@"%@", attributeMap);
+            MPILogVerbose(@"Successfully parsed placement attribute map with %lu entries", (unsigned long)attributeMap.count);
         } else {
-            NSLog(@"%@", error);
+            MPILogVerbose(@"Failed to parse placement attribute map: %@", error);
         }
     }
 
@@ -190,7 +192,7 @@ - (NSNumber *)getRoktHashedEmailUserIdentityType {
     }
 
     // Get the string representing which identity to use and convert it to the key (NSNumber)
-    NSString *hashedIdentityTypeString = roktKitConfig[kMPHashedEmailUserIdentityType];
+    NSString *hashedIdentityTypeString = roktKitConfig[kMPRemoteConfigKitConfigurationKey][kMPHashedEmailUserIdentityType];
     NSNumber *hashedIdentityTypeNumber = [MPIdentityHTTPIdentities identityTypeForString:hashedIdentityTypeString.lowercaseString];
 
     return hashedIdentityTypeNumber;
@@ -233,19 +235,19 @@ - (void)confirmUser:(NSDictionary<NSString *, NSString *> * _Nullable)attributes
 
         [[[MParticle sharedInstance] identity] identify:identityRequest completion:^(MPIdentityApiResult *_Nullable apiResult, NSError *_Nullable error) {
             if (error) {
-                NSLog(@"Failed to sync email from selectPlacement to user: %@", error);
+                MPILogVerbose(@"Failed to sync email from selectPlacement to user: %@", error);
                 completion(user);
             } else {
-                NSLog(@"Updated user identity based off selectPlacement's attributes: %@", apiResult.user.identities);
+                MPILogVerbose(@"Updated user identity based off selectPlacement's attributes: %@", apiResult.user.identities);
                 completion(apiResult.user);
             }
         }];
 
         // Warn the customer if we had to identify and therefore delay their Rokt placement.
         if (shouldIdentifyFromEmail) {
-            NSLog(@"The existing email on the user (%@) does not match the email passed in to `selectPlacements:` (%@). Please remember to sync the email identity to mParticle as soon as you receive it. We will now identify the user before continuing to `selectPlacements:`", user.identities[@(MPIdentityEmail)], email);
+            MPILogVerbose(@"The existing email on the user (%@) does not match the email passed in to `selectPlacements:` (%@). Please remember to sync the email identity to mParticle as soon as you receive it. We will now identify the user before continuing to `selectPlacements:`", user.identities[@(MPIdentityEmail)], email);
         } else if (shouldIdentifyFromHash) {
-            NSLog(@"The existing hashed email on the user (%@) does not match the email passed in to `selectPlacements:` (%@). Please remember to sync the email identity to mParticle as soon as you receive it. We will now identify the user before continuing to `selectPlacements:`", user.identities[hashedEmailIdentity], hashedEmail);
+            MPILogVerbose(@"The existing hashed email on the user (%@) does not match the email passed in to `selectPlacements:` (%@). Please remember to sync the email identity to mParticle as soon as you receive it. We will now identify the user before continuing to `selectPlacements:`", user.identities[hashedEmailIdentity], hashedEmail);
         }
     } else {
         completion(user);