rox-rollout 5.1.1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae34336f9f49d2ba7a2f77003d3f537eb53bbf4cde40fff04846a4c71d9fe177
-  data.tar.gz: d168174f3d6b72a482b89868d950e4bd8c30c908c0df6d0c11d276aceb8c229d
+  metadata.gz: e4cb36cd9c9f0f6d8bf17ec5eae746e232f2b52173af69bb23875ab310202fee
+  data.tar.gz: db305b734a05052c51e191fdf6c3c2f6ea68ed1d45302bcf772c43b44f2be25d
 SHA512:
-  metadata.gz: be4f8985f0289f5becb88a46f13578d83982ad0b5d471c3241dd8127493cdca9d1479eae63bc87e6c13c81092a37ae63e48bedaa40b806020a497a091e0996f2
-  data.tar.gz: f5c134a9692176e0495bbb3805799a439c14a08b5c160a61148c4affdb7e39f2699d1586e7f853e6bdd7fc43103bd9a66d17fc61b93a9b228627a92a7a6217ba
+  metadata.gz: 710eec50310d083d79cbf5580abcdd44c60586678947bdf39687cf6a29568f320949c935997d0ea8f3c65ced8fcbace9ad368f1a3ef48fe095e942095e222ad1
+  data.tar.gz: f715fdb536495f27c33449b260e77f14d7684afe24f5b0ca4f9f9689995b6c5015821e196d29092616663a72ce762f113a872e4309b8e6c1dccaf1ce7f3a42f7

data/e2e-server/run_server.sh

@@ -8,9 +8,10 @@ gem install sinatra --conservative
 gem install sinatra-contrib --conservative
 gem install json --conservative
 gem install em-eventsource --conservative
+gem install rackup
 
 nohup ruby ./server.rb $1 1>"$DIR"/log_"$1".out 2>&1 &
 while true ; do
   curl -p http://127.0.0.1:$1/status-check && exit 
   sleep 1
-done
+done

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

@@ -10,10 +10,11 @@ require 'rox/core/logging/logging'
 module Rox
   module Core
     class ConfigurationParser
-      def initialize(signature_verifier, error_reporter, configuration_fetched_invoker)
+      def initialize(signature_verifier, error_reporter, configuration_fetched_invoker, rox_options = nil)
         @signature_verifier = signature_verifier
         @error_reporter = error_reporter
         @configuration_fetched_invoker = configuration_fetched_invoker
+        @rox_options = rox_options
       end
 
       def parse(fetch_result, sdk_settings)
@@ -31,8 +32,8 @@ module Rox
           return nil
         end
 
-        if fetch_result.source != ConfigurationSource::ROXY && !@signature_verifier.verify(json_obj['data'],
-                                                                                           json_obj['signature_v0'])
+        if signature_verification_enabled? && 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']}"))
@@ -81,6 +82,14 @@ module Rox
       def parse_target_group(data)
         TargetGroupModel.new(data['_id'], data['condition'])
       end
+
+      private
+
+      def signature_verification_enabled?
+        return true if @rox_options.nil?
+
+        !@rox_options.disable_signature_verification
+      end
     end
   end
 end

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

@@ -1,3 +1,5 @@
+require 'rox/server/self_managed_options'
+
 module Rox
   module Core
     module Environment
@@ -50,6 +52,16 @@ module Rox
         @notifications_path
       end
 
+      def self.set_platform(rox_options)
+        @cdn_path = 'https://rox-conf.cloudbees.io'
+        @state_cdn_path = 'https://rox-state.cloudbees.io'
+        alternative_api_url = rox_options&.self_managed_options&.server_url || 'https://api.cloudbees.io'
+        @api_path = "#{alternative_api_url}/device/get_configuration"
+        @state_api_path = "#{alternative_api_url}/device/update_state_store"
+        @analytics_path = rox_options&.self_managed_options&.analytics_url || 'https://fm-analytics.cloudbees.io'
+        @notifications_path = 'https://sdk-notification-service.cloudbees.io/sse'
+      end
+
       private
       def self.setQA()
         @cdn_path = 'https://qa-conf.rollout.io'
