rox-rollout 4.1.0 → 5.0.0

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)
@@ -82,4 +83,4 @@ module Rox
       end
     end
   end
-end
+end

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.7.0'
+      PLATFORM = 'Ruby'.freeze
+      API_VERSION = '1.9.0'.freeze
     end
   end
-end
+end

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

@@ -8,33 +8,57 @@ module Rox
       def self.cdn_path
         case ENV['ROLLOUT_MODE']
         when 'QA'
-          'https://s3.amazonaws.com/qa-rox-conf.rollout.io/v1/qa'
+          'https://qa-conf.rollout.io'
         when 'LOCAL'
-          'https://s3.amazonaws.com/qa-rox-conf.rollout.io/v1/development'
+          'https://development-conf.rollout.io'
         else
-          'https://s3.amazonaws.com/rox-conf.rollout.io/v1/production'
+          'https://conf.rollout.io'
         end
       end
 
-      def self.api_path
+      def self.api_path(api_url = nil)
         case ENV['ROLLOUT_MODE']
         when 'QA'
-          'https://qax.rollout.io/device/request_configuration'
+          'https://qa-api.rollout.io/device/get_configuration'
         when 'LOCAL'
-          'http://127.0.0.1:8557/device/request_configuration'
+          'http://127.0.0.1:8557/device/get_configuration'
         else
-          'https://x-api.rollout.io/device/request_configuration'
+          api_url ||= 'https://x-api.rollout.io'
+          "#{api_url}/device/get_configuration"
         end
       end
 
-      def self.analytics_path
+      def self.state_cdn_path
+        case ENV['ROLLOUT_MODE']
+        when 'QA'
+          'https://qa-statestore.rollout.io'
+        when 'LOCAL'
+          'https://development-statestore.rollout.io'
+        else
+          'https://statestore.rollout.io'
+        end
+      end
+
+      def self.state_api_path(api_url = nil)
+        case ENV['ROLLOUT_MODE']
+        when 'QA'
+          'https://qa-api.rollout.io/device/update_state_store'
+        when 'LOCAL'
+          'http://127.0.0.1:8557/device/update_state_store'
+        else
+          api_url ||= 'https://x-api.rollout.io'
+          "#{api_url}/device/update_state_store"
+        end
+      end
+
+      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
 
@@ -50,4 +74,4 @@ module Rox
       end
     end
   end
-end
+end

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

@@ -8,22 +8,23 @@ module Rox
         @name = name
       end
 
