rox-rollout 4.7.1 → 5.0.2

data/lib/rox/core/analytics.rb

@@ -0,0 +1,18 @@
+require 'segment/analytics'
+
+module Rox
+  module Core
+    # Analytics based on segment client
+    # https://segment.com/docs/connections/sources/catalog/libraries/server/ruby/
+    class Analytics
+      attr_reader :client
+
+      def initialize(key)
+        @client = Segment::Analytics.new({
+                                           write_key: key,
+                                           on_error: proc { |_status, msg| print msg }
+                                         })
+      end
+    end
+  end
+end

data/lib/rox/core/client/buid.rb

@@ -6,13 +6,13 @@ module Rox
   module Core
     class BUID
       BUID_GENERATORS = [
-          PropertyType::PLATFORM,
-          PropertyType::APP_KEY,
-          PropertyType::LIB_VERSION,
-          PropertyType::API_VERSION
+        PropertyType::PLATFORM,
+        PropertyType::APP_KEY,
+        PropertyType::LIB_VERSION,
+        PropertyType::API_VERSION
       ].freeze
 
-      def initialize(sdk_settings, device_properties, flag_repository, custom_property_repository)
+      def initialize(sdk_settings, device_properties, _flag_repository, _custom_property_repository)
         @sdk_settings = sdk_settings
         @device_properties = device_properties
         @buid = nil
@@ -31,11 +31,11 @@ module Rox
       end
 
       def query_string_parts
-        generators = BUID::BUID_GENERATORS.map {|pt, _| pt.name}
+        generators = BUID::BUID_GENERATORS.map { |pt, _| pt.name }
 
         {
-            PropertyType::BUID.name => value,
-            PropertyType::BUID_GENERATORS_LIST.name => generators.join(','),
+          PropertyType::BUID.name => value,
+          PropertyType::BUID_GENERATORS_LIST.name => generators.join(',')
         }
       end
 

data/lib/rox/core/client/device_properties.rb

@@ -4,11 +4,17 @@ require 'rox/core/consts/build'
 module Rox
   module Core
     class DeviceProperties
+      attr_reader :rox_options
+
       def initialize(sdk_settings, rox_options)
         @sdk_settings = sdk_settings
         @rox_options = rox_options
       end
 
+      def get(property)
+        all_properties[property.name]
+      end
+
       def all_properties
         {
           PropertyType::PACKAGE_NAME.name => @rox_options.version,
@@ -20,7 +26,7 @@ module Rox
           PropertyType::APP_RELEASE.name => @rox_options.version,
           PropertyType::DISTINCT_ID.name => distinct_id,
           PropertyType::APP_KEY.name => @sdk_settings.api_key,
-          PropertyType::PLATFORM.name => Build::PLATFORM,
+          PropertyType::PLATFORM.name => Build::PLATFORM
         }
       end
 

data/lib/rox/core/client/dynamic_api.rb

@@ -1,4 +1,5 @@
 require 'rox/core/entities/flag'
+require 'rox/server/flags/normalize_flag_type'
 
 module Rox
   module Core
@@ -9,28 +10,65 @@ module Rox
       end
 
       def enabled?(name, default_value, context = nil)
-        variant = @flag_repository.flag(name)
-        if variant.nil?
-          variant = @entities_provider.create_flag(default_value)
-          @flag_repository.add_flag(variant, name)
-        end
+        raise ArgumentError, 'flag name should be a string' unless name.is_a?(String)
+        raise ArgumentError, 'default value should be boolean' unless [true, false].include?(default_value)
 
-        return default_value unless variant.is_a?(Flag)
+        string = @flag_repository.flag(name)
+        if string.nil?
+          string = @entities_provider.create_flag(default_value)
+          @flag_repository.add_flag(string, name)
+        end
 