@@ -75,11 +87,11 @@ module Rox
         alternative_api_url = rox_options&.self_managed_options&.server_url || 'https://x-api.rollout.io'
         @api_path = "#{alternative_api_url}/device/get_configuration"
         @state_api_path = "#{alternative_api_url}/device/update_state_store"
-        @analytics_path = rox_options&.self_managed_options&.analytics_url ||'https://analytic.rollout.io'
+        @analytics_path = rox_options&.self_managed_options&.analytics_url || 'https://analytic.rollout.io'
         @notifications_path = 'https://push.rollout.io/sse'
       end
     end
   end
 end
 
-Rox::Core::Environment.reset
+Rox::Core::Environment.reset

data/lib/rox/core/core.rb

@@ -25,11 +25,14 @@ 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/helpers/api_key'
 require 'rox/core/error_handling/userspace_unhandled_error_invoker'
 
 module Rox
   module Core
     class Core
+      include Rox::Core::Helpers::ApiKey
+
       def initialize
         @flag_repository = FlagRepository.new
         @custom_property_repository = CustomPropertyRepository.new
@@ -59,7 +62,7 @@ module Rox
       def setup(sdk_settings, device_properties)
         @sdk_settings = sdk_settings
         @rox_options = device_properties.rox_options
-        Rox::Core::Environment.reset(@rox_options)
+        reset_environment!(sdk_settings&.api_key, @rox_options)
 
         experiments_extensions = ExperimentsExtensions.new(@parser, @target_group_repository, @flag_repository,
                                                            @experiment_repository)
@@ -156,7 +159,7 @@ module Rox
                                SignatureVerifier.new
                              end
         configuration_parser = ConfigurationParser.new(signature_verifier, @error_reporter,
-                                                       @configuration_fetched_invoker)
+                                                       @configuration_fetched_invoker, @rox_options)
         result = @configuration_fetcher.fetch
         return if result.nil?
 
@@ -220,12 +223,13 @@ module Rox
         @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'
+      def reset_environment!(api_key, rox_options)
+        raise ArgumentError, 'Blank Feature Flag API key - must be specified' unless api_key
+
+        if is_cbp?(api_key)
+          Rox::Core::Environment.set_platform(rox_options)
+        else
+          Rox::Core::Environment.reset(rox_options)
         end
       end
 

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

@@ -43,6 +43,10 @@ module Rox
       def disabled(context)
         yield unless enabled?(context)
       end
+
+      def external_type
+        'Boolean'
+      end
     end
   end
 end

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

@@ -8,6 +8,10 @@ module Rox
         send_impressions(return_value, context)
         return_value
       end
+
+      def external_type
+        'Number'
+      end
     end
   end
 end

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

@@ -8,6 +8,10 @@ module Rox
         send_impressions(return_value, context)
         return_value
       end
+
+      def external_type
+        'Number'
+      end
     end
   end
 end

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

@@ -63,6 +63,10 @@ module Rox
 
         return_value
       end
+
+      def external_type
+        'String'
+      end
     end
   end
 end

data/lib/rox/core/helpers/api_key.rb

@@ -0,0 +1,28 @@
+
+module Rox
+  module Core
+    module Helpers
+      module ApiKey
+        MONGO_API_KEY_PATTERN = /^[a-f\d]{24}$/
+        UUID_API_KEY_PATTERN = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i
+
+        def is_cbp?(api_key)
+          validate_api_key(api_key) && UUID_API_KEY_PATTERN.match?(api_key)
+        rescue ArgumentError
+          false
+        end
+
+        def validate_api_key(api_key)
+          if api_key&.strip&.empty?
+            raise ArgumentError, 'Blank Rollout api key - must be specified'
+          elsif !MONGO_API_KEY_PATTERN.match(api_key) && !UUID_API_KEY_PATTERN.match(api_key)
+            raise ArgumentError, 'Illegal Rollout api key'
+          else
+            true
+          end
+        end
+      end
+    end
+
+  end
+end

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

