Development

CHANGES.txt

@@ -1,5 +1,9 @@
 CHANGES
 
+8.4.0 (May 3, 2024)
+- Fixed issue preventing Impressopns and Events posting if client.destroy is called before the post threads started
+- Added support for targeting rules based on semantic versions (https://semver.org/).
+
 8.3.1 (Mar 22, 2024)
 - Fixed ruby process hanging due to failed thread.join command, when calling destroy and a http request still active.
 - Fixed streaming notification parser. Issue ref: https://github.com/splitio/ruby-client/issues/511

lib/splitclient-rb.rb

@@ -90,6 +90,12 @@
 require 'splitclient-rb/engine/matchers/equal_to_boolean_matcher'
 require 'splitclient-rb/engine/matchers/equal_to_matcher'
 require 'splitclient-rb/engine/matchers/matches_string_matcher'
+require 'splitclient-rb/engine/matchers/semver'
+require 'splitclient-rb/engine/matchers/equal_to_semver_matcher'
+require 'splitclient-rb/engine/matchers/greater_than_or_equal_to_semver_matcher'
+require 'splitclient-rb/engine/matchers/less_than_or_equal_to_semver_matcher'
+require 'splitclient-rb/engine/matchers/between_semver_matcher'
+require 'splitclient-rb/engine/matchers/in_list_semver_matcher'
 require 'splitclient-rb/engine/evaluator/splitter'
 require 'splitclient-rb/engine/impressions/noop_unique_keys_tracker'
 require 'splitclient-rb/engine/impressions/unique_keys_tracker'
@@ -105,6 +111,8 @@
 require 'splitclient-rb/engine/synchronizer'
 require 'splitclient-rb/utilitites'
 
+require 'splitclient-rb/spec.rb'
+
 # SSE
 require 'splitclient-rb/sse/event_source/client'
 require 'splitclient-rb/sse/event_source/event_parser'

lib/splitclient-rb/cache/repositories/events/memory_repository.rb

@@ -29,6 +29,10 @@ def clear
             @adapter.clear
           end
 
+          def empty?
+            @adapter.empty?
+          end
+
           def batch
             return [] if @config.events_queue_size.zero?
 

lib/splitclient-rb/cache/repositories/events_repository.rb

@@ -25,6 +25,10 @@ def post_events
           @config.log_found_exception(__method__.to_s, e)
         end
 
+        def empty?
+          @repository.empty?
+         end
+
         protected
 
         def metadata

lib/splitclient-rb/cache/repositories/splits_repository.rb

@@ -5,6 +5,32 @@ module Cache
     module Repositories
       class SplitsRepository < Repository
         attr_reader :adapter
+        DEFAULT_CONDITIONS_TEMPLATE = [{
+          conditionType: "ROLLOUT",
+          matcherGroup: {
+              combiner: "AND",
+              matchers: [
+              {
+                  keySelector: nil,
+                  matcherType: "ALL_KEYS",
+                  negate: false,
+                  userDefinedSegmentMatcherData: nil,
+                  whitelistMatcherData: nil,
+                  unaryNumericMatcherData: nil,
+                  betweenMatcherData: nil,
+                  dependencyMatcherData: nil,
+                  booleanMatcherData: nil,
+                  stringMatcherData: nil
+              }]
+          },
+          partitions: [
+              {
+              treatment: "control",
+              size: 100
+              }
+          ],
+          label: "targeting rule type unsupported by sdk"
+        }]
 
         def initialize(config, flag_sets_repository, flag_set_filter)
           super(config)
@@ -155,6 +181,10 @@ def add_feature_flag(split)
             remove_from_flag_sets(existing_split)
           end
 
+          if check_undefined_matcher(split)
+            @config.logger.warn("Feature Flag #{split[:name]} has undefined matcher, setting conditions to default template.")
+            split[:conditions] = SplitsRepository::DEFAULT_CONDITIONS_TEMPLATE
+          end
           if !split[:sets].nil?
             for flag_set in split[:sets]
               if !@flag_sets.flag_set_exist?(flag_set)
@@ -170,6 +200,18 @@ def add_feature_flag(split)
           @adapter.set_string(namespace_key(".split.#{split[:name]}"), split.to_json)
         end
 
+        def check_undefined_matcher(split)
+          for condition in split[:conditions]
+            for matcher in condition[:matcherGroup][:matchers]
+              if !SplitIoClient::Condition.instance_methods(false).map(&:to_s).include?("matcher_#{matcher[:matcherType].downcase}")
+                @config.logger.error("Detected undefined matcher #{matcher[:matcherType].downcase} in feature flag #{split[:name]}")
+                return true
+              end
+            end
+          end
+          return false
+        end
+
         def remove_feature_flag(split)
           decrease_tt_name_count(split[:trafficTypeName])
           remove_from_flag_sets(split)

lib/splitclient-rb/clients/split_client.rb

@@ -96,7 +96,16 @@ def get_treatments_with_config_by_flag_sets(key, flag_sets, attributes = {})
 
     def destroy
       @config.logger.info('Split client shutdown started...') if @config.debug_enabled
-
+      if !@config.cache_adapter.is_a?(SplitIoClient::Cache::Adapters::RedisAdapter) && @config.impressions_mode != :none &&
+          (!@impressions_repository.empty? || !@events_repository.empty?)
+        @config.logger.debug("Impressions and/or Events cache is not empty")
+        # Adding small delay to ensure sender threads are fully running
+        sleep(0.1)
+        if !@config.threads.key?(:impressions_sender) || !@config.threads.key?(:events_sender)
+          @config.logger.debug("Periodic data recording thread has not started yet, waiting for service startup.")
+          @config.threads[:start_sdk].join(5) if @config.threads.key?(:start_sdk)
+        end
+      end
       @config.threads.select { |name, thread| name.to_s.end_with? 'sender' }.values.each do |thread|
         thread.raise(SplitIoClient::SDKShutdownException)
         thread.join

lib/splitclient-rb/engine/api/client.rb

@@ -10,6 +10,7 @@ def initialize(config)
       end
 
       def get_api(url, api_key, params = {}, cache_control_headers = false)
+        api_client.options.params_encoder.sort_params = false
         api_client.get(url, params) do |req|
           req.headers = common_headers(api_key).merge('Accept-Encoding' => 'gzip')
           req.headers = req.headers.merge('Cache-Control' => 'no-cache') if cache_control_headers
@@ -29,7 +30,7 @@ def post_api(url, api_key, data, headers = {}, params = {})
           req.headers = common_headers(api_key)
                         .merge('Content-Type' => 'application/json')
                         .merge(headers)
-          
+
           machine_ip = @config.machine_ip
           machine_name = @config.machine_name
 
@@ -55,6 +56,7 @@ def api_client
         @api_client ||= Faraday.new do |builder|
           builder.use SplitIoClient::FaradayMiddleware::Gzip
           builder.adapter :net_http_persistent
+          builder.options.params_encoder = Faraday::FlatParamsEncoder
         end
       end
 

lib/splitclient-rb/engine/api/splits.rb

@@ -4,19 +4,20 @@ module SplitIoClient
   module Api
     # Retrieves split definitions from the Split Backend
     class Splits < Client
+
       def initialize(api_key, config, telemetry_runtime_producer)
         super(config)
         @api_key = api_key
         @telemetry_runtime_producer = telemetry_runtime_producer
         @flag_sets_filter = @config.flag_sets_filter
       end
 
-      def since(since, fetch_options = { cache_control_headers: false, till: nil, sets: nil })
+      def since(since, fetch_options = { cache_control_headers: false, till: nil, sets: nil})
         start = Time.now
 
-        params = { since: since }
-        params[:till] = fetch_options[:till] unless fetch_options[:till].nil?
+        params = { s: SplitIoClient::Spec::FeatureFlags::SPEC_VERSION, since: since }
         params[:sets] = @flag_sets_filter.join(",") unless @flag_sets_filter.empty?
+        params[:till] = fetch_options[:till] unless fetch_options[:till].nil?
         @config.logger.debug("Fetching from splitChanges with #{params}: ")
         response = get_api("#{@config.base_uri}/splitChanges", @api_key, params, fetch_options[:cache_control_headers])
         if response.status == 414

lib/splitclient-rb/engine/auth_api_client.rb

@@ -14,7 +14,7 @@ def initialize(config, telemetry_runtime_producer)
 
       def authenticate(api_key)
         start = Time.now
-        response = @api_client.get_api(@config.auth_service_url, api_key)
+        response = @api_client.get_api("#{@config.auth_service_url}?s=#{SplitIoClient::Spec::FeatureFlags::SPEC_VERSION}", api_key)
 
         return process_success(response, start) if response.success?
 

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  class BetweenSemverMatcher < Matcher
+    MATCHER_TYPE = 'BETWEEN_SEMVER'
+
+    attr_reader :attribute
+
+    def initialize(attribute, start_value, end_value, logger, validator)
+      super(logger)
+      @validator = validator
+      @attribute = attribute
+      @semver_start = SplitIoClient::Semver.build(start_value, logger)
+      @semver_end = SplitIoClient::Semver.build(end_value, logger)
+      @logger = logger
+    end
+
+    def match?(args)
+      return false unless verify_semver_arg?(args, 'BetweenSemverMatcher')
+
+      value_to_match = SplitIoClient::Semver.build(args[:attributes][@attribute.to_sym], @logger)
+      if value_to_match.nil? || @semver_start.nil? || @semver_end.nil?
+        @logger.error('betweenStringMatcherData is required for BETWEEN_SEMVER matcher type')
+        return false
+
+      end
+      matches = ([0, -1].include?(@semver_start.compare(value_to_match)) &&
+                 [0, 1].include?(@semver_end.compare(value_to_match)))
+      @logger.debug("[BetweenMatcher] #{value_to_match} matches -> #{matches}")
+      matches
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  class EqualToSemverMatcher < Matcher
+    MATCHER_TYPE = 'EQUAL_TO_SEMVER'
+
+    attr_reader :attribute
+
+    def initialize(attribute, string_value, logger, validator)
+      super(logger)
+      @validator = validator
+      @attribute = attribute
+      @semver = SplitIoClient::Semver.build(string_value, logger)
+      @logger = logger
+    end
+
+    def match?(args)
+      return false unless verify_semver_arg?(args, 'EqualsToSemverMatcher')
+
+      value_to_match = SplitIoClient::Semver.build(args[:attributes][@attribute.to_sym], @logger)
+      return false unless check_semver_value_to_match(value_to_match, MATCHER_TYPE)
+
+      matches = (@semver.version == value_to_match.version)
+      @logger.debug("[EqualsToSemverMatcher] #{value_to_match} matches -> #{matches}")
+      matches
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  class GreaterThanOrEqualToSemverMatcher < Matcher
+    MATCHER_TYPE = 'GREATER_THAN_OR_EQUAL_TO_SEMVER'
+
+    attr_reader :attribute
+
+    def initialize(attribute, string_value, logger, validator)
+      super(logger)
+      @validator = validator
+      @attribute = attribute
+      @semver = SplitIoClient::Semver.build(string_value, logger)
+      @logger = logger
+    end
+
+    def match?(args)
+      return false unless verify_semver_arg?(args, 'GreaterThanOrEqualsToSemverMatcher')
+
+      value_to_match = SplitIoClient::Semver.build(args[:attributes][@attribute.to_sym], @logger)
+      return false unless check_semver_value_to_match(value_to_match, MATCHER_TYPE)
+
+      matches = [0, 1].include?(value_to_match.compare(@semver))
+      @logger.debug("[GreaterThanOrEqualsToSemverMatcher] #{value_to_match} matches -> #{matches}")
+      matches
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  class InListSemverMatcher < Matcher
+    MATCHER_TYPE = 'IN_LIST_SEMVER'
+
+    attr_reader :attribute
+
+    def initialize(attribute, list_value, logger, validator)
+      super(logger)
+      @validator = validator
+      @attribute = attribute
+      @semver_list = []
+
+      list_value.map do |item|
+        version = SplitIoClient::Semver.build(item, logger)
+        @semver_list << version unless version.nil?
+      end
+      @logger = logger
+    end
+
+    def match?(args)
+      return false if @semver_list.empty? || !verify_semver_arg?(args, 'InListSemverMatcher')
+
+      value_to_match = SplitIoClient::Semver.build(args[:attributes][@attribute.to_sym], @logger)
+      if value_to_match.nil?
+        @logger.error('whitelistMatcherData is required for IN_LIST_SEMVER matcher type')
+        return false
+
+      end
+      matches = (@semver_list.map { |item| item.version == value_to_match.version }).any? { |item| item == true }
+      @logger.debug("[InListSemverMatcher] #{value_to_match} matches -> #{matches}")
+      matches
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  class LessThanOrEqualToSemverMatcher < Matcher
+    MATCHER_TYPE = 'LESS_THAN_OR_EQUAL_TO_SEMVER'
+
+    attr_reader :attribute
+
+    def initialize(attribute, string_value, logger, validator)
+      super(logger)
+      @validator = validator
+      @attribute = attribute
+      @semver = SplitIoClient::Semver.build(string_value, logger)
+      @logger = logger
+    end
+
+    def match?(args)
+      return false unless verify_semver_arg?(args, 'LessThanOrEqualsToSemverMatcher')
+
+      value_to_match = SplitIoClient::Semver.build(args[:attributes][@attribute.to_sym], @logger)
+      return false unless check_semver_value_to_match(value_to_match, MATCHER_TYPE)
+
+      matches = [0, -1].include?(value_to_match.compare(@semver))
+      @logger.debug("[LessThanOrEqualsToSemverMatcher] #{value_to_match} matches -> #{matches}")
+      matches
+    end
+  end
+end

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

@@ -30,5 +30,23 @@ def equals?(obj)
     def string_type?
       false
     end
+
+    private
+
+    def verify_semver_arg?(args, matcher_name)
+      @logger.debug("[#{matcher_name}] evaluating value and attributes.")
+      return false unless @validator.valid_matcher_arguments(args)
+
+      true
+    end
+
+    def check_semver_value_to_match(value_to_match, matcher_spec_name)
+      if value_to_match.nil? || @semver.nil?
+        @logger.error("stringMatcherData is required for #{matcher_spec_name} matcher type")
+        return false
+
+      end
+      true
+    end
   end
 end