Fix isFeatureEnabled to always return a boolean value. (#79)

Author: mikeproeng37

lib/optimizely.rb

@@ -160,7 +160,7 @@ def set_forced_variation(experiment_key, user_id, variation_key)
       #
       # experiment_key - String - key identifying the experiment.
       # user_id - String - The user ID to be used for bucketing.
-      # variation_key - The variation key specifies the variation which the user will 
+      # variation_key - The variation key specifies the variation which the user will
       #   be forced into. If nil, then clear the existing experiment-to-variation mapping.
       #
       # Returns - Boolean - indicates if the set completed successfully.
@@ -234,10 +234,12 @@ def track(event_key, user_id, attributes = nil, event_tags = nil)
       rescue => e
         @logger.log(Logger::ERROR, "Unable to dispatch conversion event. Error: #{e}")
       end
+
       @notification_center.send_notifications(
           NotificationCenter::NOTIFICATION_TYPES[:TRACK],
           event_key, user_id, attributes, event_tags, conversion_event
       )
+      return nil
     end
 
     def is_feature_enabled(feature_flag_key, user_id, attributes = nil)
@@ -255,7 +257,7 @@ def is_feature_enabled(feature_flag_key, user_id, attributes = nil)
       unless @is_valid
         logger = SimpleLogger.new
         logger.log(Logger::ERROR, InvalidDatafileError.new('is_feature_enabled').message)
-        return nil
+        return false
       end
 
       feature_flag = @config.get_feature_flag_from_key(feature_flag_key)
@@ -408,7 +410,7 @@ def get_feature_variable_for_type(feature_flag_key, variable_key, variable_type,
         @logger.log(Logger::INFO, "No feature flag was found for key '#{feature_flag_key}'.")
         return nil
       end
-      
+
       variable = @config.get_feature_variable(feature_flag, variable_key)
 
       # Error message logged in ProjectConfig- get_feature_flag_from_key

spec/project_spec.rb

@@ -121,6 +121,7 @@ class InvalidErrorHandler; end
     before(:example) do
       allow(Time).to receive(:now).and_return(time_now)
       allow(SecureRandom).to receive(:uuid).and_return('a68cf1ad-0393-4e18-af87-efe8f01a7c9c');
+
       @expected_activate_params = {
         account_id: '12001',
         project_id: '111001',
@@ -271,7 +272,7 @@ class InvalidErrorHandler; end
        instance_of(Optimizely::Event)
       )
       project_instance.activate('test_experiment', 'test_user')
-      
+
       expect(spy_logger).to have_received(:log).once.with(Logger::INFO, include("Dispatching impression event to" \
                                                                                 " URL #{impression_log_url} with params #{params}"))
     end
@@ -288,7 +289,7 @@ class InvalidErrorHandler; end
       expect { project_instance.activate('test_experiment', 'test_user', 'invalid') }
              .to raise_error(Optimizely::InvalidAttributeFormatError)
     end
-    
+
     it 'should override the audience check if the user is whitelisted to a specific variation' do
       params = @expected_activate_params
       params[:visitors][0][:visitor_id] = 'forced_audience_user'
@@ -330,7 +331,7 @@ class InvalidErrorHandler; end
     before(:example) do
       allow(Time).to receive(:now).and_return(time_now)
       allow(SecureRandom).to receive(:uuid).and_return('a68cf1ad-0393-4e18-af87-efe8f01a7c9c');
-      
+
       @expected_track_event_params = {
         account_id: '12001',
         project_id: '111001',
@@ -365,7 +366,7 @@ class InvalidErrorHandler; end
       project_instance.track('test_event', 'test_user')
       expect(project_instance.event_dispatcher).to have_received(:dispatch_event).with(Optimizely::Event.new(:post, conversion_log_url, params, post_headers)).once
     end
-    
+
     it 'should properly track an event by calling dispatch_event with right params after forced variation' do
       params = @expected_track_event_params
       params[:visitors][0][:snapshots][0][:decisions][0][:variation_id] = '111129'
@@ -548,15 +549,15 @@ class InvalidErrorHandler; end
       expect(project_instance.get_variation('test_experiment_with_audience', 'test_user', user_attributes))
              .to eq('control_with_audience')
     end
-    
+
     it 'should have get_variation return expected variation with bucketing id attribute when audience conditions match' do
       user_attributes = {
         'browser_type' => 'firefox',
         OptimizelySpec::RESERVED_ATTRIBUTE_KEY_BUCKETING_ID => 'pid'
-      } 
+      }
       expect(project_instance.get_variation('test_experiment_with_audience', 'test_user', user_attributes))
             .to eq('control_with_audience')
-    end    
+    end
 
     it 'should have get_variation return nil when attributes are invalid' do
       allow(project_instance).to receive(:attributes_valid?).and_return(false)
@@ -586,7 +587,7 @@ class InvalidErrorHandler; end
       user_attributes = {
         'browser_type' => 'firefox',
         OptimizelySpec::RESERVED_ATTRIBUTE_KEY_BUCKETING_ID => 'pid'
-      } 
+      }
       expect(project_instance.get_variation('test_experiment_not_started', 'test_user',user_attributes)).to eq(nil)
     end
 
@@ -647,12 +648,12 @@ class InvalidErrorHandler; end
       }
     end
 
