rox-rollout 4.7.1 → 5.0.2

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
@@ -66,18 +83,19 @@ module Rox
 
       def self.state_payload(seralized_flag_repository, serialized_custom_property_repository, device_properties, dev_mode_secret)
         values = {}
+        # be careful adding here properties, md5 signature uses all props
+        # to add more payload data, please change the md5_signature to use only the relevant properties (the current ones creating the payload)
         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 +105,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
           }

data/lib/rox/core/notifications/notification_listener.rb

@@ -1,4 +1,4 @@
-require "em-eventsource"
+require 'em-eventsource'
 
 module Rox
   module Core
@@ -15,7 +15,7 @@ module Rox
       end
 
       def start
-        sse_url = @listen_url.chomp('/') + '/' + @app_key
+        sse_url = "#{@listen_url.chomp('/')}/#{@app_key}"
         @thread = Thread.new do
           EM.run do
             source = EventMachine::EventSource.new(sse_url)
@@ -37,9 +37,9 @@ module Rox
       end
 
       def stop
-        @thread.terminate unless @thread.nil?
+        @thread&.terminate
         @thread = nil
       end
     end
   end
-end
+end

data/lib/rox/core/properties/custom_property.rb

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

data/lib/rox/core/properties/custom_property_type.rb

@@ -15,4 +15,4 @@ module Rox
       SEMVER = CustomPropertyType.new('semver', 'Semver')
     end
   end
-end
+end

data/lib/rox/core/properties/device_property.rb

@@ -4,8 +4,8 @@ module Rox
   module Core
     class DeviceProperty < CustomProperty
       def initialize(name, type, value = nil)
-        super('rox.' + name, type, value)
+        super("rox.#{name}", type, value)
       end
     end
   end
-end
+end

data/lib/rox/core/properties/property_factory.rb

@@ -0,0 +1,132 @@
+require 'securerandom'
+require 'rox/server/rox_options'
+require 'rox/server/client/sdk_settings'
+require 'rox/server/client/server_properties'
+require 'rox/core/properties/device_property'
+require 'rox/core/properties/custom_property'
+require 'rox/core/properties/custom_property_type'
+require 'rox/core/consts/property_type'
+
+module Rox
+  module Core
+    # Consolidates creation of all the internal properties
+    class PropertyFactory
+      def initialize(server_properties)
+        @server_properties = server_properties
+      end
+
+      def platform
+        property = Rox::Core::PropertyType::PLATFORM
+        type = Rox::Core::CustomPropertyType::STRING
+
+        Rox::Core::DeviceProperty.new(
+          property.name,
+          type,
+          @server_properties.get(property)
+        )
+      end
+
+      def app_release
+        property = Rox::Core::PropertyType::APP_RELEASE
+        type = Rox::Core::CustomPropertyType::SEMVER
+
+        Rox::Core::DeviceProperty.new(
+          property.name,
+          type,
+          @server_properties.get(property)
+        )
+      end
+
+      def distinct_id
+        property = Rox::Core::PropertyType::DISTINCT_ID
+        type = Rox::Core::CustomPropertyType::STRING
+
+        Rox::Core::DeviceProperty.new(
+          property.name,
+          type
+        ) do |_|
+          SecureRandom.uuid
+        end
+      end
+
+      def internal_real_platform
+        property = Rox::Core::PropertyType::PLATFORM
+        type = Rox::Core::CustomPropertyType::STRING
+
+        Rox::Core::DeviceProperty.new(
+          'internal.realPlatform',
+          type,
+          @server_properties.get(property)
+        )
+      end
+
+      def internal_custom_platform
+        property = Rox::Core::PropertyType::PLATFORM
+        type = Rox::Core::CustomPropertyType::STRING
+
+        Rox::Core::DeviceProperty.new(
+          'internal.customPlatform',
+          type,
+          @server_properties.get(property)
+        )
+      end
+
+      def internal_app_key
+        type = Rox::Core::CustomPropertyType::STRING
+
+        Rox::Core::DeviceProperty.new(
+          'internal.appKey',
+          type,
+          @server_properties.rollout_key
+        )
+      end
+
+      def internal_distinct_id
+        type = Rox::Core::CustomPropertyType::STRING
+
+        Rox::Core::DeviceProperty.new(
+          "internal.#{Rox::Core::PropertyType::DISTINCT_ID.name}",
+          type
+        ) do
+          SecureRandom.uuid
+        end
+      end
+
+      def internal_lib_version
+        type = Rox::Core::CustomPropertyType::SEMVER
+
+        Rox::Core::DeviceProperty.new(
+          'internal.lib_version',
+          type,
+          @server_properties.lib_version
+        )
+      end
+
+      def internal_api_version
+        property = Rox::Core::PropertyType::API_VERSION
+        type = Rox::Core::CustomPropertyType::SEMVER
+
+        Rox::Core::DeviceProperty.new(
+          'internal.api_version',
+          type,
+          property
+        )
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def all_properties
+        [
+          platform,
+          app_release,
+          distinct_id,
+          internal_real_platform,
+          internal_custom_platform,
+          internal_app_key,
+          internal_distinct_id,
+          internal_lib_version,
+          internal_api_version
+        ]
+      end
+    end
+  end
+end