@@ -8,10 +8,13 @@ require 'rox/core/network/request'
 require 'rox/core/network/request_data'
 require 'rox/core/network/response'
 require 'rox/core/utils/debouncer'
+require 'rox/core/helpers/api_key'
 
 module Rox
   module Core
     class StateSender
+      include Rox::Core::Helpers::ApiKey
+
       def initialize(sdk_settings, device_properties, flag_repository, custom_property_repository)
         @sdk_settings = sdk_settings
         @device_properties = device_properties
@@ -27,8 +30,8 @@ module Rox
 
       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)
+        serialized_feature_flags = seralize_flag_repository
+        serialized_custom_properties = serialize_custom_properties_repository
 
         state_payload = StateSender.state_payload(serialized_feature_flags, serialized_custom_properties,
                                                   @device_properties, @sdk_settings.dev_mode_secret)
@@ -39,7 +42,7 @@ module Rox
           response = get_state_from_CDN(rollout_key, md5_signature)
           if response.success?
             Rox::Core::Logging.logger.debug('Successfully fetched state from CDN')
-            return
+            return response, nil
           else
             Rox::Core::Logging.logger.debug('Failed to fetch state from CDN. Sending state to API...')
           end
@@ -52,6 +55,7 @@ module Rox
                     'Failed to send state to API.'
                   end
         Rox::Core::Logging.logger.debug(message)
+        return response, state_payload
       end
 
       def dump_state
@@ -108,7 +112,7 @@ module Rox
       def self.seralize_flag_repository_with_values(flag_repository)
         flags = []
         flag_repository.all_flags.sort_by(&:name).each do |f|
