rox-rollout 4.7.3 → 5.0.0

data/lib/rox/core/entities/rox_double.rb

@@ -0,0 +1,11 @@
+require 'rox/core/entities/rox_string'
+
+module Rox
+  module Core
+    class RoxDouble < RoxString
+      def value(context = nil)
+        internal_value(context, false, Float)
+      end
+    end
+  end
+end

data/lib/rox/core/entities/rox_int.rb

@@ -0,0 +1,11 @@
+require 'rox/core/entities/rox_string'
+
+module Rox
+  module Core
+    class RoxInt < RoxString
+      def value(context = nil)
+        internal_value(context, false, Integer)
+      end
+    end
+  end
+end

data/lib/rox/core/entities/{variant.rb → rox_string.rb}

@@ -4,22 +4,31 @@ require 'rox/core/impression/models/reporting_value'
 
 module Rox
   module Core
-    class Variant
-      attr_accessor :default_value, :options, :name, :context, :condition, :parser, :impression_invoker, :client_experiment
+    class RoxString
+      attr_accessor :default_value, :options, :name, :condition, :parser, :impression_invoker,
+                    :client_experiment
 
       def initialize(default_value, options = [])
         @default_value = default_value
         @options = options.clone
+        raise ArgumentError, 'options should be an array' unless options.is_a?(Array)
+        if options.length > 0 && options.any? { |x| x.class != default_value.class }
+          raise ArgumentError, 'options should be the same type as default value'
+        end
         @options << default_value unless options.include?(default_value)
 
         @condition = nil
         @parser = nil
-        @context = nil
         @impression_invoker = nil
         @client_experiment = nil
         @name = nil
       end
 
+      def send_impressions(return_value, merged_context)
+        reporting_value = ReportingValue.new(@name, return_value, @client_experiment)
+        @impression_invoker&.invoke(reporting_value, @client_experiment, merged_context)
+      end
+
       def set_for_evaluation(parser, experiment, impression_invoker)
         if experiment.nil?
           @client_experiment = nil
@@ -37,24 +46,22 @@ module Rox
         internal_value(context, false)
       end
 
-      def internal_value(context, nil_instead_of_default)
+      def internal_value(context, nil_instead_of_default, evaluated_type = String)
         return_value = nil_instead_of_default ? nil : @default_value
-        merged_context = MergedContext.new(@context, context)
+        merged_context = MergedContext.new(@parser&.global_context, context)
 
-        if !@parser.nil? && !@condition.nil? && !@condition.empty?
+        unless @parser.nil? || @condition.nil? || @condition.empty?
           evaluation_result = @parser.evaluate_expression(@condition, merged_context)
           unless evaluation_result.nil?
-            value = evaluation_result.string_value
-            if !value.nil? && !value.empty?
-              return_value = value
-            end
+            value = evaluated_type == String ? evaluation_result.string_value : evaluation_result.value
+            is_empty = value.is_a?(String) && value.empty?
+            return_value = value if !value.nil? && !is_empty
           end
         end
 
-        @impression_invoker.invoke(ReportingValue.new(@name, return_value), @client_experiment, merged_context) if @impression_invoker != nil
-
+        send_impressions(return_value, merged_context)
         return_value
       end
     end
   end
-end
+end

data/lib/rox/core/error_handling/exception_trigger.rb

@@ -0,0 +1,10 @@
+module Rox
+  module Core
+    module ExceptionTrigger
+      DYNAMIC_PROPERTIES_RULE = 1
+      CONFIGURATION_FETCHED_HANDLER = 2
+      IMPRESSION_HANDLER = 3
+      CUSTOM_PROPERTY_GENERATOR = 4
+    end
+  end
+end

data/lib/rox/core/error_handling/userspace_handler_exception.rb

@@ -0,0 +1,12 @@
+module Rox
+  module Core
+    class UserspaceHandlerException < StandardError
+      def initialize(exception_source, exception_trigger, exception)
+        @exception_source = exception_source
+        @exception_trigger = exception_trigger
+        @exception = exception
+        super('user unhandled exception in roxx expression')
+      end
+    end
+  end
+end

data/lib/rox/core/error_handling/userspace_unhandled_error_invoker.rb