data/lib/rox/core/register/registerer.rb

@@ -7,25 +7,26 @@ module Rox
         @mutex = Mutex.new
       end
 
-      def register_instance(container, ns)
-        raise ArgumentError, 'A namespace cannot be null' if ns.nil?
+      def register_instance(container, namespace)
+        raise ArgumentError, 'A namespace cannot be null' if namespace.nil?
 
         @mutex.synchronize do
-          raise ArgumentError, "A container with the given namespace (#{ns}) has already been registered" if @namespaces.include?(ns)
+          if @namespaces.include?(namespace)
+            raise ArgumentError,
+                  "A container with the given namespace (#{namespace}) has already been registered"
+          end
         end
 
-        @namespaces << ns
+        @namespaces << namespace
 
-        container.instance_variables().each do |attribute_name|
+        container.instance_variables.each do |attribute_name|
           begin
             value = container.instance_variable_get(attribute_name)
-            if value != nil && value.is_a?(Variant)
-              var_name = attribute_name.to_s();
-              # removing the attribute starting @ (if [always] exists)
-              if (var_name[0] == '@')
-                var_name[0] = '';
-              end
-              @flag_repository.add_flag(value, ns == '' ? var_name : "#{ns}.#{var_name}")
+            if !value.nil? && value.is_a?(RoxString)
+              var_name = attribute_name.to_s
+            # removing the attribute starting @ (if [always] exists)
+              var_name[0] = '' if var_name[0] == '@'
+              @flag_repository.add_flag(value, namespace == '' ? var_name : "#{namespace}.#{var_name}")
             end
           rescue StandardError
             next

data/lib/rox/core/reporting/error_reporter.rb

@@ -13,6 +13,7 @@ module Rox
 
       def report(message, ex)
         return if @device_properties.rollout_environment == 'LOCAL'
+        return if @device_properties.rox_options.self_managed?
 
         Logging.logger.error("Error report: #{message}", ex)
 
@@ -33,8 +34,8 @@ module Rox
         begin
           @request.send_post(ErrorReporter::BUGSNAG_NOTIFY_URL, payload)
           Logging.logger.debug('Bugsnag error report was sent')
-        rescue StandardError => ex
-          Logging.logger.error('Failed to send bugsnag error ', ex)
+        rescue StandardError => e
+          Logging.logger.error('Failed to send bugsnag error ', e)
         end
       end
 
@@ -49,13 +50,13 @@ module Rox
 
       def add_metadata(message, ev)
         inner_data = {
-            'message' => message,
-            'deviceId' => @device_properties.distinct_id,
-            'buid' => @buid.to_s
+          'message' => message,
+          'deviceId' => @device_properties.distinct_id,
+          'buid' => @buid.to_s
         }
 
         metadata = {
-            'data' => inner_data
+          'data' => inner_data
         }
 
         ev['metaData'] = metadata
@@ -88,15 +89,15 @@ module Rox
 
       def add_notifier(payload)
         notifier = {
-            'name' => 'Rollout Ruby SDK',
-            'version' => @device_properties.lib_version
+          'name' => 'Rollout Ruby SDK',
+          'version' => @device_properties.lib_version
         }
         payload['notifier'] = notifier
       end
 
       def add_user(id, rollout_key, ev)
         user = {
-            id => rollout_key
+          id => rollout_key
         }
         ev['user'] = user
       end
