rox-rollout 5.0.3 → 5.1.1

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

@@ -4,7 +4,9 @@ module Rox
   module Core
     class RoxInt < RoxString
       def value(context = nil)
-        internal_value(context, false, Integer)
+        return_value = Rox::Server::NormalizeFlagType.normalize_int(internal_value(context, false, Integer))
+        send_impressions(return_value, context)
+        return_value
       end
     end
   end

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

@@ -43,7 +43,9 @@ module Rox
       end
 
       def value(context = nil)
-        internal_value(context, false)
+        return_value = internal_value(context, false)
+        send_impressions(return_value, context)
+        return_value
       end
 
       def internal_value(context, nil_instead_of_default, evaluated_type = String)
@@ -59,7 +61,6 @@ module Rox
           end
         end
 
-        send_impressions(return_value, merged_context)
         return_value
       end
     end

data/lib/rox/core/impression/impression_invoker.rb

@@ -18,7 +18,6 @@ module Rox
         @mutex = Mutex.new
       end
 
-      # TODO: write analytics client and initiate it before using it
       def call_analytics_gateway(reporting_value, stickiness_property, context)
         begin
           analytics_enabled = @internal_flags.enabled?('rox.internal.analytics')
@@ -30,9 +29,9 @@ module Rox
               distinct_id = prop_value if prop_value.instance_of?(String)
             end
 
-            event_time = (Time.now.to_f * 1000.0).to_i
+            event_time = DateTime.now.strftime('%Q').to_i
             begin
-              event_time = ENV['rox.analytics.ms'].to_i
+              event_time = ENV['rox.analytics.ms'].to_i if ENV['rox.analytics.ms']
             rescue StandardError
             end
 
@@ -40,7 +39,6 @@ module Rox
                                       flag: reporting_value.name,
                                       value: reporting_value.value,
                                       distinctId: distinct_id,
-                                      experimentVersion: '0',
                                       type: 'IMPRESSION',
                                       time: event_time
                                     })
@@ -49,9 +47,9 @@ module Rox
           Logging.logger.error('Failed to send analytics', ex)
         end
       end
-      
+
       def invoke(reporting_value, stickiness_property, context)
-        #call_analytics_gateway
+        call_analytics_gateway(reporting_value, stickiness_property, context)
         raise_impression_event(ImpressionArgs.new(reporting_value, context))
       end
 

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

@@ -23,7 +23,7 @@ module Rox
       end
 
       def build_for_api
-        build_request_with_full_params("#{Rox::Core::Environment.api_path(@rox_options.self_managed_options&.server_url)}/#{relative_path}")
+        build_request_with_full_params("#{Rox::Core::Environment.api_path}/#{relative_path}")
       end
 
       def relative_path

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

@@ -21,8 +21,8 @@ module Rox
       end
 
       def missing_via_response_body?
-        @status_code == 200 && @content_type == 'application/json' &&
-          [404, '404'].include?(JSON.parse(text)['result'])
+        # api send state respons returns 200 'OK', application/json filters it
+        @status_code == 200 && @content_type == 'application/json' && @text && [404, '404'].include?(JSON.parse(text)['result'])
       rescue JSON::ParserError
         Logging.logger.error("Failed to parse JSON response: #{text}")
         false

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

@@ -69,7 +69,7 @@ module Rox
 
       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
+          "#{Rox::Core::Environment.state_api_path}/#{rollout_key}/#{md5_signature}", state_payload
         )
       end
 

data/lib/rox/server/network_configurations_options.rb

@@ -0,0 +1,20 @@
+module Rox
+    module Server
+        class NetworkConfigurationsOptions
+            attr_reader :get_config_api_endpoint, :get_config_cloud_endpoint,
+                        :send_state_api_endpoint, :send_state_cloud_endpoint,
+                        :analytics_endpoint, :push_notification_endpoint
+
+            def initialize(get_config_api_endpoint:, get_config_cloud_endpoint:,
+                            send_state_api_endpoint:, send_state_cloud_endpoint:,
+                            analytics_endpoint:, push_notification_endpoint:)
+                @get_config_api_endpoint = get_config_api_endpoint
+                @get_config_cloud_endpoint = get_config_cloud_endpoint
+                @send_state_api_endpoint = send_state_api_endpoint
+                @send_state_cloud_endpoint = send_state_cloud_endpoint
+                @analytics_endpoint = analytics_endpoint
+                @push_notification_endpoint = push_notification_endpoint
+            end
+        end
+    end
+end