-          flags << {
+          flags <<  {
             name: f.name,
             enabled: f.enabled?,
             defaultValue: f.default_value,
@@ -142,6 +146,45 @@ module Rox
         end
         properties
       end
+
+      private
+
+      def cbp?
+        # Memoize assuming that @sdk_settings are not mutable during state sender lifetime
+        @cbp ||= is_cbp?(@sdk_settings&.api_key)
+      end
+
+      def seralize_flag_repository
+        flags = []
+        @flag_repository.all_flags.sort_by(&:name).each do |f|
+           flag = {
+            name: f.name,
+            defaultValue: f.default_value,
+            options: f.options
+          }
+
+          flag[:externalType] = f.external_type if cbp?
+
+          flags << flag
+        end
+        flags
+      end
+
+      def serialize_custom_properties_repository
+        properties = []
+        @custom_property_repository.all_custom_properties.sort_by(&:name).each do |p|
+          # Check not to send date custom properties to rollout
+          return if !is_cbp?(@sdk_settings&.api_key) && p.type.external_type == DateTime
+
+          properties << {
+            name: p.name,
+            type: p.type.type,
+            externalType: p.type.external_type
+          }
+        end
+        properties
+      end
+
     end
   end
 end

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

@@ -13,6 +13,7 @@ module Rox
       INT = CustomPropertyType.new('int', 'Number')
       FLOAT = CustomPropertyType.new('double', 'Number')
       SEMVER = CustomPropertyType.new('semver', 'Semver')
+      DATETIME = CustomPropertyType.new("time", "DateTime")
     end
   end
 end

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

@@ -113,6 +113,17 @@ module Rox
         )
       end
 
+      def internal_datetime
+        type = Rox::Core::CustomPropertyType::DATETIME
+
+        Rox::Core::DeviceProperty.new(
+          "now",
+          type
+        ) do
+          Time.now
+        end
+      end
+
       # rubocop:disable Metrics/MethodLength
       def all_properties
         [
@@ -124,7 +135,8 @@ module Rox
           internal_app_key,
           internal_distinct_id,
           internal_lib_version,
-          internal_api_version
+          internal_api_version,
+          internal_datetime
         ]
       end
     end

data/lib/rox/core/roxx/parser.rb

@@ -169,6 +169,15 @@ module Rox
             stack.push(TokenType::UNDEFINED)
           end
         end
+
+        add_operator('tsToNum') do |_parser, stack, _context|
+          datetime = stack.pop
+          if datetime.is_a?(DateTime)
+            stack.push(datetime.to_time.to_i)
+          else
+            stack.push(TokenType::UNDEFINED)
+          end
+        end
       end
     end
   end

data/lib/rox/core/roxx/value_compare_extensions.rb

@@ -8,9 +8,9 @@ module Rox
       def extend
         @parser.add_operator('lt') do |_parser, stack, _context|
           begin
-            op1 = stack.pop.to_f
-            op2 = stack.pop.to_f
-            stack.push(op1 < op2)
+            op1 = stack.pop
+            op2 = stack.pop
+            stack.push(op1.to_f < op2.to_f)
           rescue StandardError
             stack.push(false)
           end
@@ -18,9 +18,9 @@ module Rox
 
         @parser.add_operator('lte') do |_parser, stack, _context|
           begin
-            op1 = stack.pop.to_f
-            op2 = stack.pop.to_f
-            stack.push(op1 <= op2)
+            op1 = stack.pop
+            op2 = stack.pop
+            stack.push(op1.to_f <= op2.to_f)
           rescue StandardError
             stack.push(false)
           end
@@ -28,9 +28,9 @@ module Rox
 
         @parser.add_operator('gt') do |_parser, stack, _context|
           begin
-            op1 = stack.pop.to_f
-            op2 = stack.pop.to_f
-            stack.push(op1 > op2)
+            op1 = stack.pop
+            op2 = stack.pop
+            stack.push(op1.to_f > op2.to_f)
           rescue StandardError
             stack.push(false)
           end
@@ -38,9 +38,9 @@ module Rox
 
         @parser.add_operator('gte') do |_parser, stack, _context|
           begin
-            op1 = stack.pop.to_f
-            op2 = stack.pop.to_f
-            stack.push(op1 >= op2)
+            op1 = stack.pop
+            op2 = stack.pop
+            stack.push(op1.to_f >= op2.to_f)
           rescue StandardError
             stack.push(false)
           end
@@ -48,9 +48,9 @@ module Rox
 
         @parser.add_operator('numne') do |_parser, stack, _context|
           begin
-            op1 = stack.pop.to_f
-            op2 = stack.pop.to_f
-            stack.push(op1 != op2)
+            op1 = stack.pop
+            op2 = stack.pop
+            stack.push(op1.to_f != op2.to_f)
           rescue StandardError
             stack.push(false)
           end
@@ -58,9 +58,9 @@ module Rox
 
         @parser.add_operator('numeq') do |_parser, stack, _context|
           begin
-            op1 = stack.pop.to_f
-            op2 = stack.pop.to_f
-            stack.push(op1 == op2)
+            op1 = stack.pop
+            op2 = stack.pop
+            stack.push(op1.to_f == op2.to_f)
           rescue StandardError
             stack.push(false)
           end

data/lib/rox/server/rox_options.rb

@@ -1,15 +1,19 @@
 require 'rox/core/logging/logging'
 require 'rox/server/logging/server_logger'
+require 'rox/core/helpers/api_key'
 
 module Rox
   module Server
     class RoxOptions
+      include Rox::Core::Helpers::ApiKey
+
       attr_reader :dev_mode_key, :version, :fetch_interval,
                   :logger, :impression_handler,
                   :configuration_fetched_handler,
                   :roxy_url, :self_managed_options,
                   :network_configurations_options,
-                  :dynamic_property_rule_handler
+                  :dynamic_property_rule_handler,
+                  :disable_signature_verification
 
       def initialize(
         dev_mode_key: nil,
@@ -21,7 +25,8 @@ module Rox
         roxy_url: nil,
         self_managed_options: nil,
         network_configurations_options: nil,
-        dynamic_property_rule_handler: nil
+        dynamic_property_rule_handler: nil,
+        disable_signature_verification: nil
       )
         @dev_mode_key = dev_mode_key || 'stam'
         @version = version || '0.0'
@@ -42,11 +47,43 @@ module Rox
         @dynamic_property_rule_handler = dynamic_property_rule_handler || proc do |prop_name, context|
           context ? context[prop_name] : nil
         end
+        @disable_signature_verification = disable_signature_verification
       end
 
       def self_managed?
         !@self_managed_options.nil?
       end
+
+      def clone_with_options(options = {})
+        # Check if any keys that are not present as attributes were given as params
+        redundant_keys = options.keys - valid_attributes
+
+        # Filter options if there are such keys that are not present
+        if !redundant_keys.empty?
+          options = options.reduce({}) do |acc, (key, value)|
+            acc[key] = value unless redundant_keys.include?(key)
+            acc
+          end
+        end
+
+        valid_attributes.each do |va|
+          unless options.key?(va)
+            options[va] = self.instance_variable_get("@#{va}".to_sym)
+          end
+        end
+
+        self.class.new(**options)
+      end
+
+      private
+
+      def valid_attributes
+        return @valid_attributes if @valid_attributes
+
+        cons = self.class.instance_method(:initialize)
+        key_parameters = cons.parameters.select { |type, name| type == :keyreq || type == :key }
+        @valid_attributes = key_parameters.map(&:last)
+      end
     end
   end
 end

data/lib/rox/server/rox_server.rb

@@ -14,9 +14,20 @@ module Rox
 
       class << self
         def setup(api_key, rox_options = nil)
-          validate_api_key(api_key)
-
-          rox_options = Rox::Server::RoxOptions.new if rox_options.nil?
+          # @core.setup calls validate_api_key internally anyway, but it will happen in another thread
+          # because of the report_on_exception code below (which might effect older [maybe not supported Ruby versions])
+          # decided to call it explicity here too (to keep the current behavor)
+          # anyway, this also short circuit the initialization (no need for the initialization and Thread.new)
+          # and only costs us calling the validation twice instead of once
+          @core.validate_api_key(api_key)
+
+          rox_options = if rox_options.nil?
+                          Rox::Server::RoxOptions.new(disable_signature_verification: @core.is_cbp?(api_key))
+                        else
+                          rox_options = rox_options.clone_with_options({
+                            disable_signature_verification: @core.is_cbp?(api_key) || rox_options.disable_signature_verification
+                          })
+                        end
           sdk_settings = Rox::Server::SdkSettings.new(api_key, rox_options.dev_mode_key)
           server_properties = Rox::Server::ServerProperties.new(sdk_settings, rox_options)
 
@@ -93,6 +104,12 @@ module Rox
                                                                   &block))
         end
 
