Merge pull request #559 from splitio/feature/rule-based-segments

Feature/rule based segments

Author: chillaq

CHANGES.txt

@@ -1,5 +1,9 @@
 CHANGES
 
+8.6.0 (Jun xx, 2025)
+- Added support for rule-based segments. These segments determine membership at runtime by evaluating their configured rules against the user attributes provided to the SDK.
+- Added support for feature flag prerequisites. This allows customers to define dependency conditions between flags, which are evaluated before any allowlists or targeting rules.
+
 8.5.0 (Jan 17, 2025)
 - Fixed high cpu usage when unique keys are cleared every 24 hours.
 - Added support for the new impressions tracking toggle available on feature flags, both respecting the setting and including the new field being returned on SplitView type objects. Read more in our docs.

lib/splitclient-rb.rb

@@ -23,6 +23,7 @@
 require 'splitclient-rb/cache/repositories/splits_repository'
 require 'splitclient-rb/cache/repositories/events_repository'
 require 'splitclient-rb/cache/repositories/impressions_repository'
+require 'splitclient-rb/cache/repositories/rule_based_segments_repository'
 require 'splitclient-rb/cache/repositories/events/memory_repository'
 require 'splitclient-rb/cache/repositories/events/redis_repository'
 require 'splitclient-rb/cache/repositories/flag_sets/memory_repository'
@@ -47,6 +48,7 @@
 require 'splitclient-rb/helpers/decryption_helper'
 require 'splitclient-rb/helpers/util'
 require 'splitclient-rb/helpers/repository_helper'
+require 'splitclient-rb/helpers/evaluator_helper'
 require 'splitclient-rb/split_factory'
 require 'splitclient-rb/split_factory_builder'
 require 'splitclient-rb/split_config'
@@ -96,13 +98,17 @@
 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/matchers/rule_based_segment_matcher'
+require 'splitclient-rb/engine/matchers/prerequisites_matcher'
 require 'splitclient-rb/engine/evaluator/splitter'
 require 'splitclient-rb/engine/impressions/noop_unique_keys_tracker'
 require 'splitclient-rb/engine/impressions/unique_keys_tracker'
 require 'splitclient-rb/engine/metrics/binary_search_latency_tracker'
 require 'splitclient-rb/engine/models/split'
 require 'splitclient-rb/engine/models/label'
+require 'splitclient-rb/engine/models/segment_type'
 require 'splitclient-rb/engine/models/treatment'
+require 'splitclient-rb/engine/models/split_http_response'
 require 'splitclient-rb/engine/auth_api_client'
 require 'splitclient-rb/engine/back_off'
 require 'splitclient-rb/engine/push_manager'

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

@@ -2,10 +2,11 @@ module SplitIoClient
   module Cache
     module Fetchers
       class SplitFetcher
-        attr_reader :splits_repository
+        attr_reader :splits_repository, :rule_based_segments_repository
 
-        def initialize(splits_repository, api_key, config, telemetry_runtime_producer)
+        def initialize(splits_repository, rule_based_segments_repository, api_key, config, telemetry_runtime_producer)
           @splits_repository = splits_repository
+          @rule_based_segments_repository = rule_based_segments_repository
           @api_key = api_key
           @config = config
           @semaphore = Mutex.new
@@ -23,10 +24,11 @@ def call
 
         def fetch_splits(fetch_options = { cache_control_headers: false, till: nil })
           @semaphore.synchronize do
-            data = splits_since(@splits_repository.get_change_number, fetch_options)
-
-            SplitIoClient::Helpers::RepositoryHelper.update_feature_flag_repository(@splits_repository, data[:splits], data[:till], @config)
+            data = splits_since(@splits_repository.get_change_number, @rule_based_segments_repository.get_change_number, fetch_options)
+            SplitIoClient::Helpers::RepositoryHelper.update_feature_flag_repository(@splits_repository, data[:ff][:d], data[:ff][:t], @config, @splits_api.clear_storage)
+            SplitIoClient::Helpers::RepositoryHelper.update_rule_based_segment_repository(@rule_based_segments_repository, data[:rbs][:d], data[:rbs][:t], @config)
             @splits_repository.set_segment_names(data[:segment_names])
+            @rule_based_segments_repository.set_segment_names(data[:segment_names])
             @config.logger.debug("segments seen(#{data[:segment_names].length}): #{data[:segment_names].to_a}") if @config.debug_enabled
 
             { segment_names: data[:segment_names], success: true }
@@ -55,8 +57,8 @@ def splits_thread
           end
         end
 