data/lib/rox/server/rox_options.rb

@@ -3,20 +3,12 @@ require 'rox/server/logging/server_logger'
 
 module Rox
   module Server
-    class SelfManagedOptions
-      attr_reader :server_url, :analytics_url
-
-      def initialize(server_url:, analytics_url:)
-        @server_url = server_url
-        @analytics_url = analytics_url
-      end
-    end
-
     class RoxOptions
       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
 
       def initialize(
@@ -28,6 +20,7 @@ module Rox
         configuration_fetched_handler: nil,
         roxy_url: nil,
         self_managed_options: nil,
+        network_configurations_options: nil,
         dynamic_property_rule_handler: nil
       )
         @dev_mode_key = dev_mode_key || 'stam'
@@ -45,6 +38,7 @@ module Rox
         @configuration_fetched_handler = configuration_fetched_handler
         @roxy_url = roxy_url
         @self_managed_options = self_managed_options
+        @network_configurations_options = network_configurations_options
         @dynamic_property_rule_handler = dynamic_property_rule_handler || proc do |prop_name, context|
           context ? context[prop_name] : nil
         end

data/lib/rox/server/self_managed_options.rb

@@ -0,0 +1,12 @@
+module Rox
+    module Server
+        class SelfManagedOptions
+            attr_reader :server_url, :analytics_url
+
+            def initialize(server_url:, analytics_url:)
+                @server_url = server_url
+                @analytics_url = analytics_url
+            end
+        end
+    end
+end

data/lib/rox/version.rb

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

data/rox.gemspec

@@ -20,11 +20,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.3'
+  spec.required_ruby_version = '>= 2.5'
 
   spec.add_runtime_dependency 'em-eventsource', '~> 0.3.2'
 
-  spec.add_development_dependency 'bundler', '~> 2.3.3'
+  spec.add_development_dependency 'bundler', '~> 2.4.6'
   spec.add_development_dependency 'minitest', '~> 5.11'
   spec.add_development_dependency 'pry-byebug', '~> 3.7.0'
   spec.add_development_dependency 'rake', '~> 12.3'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rox-rollout
 version: !ruby/object:Gem::Version
-  version: 5.0.3
+  version: 5.1.1
 platform: ruby
 authors:
 - CloudBees
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-04 00:00:00.000000000 Z
+date: 2023-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-eventsource
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.3
+        version: 2.4.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.3
+        version: 2.4.6
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -108,16 +108,16 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.7.5
-description: 
+description:
 email:
 - support@rollout.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
 - ".editorconfig"
-- ".github/workflows/ruby.yml"
+- ".github/workflows/e2e_tests.yaml"
+- ".github/workflows/unit_tests.yaml"
 - ".gitignore"
 - ".rubocop.yml"
 - Gemfile
@@ -126,14 +126,21 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- e2e-server/.gitignore
 - e2e-server/run_server.sh
 - e2e-server/server.rb
-- e2e/container.rb
-- e2e/custom_props.rb
-- e2e/rox_e2e_test.rb
-- e2e/test_vars.rb
 - example/local.rb
 - lib/rox.rb
+- lib/rox/core/analytics/backoff_policy.rb
+- lib/rox/core/analytics/client.rb
+- lib/rox/core/analytics/defaults.rb
+- lib/rox/core/analytics/logging.rb
+- lib/rox/core/analytics/message_batch.rb
+- lib/rox/core/analytics/response.rb
+- lib/rox/core/analytics/test_queue.rb
+- lib/rox/core/analytics/transport.rb
+- lib/rox/core/analytics/utils.rb
+- lib/rox/core/analytics/worker.rb
 - lib/rox/core/client/buid.rb
 - lib/rox/core/client/device_properties.rb
 - lib/rox/core/client/dynamic_api.rb
@@ -215,15 +222,17 @@ files:
 - lib/rox/server/flags/rox_string.rb
 - lib/rox/server/flags/server_entities_provider.rb
 - lib/rox/server/logging/server_logger.rb
+- lib/rox/server/network_configurations_options.rb
 - lib/rox/server/rox_options.rb
 - lib/rox/server/rox_server.rb
+- lib/rox/server/self_managed_options.rb
 - lib/rox/version.rb
 - rox.gemspec
 homepage: https://github.com/rollout/rox-ruby
 licenses:
 - Nonstandard
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -231,15 +240,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.4.7
+signing_key:
 specification_version: 4
 summary: Feature Management ROX Ruby SDK
 test_files: []

