rox-rollout 4.1.0 → 5.0.0

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
 
@@ -39,8 +39,8 @@ module Rox
           resp_body = gz.read
         end
 
-        Response.new(resp.code.to_i, resp_body)
+        Response.new(resp.code.to_i, resp_body, resp['Content-Type'])
       end
     end
   end
-end
+end

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

@@ -5,25 +5,29 @@ 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}/#{@buid.value}",
-                    Rox::Core::PropertyType::DISTINCT_ID.name => @device_properties.distinct_id)
+        RequestData.new("#{Rox::Core::Environment.cdn_path}/#{relative_path}",
+                        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)
+        build_request_with_full_params("#{Rox::Core::Environment.api_path(@rox_options.self_managed_options&.server_url)}/#{relative_path}")
+      end
+
+      def relative_path
+        "#{@device_properties.rollout_key}/#{@buid.value}"
       end
 
       def build_request_with_full_params(url)
@@ -37,12 +41,11 @@ module Rox
           query_params[key] = value unless query_params.include?(key)
         end
 
-        cdn_data = build_for_cdn
-        query_params[Rox::Core::PropertyType::CACHE_MISS_URL.name] = cdn_data.url
+        query_params[Rox::Core::PropertyType::CACHE_MISS_RELATIVE_URL.name] = relative_path
         query_params['devModeSecret'] = @sdk_settings.dev_mode_secret
 
         RequestData.new(url, query_params)
       end
     end
   end
-end
+end

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

@@ -1,16 +1,32 @@
+require 'json'
+require 'rox/core/logging/logging'
+
 module Rox
   module Core
     class Response
-      attr_accessor :status_code, :text
+      attr_accessor :status_code, :text, :content_type
 
-      def initialize(status_code, text)
+      def initialize(status_code, text, content_type = 'application/octet-stream')
         @status_code = status_code
         @text = text
+        @content_type = content_type
+      end
+
+      def success?
+        status_code_success? && !missing_via_response_body?
       end
 
-      def success_status_code?
+      def status_code_success?
         @status_code >= 200 && @status_code < 300
       end
+
+      def missing_via_response_body?
+        @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
-end
+end

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

@@ -0,0 +1,146 @@
+require 'digest'
+require 'json'
+
+require 'rox/core/consts/environment'
+require 'rox/core/consts/property_type'
+require 'rox/core/logging/logging'
+require 'rox/core/network/request'
+require 'rox/core/network/request_data'
+require 'rox/core/network/response'
+require 'rox/core/utils/debouncer'
+
+module Rox
+  module Core
+    class StateSender
+      def initialize(sdk_settings, device_properties, flag_repository, custom_property_repository)
+        @sdk_settings = sdk_settings
+        @device_properties = device_properties
+        @flag_repository = flag_repository
+        @custom_property_repository = custom_property_repository
+        @request = Request.new
+        @debouncer = Debouncer.new(1, proc { send })
+      end
+
+      def delayed_send
+        @debouncer.call
+      end
+
+      def send
+        rollout_key = @device_properties.rollout_key
+        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)
+
+        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 fetched state from CDN')
+            return
+          else
+            Rox::Core::Logging.logger.debug('Failed to fetch state from CDN. Sending state to API...')
+          end
+        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)
+        url_for_state_cdn =
+          RequestData.new("#{Rox::Core::Environment.state_cdn_path}/#{rollout_key}/#{md5_signature}", {})
+        @request.send_get(url_for_state_cdn)
+      end
+
+      def send_state_to_API(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 = state_payload(serialized_feature_flags, serialized_custom_properties, device_properties,
+                               dev_mode_secret).values
+
+        hash = Digest::MD5.hexdigest(values.join('|'))
+        hash.upcase
+      end
+
+      def self.state_payload(seralized_flag_repository, serialized_custom_property_repository, device_properties, dev_mode_secret)
+        values = {}
+        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
+      end
+
+      def self.seralize_flag_repository(flag_repository)
+        flags = []
+        flag_repository.all_flags.sort_by(&:name).each do |f|
+          flags << {
+            name: f.name,
+            defaultValue: f.default_value,
+            options: f.options
+          }
+        end
+        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(&: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
+          }
+        end
+        properties
+      end
+    end
+  end
+end

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