Implements inputs validator (#103)

Author: rashidsp

lib/optimizely.rb

@@ -105,6 +105,13 @@ def activate(experiment_key, user_id, attributes = nil)
         return nil
       end
 
+      return nil unless Optimizely::Helpers::Validator.inputs_valid?(
+        {
+          experiment_key: experiment_key,
+          user_id: user_id
+        }, @logger, Logger::ERROR
+      )
+
       variation_key = get_variation(experiment_key, user_id, attributes)
 
       if variation_key.nil?
@@ -135,10 +142,12 @@ def get_variation(experiment_key, user_id, attributes = nil)
         return nil
       end
 
-      if user_id.to_s.empty?
-        @logger.log(Logger::ERROR, 'User ID cannot be empty.')
-        return nil
-      end
+      return nil unless Optimizely::Helpers::Validator.inputs_valid?(
+        {
+          experiment_key: experiment_key,
+          user_id: user_id
+        }, @logger, Logger::ERROR
+      )
 
       unless user_inputs_valid?(attributes)
         @logger.log(Logger::INFO, "Not activating user '#{user_id}.")
@@ -196,10 +205,12 @@ def track(event_key, user_id, attributes = nil, event_tags = nil)
         return nil
       end
 
-      if user_id.to_s.empty?
-        @logger.log(Logger::ERROR, 'User ID cannot be empty.')
-        return nil
-      end
+      return nil unless Optimizely::Helpers::Validator.inputs_valid?(
+        {
+          event_key: event_key,
+          user_id: user_id
+        }, @logger, Logger::ERROR
+      )
 
       return nil unless user_inputs_valid?(attributes, event_tags)
 
@@ -254,15 +265,12 @@ def is_feature_enabled(feature_flag_key, user_id, attributes = nil)
         return false
       end
 
-      unless feature_flag_key
-        @logger.log(Logger::ERROR, 'Feature flag key cannot be empty.')
-        return false
-      end
-
-      if user_id.to_s.empty?
-        @logger.log(Logger::ERROR, 'User ID cannot be empty.')
-        return false
-      end
+      return false unless Optimizely::Helpers::Validator.inputs_valid?(
+        {
+          feature_flag_key: feature_flag_key,
+          user_id: user_id
+        }, @logger, Logger::ERROR
+      )
 
       feature_flag = @config.get_feature_flag_from_key(feature_flag_key)
       unless feature_flag
@@ -312,6 +320,8 @@ def get_enabled_features(user_id, attributes = nil)
         return enabled_features
       end
 
+      return enabled_features unless Optimizely::Helpers::Validator.inputs_valid?({user_id: user_id}, @logger, Logger::ERROR)
+
       @config.feature_flags.each do |feature|
         enabled_features.push(feature['key']) if is_feature_enabled(
           feature['key'],
@@ -426,20 +436,15 @@ def get_feature_variable_for_type(feature_flag_key, variable_key, variable_type,
       # Returns nil if the feature flag or variable or user ID is empty
       #             in case of variable type mismatch
 
-      unless feature_flag_key
-        @logger.log(Logger::ERROR, 'Feature flag key cannot be empty.')
-        return nil
-      end
-
-      unless variable_key
-        @logger.log(Logger::ERROR, 'Variable key cannot be empty.')
-        return nil
-      end
-
-      if user_id.to_s.empty?
-        @logger.log(Logger::ERROR, 'User ID cannot be empty.')
-        return nil
-      end
+      return nil unless Optimizely::Helpers::Validator.inputs_valid?(
+        {
+          feature_flag_key: feature_flag_key,
+          variable_key: variable_key,
+          variable_type: variable_type,
+          user_id: user_id
+        },
+        @logger, Logger::ERROR
+      )
 
       feature_flag = @config.get_feature_flag_from_key(feature_flag_key)
       unless feature_flag

lib/optimizely/helpers/constants.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2016-2017, Optimizely and contributors
+#    Copyright 2016-2018, Optimizely and contributors
 #
 #    Licensed under the Apache License, Version 2.0 (the "License");
 #    you may not use this file except in compliance with the License.
@@ -306,6 +306,15 @@ module Constants
         'INTEGER' => 'integer',
         'STRING' => 'string'
       }.freeze
+
+      INPUT_VARIABLES = {
+        'FEATURE_FLAG_KEY' => 'Feature flag key',
+        'EXPERIMENT_KEY' => 'Experiment key',
+        'USER_ID' => 'User ID',
+        'VARIATION_KEY' => 'Variation key',
+        'VARIABLE_KEY' => 'Variable key',
+        'VARIABLE_TYPE' => 'Variable type'
+      }.freeze
     end
   end
 end

lib/optimizely/helpers/validator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2016-2017, Optimizely and contributors
+#    Copyright 2016-2018, Optimizely and contributors
 #
 #    Licensed under the Apache License, Version 2.0 (the "License");
 #    you may not use this file except in compliance with the License.
@@ -95,6 +95,27 @@ def string_numeric?(str)
       rescue
         false
       end
+
+      def inputs_valid?(variables, logger = NoOpLogger.new, level = Logger::ERROR)
+        # Determines if values of variables in given array are non empty string.
+        #
+        # variables - array values to validate.
+        #
+        # logger - logger.
+        #
+        # Returns boolean True if all of the values are valid, False otherwise.
+
+        return false unless variables.respond_to?(:each) && !variables.empty?
+        is_valid = true
+        variables.each do |key, value|
+          next if value.is_a?(String) && !value.empty?
+          is_valid = false
+          if logger_valid?(logger) && level
+            logger.log(level, "#{Optimizely::Helpers::Constants::INPUT_VARIABLES[key.to_s.upcase]} is invalid")
+          end
+        end
+        is_valid
+      end
     end
   end
 end

lib/optimizely/project_config.rb

@@ -15,6 +15,7 @@
 #    limitations under the License.
 #
 require 'json'
+require_relative 'helpers/validator'
 
 module Optimizely
   V1_CONFIG_VERSION = '1'
@@ -275,11 +276,12 @@ def get_forced_variation(experiment_key, user_id)
       #
       # Returns Variation The variation which the given user and experiment should be forced into.
 
-      # check for nil and empty string user ID
-      if user_id.nil? || user_id.empty?
-        @logger.log(Logger::DEBUG, 'User ID is invalid')
-        return nil
-      end
+      return nil unless Optimizely::Helpers::Validator.inputs_valid?(
+        {
+          experiment_key: experiment_key,
+          user_id: user_id
+        }, @logger, Logger::DEBUG
+      )
 
       unless @forced_variation_map.key? user_id
         @logger.log(Logger::DEBUG, "User '#{user_id}' is not in the forced variation map.")
@@ -323,11 +325,12 @@ def set_forced_variation(experiment_key, user_id, variation_key)
       #
       # Returns a boolean value that indicates if the set completed successfully.
 
-      #  check for null and empty string user ID
-      if user_id.nil? || user_id.empty?
-        @logger.log(Logger::DEBUG, 'User ID is invalid')
-        return false
-      end
+      return false unless Optimizely::Helpers::Validator.inputs_valid?(
+        {
+          user_id: user_id,
+          experiment_key: experiment_key
+        }, @logger, Logger::DEBUG
+      )
 
       experiment = get_experiment_from_key(experiment_key)
       experiment_id = experiment['id'] if experiment

spec/project_config_spec.rb

@@ -859,6 +859,7 @@
       @valid_experiment = {id: '111127', key: 'test_experiment'}
       @valid_variation = {id: '111128', key: 'control'}
     end
+
     # User ID is nil
     it 'should log a message and return nil when user_id is passed as nil for get_forced_variation' do
       expect(config.get_forced_variation(@valid_experiment[:key], nil)).to eq(nil)
@@ -963,6 +964,26 @@
       @valid_variation_for_exp_2 = {id: '122228', key: 'control_with_audience'}
     end
 
+    it 'should call inputs_valid? with the proper arguments in set_forced_variation' do
+      expect(Optimizely::Helpers::Validator).to receive(:inputs_valid?).with(
+        {
+          user_id: @user_id,
+          experiment_key: @valid_experiment[:key]
+        }, spy_logger, Logger::DEBUG
+      )
+      config.set_forced_variation(@valid_experiment[:key], @user_id, @valid_variation[:key])
+    end
+
+    it 'should call inputs_valid? with the proper arguments in get_forced_variation' do
+      expect(Optimizely::Helpers::Validator).to receive(:inputs_valid?).with(
+        {
+          experiment_key: @valid_experiment[:key],
+          user_id: @user_id
+        }, spy_logger, Logger::DEBUG
+      )
+      config.get_forced_variation(@valid_experiment[:key], @user_id)
+    end
+
     # Call set variation with different variations on one user/experiment to confirm that each set is expected.
     it 'should set and return expected variations when different variations are set and removed for one user/experiment' do
       expect(config.set_forced_variation(@valid_experiment[:key], @user_id, @valid_variation[:key])).to eq(true)