optimizely-sdk 5.1.0 → 5.2.0

data/lib/optimizely/helpers/constants.rb

@@ -201,6 +201,12 @@ module Optimizely
                 },
                 'forcedVariations' => {
                   'type' => 'object'
+                },
+                'cmab' => {
+                  'type' => 'object'
+                },
+                'holdouts' => {
+                  'type' => 'array'
                 }
               },
               'required' => %w[
@@ -303,6 +309,43 @@ module Optimizely
               },
               'required' => %w[key]
             }
+          },
+          'cmab' => {
+            'type' => 'object',
+            'properties' => {
+              'attributeIds' => {
+                'type' => 'array',
+                'items' => {'type' => 'string'}
+              },
+              'trafficAllocation' => {
+                'type' => 'integer'
+              }
+            }
+          },
+          'holdouts' => {
+            'type' => 'array',
+            'items' => {
+              'type' => 'object',
+              'properties' => {
+                'id' => {
+                  'type' => 'string'
+                },
+                'key' => {
+                  'type' => 'string'
+                },
+                'status' => {
+                  'type' => 'string'
+                },
+                'includedFlags' => {
+                  'type' => 'array',
+                  'items' => {'type' => 'string'}
+                },
+                'excludedFlags' => {
+                  'type' => 'array',
+                  'items' => {'type' => 'string'}
+                }
+              }
+            }
           }
         },
         'required' => %w[
@@ -454,6 +497,9 @@ module Optimizely
         'IF_MODIFIED_SINCE' => 'If-Modified-Since',
         'LAST_MODIFIED' => 'Last-Modified'
       }.freeze
+
+      CMAB_FETCH_FAILED = 'CMAB decision fetch failed (%s).'
+      INVALID_CMAB_FETCH_RESPONSE = 'Invalid CMAB fetch response'
     end
   end
 end

data/lib/optimizely/helpers/sdk_settings.rb

@@ -22,7 +22,7 @@ module Optimizely
   module Helpers
     class OptimizelySdkSettings
       attr_accessor :odp_disabled, :segments_cache_size, :segments_cache_timeout_in_secs, :odp_segments_cache, :odp_segment_manager,
-                    :odp_event_manager, :fetch_segments_timeout, :odp_event_timeout, :odp_flush_interval
+                    :odp_event_manager, :fetch_segments_timeout, :odp_event_timeout, :odp_flush_interval, :cmab_prediction_endpoint
 
       # Contains configuration used for Optimizely Project initialization.
       #
@@ -35,6 +35,7 @@ module Optimizely
       # @param odp_segment_request_timeout - Time to wait in seconds for fetch_qualified_segments (optional. default = 10).
       # @param odp_event_request_timeout - Time to wait in seconds for send_odp_events (optional. default = 10).
       # @param odp_event_flush_interval - Time to wait in seconds for odp events to accumulate before sending (optional. default = 1).
+      # @param cmab_prediction_endpoint - Custom CMAB prediction endpoint URL template (optional). Use %s as placeholder for rule_id. Defaults to production endpoint if not provided.
       def initialize(
         disable_odp: false,
         segments_cache_size: Constants::ODP_SEGMENTS_CACHE_CONFIG[:DEFAULT_CAPACITY],
@@ -44,7 +45,8 @@ module Optimizely
         odp_event_manager: nil,
         odp_segment_request_timeout: nil,
         odp_event_request_timeout: nil,
-        odp_event_flush_interval: nil
+        odp_event_flush_interval: nil,
+        cmab_prediction_endpoint: nil
       )
         @odp_disabled = disable_odp
         @segments_cache_size = segments_cache_size
@@ -55,6 +57,7 @@ module Optimizely
         @fetch_segments_timeout = odp_segment_request_timeout
         @odp_event_timeout = odp_event_request_timeout
         @odp_flush_interval = odp_event_flush_interval
+        @cmab_prediction_endpoint = cmab_prediction_endpoint
       end
     end
   end

data/lib/optimizely/helpers/validator.rb

@@ -122,11 +122,11 @@ module Optimizely
 
         return false unless variables.respond_to?(:each) && !variables.empty?
 
-        is_valid = true # rubocop:disable Lint/UselessAssignment
+        is_valid = true
         if variables.include? :user_id
           # Empty str is a valid user ID.
           unless variables[:user_id].is_a?(String)