-        is_enabled = variant.internal_enabled?(context, nil_instead_of_default: true)
-        is_enabled.nil? ? default_value : is_enabled
+        merged_context = MergedContext.new(string.parser&.global_context, context)
+        return_value = unless string.is_a?(Flag)
+                         default_value
+                       else
+                         is_enabled = string.internal_enabled?(context, nil_instead_of_default: true)
+                         is_enabled.nil? ? default_value : is_enabled
+                       end
+        string.send_impressions(return_value, merged_context)
+        return_value
       end
 
       def value(name, default_value, context = nil, options = [])
-        variant = @flag_repository.flag(name)
-        if variant.nil?
-          variant = @entities_provider.create_variant(default_value, options)
-          @flag_repository.add_flag(variant, name)
+        generic_value(name, default_value, context, options)
+      end
+
+      def int_value(name, default_value, context = nil, options = [])
+        create_method = @entities_provider.method(:create_int)
+        normalize_method = Rox::Server::NormalizeFlagType.method(:normalize_int)
+        generic_value(name, default_value, context, options, Integer, create_method, normalize_method)
+      end
+
+      def double_value(name, default_value, context = nil, options = [])
+        create_method = @entities_provider.method(:create_double)
+        normalize_method = Rox::Server::NormalizeFlagType.method(:normalize_float)
+        generic_value(name, default_value, context, options, Float, create_method, normalize_method)
+      end
+
+      private
+
+      def generic_value(name, default_value, context, options, flag_type = String, create_method = nil, normalize_method = Rox::Server::NormalizeFlagType.method(:normalize_string))
+        unless name.is_a?(String)
+          raise ArgumentError, 'DynamicApi error - name must be string'
+        end
+
+        unless default_value.is_a?(flag_type)
+          raise ArgumentError, "DynamicApi default value must be of #{flag_type} type. Received #{default_value}"
+        end
+
+        string = @flag_repository.flag(name)
+        if string.nil?
+          string = create_method.nil? ? @entities_provider.create_string(default_value, options) : create_method.call(default_value, options)
+          @flag_repository.add_flag(string, name)
         end
 
-        value = variant.internal_value(context, nil_instead_of_default: true)
-        value.nil? ? default_value : value
+        merged_context = MergedContext.new(string.parser&.global_context, context)
+        value = string.internal_value(context, nil_instead_of_default: true)
+        return_value = value.nil? ? normalize_method.call(default_value) : normalize_method.call(value)
+        string.send_impressions(return_value, merged_context)
+        return_value
       end
     end
   end
-end
+end

data/lib/rox/core/client/internal_flags.rb

@@ -3,12 +3,24 @@ require 'rox/core/entities/flag'
 module Rox
   module Core
     class InternalFlags
-      def initialize(experiment_repository, parser)
+      @@defaults_self_managed = {
+        'rox.internal.pushUpdates' => false,
+        'rox.internal.considerThrottleInPush' => false,
+        'rox.internal.throttleFetchInSeconds' => 0
+      }
+
+      def initialize(experiment_repository, parser, rox_options)
         @experiment_repository = experiment_repository
         @parser = parser
+        @rox_options = rox_options
       end
 
       def enabled?(flag_name)
+        if @rox_options.self_managed?
+          value = @@defaults_self_managed[flag_name]
+          return value unless value.nil?
+        end
+
         internal_experiment = @experiment_repository.experiment_by_flag(flag_name)
         return false if internal_experiment.nil?
 
@@ -17,4 +29,4 @@ module Rox
       end
     end
   end
-end
+end

data/lib/rox/core/client/sdk_settings.rb

@@ -2,4 +2,4 @@ module Rox
   module Core
     SdkSettings = Struct.new(:api_key, :dev_mode_secret)
   end
-end
+end

data/lib/rox/core/configuration/configuration.rb

@@ -2,4 +2,4 @@ module Rox
   module Core
     Configuration = Struct.new(:experiments, :target_groups, :signature_date)
   end
-end
+end

data/lib/rox/core/configuration/configuration_fetched_args.rb

@@ -14,10 +14,10 @@ module Rox
       end
 
       def self.error(error_details)
-        args = ConfigurationFetchedArgs.new(FetcherStatus::ERROR_FETCHED_FAILED, nil, false )
+        args = ConfigurationFetchedArgs.new(FetcherStatus::ERROR_FETCHED_FAILED, nil, false)
         args.error_details = error_details
         args
       end
     end
   end