data/.circleci/config.yml

@@ -1,73 +0,0 @@
-version: 2.1
-jobs:
-  test_2-6: &test-template
-    docker:
-    - image: circleci/ruby:2.6.4
-
-    working_directory: ~/repo
-
-    steps:
-    - checkout
-
-    - run:
-        name: install ssh
-        command: |
-          sudo apt-get update
-          sudo apt-get install libssl-dev
-
-    - run:
-        name: install dependencies
-        command: |
-          bundle install --jobs=4 --retry=3 --path vendor/bundle
-
-    - run:
-        name: run tests
-        command: |
-          bundle exec rake test
-
-    - run:
-        name: run tests
-        command: |
-          bundle exec rake e2e
-
-  test_2-5:
-    <<: *test-template
-    docker:
-    - image: circleci/ruby:2.5.6
-  test_2-4:
-    <<: *test-template
-    docker:
-    - image: circleci/ruby:2.4.7
-  test_2-3:
-    <<: *test-template
-    docker:
-    - image: circleci/ruby:2.3.8
-
-  sdk-integration-test:
-      <<: *test-template
-      steps:
-      - run:
-          name: trigger sdk integration test workflow
-          command: >-
-            curl -X POST https://circleci.com/api/v2/project/gh/rollout/sdk-integration-tests/pipeline
-            --header 'Content-Type: application/json'
-            --header 'Accept: application/json'
-            --header 'x-attribution-login: rox-ruby'
-            --header 'x-attribution-actor-id: rox-ruby'
-            --header 'Circle-Token: '$CircleApiToken
-            --data '{"parameters": {"sdk_triggered_run": true, "repo_name": "'$CIRCLE_PROJECT_REPONAME'", "repo_owner": "'$CIRCLE_PROJECT_USERNAME'", "sha": "'$CIRCLE_SHA1'"  }}'
-
-workflows:
-  version: 2
-  test:
-    jobs:
-    - test_2-6
-    - test_2-5
-    - test_2-4
-    - test_2-3
-    - sdk-integration-test:
-        requires:
-          - test_2-6
-          - test_2-5
-          - test_2-4
-          - test_2-3

data/e2e/container.rb

@@ -1,35 +0,0 @@
-require 'rox/server/flags/rox_flag'
-require 'rox/server/flags/rox_string'
-
-module E2E
-  class Container
-    attr_accessor :simple_flag, :simple_flag_overwritten, :flag_for_impression,
-                  :flag_for_impression_with_experiment_and_context, :flag_custom_properties,
-                  :flag_target_groups_all, :flag_target_groups_any, :flag_target_groups_none,
-                  :variant_with_context, :variant, :variant_overwritten, :flag_for_dependency,
-                  :flag_dependent, :flag_color_dependent_with_context
-
-    def initialize
-      @simple_flag = Rox::Server::RoxFlag.new(true)
-      @simple_flag_overwritten = Rox::Server::RoxFlag.new(true)
-
-      @flag_for_impression = Rox::Server::RoxFlag.new(false)
-      @flag_for_impression_with_experiment_and_context = Rox::Server::RoxFlag.new(false)
-
-      @flag_custom_properties = Rox::Server::RoxFlag.new
-
-      @flag_target_groups_all = Rox::Server::RoxFlag.new
-      @flag_target_groups_any = Rox::Server::RoxFlag.new
-      @flag_target_groups_none = Rox::Server::RoxFlag.new
-
-      @variant_with_context = Rox::Server::RoxString.new('red', %w[red blue green])
-
-      @variant = Rox::Server::RoxString.new('red', %w[red blue green])
-      @variant_overwritten = Rox::Server::RoxString.new('red', %w[red blue green])
-
-      @flag_for_dependency = Rox::Server::RoxFlag.new(false)
-      @flag_dependent = Rox::Server::RoxFlag.new(false)
-      @flag_color_dependent_with_context = Rox::Server::RoxString.new('White', %w[White Blue Green Yellow])
-    end
-  end
-end

data/e2e/custom_props.rb

