Merge pull request #470 from splitio/development

[8.1.2] Development into Main

Author: sanzmauro

CHANGES.txt

@@ -1,5 +1,8 @@
 CHANGES
 
+8.1.2 (May 15, 2023)
+- Updated terminology on the SDKs codebase to be more aligned with current standard without causing a breaking change. The core change is the term split for feature flag on things like logs and IntelliSense comments.
+
 8.1.1 (Mar 17, 2023)
 - Added retries with backoff when the sdk tries to connect to the Streaming service and it is not available.
 - Updated the way that the sdk write mtks in redis.

README.md

@@ -1,8 +1,9 @@
 # Split SDK for Ruby
-![Build Status](https://github.com/splitio/ruby-client/actions/workflows/ci.yml/badge.svg?branch=master)
+[![build status](https://github.com/splitio/ruby-client/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/splitio/ruby-client/actions)
+[![Documentation](https://img.shields.io/badge/ruby_client-documentation-informational)](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
 
 ## Overview
-This SDK is designed to work with Split, the platform for controlled rollouts, which serves features to your users via a Split feature flag to manage your complete customer experience.
+This SDK is designed to work with Split, the platform for controlled rollouts, which serves features to your users via feature flags to manage your complete customer experience.
 
 [![Twitter Follow](https://img.shields.io/twitter/follow/splitsoftware.svg?style=social&label=Follow&maxAge=1529000)](https://twitter.com/intent/follow?screen_name=splitsoftware)
 
@@ -21,7 +22,7 @@ Below is a simple example that describes the instantiation and most basic usage
 ```ruby
 require 'splitclient-rb'
 
-split_factory = SplitIoClient::SplitFactory.new('SDK_API_KEY')
+split_factory = SplitIoClient::SplitFactory.new('YOUR_SDK_KEY')
 split_client = split_factory.client
 
 begin
@@ -30,7 +31,7 @@ rescue SplitIoClient::SDKBlockerTimeoutExpiredException
   puts 'SDK is not ready. Decide whether to continue or abort execution'
 end
 
-treatment = split_client.get_treatment('CUSTOMER_ID', 'SPLIT_NAME');
+treatment = split_client.get_treatment('CUSTOMER_ID', 'FEATURE_FLAG_NAME');
 
 if treatment == 'on'
   # insert code here to show on treatment
@@ -60,16 +61,21 @@ To learn more about Split, contact hello@split.io, or get started with feature f
 
 Split has built and maintains SDKs for:
 
+* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
+* Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
+* Angular [Github](https://github.com/splitio/angular-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/6495326064397-Angular-utilities)
+* GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
+* iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
 * Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)
-* Javascript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
+* JavaScript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
+* JavaScript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK)
 * Node [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
-* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
-* Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
 * PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
 * Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)
-* GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
-* Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
-* iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
+* React [Github](https://github.com/splitio/react-client) [Docs](https://help.split.io/hc/en-us/articles/360038825091-React-SDK)
+* React Native [Github](https://github.com/splitio/react-native-client) [Docs](https://help.split.io/hc/en-us/articles/4406066357901-React-Native-SDK)
+* Redux [Github](https://github.com/splitio/redux-client) [Docs](https://help.split.io/hc/en-us/articles/360038851551-Redux-SDK)
+* Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
 
 For a comprehensive list of open source projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
 

lib/splitclient-rb/cache/fetchers/split_fetcher.rb

@@ -49,12 +49,12 @@ def stop_splits_thread
 
         def splits_thread
           @config.threads[:split_fetcher] = Thread.new do
-            @config.logger.info('Starting splits fetcher service') if @config.debug_enabled
+            @config.logger.info('Starting feature flags fetcher service') if @config.debug_enabled
             loop do
               fetch_splits
 
               sleep_for = SplitIoClient::Cache::Stores::StoreUtils.random_interval(@config.features_refresh_rate)
-              @config.logger.debug("Splits fetcher is sleeping for: #{sleep_for} seconds") if @config.debug_enabled
+              @config.logger.debug("Feature flags fetcher is sleeping for: #{sleep_for} seconds") if @config.debug_enabled
               sleep(sleep_for)
             end
           end
@@ -66,7 +66,7 @@ def splits_since(since, fetch_options = { cache_control_headers: false, till: ni
 
         def add_split_unless_archived(split)
           if Engine::Models::Split.archived?(split)
-            @config.logger.debug("Seeing archived split #{split[:name]}") if @config.debug_enabled
+            @config.logger.debug("Seeing archived feature flag #{split[:name]}") if @config.debug_enabled
 
             remove_archived_split(split)
           else
@@ -75,13 +75,13 @@ def add_split_unless_archived(split)
         end
 
         def remove_archived_split(split)
-          @config.logger.debug("removing split from store(#{split})") if @config.debug_enabled
+          @config.logger.debug("removing feature flag from store(#{split})") if @config.debug_enabled
 
           @splits_repository.remove_split(split)
         end
 
         def store_split(split)
-          @config.logger.debug("storing split (#{split[:name]})") if @config.debug_enabled
+          @config.logger.debug("storing feature flag (#{split[:name]})") if @config.debug_enabled
 
           @splits_repository.add_split(split)
         end

lib/splitclient-rb/cache/stores/localhost_split_store.rb

@@ -31,7 +31,7 @@ def call
 
         def splits_thread
           @config.threads[:split_store] = Thread.new do
-            @config.logger.info('Starting splits fetcher service')
+            @config.logger.info('Starting feature flags fetcher service')
             loop do
               store_splits
 
@@ -53,7 +53,7 @@ def store_splits
         end
 
         def store_split(split)
-          @config.logger.debug("storing split (#{split[:name]})") if @config.debug_enabled
+          @config.logger.debug("storing feature flag (#{split[:name]})") if @config.debug_enabled
 
           @splits_repository.add_split(split)
         end

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/engine/api/splits.rb

@@ -20,9 +20,9 @@ def since(since, fetch_options = { cache_control_headers: false, till: nil })
           result = splits_with_segment_names(response.body)
 
           unless result[:splits].empty?
-            @config.split_logger.log_if_debug("#{result[:splits].length} splits retrieved. since=#{since}")
+            @config.split_logger.log_if_debug("#{result[:splits].length} feature flags retrieved. since=#{since}")
           end
-          @config.split_logger.log_if_transport("Split changes response: #{result.to_s}")
+          @config.split_logger.log_if_transport("Feature flag changes response: #{result.to_s}")
 
           bucket = BinarySearchLatencyTracker.get_bucket((Time.now - start) * 1000.0)
           @telemetry_runtime_producer.record_sync_latency(Telemetry::Domain::Constants::SPLIT_SYNC, bucket)
@@ -32,10 +32,10 @@ def since(since, fetch_options = { cache_control_headers: false, till: nil })
         else
           @telemetry_runtime_producer.record_sync_error(Telemetry::Domain::Constants::SPLIT_SYNC, response.status)
 
-          @config.logger.error("Unexpected status code while fetching splits: #{response.status}. " \
+          @config.logger.error("Unexpected status code while fetching feature flags: #{response.status}. " \
           'Check your API key and base URI')
 
-          raise 'Split SDK failed to connect to backend to fetch split definitions'
+          raise 'Split SDK failed to connect to backend to fetch feature flags definitions'
         end
       end
 

lib/splitclient-rb/engine/matchers/dependency_matcher.rb

@@ -4,18 +4,18 @@ module SplitIoClient
   class DependencyMatcher
     MATCHER_TYPE = 'IN_SPLIT_TREATMENT'
 
-    def initialize(split, treatments, logger)
-      @split = split
+    def initialize(feature_flag, treatments, logger)
+      @feature_flag = feature_flag
       @treatments = treatments
       @logger = logger
     end
 
     def match?(args)
       keys = { matching_key: args[:matching_key], bucketing_key: args[:bucketing_key] }
-      evaluate = args[:evaluator].call(keys, @split, args[:attributes])
+      evaluate = args[:evaluator].call(keys, @feature_flag, args[:attributes])
       matches = @treatments.include?(evaluate[:treatment])
-      @logger.log_if_debug("[dependencyMatcher] Parent split #{@split} evaluated to #{evaluate[:treatment]} \
-        with label #{evaluate[:label]}. #{@split} evaluated treatment is part of [#{@treatments}] ? #{matches}.")
+      @logger.log_if_debug("[dependencyMatcher] Parent feature flag #{@feature_flag} evaluated to #{evaluate[:treatment]} \
+        with label #{evaluate[:label]}. #{@feature_flag} evaluated treatment is part of [#{@treatments}] ? #{matches}.")
       matches
     end
 

lib/splitclient-rb/engine/synchronizer.rb

@@ -201,7 +201,7 @@ def sync_result(success, remaining_attempts, segment_names = nil)
       end
 
       def sync_splits_and_segments
-        @config.logger.debug('Synchronizing Splits and Segments ...') if @config.debug_enabled
+        @config.logger.debug('Synchronizing feature flags and segments ...') if @config.debug_enabled
         splits_result = @split_fetcher.fetch_splits
 
         splits_result[:success] && @segment_fetcher.fetch_segments

lib/splitclient-rb/managers/split_manager.rb

@@ -50,31 +50,31 @@ def split_names
     # method to get a split view
     #
     # @returns a split view
-    def split(split_name)
-      return unless @config.valid_mode && @splits_repository && @config.split_validator.valid_split_parameters(split_name)
+    def split(feature_flag_name)
+      return unless @config.valid_mode && @splits_repository && @config.split_validator.valid_split_parameters(feature_flag_name)
 
       if !ready?
         @config.logger.error("split: the SDK is not ready, the operation cannot be executed")
         return
       end
 
-      sanitized_split_name= split_name.to_s.strip
+      sanitized_feature_flag_name = feature_flag_name.to_s.strip
 
-      if split_name.to_s != sanitized_split_name
-        @config.logger.warn("split: split_name #{split_name} has extra whitespace, trimming")
-        split_name = sanitized_split_name
+      if feature_flag_name.to_s != sanitized_feature_flag_name
+        @config.logger.warn("split: feature_flag_name #{feature_flag_name} has extra whitespace, trimming")
+        feature_flag_name = sanitized_feature_flag_name
       end
 
-      split = @splits_repository.get_split(split_name)
+      split = @splits_repository.get_split(feature_flag_name)
 
       if ready? && split.nil?
-        @config.logger.warn("split: you passed #{split_name} " \
-          'that does not exist in this environment, please double check what Splits exist in the web console')
+        @config.logger.warn("split: you passed #{feature_flag_name} " \
+          'that does not exist in this environment, please double check what feature flags exist in the Split user interface')
       end
 
       return if split.nil? || Engine::Models::Split.archived?(split)
 
-      build_split_view(split_name, split)
+      build_split_view(feature_flag_name, split)
     end
 
     def block_until_ready(time = nil)

lib/splitclient-rb/sse/workers/splits_worker.rb

@@ -14,7 +14,7 @@ def initialize(synchronizer, config, splits_repository)
 
         def start
           if @running.value
-            @config.logger.debug('splits worker already running.')
+            @config.logger.debug('feature_flags_worker already running.')
             return
           end
 
@@ -24,7 +24,7 @@ def start
 
         def stop
           unless @running.value
-            @config.logger.debug('splits worker not running.')
+            @config.logger.debug('feature_flags_worker not running.')
             return
           end
 
@@ -33,14 +33,14 @@ def stop
         end
 
         def add_to_queue(change_number)
-          @config.logger.debug("SplitsWorker add to queue #{change_number}")
+          @config.logger.debug("feature_flags_worker add to queue #{change_number}")
           @queue.push(change_number)
         end
 
         def kill_split(change_number, split_name, default_treatment)
           return if @splits_repository.get_change_number.to_i > change_number
 
-          @config.logger.debug("SplitsWorker kill #{split_name}, #{change_number}")
+          @config.logger.debug("feature_flags_worker kill #{split_name}, #{change_number}")
           @splits_repository.kill(change_number, split_name, default_treatment)
           add_to_queue(change_number)
         end
@@ -49,14 +49,14 @@ def kill_split(change_number, split_name, default_treatment)
 
         def perform
           while (change_number = @queue.pop)
-            @config.logger.debug("SplitsWorker change_number dequeue #{change_number}")
+            @config.logger.debug("feature_flags_worker change_number dequeue #{change_number}")
             @synchronizer.fetch_splits(change_number)
           end
         end
 
         def perform_thread
           @config.threads[:split_update_worker] = Thread.new do
-            @config.logger.debug('Starting splits worker ...') if @config.debug_enabled
+            @config.logger.debug('starting feature_flags_worker ...') if @config.debug_enabled
             perform
           end
         end