-        def splits_since(since, fetch_options = { cache_control_headers: false, till: nil })
-          splits_api.since(since, fetch_options)
+        def splits_since(since, since_rbs, fetch_options = { cache_control_headers: false, till: nil })
+          splits_api.since(since, since_rbs, fetch_options)
         end
 
         def splits_api

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

@@ -0,0 +1,122 @@
+require 'concurrent'
+
+module SplitIoClient
+  module Cache
+    module Repositories
+      class RuleBasedSegmentsRepository < 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
+              }]
+          }
+        }]
+        TILL_PREFIX = '.rbsegments.till'
+        RB_SEGMENTS_PREFIX = '.rbsegment.'
+        REGISTERED_PREFIX = '.segments.registered'
+
+        def initialize(config)
+          super(config)
+          @adapter = case @config.cache_adapter.class.to_s
+          when 'SplitIoClient::Cache::Adapters::RedisAdapter'
+            SplitIoClient::Cache::Adapters::CacheAdapter.new(@config)
+          else
+            @config.cache_adapter
+          end
+          unless @config.mode.equal?(:consumer)
+            @adapter.set_string(namespace_key(TILL_PREFIX), '-1')
+            @adapter.initialize_map(namespace_key(REGISTERED_PREFIX))
+          end
+        end
+
+        def update(to_add, to_delete, new_change_number)
+          to_add.each{ |rule_based_segment| add_rule_based_segment(rule_based_segment) }
+          to_delete.each{ |rule_based_segment| remove_rule_based_segment(rule_based_segment) }
+          set_change_number(new_change_number)
+        end
+
+        def get_rule_based_segment(name)
+          rule_based_segment = @adapter.string(namespace_key("#{RB_SEGMENTS_PREFIX}#{name}"))
+
+          JSON.parse(rule_based_segment, symbolize_names: true) if rule_based_segment
+        end
+
+        def rule_based_segment_names
+          @adapter.find_strings_by_prefix(namespace_key(RB_SEGMENTS_PREFIX))
+            .map { |rule_based_segment_names| rule_based_segment_names.gsub(namespace_key(RB_SEGMENTS_PREFIX), '') }
+        end
+
+        def set_change_number(since)
+          @adapter.set_string(namespace_key(TILL_PREFIX), since)
+        end
+
+        def get_change_number
+          @adapter.string(namespace_key(TILL_PREFIX))
+        end
+
+        def set_segment_names(names)
+          return if names.nil? || names.empty?
+
+          names.each do |name|
+            @adapter.add_to_set(namespace_key(REGISTERED_PREFIX), name)
+          end
+        end
+
+        def exists?(name)
+          @adapter.exists?(namespace_key("#{RB_SEGMENTS_PREFIX}#{name}"))
+        end
+
+        def clear
+          @adapter.clear(namespace_key)
+        end
+
+        def contains?(segment_names)
+          return false if rule_based_segment_names.empty?
+          return set(segment_names).subset?(rule_based_segment_names)
+        end
+
+        private
+
+        def add_rule_based_segment(rule_based_segment)
+          return unless rule_based_segment[:name]
+
+          if check_undefined_matcher(rule_based_segment)
+            @config.logger.warn("Rule based segment #{rule_based_segment[:name]} has undefined matcher, setting conditions to default template.")
+            rule_based_segment[:conditions] = RuleBasedSegmentsRepository::DEFAULT_CONDITIONS_TEMPLATE
+          end
+
+          @adapter.set_string(namespace_key("#{RB_SEGMENTS_PREFIX}#{rule_based_segment[:name]}"), rule_based_segment.to_json)
+        end
+
+        def check_undefined_matcher(rule_based_segment)
+          for condition in rule_based_segment[: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 #{rule_based_segment[:name]}")
+                return true
+              end
+            end
+          end
+          return false
+        end
+
+        def remove_rule_based_segment(rule_based_segment)
+          @adapter.delete(namespace_key("#{RB_SEGMENTS_PREFIX}#{rule_based_segment[:name]}"))
+        end
+      end
+    end
+  end
+end

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

@@ -83,6 +83,13 @@ def segment_keys_count
           0
         end
 
+        def contains?(segment_names)
+          if segment_names.empty?
+            return false
+          end
+          return segment_names.to_set.subset?(used_segment_names.to_set)
+        end
+
         private
 
         def segment_data(name)

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

@@ -31,6 +31,9 @@ class SplitsRepository < Repository
           ],
           label: "targeting rule type unsupported by sdk"
         }]
+        TILL_PREFIX = '.splits.till'
+        SPLIT_PREFIX = '.split.'
+        READY_PREFIX = '.splits.ready'
 
         def initialize(config, flag_sets_repository, flag_set_filter)
           super(config)