@@ -1,55 +0,0 @@
-module E2E
-  class CustomProps
-    def self.create_custom_props
-      Rox::Server::RoxServer.set_custom_string_property('string_prop1', 'Hello')
-      Rox::Server::RoxServer.set_custom_string_property('string_prop2') do |_context|
-        TestVars.is_computed_string_prop_called = true
-        'World'
-      end
-
-      Rox::Server::RoxServer.set_custom_boolean_property('bool_prop1', true)
-      Rox::Server::RoxServer.set_custom_boolean_property('bool_prop2') do |_context|
-        TestVars.is_computed_boolean_prop_called = true
-        false
-      end
-
-      Rox::Server::RoxServer.set_custom_int_property('int_prop1', 6)
-      Rox::Server::RoxServer.set_custom_int_property('int_prop2') do |_context|
-        TestVars.is_computed_int_prop_called = true
-        28
-      end
-
-      Rox::Server::RoxServer.set_custom_float_property('float_prop1', 3.14)
-      Rox::Server::RoxServer.set_custom_float_property('float_prop2') do |_context|
-        TestVars.is_computed_float_prop_called = true
-        1.618
-      end
-
-      Rox::Server::RoxServer.set_custom_semver_property('smvr_prop1', '9.11.2001')
-      Rox::Server::RoxServer.set_custom_semver_property('smvr_prop2') do |_context|
-        TestVars.is_computed_semver_prop_called = true
-        '20.7.1969'
-      end
-
-      Rox::Server::RoxServer.set_custom_boolean_property('bool_prop_target_group_for_variant') do |context|
-        context['isDuckAndCover']
-      end
-
-      Rox::Server::RoxServer.set_custom_boolean_property('bool_prop_target_group_operand1') do |_context|
-        TestVars.target_group1
-      end
-
-      Rox::Server::RoxServer.set_custom_boolean_property('bool_prop_target_group_operand2') do |_context|
-        TestVars.target_group2
-      end
-
-      Rox::Server::RoxServer.set_custom_boolean_property('bool_prop_target_group_for_dependency') do |_context|
-        TestVars.is_prop_for_target_group_for_dependency
-      end
-
-      Rox::Server::RoxServer.set_custom_boolean_property('bool_prop_target_group_for_variant_dependency') do |context|
-        context['isDuckAndCover']
-      end
-    end
-  end
-end

data/e2e/rox_e2e_test.rb