-      CACHE_MISS_URL = PropertyType.new(1, 'cache_miss_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")
+      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')
+      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
+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

data/lib/rox/core/core.rb

@@ -11,6 +11,8 @@ require 'rox/core/network/request_configuration_builder'
 require 'rox/core/network/request'
 require 'rox/core/network/configuration_fetcher'
 require 'rox/core/network/configuration_fetcher_roxy'
+require 'rox/core/network/configuration_fetcher_self_managed'
+require 'rox/core/network/state_sender'
 require 'rox/core/notifications/notification_listener'
 require 'rox/core/register/registerer'
 require 'rox/core/client/internal_flags'
@@ -19,8 +21,11 @@ require 'rox/core/entities/flag_setter'
 require 'rox/core/impression/impression_invoker'
 require 'rox/core/reporting/error_reporter'
 require 'rox/core/security/signature_verifier'
+require 'rox/core/security/signature_verifier_mock'
 require 'rox/core/utils/periodic_task'
 require 'rox/core/client/dynamic_api'
+require 'rox/core/analytics'
+require 'rox/core/error_handling/userspace_unhandled_error_invoker'
 
 module Rox
   module Core
@@ -30,14 +35,10 @@ module Rox
         @custom_property_repository = CustomPropertyRepository.new
         @target_group_repository = TargetGroupRepository.new
         @experiment_repository = ExperimentRepository.new
-        @parser = Parser.new
+        @user_unhandled_error_invoker = Rox::Core::UserspaceUnhandledErrorInvoker.new
+        @parser = Parser.new(@user_unhandled_error_invoker)
 
-        experiments_extensions = ExperimentsExtensions.new(@parser, @target_group_repository, @flag_repository, @experiment_repository)
-        properties_extensions = PropertiesExtensions.new(@parser, @custom_property_repository)
-        experiments_extensions.extend
-        properties_extensions.extend
-
-        @configuration_fetched_invoker = ConfigurationFetchedInvoker.new
+        @configuration_fetched_invoker = ConfigurationFetchedInvoker.new(@user_unhandled_error_invoker)
         @registerer = Registerer.new(@flag_repository)
 
         @sdk_settings = nil
@@ -50,57 +51,106 @@ module Rox
         @push_updates_listener = nil
       end
 
-      def setup(sdk_settings, device_properties, rox_options)
+      def userspace_unhandled_error_handler=(handler)
+        @user_unhandled_error_invoker.handler = handler
+      end
+
+      def setup(sdk_settings, device_properties)
         @sdk_settings = sdk_settings
+        @rox_options = device_properties.rox_options
 
-        roxy_path = rox_options.nil? || rox_options.roxy_url.nil? ? nil : rox_options.roxy_url
+        experiments_extensions = ExperimentsExtensions.new(@parser, @target_group_repository, @flag_repository,
+                                                           @experiment_repository)
+        properties_extensions = PropertiesExtensions.new(@parser, @custom_property_repository, @rox_options.dynamic_property_rule_handler)
+        experiments_extensions.extend
+        properties_extensions.extend
+
+        roxy_path = @rox_options.nil? || @rox_options.roxy_url.nil? ? nil : @rox_options.roxy_url
+
+        validate_api_key(sdk_settings&.api_key) if roxy_path.nil?
 
         # TODO: Analytics.Analytics.Initialize(deviceProperties.RolloutKey, deviceProperties)
-        @internal_flags = InternalFlags.new(@experiment_repository, @parser)
+        @internal_flags = InternalFlags.new(@experiment_repository, @parser, @rox_options)
 
+        @analytics_client = Analytics.new(sdk_settings.api_key).client
         # TODO: impressionInvoker = new ImpressionInvoker(internalFlags, customPropertyRepository, deviceProperties, Analytics.Analytics.Client, roxyPath != null);
-        @impression_invoker = ImpressionInvoker.new(@internal_flags, @custom_property_repository, device_properties, nil, !roxy_path.nil?)
+        @impression_invoker = ImpressionInvoker.new(@internal_flags, @custom_property_repository, device_properties,
+                                                    @analytics_client, !roxy_path.nil?, @user_unhandled_error_invoker)
         @flag_setter = FlagSetter.new(@flag_repository, @parser, @experiment_repository, @impression_invoker)
         buid = BUID.new(sdk_settings, device_properties, @flag_repository, @custom_property_repository)
 
-        request_config_builder = RequestConfigurationBuilder.new(sdk_settings, buid, device_properties, roxy_path)
+        request_config_builder = RequestConfigurationBuilder.new(sdk_settings, buid, device_properties)
 
         client_request = Request.new
         err_reporter_request = Request.new
 
         @error_reporter = ErrorReporter.new(err_reporter_request, device_properties, buid)
 
-        if roxy_path.nil?
-          @configuration_fetcher = ConfigurationFetcher.new(request_config_builder, client_request, @configuration_fetched_invoker)
+        if @rox_options.self_managed?
+          @configuration_fetcher = ConfigurationFetcherSelfManaged.new(request_config_builder, client_request,
+                                                                       @configuration_fetched_invoker)
+          @state_sender = StateSender.new(@sdk_settings, device_properties, @flag_repository,
+                                          @custom_property_repository)
+          @flag_repository.register_flag_added_handler { @state_sender.delayed_send }
+          @custom_property_repository.register_property_added_handler { @state_sender.delayed_send }
+        elsif roxy_path.nil?
+          @configuration_fetcher = ConfigurationFetcher.new(request_config_builder, client_request,
+                                                            @configuration_fetched_invoker)
+          @state_sender = StateSender.new(@sdk_settings, device_properties, @flag_repository,
+                                          @custom_property_repository)
+          @flag_repository.register_flag_added_handler { @state_sender.delayed_send }
+          @custom_property_repository.register_property_added_handler { @state_sender.delayed_send }
         else
-          @configuration_fetcher = ConfigurationFetcherRoxy.new(request_config_builder, client_request, @configuration_fetched_invoker)
+          @configuration_fetcher = ConfigurationFetcherRoxy.new(request_config_builder, client_request,
+                                                                @configuration_fetched_invoker)
         end
 
         configuration_fetched_handler = nil
-        unless rox_options.nil?
-          configuration_fetched_handler = rox_options.configuration_fetched_handler
-        end
+        configuration_fetched_handler = @rox_options.configuration_fetched_handler unless @rox_options.nil?
 
         @configuration_fetched_invoker.register_fetched_handler(&wrap_configuration_fetched_handler(&configuration_fetched_handler))
 
-        Thread.new do
+        @thread = Thread.new do
           Thread.current.report_on_exception = false if Thread.current.respond_to?(:report_on_exception)
           fetch
+          @state_sender&.send
 
-          if !rox_options.nil? && !rox_options.impression_handler.nil?
-            @impression_invoker.register_impression_handler(&rox_options.impression_handler)
+          if !@rox_options.nil? && !@rox_options.impression_handler.nil?
+            @impression_invoker.register_impression_handler(&@rox_options.impression_handler)
           end
 
-          if !rox_options.nil? && !rox_options.fetch_interval.nil?
-            PeriodicTask.run(rox_options.fetch_interval) { fetch }
+          if !@rox_options.nil? && !@rox_options.fetch_interval.nil?
+            PeriodicTask.run(@rox_options.fetch_interval) { fetch }
           end
         end
       end
 
+      def shutdown
+        return if @thread.nil?
+
+        Thread.kill(@thread)
+        @thread = nil
+
+        unless @push_updates_listener.nil?
+          @push_updates_listener.stop
+          @push_updates_listener = nil
+        end
+
+        return if @analytics_client.nil?
+
+        @analytics_client.flush
+      end
+
       def fetch
         return if @configuration_fetcher.nil?
 
-        configuration_parser = ConfigurationParser.new(SignatureVerifier.new, @error_reporter, @configuration_fetched_invoker)
+        signature_verifier = if @rox_options.self_managed?
+                               SignatureVerifierMock.new
+                             else
+                               SignatureVerifier.new
+                             end
+        configuration_parser = ConfigurationParser.new(signature_verifier, @error_reporter,
+                                                       @configuration_fetched_invoker)
         result = @configuration_fetcher.fetch
         return if result.nil?
 
@@ -113,17 +163,22 @@ module Rox
 
         has_changes = @last_configurations.nil? || @last_configurations.data != result.data
         @last_configurations = result
-        @configuration_fetched_invoker.invoke(FetcherStatus::APPLIED_FROM_NETWORK, configuration.signature_date, has_changes)
+        @configuration_fetched_invoker.invoke(FetcherStatus::APPLIED_FROM_NETWORK, configuration.signature_date,
+                                              has_changes)
+      end
+
+      def register_with_namespace(namespace, rox_container)
+        @registerer.register_instance(rox_container, namespace)
       end
 
-      def register(ns, rox_container)
-        @registerer.register_instance(rox_container, ns)
+      def register(*args)
+        rox_container = args.pop
+        namespace = args.length == 1 ? args.pop : ''
+        @registerer.register_instance(rox_container, namespace)
       end
 
       def context=(context)
-        @flag_repository.all_flags.each do |flag|
-          flag.context = context
-        end
+        @parser.global_context = context
       end
 
       def add_custom_property(property)
@@ -137,7 +192,7 @@ module Rox
       def wrap_configuration_fetched_handler(&handler)
         lambda do |args|
           start_or_stop_push_updated_listener unless args.fetcher_status == FetcherStatus::ERROR_FETCHED_FAILED
-          handler.call(args) unless handler.nil?
+          handler&.call(args)
         end
       end
 
@@ -145,7 +200,7 @@ module Rox
         if @internal_flags.enabled?('rox.internal.pushUpdates')
           if @push_updates_listener.nil?
             @push_updates_listener = NotificationListener.new(Environment.notifications_path, @sdk_settings.api_key)
-            @push_updates_listener.on 'changed' do |data|
+            @push_updates_listener.on 'changed' do |_data|
               fetch
             end
             @push_updates_listener.start
@@ -161,6 +216,19 @@ module Rox
       def dynamic_api(entities_provider)
         Rox::Core::DynamicApi.new(@flag_repository, entities_provider)
       end
+
+      def dump_state
+        @state_sender.dump_state
+      end
+
+      def validate_api_key(api_key)
+        valid_api_key_pattern = /^[a-f\d]{24}$/
+        if api_key&.strip&.empty?
+          raise ArgumentError, 'Blank Rollout api key - must be specified'
+        elsif !valid_api_key_pattern.match(api_key)
+          raise ArgumentError, 'Illegal Rollout api key'
+        end
+      end
     end
   end
-end
+end