@@ -43,10 +46,7 @@ def initialize(config, flag_sets_repository, flag_set_filter)
           end
           @flag_sets = flag_sets_repository
           @flag_set_filter = flag_set_filter
-          unless @config.mode.equal?(:consumer)
-            @adapter.set_string(namespace_key('.splits.till'), '-1')
-            @adapter.initialize_map(namespace_key('.segments.registered'))
-          end
+          initialize_keys
         end
 
         def update(to_add, to_delete, new_change_number)
@@ -87,16 +87,16 @@ def traffic_type_exists(tt_name)
 
         # Return an array of Split Names excluding control keys like splits.till
         def split_names
-          @adapter.find_strings_by_prefix(namespace_key('.split.'))
-            .map { |split| split.gsub(namespace_key('.split.'), '') }
+          @adapter.find_strings_by_prefix(namespace_key(SPLIT_PREFIX))
+            .map { |split| split.gsub(namespace_key(SPLIT_PREFIX), '') }
         end
 
         def set_change_number(since)
-          @adapter.set_string(namespace_key('.splits.till'), since)
+          @adapter.set_string(namespace_key(TILL_PREFIX), since)
         end
 
         def get_change_number
-          @adapter.string(namespace_key('.splits.till'))
+          @adapter.string(namespace_key(TILL_PREFIX))
         end
 
         def set_segment_names(names)
@@ -112,21 +112,22 @@ def exists?(name)
         end
 
         def ready?
-          @adapter.string(namespace_key('.splits.ready')).to_i != -1
+          @adapter.string(namespace_key(READY_PREFIX)).to_i != -1
         end
 
         def not_ready!
-          @adapter.set_string(namespace_key('.splits.ready'), -1)
+          @adapter.set_string(namespace_key(READY_PREFIX), -1)
         end
 
         def ready!
-          @adapter.set_string(namespace_key('.splits.ready'), Time.now.utc.to_i)
+          @adapter.set_string(namespace_key(READY_PREFIX), Time.now.utc.to_i)
         end
 
         def clear
           @tt_cache.clear
 
           @adapter.clear(namespace_key)
+          initialize_keys
         end
 
         def kill(change_number, split_name, default_treatment)
@@ -167,6 +168,13 @@ def flag_set_filter
 
         private
 
+        def initialize_keys
+          unless @config.mode.equal?(:consumer)
+            @adapter.set_string(namespace_key(TILL_PREFIX), '-1')
+            @adapter.initialize_map(namespace_key('.segments.registered'))
+          end
+        end
+
         def add_feature_flag(split)
           return unless split[:name]
           existing_split = get_split(split[:name])

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

@@ -22,7 +22,8 @@ def build_split(feature, treatments)
               seed: 2_089_907_429,
               defaultTreatment: 'control_treatment',
               configurations: build_configurations(treatments),
-              conditions: build_conditions(treatments)
+              conditions: build_conditions(treatments),
+              prerequisites: []
             }
           end
 

lib/splitclient-rb/clients/split_client.rb

@@ -22,6 +22,7 @@ def initialize(sdk_key, repositories, status_manager, config, impressions_manage
       @api_key = sdk_key
       @splits_repository = repositories[:splits]
       @segments_repository = repositories[:segments]
+      @rule_based_segments_repository = repositories[:rule_based_segments]
       @impressions_repository = repositories[:impressions]
       @events_repository = repositories[:events]
       @status_manager = status_manager
@@ -115,6 +116,7 @@ def destroy
 
       @splits_repository.clear
       @segments_repository.clear
+      @rule_based_segments_repository.clear
 
       SplitIoClient.load_factory_registry
       SplitIoClient.split_factory_registry.remove(@api_key)

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

@@ -20,6 +20,11 @@ def get_api(url, api_key, params = {}, cache_control_headers = false)
 
           @config.split_logger.log_if_debug("GET #{url} proxy: #{api_client.proxy}")
         end
+      
+      rescue Zlib::GzipFile::Error => e
+        @config.logger.warn("Incorrect formatted response exception: #{e}\n")
+        SplitIoClient::Engine::Models::SplitHttpResponse.new(400, '', true)
+
       rescue StandardError => e
         @config.logger.warn("#{e}\nURL:#{url}\nparams:#{params}")
         raise e, 'Split SDK failed to connect to backend to retrieve information', e.backtrace
@@ -50,6 +55,9 @@ def post_api(url, api_key, data, headers = {}, params = {})
         raise e, 'Split SDK failed to connect to backend to post information', e.backtrace
       end
 
+      def sdk_url_overriden?
+        @config.sdk_url_overriden?
+      end
       private
 
       def api_client