@@ -0,0 +1,41 @@
+require 'rox/core/logging/logging'
+
+module Rox
+  module Core
+    class UserspaceUnhandledErrorInvoker
+      def initialize(user_unhandler_error_handler = nil)
+        @user_unhandler_error_handler = user_unhandler_error_handler
+      end
+
+      def invoke(exception_source, exception_trigger, exception)
+        unless @user_unhandler_error_handler
+          Logging.logger.error("User Unhandled Error Occurred, no fallback handler was set, exception ignored: #{exception}")
+          return
+        end
+
+        begin
+          userspace_unhandled_error_args = UserspaceUnhandledErrorArgs.new(exception_source, exception_trigger, exception)
+          @user_unhandler_error_handler.call(userspace_unhandled_error_args)
+        rescue StandardError => e
+          Logging.logger.error("User Unhandled Error Handler itself threw an exception. original exception: #{e}")
+        end
+      end
+
+      def handler=(handler)
+        @user_unhandler_error_handler = handler
+      end
+    end
+
+    class UserspaceUnhandledErrorArgs
+      def initialize(exception_source = nil, exception_trigger = nil, exception = nil)
+        @exception_source = exception_source
+        @exception_trigger = exception_trigger
+        @exception = exception
+      end
+
+      def to_s
+        "UserspaceUnhandledErrorArgs(#{@exception_source}, #{@exception_trigger}, #{@exception})"
+      end
+    end
+  end
+end

data/lib/rox/core/impression/impression_args.rb

@@ -1,5 +1,5 @@
 module Rox
   module Core
-    ImpressionArgs = Struct.new(:reporting_value, :experiment, :context)
+    ImpressionArgs = Struct.new(:reporting_value, :context)
   end
-end
+end

data/lib/rox/core/impression/impression_invoker.rb

@@ -1,23 +1,54 @@
 require 'rox/core/impression/impression_args'
+require 'rox/core/logging/logging'
+require 'rox/core/error_handling/exception_trigger'
+require 'rox/core/consts/property_type'
 
 module Rox
   module Core
     class ImpressionInvoker
-      def initialize(internal_flags, custom_property_repository, device_properties, analytics_client, is_roxy)
+      def initialize(internal_flags, custom_property_repository, device_properties, analytics_client, is_roxy, user_unhandled_error_invoker)
         @internal_flags = internal_flags
         @custom_property_repository = custom_property_repository
         @device_properties = device_properties
         @analytics_client = analytics_client
         @is_roxy = is_roxy
+        @user_unhandled_error_invoker = user_unhandled_error_invoker
 
         @impression_handlers = []
         @mutex = Mutex.new
       end
 
-      def invoke(reporting_value, client_experiment, context)
-        # TODO: Implement analytics logic
+      def invoke(reporting_value, stickiness_property, context)
+        begin
+          analytics_enabled = @internal_flags.enabled?('rox.internal.analytics')
+          if analytics_enabled && !@is_roxy
+            prop = @custom_property_repository.custom_property(stickiness_property) || @custom_property_repository.custom_property("rox.#{Rox::Core::PropertyType::DISTINCT_ID.name}")
+            distinct_id = '(null_distinct_id'
+            unless prop.nil?
+              prop_value = prop.value(context)
+              distinct_id = prop_value if prop_value.instance_of?(String)
+            end
 
-        raise_impression_event(ImpressionArgs.new(reporting_value, client_experiment, context))
+            event_time = (Time.now.to_f * 1000.0).to_i
+            begin
+              event_time = ENV['rox.analytics.ms'].to_i
+            rescue StandardError
+            end
+
+            @analytics_client.track({
+                                      flag: reporting_value.name,
+                                      value: reporting_value.value,
+                                      distinctId: distinct_id,
+                                      experimentVersion: '0',
+                                      type: 'IMPRESSION',
+                                      time: event_time
+                                    })
+          end
+        rescue StandardError => ex
+          Logging.logger.error('Failed to send analytics', ex)
+        end
+
+        raise_impression_event(ImpressionArgs.new(reporting_value, context))
       end
 
       def register_impression_handler(&block)
@@ -32,10 +63,13 @@ module Rox
           handlers = @impression_handlers.clone
         end
 