+        def set_custom_datetime_property(name, value = nil, &block)
+          @core.add_custom_property(
+            Rox::Core::CustomProperty.new(name, Rox::Core::CustomPropertyType::DATETIME, value, &block)
+          )
+        end
+
         def dynamic_api
           @core.dynamic_api(Rox::Server::ServerEntitiesProvider.new)
         end
@@ -100,14 +117,6 @@ module Rox
         def dump_state
           @core.dump_state
         end
-
-        private
-
-        def validate_api_key(api_key)
-          raise ArgumentError, 'api_key is not valid' if (api_key =~ /^[a-f\d]{24}$/).nil?
-
-          true
-        end
       end
     end
   end

data/lib/rox/version.rb

@@ -1,3 +1,3 @@
 module Rox
-  VERSION = '5.1.1'.freeze
+  VERSION = '6.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rox-rollout
 version: !ruby/object:Gem::Version
-  version: 5.1.1
+  version: 6.0.0
 platform: ruby
 authors:
 - CloudBees
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-08 00:00:00.000000000 Z
+date: 2024-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-eventsource
@@ -168,6 +168,7 @@ files:
 - lib/rox/core/error_handling/exception_trigger.rb
 - lib/rox/core/error_handling/userspace_handler_exception.rb
 - lib/rox/core/error_handling/userspace_unhandled_error_invoker.rb
+- lib/rox/core/helpers/api_key.rb
 - lib/rox/core/impression/impression_args.rb
 - lib/rox/core/impression/impression_invoker.rb
 - lib/rox/core/impression/models/experiment.rb
@@ -247,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.5.14
 signing_key:
 specification_version: 4
 summary: Feature Management ROX Ruby SDK