-end
+end

data/lib/rox/core/configuration/configuration_fetched_invoker.rb

@@ -3,9 +3,10 @@ require 'rox/core/configuration/configuration_fetched_args'
 module Rox
   module Core
     class ConfigurationFetchedInvoker
-      def initialize
+      def initialize(user_unhandled_error_invoker)
         @fetched_handlers = []
         @mutex = Mutex.new
+        @user_unhandled_error_invoker = user_unhandled_error_invoker
       end
 
       def invoke(fetcher_status, creation_date, has_changes)
@@ -29,9 +30,13 @@ module Rox
         end
 
         handlers.each do |handler|
-          handler.call(args)
+          begin
+            handler.call(args)
+          rescue StandardError => e
+            user_unhandled_error_invoker.invoke(handler, Rox::Core::CONFIGURATION_FETCHED_HANDLER, e)
+          end
         end
       end
     end
   end
-end
+end

data/lib/rox/core/configuration/configuration_parser.rb

@@ -17,50 +17,51 @@ module Rox
       end
 
       def parse(fetch_result, sdk_settings)
-        begin
-          if fetch_result.nil? || fetch_result.data.nil? || fetch_result.data.empty?
-            @configuration_fetched_invoker.invoke_error(FetcherError::EMPTY_JSON)
-            @error_reporter.report('Failed to parse JSON configuration - Null Or Empty', ArgumentError.new('data'))
-            return nil
-          end
-
-          begin
-            json_obj = JSON.parse(fetch_result.data)
-          rescue StandardError => ex
-            @configuration_fetched_invoker.invoke_error(FetcherError::CORRUPTED_JSON)
-            @error_reporter.report('Failed to parse JSON configuration', ex)
-            return nil
-          end
-
-          if fetch_result.source != ConfigurationSource::ROXY && !@signature_verifier.verify(json_obj['data'], json_obj['signature_v0'])
-            @configuration_fetched_invoker.invoke_error(FetcherError::SIGNATURE_VERIFICATION_ERROR)
-            @error_reporter.report('Failed to validate signature', StandardError.new("Data : #{json_obj['data']} Signature : #{json_obj['signature_v0']}"))
-            return nil
-          end
+        if fetch_result.nil? || fetch_result.data.nil? || fetch_result.data.empty?
+          @configuration_fetched_invoker.invoke_error(FetcherError::EMPTY_JSON)
+          @error_reporter.report('Failed to parse JSON configuration - Null Or Empty', ArgumentError.new('data'))
+          return nil
+        end
 
-          signature_date = DateTime.rfc3339(json_obj['signed_date']).to_time
-          internal_data_string = json_obj['data']
-          internal_data_object = JSON.parse(internal_data_string)
+        begin
+          json_obj = JSON.parse(fetch_result.data)
+        rescue StandardError => e
+          @configuration_fetched_invoker.invoke_error(FetcherError::CORRUPTED_JSON)
+          @error_reporter.report('Failed to parse JSON configuration', e)
+          return nil
+        end
 
-          if fetch_result.source != ConfigurationSource::ROXY && internal_data_object['application'] != sdk_settings.api_key
-            @configuration_fetched_invoker.invoke_error(FetcherError::MISMATCH_APP_KEY)
-            @error_reporter.report('Failed to parse JSON configuration - ', StandardError.new("Internal Data: #{internal_data_object['application']} SdkSettings: #{sdk_settings.api_key}"))
-            return nil
-          end
+        if fetch_result.source != ConfigurationSource::ROXY && !@signature_verifier.verify(json_obj['data'],
+                                                                                           json_obj['signature_v0'])
+          @configuration_fetched_invoker.invoke_error(FetcherError::SIGNATURE_VERIFICATION_ERROR)
+          @error_reporter.report('Failed to validate signature',
+                                 StandardError.new("Data : #{json_obj['data']} Signature : #{json_obj['signature_v0']}"))
+          return nil
+        end
 
