Merge pull request #459 from splitio/dw/SDKS-6908

[DW] split_client updated logs

Author: sanzmauro

lib/splitclient-rb/clients/split_client.rb

@@ -11,11 +11,11 @@ class SplitClient
     #
     # Creates a new split client instance that connects to split.io API.
     #
-    # @param api_key [String] the API key for your split account
+    # @param sdk_key [String] the SDK key for your split account
     #
     # @return [SplitIoClient] split.io client instance
-    def initialize(api_key, repositories, status_manager, config, impressions_manager, telemetry_evaluation_producer)
-      @api_key = api_key
+    def initialize(sdk_key, repositories, status_manager, config, impressions_manager, telemetry_evaluation_producer)
+      @api_key = sdk_key
       @splits_repository = repositories[:splits]
       @segments_repository = repositories[:segments]
       @impressions_repository = repositories[:impressions]
@@ -103,8 +103,8 @@ def track(key, traffic_type_name, event_type, value = nil, properties = nil)
 
       if ready? && !@config.localhost_mode && !@splits_repository.traffic_type_exists(traffic_type_name)
         @config.logger.warn("track: Traffic Type #{traffic_type_name} " \
-          "does not have any corresponding Splits in this environment, make sure you're tracking " \
-          'your events to a valid traffic type defined in the Split console')
+          "does not have any corresponding feature flags in this environment, make sure you're tracking " \
+          'your events to a valid traffic type defined in the Split user interface')
       end
 
       @events_repository.add(key.to_s, traffic_type_name.downcase, event_type.to_s, (Time.now.to_f * 1000).to_i, value, properties, properties_size)
@@ -147,10 +147,10 @@ def sanitize_split_names(calling_method, split_names)
         if (split_name.is_a?(String) || split_name.is_a?(Symbol)) && !split_name.empty?
           true
         elsif split_name.is_a?(String) && split_name.empty?
-          @config.logger.warn("#{calling_method}: you passed an empty split_name, split_name must be a non-empty String or a Symbol")
+          @config.logger.warn("#{calling_method}: you passed an empty feature_flag_name, flag name must be a non-empty String or a Symbol")
           false
         else
-          @config.logger.warn("#{calling_method}: you passed an invalid split_name, split_name must be a non-empty String or a Symbol")
+          @config.logger.warn("#{calling_method}: you passed an invalid feature_flag_name, flag name must be a non-empty String or a Symbol")
           false
         end
       end
@@ -200,7 +200,7 @@ def treatments(key, split_names, attributes = {}, calling_method = 'get_treatmen
       sanitized_split_names = sanitize_split_names(calling_method, split_names)
 
       if sanitized_split_names.empty?
-        @config.logger.error("#{calling_method}: split_names must be a non-empty Array")
+        @config.logger.error("#{calling_method}: feature_flag_names must be a non-empty Array")
         return {}
       end
 
@@ -258,7 +258,7 @@ def treatment(
       sanitized_split_name = split_name.to_s.strip
 
       if split_name.to_s != sanitized_split_name
-        @config.logger.warn("#{calling_method}: split_name #{split_name} has extra whitespace, trimming")
+        @config.logger.warn("#{calling_method}: feature_flag_name #{split_name} has extra whitespace, trimming")
         split_name = sanitized_split_name
       end
 
@@ -271,7 +271,7 @@ def treatment(
 
         if split.nil? && ready?
           @config.logger.warn("#{calling_method}: you passed #{split_name} that " \
-            'does not exist in this environment, please double check what Splits exist in the web console')
+            'does not exist in this environment, please double check what feature flags exist in the Split user interface')
 
           return parsed_treatment(multiple, control_treatment.merge({ label: Engine::Models::Label::NOT_FOUND }))
         end

lib/splitclient-rb/validators.rb

@@ -156,7 +156,7 @@ def valid_bucketing_key?(method, key, bucketing_key)
 
     def valid_split_names?(method, split_names)
       unless !split_names.nil? && split_names.is_a?(Array)
-        @config.logger.error("#{method}: split_names must be a non-empty Array")
+        @config.logger.error("#{method}: feature_flag_names must be a non-empty Array")
         return false
       end
 

spec/engine_spec.rb

@@ -282,7 +282,7 @@
       it 'trims split_name and logs warning when extra whitespaces' do
         split_name = ' test_feature  '
         expect(subject.get_treatment('fake_user_id_1', split_name)).to eq 'on'
-        expect(log.string).to include "get_treatment: split_name #{split_name} has extra whitespace, trimming"
+        expect(log.string).to include "get_treatment: feature_flag_name #{split_name} has extra whitespace, trimming"
       end
 
       it 'returns CONTROL when non Hash attributes' do
@@ -295,8 +295,8 @@
         expect(subject.get_treatment('random_user_id', 'non_existing_feature'))
           .to eq SplitIoClient::Engine::Models::Treatment::CONTROL
         expect(log.string).to include 'get_treatment: you passed non_existing_feature ' \
-          'that does not exist in this environment, please double check what Splits exist ' \
-          'in the web console'
+          'that does not exist in this environment, please double check what feature flags exist ' \
+          'in the Split user interface'
       end
 
       it 'returns CONTROL with NOT_READY label when not ready' do
@@ -366,17 +366,17 @@
 
       it 'returns empty hash on nil split_names' do
         expect(subject.get_treatments('random_user_id', nil)).to be_nil
-        expect(log.string).to include 'get_treatments: split_names must be a non-empty Array'
+        expect(log.string).to include 'get_treatments: feature_flag_names must be a non-empty Array'
       end
 
       it 'returns empty hash when no Array split_names' do
         expect(subject.get_treatments('random_user_id', Object.new)).to be_nil
-        expect(log.string).to include 'get_treatments: split_names must be a non-empty Array'
+        expect(log.string).to include 'get_treatments: feature_flag_names must be a non-empty Array'
       end
 
       it 'returns empty hash on empty array split_names' do
         expect(subject.get_treatments('random_user_id', [])).to eq({})
-        expect(log.string).to include 'get_treatments: split_names must be a non-empty Array'
+        expect(log.string).to include 'get_treatments: feature_flag_names must be a non-empty Array'
       end
 
       it 'sanitizes split_names removing repeating and nil split_names' do
@@ -386,14 +386,14 @@
 
       it 'warns when non string split_names' do
         expect(subject.get_treatments('random_user_id', [Object.new, Object.new])).to eq({})
-        expect(log.string).to include 'get_treatments: you passed an invalid split_name, ' \
-          'split_name must be a non-empty String or a Symbol'
+        expect(log.string).to include 'get_treatments: you passed an invalid feature_flag_name, ' \
+          'flag name must be a non-empty String or a Symbol'
       end
 
       it 'warns when empty split_names' do
         expect(subject.get_treatments('random_user_id', [''])).to eq({})
-        expect(log.string).to include 'get_treatments: you passed an empty split_name, ' \
-          'split_name must be a non-empty String or a Symbol'
+        expect(log.string).to include 'get_treatments: you passed an empty feature_flag_name, ' \
+          'flag name must be a non-empty String or a Symbol'
       end
     end
 
@@ -953,8 +953,8 @@
 
         expect(subject.track('123', traffic_type_name, 'event_type', 123)).to be true
         expect(log.string).to include "track: Traffic Type #{traffic_type_name} " \
-          "does not have any corresponding Splits in this environment, make sure you're tracking " \
-          'your events to a valid traffic type defined in the Split console'
+          "does not have any corresponding feature flags in this environment, make sure you're tracking " \
+          'your events to a valid traffic type defined in the Split user interface'
       end
     end
   end