-            is_valid = false # rubocop:disable Lint/UselessAssignment
+            is_valid = false
             logger.log(level, "#{Constants::INPUT_VARIABLES['USER_ID']} is invalid")
           end
           variables.delete :user_id

data/lib/optimizely/odp/lru_cache.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2022, Optimizely and contributors
+#    Copyright 2022-2025, Optimizely and contributors
 #
 #    Licensed under the Apache License, Version 2.0 (the "License");
 #    you may not use this file except in compliance with the License.
@@ -91,6 +91,19 @@ module Optimizely
 
       @cache_mutex.synchronize { @map[key]&.value }
     end
+
+    # Remove the element associated with the provided key from the cache
+    #
+    # @param key - The key to remove
+
+    def remove(key)
+      return if @capacity <= 0
+
+      @cache_mutex.synchronize do
+        @map.delete(key)
+      end
+      nil
+    end
   end
 
   class CacheElement

data/lib/optimizely/optimizely_factory.rb

@@ -22,6 +22,8 @@ require 'optimizely/event_dispatcher'
 require 'optimizely/event/batch_event_processor'
 require 'optimizely/logger'
 require 'optimizely/notification_center'
+require 'optimizely/cmab/cmab_client'
+require 'optimizely/cmab/cmab_service'
 
 module Optimizely
   class OptimizelyFactory
@@ -83,6 +85,46 @@ module Optimizely
       @blocking_timeout = blocking_timeout
     end
 
+    # Convenience method for setting CMAB cache size.
+    # @param cache_size Integer - Maximum number of items in CMAB cache.
+    # @param logger - Optional LoggerInterface Provides a log method to log messages.
+    def self.cmab_cache_size(cache_size, logger = NoOpLogger.new)
+      unless cache_size.is_a?(Integer) && cache_size.positive?
+        logger.log(
+          Logger::ERROR,
+          "CMAB cache size is invalid, setting to default size #{Optimizely::DefaultCmabCacheOptions::DEFAULT_CMAB_CACHE_SIZE}."
+        )
+        return
+      end
+      @cmab_cache_size = cache_size
+    end
+
+    # Convenience method for setting CMAB cache TTL.
+    # @param cache_ttl Numeric - Time in seconds for cache entries to live.
+    # @param logger - Optional LoggerInterface Provides a log method to log messages.
+    def self.cmab_cache_ttl(cache_ttl, logger = NoOpLogger.new)
+      unless cache_ttl.is_a?(Numeric) && cache_ttl.positive?
+        logger.log(
+          Logger::ERROR,
+          "CMAB cache TTL is invalid, setting to default TTL #{Optimizely::DefaultCmabCacheOptions::DEFAULT_CMAB_CACHE_TIMEOUT}."
+        )
+        return
+      end
+      @cmab_cache_ttl = cache_ttl
+    end
+
+    # Convenience method for setting custom CMAB cache.
+    # @param custom_cache - Cache implementation responding to lookup, save, remove, and reset methods.
+    def self.cmab_custom_cache(custom_cache)
+      @cmab_custom_cache = custom_cache
+    end
+
+    # Convenience method for setting custom CMAB prediction endpoint.
+    # @param prediction_endpoint String - Custom URL template for CMAB prediction API. Use %s as placeholder for rule_id.
+    def self.cmab_prediction_endpoint(prediction_endpoint)
+      @cmab_prediction_endpoint = prediction_endpoint
+    end
+
     # Returns a new optimizely instance.
     #
     # @params sdk_key - Required String uniquely identifying the fallback datafile corresponding to project.
@@ -165,6 +207,18 @@ module Optimizely
         notification_center: notification_center
       )
 
+      # Initialize CMAB components
+      cmab_prediction_endpoint = nil
+      cmab_prediction_endpoint = settings.cmab_prediction_endpoint if settings&.cmab_prediction_endpoint
+      cmab_prediction_endpoint ||= @cmab_prediction_endpoint
+
+      cmab_client = DefaultCmabClient.new(logger: logger, prediction_endpoint: cmab_prediction_endpoint)
+      cmab_cache = @cmab_custom_cache || LRUCache.new(
+        @cmab_cache_size || Optimizely::DefaultCmabCacheOptions::DEFAULT_CMAB_CACHE_SIZE,
+        @cmab_cache_ttl || Optimizely::DefaultCmabCacheOptions::DEFAULT_CMAB_CACHE_TIMEOUT
+      )
+      cmab_service = DefaultCmabService.new(cmab_cache, cmab_client, logger)
+
       Optimizely::Project.new(
         datafile: datafile,
         event_dispatcher: event_dispatcher,
@@ -176,7 +230,8 @@ module Optimizely
         config_manager: config_manager,
         notification_center: notification_center,
         event_processor: event_processor,
-        settings: settings
+        settings: settings,
+        cmab_service: cmab_service
       )
     end
   end