-          experiments = parse_experiments(internal_data_object)
-          target_groups = parse_target_groups(internal_data_object)
+        signature_date = DateTime.rfc3339(json_obj['signed_date']).to_time
+        internal_data_string = json_obj['data']
+        internal_data_object = JSON.parse(internal_data_string)
 
-          Configuration.new(experiments, target_groups, signature_date)
-        rescue StandardError => ex
-          Logging.logger.error('Failed to parse configurations', ex)
-          @configuration_fetched_invoker.invoke_error(FetcherError::UNKNOWN)
+        if fetch_result.source != ConfigurationSource::ROXY && internal_data_object['application'] != sdk_settings.api_key
+          @configuration_fetched_invoker.invoke_error(FetcherError::MISMATCH_APP_KEY)
+          @error_reporter.report('Failed to parse JSON configuration - ',
+                                 StandardError.new("Internal Data: #{internal_data_object['application']} SdkSettings: #{sdk_settings.api_key}"))
           return nil
         end
+
+        experiments = parse_experiments(internal_data_object)
+        target_groups = parse_target_groups(internal_data_object)
+
+        Configuration.new(experiments, target_groups, signature_date)
+      rescue StandardError => e
+        Logging.logger.error('Failed to parse configurations', e)
+        @configuration_fetched_invoker.invoke_error(FetcherError::UNKNOWN)
+        nil
       end
 
       def parse_experiments(data)
-        data['experiments'].map { |e| parse_experiment(e)}
+        data['experiments'].map { |e| parse_experiment(e) }
       end
 
       def parse_experiment(data)
@@ -69,12 +70,12 @@ module Rox
         name = data['name']
         id = data['_id']
         labels = data['labels'] || []
-        flags = data['featureFlags'].map {|f| f['name']}
+        flags = data['featureFlags'].map { |f| f['name'] }
         ExperimentModel.new(id, name, condition, is_archived, flags, labels)
       end
 
       def parse_target_groups(data)
-        data['targetGroups'].map { |g| parse_target_group(g)}
+        data['targetGroups'].map { |g| parse_target_group(g) }
       end
 
       def parse_target_group(data)

data/lib/rox/core/configuration/fetcher_error.rb

@@ -10,4 +10,4 @@ module Rox
       NO_ERROR = 'NoError'.freeze
     end
   end
-end
+end

data/lib/rox/core/configuration/fetcher_status.rb

@@ -7,4 +7,4 @@ module Rox
       ERROR_FETCHED_FAILED = 'ErrorFetchedFailed'.freeze
     end
   end
-end
+end

data/lib/rox/core/configuration/models/experiment_model.rb

@@ -2,4 +2,4 @@ module Rox
   module Core
     ExperimentModel = Struct.new(:id, :name, :condition, :is_archived, :flags, :labels)
   end
-end
+end

data/lib/rox/core/configuration/models/target_group_model.rb

@@ -2,4 +2,4 @@ module Rox
   module Core
     TargetGroupModel = Struct.new(:id, :condition)
   end
-end
+end

data/lib/rox/core/consts/build.rb

@@ -1,8 +1,8 @@
 module Rox
   module Core
     module Build
-      PLATFORM = 'Ruby'
-      API_VERSION = '1.8.0'
+      PLATFORM = 'Ruby'.freeze
+      API_VERSION = '1.9.0'.freeze
     end
   end
 end

data/lib/rox/core/consts/environment.rb

@@ -16,14 +16,15 @@ module Rox
         end
       end
 
-      def self.api_path
+      def self.api_path(api_url = nil)
         case ENV['ROLLOUT_MODE']
         when 'QA'
-          'https://qax.rollout.io/device/get_configuration'
+          'https://qa-api.rollout.io/device/get_configuration'
         when 'LOCAL'
           'http://127.0.0.1:8557/device/get_configuration'
         else
-          'https://x-api.rollout.io/device/get_configuration'
+          api_url ||= 'https://x-api.rollout.io'
+          "#{api_url}/device/get_configuration"
         end
       end
 