-    it 'should return nil when called with invalid project config' do
+    it 'should return false when called with invalid project config' do
       invalid_project = Optimizely::Project.new('invalid',nil,spy_logger)
-      expect(invalid_project.is_feature_enabled('totally_invalid_feature_key', 'test_user')).to be nil
-      
+      expect(invalid_project.is_feature_enabled('totally_invalid_feature_key', 'test_user')).to be false
+
     end
-    
+
     it 'should return false when the feature flag key is invalid' do
       expect(project_instance.is_feature_enabled('totally_invalid_feature_key', 'test_user')).to be false
       expect(spy_logger).to have_received(:log).once.with(Logger::ERROR, "Feature flag key 'totally_invalid_feature_key' is not in datafile.")
@@ -691,14 +692,14 @@ class InvalidErrorHandler; end
           variation_to_return,
           Optimizely::DecisionService::DECISION_SOURCE_EXPERIMENT
       )
-      
+
       expect(project_instance.notification_center).to receive(:send_notifications)
       .with(
         Optimizely::NotificationCenter::NOTIFICATION_TYPES[:ACTIVATE],
         experiment_to_return, 'test_user', nil, variation_to_return,
         instance_of(Optimizely::Event)
       )
-      
+
       allow(project_instance.decision_service).to receive(:get_variation_for_feature).and_return(decision_to_return)
 
       expected_params = @expected_bucketed_params
@@ -976,7 +977,7 @@ class InvalidErrorHandler; end
       expect(project_instance.get_variation('test_experiment','test_user')). to eq('variation')
     end
 
-    # setForcedVariation on a running experiment with audience enabled and then call getVariation on that same experiment with invalid attributes. 
+    # setForcedVariation on a running experiment with audience enabled and then call getVariation on that same experiment with invalid attributes.
     it 'should return nil when getVariation called on audience enabled running experiment with invalid attributes' do
       project_instance.set_forced_variation('test_experiment_with_audience','test_user','control_with_audience')
       expect { project_instance.get_variation('test_experiment_with_audience', 'test_user', 'invalid') }
@@ -986,7 +987,7 @@ class InvalidErrorHandler; end
     # Adding this test case to cover this in code coverage. All test cases for getForceVariation are present in
     # project_config_spec.rb which test the get_force_variation method in project_config. The one in optimizely.rb
     # only calls the other one
-    
+
     # getForceVariation on a running experiment after setforcevariation
     it 'should return expected variation id  when get_forced_variation is called on a running experiment after setForcedVariation' do
       project_instance.set_forced_variation('test_experiment','test_user','variation')