data/lib/optimizely/project_config.rb

@@ -62,6 +62,8 @@ module Optimizely
 
     def all_segments; end
 
+    def region; end
+
     def experiment_running?(experiment); end
 
     def get_experiment_from_key(experiment_key); end
@@ -86,6 +88,10 @@ module Optimizely
 
     def get_attribute_id(attribute_key); end
 
+    def get_attribute_by_key(attribute_key); end
+
+    def get_attribute_key_by_id(attribute_id); end
+
     def variation_id_exists?(experiment_id, variation_id); end
 
     def get_feature_flag_from_key(feature_flag_key); end

data/lib/optimizely/version.rb

@@ -17,5 +17,5 @@
 #
 module Optimizely
   CLIENT_ENGINE = 'ruby-sdk'
-  VERSION = '5.1.0'
+  VERSION = '5.2.0'
 end

data/lib/optimizely.rb

@@ -43,6 +43,8 @@ require_relative 'optimizely/odp/lru_cache'
 require_relative 'optimizely/odp/odp_manager'
 require_relative 'optimizely/helpers/sdk_settings'
 require_relative 'optimizely/user_profile_tracker'
+require_relative 'optimizely/cmab/cmab_client'
+require_relative 'optimizely/cmab/cmab_service'
 
 module Optimizely
   class Project
@@ -84,7 +86,8 @@ module Optimizely
       event_processor: nil,
       default_decide_options: [],
       event_processor_options: {},
-      settings: nil
+      settings: nil,
+      cmab_service: nil
     )
       @logger = logger || NoOpLogger.new
       @error_handler = error_handler || NoOpErrorHandler.new
@@ -131,7 +134,24 @@ module Optimizely
 
       setup_odp!(@config_manager.sdk_key)
 
-      @decision_service = DecisionService.new(@logger, @user_profile_service)
+      # Initialize CMAB components if cmab service is nil
+      if cmab_service.nil?
+        @cmab_client = DefaultCmabClient.new(
+          http_client: nil,
+          retry_config: CmabRetryConfig.new,
+          logger: @logger
+        )
+        @cmab_cache = LRUCache.new(Optimizely::DefaultCmabCacheOptions::DEFAULT_CMAB_CACHE_SIZE, Optimizely::DefaultCmabCacheOptions::DEFAULT_CMAB_CACHE_TIMEOUT)
+        @cmab_service = DefaultCmabService.new(
+          @cmab_cache,
+          @cmab_client,
+          @logger
+        )
+      else
+        @cmab_service = cmab_service
+      end
+
+      @decision_service = DecisionService.new(@logger, @cmab_service, @user_profile_service)
 
       @event_processor = if event_processor.respond_to?(:process)
                            event_processor
@@ -185,18 +205,23 @@ module Optimizely
       feature_flag = config.get_feature_flag_from_key(flag_key)
       experiment = nil
       decision_source = Optimizely::DecisionService::DECISION_SOURCES['ROLLOUT']
+      experiment_id = nil
+      variation_id = nil
+
       # Send impression event if Decision came from a feature test and decide options doesn't include disableDecisionEvent
       if decision.is_a?(Optimizely::DecisionService::Decision)
         experiment = decision.experiment
         rule_key = experiment ? experiment['key'] : nil
-        variation = decision['variation']
+        experiment_id = experiment ? experiment['id'] : nil
+        variation = decision.variation
         variation_key = variation ? variation['key'] : nil
+        variation_id = variation ? variation['id'] : nil
         feature_enabled = variation ? variation['featureEnabled'] : false
         decision_source = decision.source
       end
 
       if !decide_options.include?(OptimizelyDecideOption::DISABLE_DECISION_EVENT) && (decision_source == Optimizely::DecisionService::DECISION_SOURCES['FEATURE_TEST'] || config.send_flag_decisions)