@@ -38,25 +39,26 @@ module Rox
         end
       end
 
-      def self.state_api_path
+      def self.state_api_path(api_url = nil)
         case ENV['ROLLOUT_MODE']
         when 'QA'
-          'https://qax.rollout.io/device/update_state_store'
+          'https://qa-api.rollout.io/device/update_state_store'
         when 'LOCAL'
           'http://127.0.0.1:8557/device/update_state_store'
         else
-          'https://x-api.rollout.io/device/update_state_store'
+          api_url ||= 'https://x-api.rollout.io'
+          "#{api_url}/device/update_state_store"
         end
       end
 
-      def self.analytics_path
+      def self.analytics_path(analytics_url = 'https://analytic.rollout.io')
         case ENV['ROLLOUT_MODE']
         when 'QA'
           'https://qaanalytic.rollout.io'
         when 'LOCAL'
           'http://127.0.0.1:8787'
         else
-          'https://analytic.rollout.io'
+          analytics_url
         end
       end
 

data/lib/rox/core/consts/property_type.rb

@@ -9,23 +9,22 @@ module Rox
       end
 
       CACHE_MISS_RELATIVE_URL = PropertyType.new(1, 'cache_miss_relative_url')
-      PACKAGE_NAME = PropertyType.new(2, "package_name")
-      VERSION_NAME = PropertyType.new(3, "version_name")
-      LIB_VERSION = PropertyType.new(4, "lib_version")
-      ROLLOUT_BUILD = PropertyType.new(5, "rollout_build")
-      API_VERSION = PropertyType.new(6, "api_version")
-      BUID = PropertyType.new(7, "buid")
-      BUID_GENERATORS_LIST = PropertyType.new(8, "buid_generators_list")
-      APP_VERSION = PropertyType.new(9, "app_version")
-      APP_RELEASE = PropertyType.new(10, "app_release")
-      DISTINCT_ID = PropertyType.new(11, "distinct_id")
-      APP_KEY = PropertyType.new(12, "app_key")
-      FEATURE_FLAGS = PropertyType.new(13, "feature_flags")
-      REMOTE_VARIABLES = PropertyType.new(14, "remote_variables")
-      CUSTOM_PROPERTIES = PropertyType.new(15, "custom_properties")
-      PLATFORM = PropertyType.new(16, "platform")
-      DEV_MODE_SECRET = PropertyType.new(17, "dev_mode_secret")
-      STATE_MD5 = PropertyType.new(18, "state_md5")
+      PACKAGE_NAME = PropertyType.new(2, 'package_name')
+      VERSION_NAME = PropertyType.new(3, 'version_name')
+      LIB_VERSION = PropertyType.new(4, 'lib_version')
+      ROLLOUT_BUILD = PropertyType.new(5, 'rollout_build')
+      API_VERSION = PropertyType.new(6, 'api_version')
+      BUID = PropertyType.new(7, 'buid')
+      BUID_GENERATORS_LIST = PropertyType.new(8, 'buid_generators_list')
+      APP_VERSION = PropertyType.new(9, 'app_version')
+      APP_RELEASE = PropertyType.new(10, 'app_release')
+      DISTINCT_ID = PropertyType.new(11, 'distinct_id')
+      APP_KEY = PropertyType.new(12, 'app_key')
+      FEATURE_FLAGS = PropertyType.new(13, 'feature_flags')
+      CUSTOM_PROPERTIES = PropertyType.new(14, 'custom_properties')
+      PLATFORM = PropertyType.new(15, 'platform')
+      DEV_MODE_SECRET = PropertyType.new(16, 'dev_mode_secret')
+      STATE_MD5 = PropertyType.new(17, 'state_md5')
     end
   end
 end

data/lib/rox/core/context/merged_context.rb

@@ -9,8 +9,9 @@ module Rox
       def [](key)
         return @local_context[key] unless @local_context.nil? || @local_context[key].nil?
         return @global_context[key] unless @global_context.nil?
+
         nil
       end
     end
   end
-end
+end