@@ -1,157 +0,0 @@
-require 'minitest/autorun'
-require 'rox/server/rox_options'
-require 'rox/server/rox_server'
-require_relative 'container'
-require_relative 'custom_props'
-require_relative 'test_vars'
-
-module E2E
-  class Logger
-    def debug(message, _ex = nil)
-      puts 'Before Rox.Setup', message
-    end
-
-    def error(message, ex = nil)
-      puts 'Before Rox.Setup', message, ex
-    end
-
-    def warn(message, _ex = nil)
-      puts 'Before Rox.Setup', message
-    end
-  end
-
-  class RoxE2ETest < Minitest::Test
-    ENV['ROLLOUT_MODE'] = 'QA'
-
-    configuration_fetched_handler = proc do |e|
-      if !e.nil? && e.fetcher_status == Rox::Core::FetcherStatus::APPLIED_FROM_NETWORK
-        TestVars.configuration_fetched_count += 1
-      end
-    end
-
-    impression_handler = proc do |e|
-      if !e.nil? && !e.reporting_value.nil? && (e.reporting_value.name == 'flag_for_impression')
-        TestVars.is_impression_raised = true
-      end
-      TestVars.impression_returned_args = e
-    end
-
-    option = Rox::Server::RoxOptions.new(
-      configuration_fetched_handler: configuration_fetched_handler,
-      impression_handler: impression_handler,
-      dev_mode_key: '67e39e708444aa953414e444',
-      logger: Logger.new
-    )
-
-    @@container = Container.new
-    Rox::Server::RoxServer.register(@@container)
-    CustomProps.create_custom_props
-    Rox::Server::RoxServer.setup('5b82864ebc3aec37aff1fdd5', option).join
-
-    def test_simple_flag
-      assert_equal true, @@container.simple_flag.enabled?
-    end
-
-    def test_simple_flag_overwritten
-      assert_equal false, @@container.simple_flag_overwritten.enabled?
-    end
-
-    def test_string
-      assert_equal 'red', @@container.variant.value
-    end
-
-    def test_variant_overwritten
-      assert_equal 'green', @@container.variant_overwritten.value
-    end
-
-    def test_all_custom_properties
-      assert_equal true, @@container.flag_custom_properties.enabled?
-
-      assert_equal true, TestVars.is_computed_boolean_prop_called
-      assert_equal true, TestVars.is_computed_float_prop_called
-      assert_equal true, TestVars.is_computed_int_prop_called
-      assert_equal true, TestVars.is_computed_semver_prop_called
-      assert_equal true, TestVars.is_computed_string_prop_called
-    end
-
-    def test_fetch_within_timeout
-      number_of_config_fetches = TestVars.configuration_fetched_count
-      timeout = 5
-      thread = Rox::Server::RoxServer.fetch
-      res = thread.join(timeout)
-
-      if res.nil?
-        flunk('timeout')
-      else
-        assert number_of_config_fetches < TestVars.configuration_fetched_count
-      end
-    end
-
-    def test_string_with_context
-      some_positive_context = { 'isDuckAndCover' => true }
-      some_negative_context = { 'isDuckAndCover' => false }
-
-      assert_equal 'red', @@container.variant_with_context.value
-
-      assert_equal 'blue', @@container.variant_with_context.value(some_positive_context)
-      assert_equal 'red', @@container.variant_with_context.value(some_negative_context)
-    end
-
-    def test_target_groups_all_any_none
-      TestVars.target_group1 = true
-      TestVars.target_group2 = true
-
-      assert_equal true, @@container.flag_target_groups_all.enabled?
-      assert_equal true, @@container.flag_target_groups_any.enabled?
-      assert_equal false, @@container.flag_target_groups_none.enabled?
-
-      TestVars.target_group1 = false
-      assert_equal false, @@container.flag_target_groups_all.enabled?
-      assert_equal true, @@container.flag_target_groups_any.enabled?
-      assert_equal false, @@container.flag_target_groups_none.enabled?
-
-      TestVars.target_group2 = false
-      assert_equal false, @@container.flag_target_groups_all.enabled?
-      assert_equal false, @@container.flag_target_groups_any.enabled?
-      assert_equal true, @@container.flag_target_groups_none.enabled?
-    end
-
-    def test_impression_handler
-      @@container.flag_for_impression.enabled?
-      assert_equal true, TestVars.is_impression_raised
-      TestVars.is_impression_raised = false
-
-      context = { 'var' => 'val' }
-      flag_impression_value = @@container.flag_for_impression_with_experiment_and_context.enabled?(context)
-      refute_nil TestVars.impression_returned_args
-      refute_nil TestVars.impression_returned_args.reporting_value
-      assert_equal true, TestVars.impression_returned_args.reporting_value.value
-      assert_equal true, flag_impression_value
-      assert_equal 'flag_for_impression_with_experiment_and_context',
-                   TestVars.impression_returned_args.reporting_value.name
-
-      refute_nil TestVars.impression_returned_args
-
-      assert_equal 'val', TestVars.impression_returned_args.context['var']
-    end
-
-    def test_flag_dependency
-      TestVars.is_prop_for_target_group_for_dependency = true
-      assert_equal true, @@container.flag_for_dependency.enabled?
-      assert_equal false, @@container.flag_dependent.enabled?
-
-      TestVars.is_prop_for_target_group_for_dependency = false
-      assert_equal true, @@container.flag_dependent.enabled?
-      assert_equal false, @@container.flag_for_dependency.enabled?
-    end
-
-    def test_string_dependency_with_context
-      some_positive_context = { 'isDuckAndCover' => true }
-      some_negative_context = { 'isDuckAndCover' => false }
-
-      assert_equal 'White', @@container.flag_color_dependent_with_context.value
-      assert_equal 'White', @@container.flag_color_dependent_with_context.value(some_negative_context)
-      assert_equal 'Yellow', @@container.flag_color_dependent_with_context.value(some_positive_context)
-    end
-  end
-end

data/e2e/test_vars.rb

@@ -1,21 +0,0 @@
-module E2E
-  module TestVars
-    class << self
-      attr_accessor :is_computed_boolean_prop_called, :is_computed_string_prop_called, :is_computed_int_prop_called,
-                    :is_computed_float_prop_called, :is_computed_semver_prop_called, :target_group1, :target_group2, :is_impression_raised, :is_prop_for_target_group_for_dependency, :configuration_fetched_count, :impression_returned_args
-    end
-
-    @is_computed_boolean_prop_called = false
-    @is_computed_string_prop_called = false
-    @is_computed_int_prop_called = false
-    @is_computed_float_prop_called = false
-    @is_computed_semver_prop_called = false
-    @target_group1 = false
-    @target_group2 = false
-    @is_impression_raised = false
-    @is_prop_for_target_group_for_dependency = false
-
-    @configuration_fetched_count = 0
-    @impression_returned_args = nil
-  end
-end