@@ -121,13 +122,13 @@ module Rox
 
       def add_app(ev)
         app = {
-            'releaseStage' => @device_properties.rollout_environment,
-            'version' => @device_properties.lib_version
+          'releaseStage' => @device_properties.rollout_environment,
+          'version' => @device_properties.lib_version
         }
         ev['app'] = app
       end
 
-      STACK_TRACE_LINE_REGEX = /^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$/
+      STACK_TRACE_LINE_REGEX = /^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$/.freeze
 
       def parse_stack_trace(stack_trace)
         stack = []
@@ -149,4 +150,4 @@ module Rox
       end
     end
   end
-end
+end

data/lib/rox/core/repositories/experiment_repository.rb

@@ -5,9 +5,7 @@ module Rox
         @experiments = []
       end
 
-      def experiments=(experiments)
-        @experiments = experiments
-      end
+      attr_writer :experiments
 
       def experiment_by_flag(flag_name)
         @experiments.detect { |e| e.flags.include?(flag_name) }
@@ -18,4 +16,4 @@ module Rox
       end
     end
   end
-end
+end

data/lib/rox/core/repositories/flag_repository.rb

@@ -2,29 +2,29 @@ module Rox
   module Core
     class FlagRepository
       def initialize
-        @variants = {}
+        @strings = {}
         @flag_added_handlers = []
         @mutex = Mutex.new
         @handlers_mutex = Mutex.new
       end
 
-      def add_flag(variant, name)
-        variant.name = name if variant.name.nil? || variant.name.empty?
+      def add_flag(string, name)
+        string.name = name if string.name.nil? || string.name.empty?
         @mutex.synchronize do
-          @variants[name] = variant
+          @strings[name] = string
         end
-        raise_flag_added_event(variant)
+        raise_flag_added_event(string)
       end
 
       def flag(name)
         @mutex.synchronize do
-          return @variants[name]
+          return @strings[name]
         end
       end
 
       def all_flags
         @mutex.synchronize do
-          return @variants.values
+          return @strings.values
         end
       end
 

data/lib/rox/core/repositories/roxx/experiments_extensions.rb

@@ -11,13 +11,13 @@ module Rox
       end
 
       def extend
-        @parser.add_operator('mergeSeed') do |parser, stack, context|
+        @parser.add_operator('mergeSeed') do |_parser, stack, _context|
           seed1 = stack.pop
           seed2 = stack.pop
           stack.push("#{seed1}.#{seed2}")
         end
 
-        @parser.add_operator('isInPercentage') do |parser, stack, context|
+        @parser.add_operator('isInPercentage') do |_parser, stack, _context|
           percentage = stack.pop
           seed = stack.pop
 
@@ -27,7 +27,7 @@ module Rox
           stack.push(bucket <= percentage)
         end
 
-        @parser.add_operator('isInPercentageRange') do |parser, stack, context|
+        @parser.add_operator('isInPercentageRange') do |_parser, stack, _context|
           percentage_low = stack.pop
           percentage_high = stack.pop
           seed = stack.pop
@@ -42,17 +42,17 @@ module Rox
         @parser.add_operator('flagValue') do |parser, stack, context|
           feature_flag_identifier = stack.pop
           result = Flag::FLAG_FALSE_VALUE
-          variant = @flags_repository.flag(feature_flag_identifier)
+          string = @flags_repository.flag(feature_flag_identifier)
 
-          if !variant.nil?
-            result = variant.value(context)
-          else
+          if string.nil?
             flags_experiment = @experiment_repository.experiment_by_flag(feature_flag_identifier)
 
             if !flags_experiment.nil? && !flags_experiment.condition.nil? && !flags_experiment.condition.empty?
               experiment_eval_result = parser.evaluate_expression(flags_experiment.condition, context).string_value
               result = experiment_eval_result if !experiment_eval_result.nil? && !experiment_eval_result.empty?
             end
+          else
+            result = string.value(context)
           end
 
           stack.push(result)
@@ -79,4 +79,4 @@ module Rox
       end
     end
   end
-end
+end