-        send_impression(config, experiment, variation_key || '', flag_key, rule_key || '', feature_enabled, decision_source, user_id, attributes)
+        send_impression(config, experiment, variation_key || '', flag_key, rule_key || '', feature_enabled, decision_source, user_id, attributes, decision&.cmab_uuid)
         decision_event_dispatched = true
       end
 
@@ -214,14 +239,16 @@ module Optimizely
       @notification_center.send_notifications(
         NotificationCenter::NOTIFICATION_TYPES[:DECISION],
         Helpers::Constants::DECISION_NOTIFICATION_TYPES['FLAG'],
-        user_id, (attributes || {}),
+        user_id, attributes || {},
         flag_key: flag_key,
         enabled: feature_enabled,
         variables: all_variables,
         variation_key: variation_key,
         rule_key: rule_key,
         reasons: should_include_reasons ? reasons : [],
-        decision_event_dispatched: decision_event_dispatched
+        decision_event_dispatched: decision_event_dispatched,
+        experiment_id: experiment_id,
+        variation_id: variation_id
       )
 
       OptimizelyDecision.new(
@@ -330,7 +357,7 @@ module Optimizely
 
         # If the feature flag is nil, create a default OptimizelyDecision and move to the next key
         if feature_flag.nil?
-          decisions[key] = OptimizelyDecision.new(nil, false, nil, nil, key, user_context, [])
+          decisions[key] = OptimizelyDecision.new(variation_key: nil, enabled: false, variables: nil, rule_key: nil, flag_key: key, user_context: user_context, reasons: [])
           next
         end
         valid_keys.push(key)
@@ -351,9 +378,17 @@ module Optimizely
       decision_list = @decision_service.get_variations_for_feature_list(config, flags_without_forced_decision, user_context, decide_options)
 
       flags_without_forced_decision.each_with_index do |flag, i|
-        decision = decision_list[i][0]
-        reasons = decision_list[i][1]
+        decision = decision_list[i].decision
+        reasons = decision_list[i].reasons
+        error = decision_list[i].error
         flag_key = flag['key']
+        # store error decision against key and remove key from valid keys
+        if error
+          optimizely_decision = OptimizelyDecision.new_error_decision(flag_key, user_context, reasons)
+          decisions[flag_key] = optimizely_decision
+          valid_keys.delete(flag_key) if valid_keys.include?(flag_key)
+          next
+        end
         flag_decisions[flag_key] = decision
         decision_reasons_dict[flag_key] ||= []
         decision_reasons_dict[flag_key].push(*reasons)
@@ -592,14 +627,14 @@ module Optimizely
       end
 
       user_context = OptimizelyUserContext.new(self, user_id, attributes, identify: false)
-      decision, = @decision_service.get_variation_for_feature(config, feature_flag, user_context)
-
+      decision_result = @decision_service.get_variation_for_feature(config, feature_flag, user_context)
+      decision = decision_result.decision
       feature_enabled = false
       source_string = Optimizely::DecisionService::DECISION_SOURCES['ROLLOUT']
       if decision.is_a?(Optimizely::DecisionService::Decision)
         variation = decision['variation']
         feature_enabled = variation['featureEnabled']
-        if decision.source == Optimizely::DecisionService::DECISION_SOURCES['FEATURE_TEST']
+        if decision.source == Optimizely::DecisionService::DECISION_SOURCES['FEATURE_TEST'] || decision.source == Optimizely::DecisionService::DECISION_SOURCES['HOLDOUT']
           source_string = Optimizely::DecisionService::DECISION_SOURCES['FEATURE_TEST']
           source_info = {
             experiment_key: decision.experiment['key'],
@@ -625,7 +660,7 @@ module Optimizely
       @notification_center.send_notifications(
         NotificationCenter::NOTIFICATION_TYPES[:DECISION],
         Helpers::Constants::DECISION_NOTIFICATION_TYPES['FEATURE'],
-        user_id, (attributes || {}),
+        user_id, attributes || {},
         feature_key: feature_flag_key,
         feature_enabled: feature_enabled,
         source: source_string,
@@ -832,7 +867,8 @@ module Optimizely
       end
 
       user_context = OptimizelyUserContext.new(self, user_id, attributes, identify: false)
-      decision, = @decision_service.get_variation_for_feature(config, feature_flag, user_context)
+      decision_result = @decision_service.get_variation_for_feature(config, feature_flag, user_context)
+      decision = decision_result.decision
       variation = decision ? decision['variation'] : nil
       feature_enabled = variation ? variation['featureEnabled'] : false
       all_variables = {}
@@ -853,7 +889,7 @@ module Optimizely
 
       @notification_center.send_notifications(
         NotificationCenter::NOTIFICATION_TYPES[:DECISION],
-        Helpers::Constants::DECISION_NOTIFICATION_TYPES['ALL_FEATURE_VARIABLES'], user_id, (attributes || {}),
+        Helpers::Constants::DECISION_NOTIFICATION_TYPES['ALL_FEATURE_VARIABLES'], user_id, attributes || {},
         feature_key: feature_flag_key,
         feature_enabled: feature_enabled,
         source: source_string,
@@ -1022,7 +1058,8 @@ module Optimizely
       user_context = OptimizelyUserContext.new(self, user_id, attributes, identify: false)
       user_profile_tracker = UserProfileTracker.new(user_id, @user_profile_service, @logger)
       user_profile_tracker.load_user_profile
-      variation_id, = @decision_service.get_variation(config, experiment_id, user_context, user_profile_tracker)
+      variation_result = @decision_service.get_variation(config, experiment_id, user_context, user_profile_tracker)
+      variation_id = variation_result.variation_id
       user_profile_tracker.save_user_profile
       variation = config.get_variation_from_id(experiment_key, variation_id) unless variation_id.nil?
       variation_key = variation['key'] if variation
@@ -1033,7 +1070,7 @@ module Optimizely
                                    end
       @notification_center.send_notifications(
         NotificationCenter::NOTIFICATION_TYPES[:DECISION],
-        decision_notification_type, user_id, (attributes || {}),
+        decision_notification_type, user_id, attributes || {},
         experiment_key: experiment_key,
         variation_key: variation_key
       )
@@ -1090,7 +1127,8 @@ module Optimizely
       end
 
       user_context = OptimizelyUserContext.new(self, user_id, attributes, identify: false)
-      decision, = @decision_service.get_variation_for_feature(config, feature_flag, user_context)
+      decision_result = @decision_service.get_variation_for_feature(config, feature_flag, user_context)
+      decision = decision_result.decision
       variation = decision ? decision['variation'] : nil
       feature_enabled = variation ? variation['featureEnabled'] : false
 
@@ -1108,7 +1146,7 @@ module Optimizely
 
       @notification_center.send_notifications(
         NotificationCenter::NOTIFICATION_TYPES[:DECISION],
-        Helpers::Constants::DECISION_NOTIFICATION_TYPES['FEATURE_VARIABLE'], user_id, (attributes || {}),
+        Helpers::Constants::DECISION_NOTIFICATION_TYPES['FEATURE_VARIABLE'], user_id, attributes || {},
         feature_key: feature_flag_key,
         feature_enabled: feature_enabled,
         source: source_string,
@@ -1208,7 +1246,7 @@ module Optimizely
       raise InvalidInputError, 'event_dispatcher'
     end
 
-    def send_impression(config, experiment, variation_key, flag_key, rule_key, enabled, rule_type, user_id, attributes = nil)
+    def send_impression(config, experiment, variation_key, flag_key, rule_key, enabled, rule_type, user_id, attributes = nil, cmab_uuid = nil)
       if experiment.nil?
         experiment = {
           'id' => '',
@@ -1240,6 +1278,7 @@ module Optimizely
         variation_key: variation_key,
         enabled: enabled
       }
+      metadata[:cmab_uuid] = cmab_uuid unless cmab_uuid.nil?
 
       user_event = UserEventFactory.create_impression_event(config, experiment, variation_id, metadata, user_id, attributes)
       @event_processor.process(user_event)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optimizely-sdk
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Optimizely
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-10 00:00:00.000000000 Z
+date: 2025-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,6 +134,8 @@ files:
 - lib/optimizely.rb
 - lib/optimizely/audience.rb
 - lib/optimizely/bucketer.rb
+- lib/optimizely/cmab/cmab_client.rb
+- lib/optimizely/cmab/cmab_service.rb
 - lib/optimizely/condition_tree_evaluator.rb
 - lib/optimizely/config/datafile_project_config.rb
 - lib/optimizely/config/proxy_config.rb