Fixed get_variation validation issues. (#441)

yasirfolio3 · jaeopt · commit 65c078b9862f · 2020-01-13T13:05:51.000-08:00
diff --git a/OptimizelySDKCore/OptimizelySDKCore/OPTLYLoggerMessages.h b/OptimizelySDKCore/OptimizelySDKCore/OPTLYLoggerMessages.h
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2017-2019, Optimizely, Inc. and contributors                   *
+ * Copyright 2017-2020, Optimizely, Inc. and contributors                   *
  *                                                                          *
  * Licensed under the Apache License, Version 2.0 (the "License");          *
  * you may not use this file except in compliance with the License.         *
@@ -31,6 +31,8 @@ extern NSString *const OPTLYLoggerMessagesConversionFailure;
 extern NSString *const OPTLYLoggerMessagesUserIdInvalid;
 extern NSString *const OPTLYLoggerMessagesActivateExperimentKeyEmpty;
 extern NSString *const OPTLYLoggerMessagesActivateExperimentKeyInvalid;
+extern NSString *const OPTLYLoggerMessagesGetVariationExperimentKeyEmpty;
+extern NSString *const OPTLYLoggerMessagesGetVariationExperimentKeyInvalid;
 extern NSString *const OPTLYLoggerMessagesTrackEventKeyEmpty;
 extern NSString *const OPTLYLoggerMessagesTrackEventKeyInvalid;
 extern NSString *const OPTLYLoggerMessagesTrackEventNoAssociation;
diff --git a/OptimizelySDKCore/OptimizelySDKCore/OPTLYLoggerMessages.m b/OptimizelySDKCore/OptimizelySDKCore/OPTLYLoggerMessages.m
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2017-2019, Optimizely, Inc. and contributors                   *
+ * Copyright 2017-2020, Optimizely, Inc. and contributors                   *
  *                                                                          *
  * Licensed under the Apache License, Version 2.0 (the "License");          *
  * you may not use this file except in compliance with the License.         *
@@ -27,6 +27,8 @@
 NSString *const OPTLYLoggerMessagesUserIdInvalid = @"[OPTIMIZELY] User ID cannot be nil or an empty string.";
 NSString *const OPTLYLoggerMessagesActivateExperimentKeyEmpty = @"[OPTIMIZELY] Experiment Key cannot be nil or an empty string.";
 NSString *const OPTLYLoggerMessagesActivateExperimentKeyInvalid = @"[OPTIMIZELY] Experiment not found for Key %@.";
+NSString *const OPTLYLoggerMessagesGetVariationExperimentKeyEmpty = @"[OPTIMIZELY] Experiment Key cannot be nil or an empty string.";
+NSString *const OPTLYLoggerMessagesGetVariationExperimentKeyInvalid = @"[OPTIMIZELY] Experiment not found for Key %@.";
 NSString *const OPTLYLoggerMessagesTrackEventKeyEmpty = @"[OPTIMIZELY] Event Key cannot be nil or an empty string.";
 NSString *const OPTLYLoggerMessagesTrackEventKeyInvalid = @"[OPTIMIZELY] Event not found for Key %@.";
 NSString *const OPTLYLoggerMessagesTrackEventNoAssociation = @"[OPTIMIZELY] Event key %@ is not associated with any experiment.";
diff --git a/OptimizelySDKCore/OptimizelySDKCore/Optimizely.m b/OptimizelySDKCore/OptimizelySDKCore/Optimizely.m
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2017-2019, Optimizely, Inc. and contributors                   *
+ * Copyright 2017-2020, Optimizely, Inc. and contributors                   *
  *                                                                          *
  * Licensed under the Apache License, Version 2.0 (the "License");          *
  * you may not use this file except in compliance with the License.         *
@@ -172,11 +172,31 @@ - (OPTLYVariation *)variation:(NSString *)experimentKey
                        userId:(NSString *)userId
                    attributes:(NSDictionary<NSString *, id> *)attributes
 {
+    
+    NSMutableDictionary<NSString *, NSString *> *inputValues = [[NSMutableDictionary alloc] initWithDictionary:@{
+                        OPTLYNotificationUserIdKey:[self ObjectOrNull:userId],
+                        OPTLYNotificationExperimentKey:[self ObjectOrNull:experimentKey]}];
+    NSDictionary <NSString *, NSString *> *logs = @{
+        OPTLYNotificationUserIdKey:OPTLYLoggerMessagesUserIdInvalid,
+        OPTLYNotificationExperimentKey:OPTLYLoggerMessagesGetVariationExperimentKeyEmpty};
+    
+    if (![self validateStringInputs:inputValues logs:logs]) {
+        return nil;
+    }
+    
+    // get experiment
+    OPTLYExperiment *experiment = [self.config getExperimentForKey:experimentKey];
+
+    if (!experiment) {
+        NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesGetVariationExperimentKeyInvalid, experimentKey];
+        [self.logger logMessage:logMessage withLevel:OptimizelyLogLevelError];
+        return nil;
+    }
+
     OPTLYVariation *bucketedVariation = [self.config getVariationForExperiment:experimentKey
                                                                         userId:userId
                                                                     attributes:attributes
                                                                       bucketer:self.bucketer];
-    OPTLYExperiment *experiment = [self.config getExperimentForKey:experimentKey];
     NSString *decisionType = [self.config isFeatureExperiment:experiment.experimentId] ? OPTLYDecisionTypeFeatureTest : OPTLYDecisionTypeABTest;
     
     NSMutableDictionary *args = [[NSMutableDictionary alloc] init];
diff --git a/OptimizelySDKCore/OptimizelySDKCoreTests/OptimizelyTest.m b/OptimizelySDKCore/OptimizelySDKCoreTests/OptimizelyTest.m
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2016-2019, Optimizely, Inc. and contributors                   *
+ * Copyright 2016-2020, Optimizely, Inc. and contributors                   *
  *                                                                          *
  * Licensed under the Apache License, Version 2.0 (the "License");          *
  * you may not use this file except in compliance with the License.         *
@@ -255,28 +255,63 @@ - (void)testDecisionNotificationForBasicGetVariation {
     XCTAssertNotNil(experiment);
     OPTLYVariation *variation;
     
-    // test just experiment key
+    __block NSString *decisionNotificationExperimentKey = nil;
+    __block NSString *decisionNotificationVariationKey = nil;
+    
+    [self.optimizely.notificationCenter addDecisionNotificationListener:^(NSString * _Nonnull type, NSString * _Nonnull userId, NSDictionary<NSString *,id> * _Nullable attributes, NSDictionary<NSString *,id> * _Nonnull decisionInfo) {
+        decisionNotificationExperimentKey = decisionInfo[ExperimentDecisionInfo.ExperimentKey];
+        decisionNotificationVariationKey = decisionInfo[ExperimentDecisionInfo.VariationKey];
+    }];
+    
     variation = [self.optimizely variation:experimentKey userId:kUserId];
     XCTAssertNotNil(variation);
     XCTAssertTrue([variation.variationKey isEqualToString:@"control"]);
     XCTAssertTrue([variation.variationId isEqualToString:@"6384330451"]);
+    XCTAssertEqualObjects(decisionNotificationExperimentKey, experimentKey);
+    XCTAssertEqualObjects(decisionNotificationVariationKey, variation.variationKey);
+}
+
+- (void)testDecisionNotificationForBadExperimentKey {
+    __block NSString *decisionNotificationExperimentKey = nil;
+    __block NSString *decisionNotificationVariationKey = nil;
+    NSString *experimentKey = @"badKey";
+    OPTLYExperiment *experiment = [self.optimizely.config getExperimentForKey:experimentKey];
     
-    // test with bad experiment key
+    XCTAssertNil(experiment);
+    OPTLYVariation *variation;
     
+    [self.optimizely.notificationCenter addDecisionNotificationListener:^(NSString * _Nonnull type, NSString * _Nonnull userId, NSDictionary<NSString *,id> * _Nullable attributes, NSDictionary<NSString *,id> * _Nonnull decisionInfo) {
+        decisionNotificationExperimentKey = decisionInfo[ExperimentDecisionInfo.ExperimentKey];
+        decisionNotificationVariationKey = decisionInfo[ExperimentDecisionInfo.VariationKey];
+    }];
+    
+    variation = [self.optimizely variation:experimentKey userId:kUserId];
+    XCTAssertNil(variation);
+    XCTAssertNil(decisionNotificationExperimentKey);
+    XCTAssertNil(decisionNotificationVariationKey);
+}
+
+- (void)testDecisionNotificationForEmptyExperimentKey {
     __block NSString *decisionNotificationExperimentKey = nil;
     __block NSString *decisionNotificationVariationKey = nil;
+    NSString *experimentKey = @"";
+    OPTLYExperiment *experiment = [self.optimizely.config getExperimentForKey:experimentKey];
+    
+    XCTAssertNil(experiment);
+    OPTLYVariation *variation;
     
     [self.optimizely.notificationCenter addDecisionNotificationListener:^(NSString * _Nonnull type, NSString * _Nonnull userId, NSDictionary<NSString *,id> * _Nullable attributes, NSDictionary<NSString *,id> * _Nonnull decisionInfo) {
         decisionNotificationExperimentKey = decisionInfo[ExperimentDecisionInfo.ExperimentKey];
         decisionNotificationVariationKey = decisionInfo[ExperimentDecisionInfo.VariationKey];
     }];
     
-    variation = [self.optimizely variation:@"bad" userId:kUserId];
+    variation = [self.optimizely variation:experimentKey userId:kUserId];
     XCTAssertNil(variation);
-    XCTAssertEqualObjects(decisionNotificationExperimentKey, @"bad");
-    XCTAssertEqualObjects(decisionNotificationVariationKey, [NSNull null]);
+    XCTAssertNil(decisionNotificationExperimentKey);
+    XCTAssertNil(decisionNotificationVariationKey);
 }
 
+
 // Test whitelisting works with get variation
 - (void)testDecisionNotificationForVariationWhitelisting {
     NSData *datafile = [OPTLYTestHelper loadJSONDatafileIntoDataObject:kBucketerTestDatafileName];