-        handlers.each do |handler|
-          handler.call(args)
+        begin
+          handlers.each { |handler| handler.call(args) }
+        rescue StandardError => e
+          user_unhandled_error_invoker.invoke(handler, ExceptionTrigger::IMPRESSION_HANDLER, e)
+          Logging.logger.error('Impresssion handler exception', ex)
         end
       end
     end
   end
-end
+end

data/lib/rox/core/impression/models/experiment.rb

@@ -11,4 +11,4 @@ module Rox
       end
     end
   end
-end
+end

data/lib/rox/core/impression/models/reporting_value.rb

@@ -1,5 +1,13 @@
 module Rox
   module Core
-    ReportingValue = Struct.new(:name, :value)
+    class ReportingValue
+      attr_reader :name, :value, :targeting
+
+      def initialize(name, value, experiment = nil)
+        @name = name
+        @value = value
+        @targeting = !experiment.nil?
+      end
+    end
   end
-end
+end

data/lib/rox/core/logging/logging.rb

@@ -5,8 +5,8 @@ module Rox
     class Logging
       @logger = nil
 
-      def self.logger=(logger)
-        @logger = logger
+      class << self
+        attr_writer :logger
       end
 
       def self.logger
@@ -14,4 +14,4 @@ module Rox
       end
     end
   end
-end
+end

data/lib/rox/core/logging/no_op_logger.rb

@@ -8,4 +8,4 @@ module Rox
       def warn(message, ex = nil); end
     end
   end
-end
+end

data/lib/rox/core/network/configuration_fetcher.rb

@@ -19,8 +19,8 @@ module Rox
           end
 
           write_fetch_error_to_log_and_invoke_fetch_handler(source, fetch_result)
-        rescue StandardError => ex
-          write_fetch_exception_to_log_and_invoke_fetch_handler(source, ex)
+        rescue StandardError => e
+          write_fetch_exception_to_log_and_invoke_fetch_handler(source, e)
         end
 
         nil

data/lib/rox/core/network/configuration_fetcher_roxy.rb

@@ -14,8 +14,8 @@ module Rox
           else
             write_fetch_error_to_log_and_invoke_fetch_handler(source, fetch_roxy)
           end
-        rescue StandardError => ex
-          write_fetch_exception_to_log_and_invoke_fetch_handler(source, ex)
+        rescue StandardError => e
+          write_fetch_exception_to_log_and_invoke_fetch_handler(source, e)
         end
 
         nil

data/lib/rox/core/network/configuration_fetcher_self_managed.rb

@@ -0,0 +1,30 @@
+require 'rox/core/network/configuration_source'
+require 'rox/core/network/configuration_fetch_result'
+require 'rox/core/network/configuration_fetcher_base'
+
+module Rox
+  module Core
+    class ConfigurationFetcherSelfManaged < ConfigurationFetcherBase
+      def fetch
+        source = ConfigurationSource::API
+        begin
+          fetch_result = fetch_from_api
+          if fetch_result.success?
+            return ConfigurationFetchResult.new(fetch_result.text, source)
+          else
+            write_fetch_error_to_log_and_invoke_fetch_handler(source, fetch_result)
+          end
+        rescue StandardError => e
+          write_fetch_exception_to_log_and_invoke_fetch_handler(source, e)
+        end
+
+        nil
+      end
+
+      def fetch_from_api
+        api_request = @request_configuration_builder.build_for_api
+        @request.send_post(api_request.url, api_request.query_params)
+      end
+    end
+  end
+end

data/lib/rox/core/network/configuration_source.rb

@@ -6,4 +6,4 @@ module Rox
       ROXY = 'Roxy'.freeze
     end
   end
-end
+end

data/lib/rox/core/network/request.rb

@@ -28,7 +28,7 @@ module Rox
           request.body = JSON.dump(payload)
         end
 
