optimizely-sdk 5.0.1 → 5.2.0

data/lib/optimizely/exceptions.rb

@@ -190,4 +190,28 @@ module Optimizely
       super
     end
   end
+
+  class CmabError < Error
+    # Base exception for CMAB errors
+
+    def initialize(msg = 'CMAB error occurred.')
+      super
+    end
+  end
+
+  class CmabFetchError < CmabError
+    # Exception raised when CMAB fetch fails
+
+    def initialize(msg = 'CMAB decision fetch failed with status:')
+      super
+    end
+  end
+
+  class CmabInvalidResponseError < CmabError
+    # Exception raised when CMAB fetch returns an invalid response
+
+    def initialize(msg = 'Invalid CMAB fetch response')
+      super
+    end
+  end
 end

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/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.
@@ -142,7 +184,6 @@ module Optimizely
       notification_center = nil,
       settings = nil
     )
-
       error_handler ||= NoOpErrorHandler.new
       logger ||= NoOpLogger.new
       notification_center = notification_center.is_a?(Optimizely::NotificationCenter) ? notification_center : NotificationCenter.new(logger, error_handler)
@@ -166,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,
@@ -177,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/user_profile_tracker.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'logger'
+
+module Optimizely
+  class UserProfileTracker
+    attr_reader :user_profile
+
+    def initialize(user_id, user_profile_service = nil, logger = nil)
+      @user_id = user_id
+      @user_profile_service = user_profile_service
+      @logger = logger || NoOpLogger.new
+      @profile_updated = false
+      @user_profile = {
+        user_id: user_id,
+        experiment_bucket_map: {}
+      }
+    end
+
+    def load_user_profile(reasons = [], error_handler = nil)
+      return if reasons.nil?
+
+      begin
+        @user_profile = @user_profile_service.lookup(@user_id) if @user_profile_service
+        if @user_profile.nil?
+          @user_profile = {
+            user_id: @user_id,
+            experiment_bucket_map: {}
+          }
+        end
+      rescue => e
+        message = "Error while looking up user profile for user ID '#{@user_id}': #{e}."
+        reasons << message
+        @logger.log(Logger::ERROR, message)
+        error_handler&.handle_error(e)
+      end
+    end
+
+    def update_user_profile(experiment_id, variation_id)
+      user_id = @user_profile[:user_id]
+      begin
+        @user_profile[:experiment_bucket_map][experiment_id] = {
+          variation_id: variation_id
+        }
+        @profile_updated = true
+        @logger.log(Logger::INFO, "Updated variation ID #{variation_id} of experiment ID #{experiment_id} for user '#{user_id}'.")
+      rescue => e
+        @logger.log(Logger::ERROR, "Error while updating user profile for user ID '#{user_id}': #{e}.")
+      end
+    end
+
+    def save_user_profile(error_handler = nil)
+      return unless @profile_updated && @user_profile_service
+
+      begin
+        @user_profile_service.save(@user_profile)
+        @logger.log(Logger::INFO, "Saved user profile for user '#{@user_profile[:user_id]}'.")
+      rescue => e
+        @logger.log(Logger::ERROR, "Failed to save user profile for user '#{@user_profile[:user_id]}': #{e}.")
+        error_handler&.handle_error(e)
+      end
+    end
+  end
+end

data/lib/optimizely/version.rb

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