-        resp = Net::HTTP.start(uri.hostname, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+        resp = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
           http.request(request)
         end
 

data/lib/rox/core/network/request_configuration_builder.rb

@@ -5,25 +5,25 @@ require 'rox/core/consts/property_type'
 module Rox
   module Core
     class RequestConfigurationBuilder
-      def initialize(sdk_settings, buid, device_properties, roxy_url)
+      def initialize(sdk_settings, buid, device_properties)
         @sdk_settings = sdk_settings
         @buid = buid
         @device_properties = device_properties
-        @roxy_url = roxy_url
+        @rox_options = device_properties.rox_options
       end
 
       def build_for_roxy
-        roxy_endpoint = URI.join(@roxy_url, Rox::Core::Environment.roxy_internal_path).to_s
+        roxy_endpoint = URI.join(@rox_options.roxy_url, Rox::Core::Environment.roxy_internal_path).to_s
         build_request_with_full_params(roxy_endpoint)
       end
 
       def build_for_cdn
         RequestData.new("#{Rox::Core::Environment.cdn_path}/#{relative_path}",
-                    Rox::Core::PropertyType::DISTINCT_ID.name => @device_properties.distinct_id)
+                        Rox::Core::PropertyType::DISTINCT_ID.name => @device_properties.distinct_id)
       end
 
       def build_for_api
-        build_request_with_full_params("#{Rox::Core::Environment.api_path}/#{relative_path}")
+        build_request_with_full_params("#{Rox::Core::Environment.api_path(@rox_options.self_managed_options&.server_url)}/#{relative_path}")
       end
 
       def relative_path

data/lib/rox/core/network/request_data.rb

@@ -2,4 +2,4 @@ module Rox
   module Core
     RequestData = Struct.new(:url, :query_params)
   end
-end
+end

data/lib/rox/core/network/response.rb

@@ -6,7 +6,7 @@ module Rox
     class Response
       attr_accessor :status_code, :text, :content_type
 
-      def initialize(status_code, text, content_type='application/octet-stream')
+      def initialize(status_code, text, content_type = 'application/octet-stream')
         @status_code = status_code
         @text = text
         @content_type = content_type
@@ -21,13 +21,11 @@ module Rox
       end
 
       def missing_via_response_body?
-        begin
-          @status_code == 200 && @content_type == 'application/json' &&
-            [404, "404"].include?(JSON.parse(text)['result'])
-        rescue JSON::ParserError
-          Logging.logger.error("Failed to parse JSON response: #{text}")
-          false
-        end
+        @status_code == 200 && @content_type == 'application/json' &&
+          [404, '404'].include?(JSON.parse(text)['result'])
+      rescue JSON::ParserError
+        Logging.logger.error("Failed to parse JSON response: #{text}")
+        false
       end
     end
   end

data/lib/rox/core/network/state_sender.rb

@@ -18,7 +18,7 @@ module Rox
         @flag_repository = flag_repository
         @custom_property_repository = custom_property_repository
         @request = Request.new
-        @debouncer = Debouncer.new(1, Proc.new { self.send })
+        @debouncer = Debouncer.new(1, proc { send })
       end
 
       def delayed_send
@@ -30,21 +30,35 @@ module Rox
         serialized_feature_flags = StateSender.seralize_flag_repository(@flag_repository)
         serialized_custom_properties = StateSender.serialize_custom_properties_repository(@custom_property_repository)
 
-        state_payload = StateSender.state_payload(serialized_feature_flags, serialized_custom_properties, @device_properties, @sdk_settings.dev_mode_secret)
-        md5_signature = StateSender.md5_signature(serialized_feature_flags, serialized_custom_properties, @device_properties, @sdk_settings.dev_mode_secret)
+        state_payload = StateSender.state_payload(serialized_feature_flags, serialized_custom_properties,
+                                                  @device_properties, @sdk_settings.dev_mode_secret)
+        md5_signature = StateSender.md5_signature(serialized_feature_flags, serialized_custom_properties,
+                                                  @device_properties, @sdk_settings.dev_mode_secret)
 
-        response = get_state_from_CDN(rollout_key, md5_signature)
-        if !response.success?
-          Rox::Core::Logging.logger.debug("Failed to fetch state from CDN. Sending state to API...")
-          response = send_state_to_API(rollout_key, md5_signature, state_payload)
+        unless @device_properties.rox_options.self_managed?
+          response = get_state_from_CDN(rollout_key, md5_signature)
           if response.success?
-            Rox::Core::Logging.logger.debug("Successfully sent state to API.")
+            Rox::Core::Logging.logger.debug('Successfully fetched state from CDN')
+            return
           else
-            Rox::Core::Logging.logger.debug("Failed to send state to API.")
+            Rox::Core::Logging.logger.debug('Failed to fetch state from CDN. Sending state to API...')
           end
-        else
-          Rox::Core::Logging.logger.debug("Successfully fetched state from CDN")
         end
+
+        response = send_state_to_API(rollout_key, md5_signature, state_payload)
+        message = if response.success?
+                    'Successfully sent state to API.'
+                  else
+                    'Failed to send state to API.'
+                  end
+        Rox::Core::Logging.logger.debug(message)
+      end
+
+      def dump_state
+        serialized_feature_flags = StateSender.seralize_flag_repository_with_values(@flag_repository)
+        serialized_custom_properties = StateSender.serialize_custom_properties_repository_with_values(@custom_property_repository)
+        StateSender.state_payload(serialized_feature_flags, serialized_custom_properties, @device_properties,
+                                  @sdk_settings.dev_mode_secret)
       end
 
       def get_state_from_CDN(rollout_key, md5_signature)
@@ -54,11 +68,14 @@ module Rox
       end
 
       def send_state_to_API(rollout_key, md5_signature, state_payload)
-         @request.send_post("#{Rox::Core::Environment.state_api_path}/#{rollout_key}/#{md5_signature}", state_payload)
+        @request.send_post(
+          "#{Rox::Core::Environment.state_api_path(@device_properties.rox_options.self_managed_options&.server_url)}/#{rollout_key}/#{md5_signature}", state_payload
+        )
       end
 
       def self.md5_signature(serialized_feature_flags, serialized_custom_properties, device_properties, dev_mode_secret)
-        values = self.state_payload(serialized_feature_flags, serialized_custom_properties, device_properties, dev_mode_secret).values
+        values = state_payload(serialized_feature_flags, serialized_custom_properties, device_properties,
+                               dev_mode_secret).values
 
         hash = Digest::MD5.hexdigest(values.join('|'))
         hash.upcase
@@ -69,15 +86,15 @@ module Rox
         values[PropertyType::APP_KEY.name] = device_properties.all_properties[PropertyType::APP_KEY.name]
         values[PropertyType::PLATFORM.name] = device_properties.all_properties[PropertyType::PLATFORM.name]
         values.merge!(device_properties.all_properties)
-        values.merge!({feature_flags: seralized_flag_repository})
-        values.merge!({custom_properties: serialized_custom_property_repository})
-        values["devModeSecret"] =  dev_mode_secret
+        values.merge!({ feature_flags: seralized_flag_repository })
+        values.merge!({ custom_properties: serialized_custom_property_repository })
+        values['devModeSecret'] = dev_mode_secret
         values
       end
 
       def self.seralize_flag_repository(flag_repository)
         flags = []
-        flag_repository.all_flags.sort_by{|flag| flag.name }.each do |f|
+        flag_repository.all_flags.sort_by(&:name).each do |f|
           flags << {
             name: f.name,
             defaultValue: f.default_value,
@@ -87,11 +104,37 @@ module Rox
         flags
       end
 
+      def self.seralize_flag_repository_with_values(flag_repository)
+        flags = []
+        flag_repository.all_flags.sort_by(&:name).each do |f|
+          flags << {
+            name: f.name,
+            enabled: f.enabled?,
+            defaultValue: f.default_value,
+            options: f.options
+          }
+        end
+        flags
+      end
+
       def self.serialize_custom_properties_repository(custom_property_repository)
         properties = []
-        custom_property_repository.all_custom_properties.sort_by{|prop| prop.name }.each do |p|
+        custom_property_repository.all_custom_properties.sort_by(&:name).each do |p|
+          properties << {
+            name: p.name,
+            type: p.type.type,
+            externalType: p.type.external_type
+          }
+        end
+        properties
+      end
+
+      def self.serialize_custom_properties_repository_with_values(custom_property_repository)
+        properties = []
+        custom_property_repository.all_custom_properties.sort_by(&:name).each do |p|
           properties << {
             name: p.name,
+            value: p.value(nil),
             type: p.type.type,
             externalType: p.type.external_type
           }