splitclient-rb 6.3.0 → 6.4.0.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 155d0661d53fb4c60d68bd8e03a31bf925a3afbfc2ff3bf08283d45ea1ec655e
-  data.tar.gz: 5242be792ab0dd2eaa54f191821ae9b3356a171f70c1cbcb549abc66e858c6e8
+  metadata.gz: 73ec7584b175071a904ecddbb077367364a288c179c8d45ee67f05803caf2632
+  data.tar.gz: 1beea7c46b71a7faa4c8c25ae4b0e473fcb5ada3f8a4cd7b5f95212fb7292445
 SHA512:
-  metadata.gz: 10263a795124c996f120177474e397224a42216a326bb9358e7f4bd69d86d409c4ab69fa0f2f71db1f6f375ac79828f20c4d4d369bf27bab500f44759e2c778e
-  data.tar.gz: 2298f840ae08656c85cea605eea58ef5b7e755ccf78d08a65b61366e54d745be646738cfa4e772196cd538ff70613771c712f0eaba4a3622d71d6478ed44ac0b
+  metadata.gz: 2020fd9cc79da50ea7e59151654d877488258b1a3b3f88b1eaa3c4dc25dcd12e9c7bd7e797b4a64bae89d7cfbd1db5621a7abe4af9eb7b145e5369788d5996b0
+  data.tar.gz: 60d9cc6f00a52bca4e7b89100c42f21d6ec21ec8780f656b861979a7673168c44fa74d4cbd0bfe721a2fc4baf3644463285fa534a4089df9bedf1894742d1530

data/README.md

@@ -1,4 +1,4 @@
-[ ![Codeship Status for splitio/ruby-client](https://app.codeship.com/projects/306c6b60-c164-0133-e179-16471d4e6045/status?branch=master)](https://app.codeship.com/projects/137510)
+[![Build Status](https://travis-ci.com/splitio/ruby-client.svg?branch=master)](https://travis-ci.com/splitio/ruby-client)
 
 # Split Ruby SDK
 
@@ -35,7 +35,7 @@ Split has built and maintains a SDKs for:
 
 For a comprehensive list of opensource projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
 
-**Learn more about Split:** 
+**Learn more about Split:**
 
 Visit [split.io/product](https://www.split.io/product) for an overview of Split, or visit our documentation at [docs.split.io](http://docs.split.io) for more detailed information.
 

data/lib/splitclient-rb/cache/adapters/memory_adapters/queue_adapter.rb

@@ -39,6 +39,9 @@ module SplitIoClient
             items
           end
 
+          def length
+            @current_size.value
+          end
         end
       end
     end

data/lib/splitclient-rb/cache/repositories/events/memory_repository.rb

@@ -3,27 +3,25 @@ module SplitIoClient
     module Repositories
       module Events
         class MemoryRepository < EventsRepository
-          EVENTS_SLICE = 100
+          EVENTS_MAX_SIZE_BYTES = 5242880
 
           def initialize(adapter)
             @adapter = adapter
+            @size = 0
           end
 
-          def add(key, traffic_type, event_type, time, value)
-            @adapter.add_to_queue(m: metadata, e: event(key, traffic_type, event_type, time, value))
-          rescue ThreadError # queue is full
-            if SplitIoClient.configuration.debug_enabled
-              SplitIoClient.configuration.logger.warn("Dropping events. Current size is #{SplitIoClient.configuration.events_queue_size}. " \
-                                  "Consider increasing events_queue_size")
-            end
-            @adapter.clear
-          end
+          def add(key, traffic_type, event_type, time, value, properties, event_size)
+            @adapter.add_to_queue(m: metadata, e: event(key, traffic_type, event_type, time, value, properties))
+            @size += event_size
+
+            post_events if @size >= EVENTS_MAX_SIZE_BYTES || @adapter.length == SplitIoClient.configuration.events_queue_size
 
-          def batch
-            @adapter.get_batch(EVENTS_SLICE)
+            rescue StandardError => error
+              SplitIoClient.configuration.log_found_exception(__method__.to_s, error)
           end
 
           def clear
+            @size = 0
             @adapter.clear
           end
         end

data/lib/splitclient-rb/cache/repositories/events/redis_repository.rb

@@ -3,36 +3,26 @@ module SplitIoClient
     module Repositories
       module Events
         class RedisRepository < EventsRepository
-          EVENTS_SLICE = 100
 
           def initialize(adapter)
             @adapter = adapter
           end
 
-          def add(key, traffic_type, event_type, time, value)
+          def add(key, traffic_type, event_type, time, value, properties, size)
             @adapter.add_to_queue(
               namespace_key('.events'),
-              { m: metadata, e: event(key, traffic_type, event_type, time, value) }.to_json,
+              { m: metadata, e: event(key, traffic_type, event_type, time, value, properties) }.to_json
             )
           end
 
-          def get_events(number_of_events = 0)
-            @adapter.get_from_queue(namespace_key('.events'), number_of_events).map do |e|
+          def clear
+            @adapter.get_from_queue(namespace_key('.events'), 0).map do |e|
               JSON.parse(e, symbolize_names: true)
             end
           rescue StandardError => e
             SplitIoClient.configuration.logger.error("Exception while clearing events cache: #{e}")
             []
           end
-
-          def batch
-            get_events(EVENTS_SLICE)
-          end
-
-          def clear
-            get_events
-          end
-
         end
       end
     end

data/lib/splitclient-rb/cache/repositories/events_repository.rb

@@ -4,15 +4,23 @@ module SplitIoClient
       # Repository which forwards events interface to the selected adapter
       class EventsRepository < Repository
         extend Forwardable
-        def_delegators :@adapter, :add, :clear, :batch
+        def_delegators :@repository, :add, :clear
 
-        def initialize(adapter)
-          @adapter = case adapter.class.to_s
+        def initialize(adapter, api_key)
+          @repository = case adapter.class.to_s
           when 'SplitIoClient::Cache::Adapters::MemoryAdapter'
             Repositories::Events::MemoryRepository.new(adapter)
           when 'SplitIoClient::Cache::Adapters::RedisAdapter'
             Repositories::Events::RedisRepository.new(adapter)
           end
+
+          @api_key = api_key
+        end
+
+        def post_events
+          events_api.post(self.clear)
+        rescue StandardError => error
+          SplitIoClient.configuration.log_found_exception(__method__.to_s, error)
         end
 
         protected
@@ -25,15 +33,22 @@ module SplitIoClient
           }
         end
 
-        def event(key, traffic_type, event_type, time, value)
+        def event(key, traffic_type, event_type, time, value, properties)
           {
             key: key,
             trafficTypeName: traffic_type,
             eventTypeId: event_type,
             value: value,
-            timestamp: time
+            timestamp: time,
+            properties: properties
           }.reject { |_, v| v.nil? }
         end
+
+        private
+
+        def events_api
+          @events_api ||= SplitIoClient::Api::Events.new(@api_key)
+        end
       end
     end
   end

data/lib/splitclient-rb/cache/senders/events_sender.rb

@@ -4,9 +4,8 @@ module SplitIoClient
   module Cache
     module Senders
       class EventsSender
-        def initialize(events_repository, api_key)
+        def initialize(events_repository)
           @events_repository = events_repository
-          @api_key = api_key
         end
 
         def call
@@ -31,7 +30,7 @@ module SplitIoClient
               SplitIoClient.configuration.logger.info('Starting events service')
               
               loop do
-                post_events(false)
+                post_events
 
                 sleep(SplitIoClient::Utilities.randomize_interval(SplitIoClient.configuration.events_push_rate))
               end
@@ -43,15 +42,8 @@ module SplitIoClient
           end
         end
 
-        def post_events(fetch_all_events = true)
-          events = fetch_all_events ? @events_repository.clear : @events_repository.batch
-          events_api.post(events)
-        rescue StandardError => error
-          SplitIoClient.configuration.log_found_exception(__method__.to_s, error)
-        end
-
-        def events_api
-          @events_api ||= SplitIoClient::Api::Events.new(@api_key)
+        def post_events
+          @events_repository.post_events
         end
       end
     end

data/lib/splitclient-rb/clients/split_client.rb

@@ -1,4 +1,6 @@
 module SplitIoClient
+  EVENTS_SIZE_THRESHOLD = 32768
+  EVENT_AVERAGE_SIZE = 1024
 
   class SplitClient
     #
@@ -112,10 +114,22 @@ module SplitIoClient
       @impression_router ||= SplitIoClient::ImpressionRouter.new
     end
 
-    def track(key, traffic_type_name, event_type, value = nil)
-      return false unless valid_client && SplitIoClient::Validators.valid_track_parameters(key, traffic_type_name, event_type, value)
+    def track(key, traffic_type_name, event_type, value = nil, properties = nil)
+      return false unless valid_client && SplitIoClient::Validators.valid_track_parameters(key, traffic_type_name, event_type, value, properties)
+
+      properties_size = EVENT_AVERAGE_SIZE
+
+      if !properties.nil?
+        properties, size = validate_properties(properties)
+        properties_size += size
+        if (properties_size > EVENTS_SIZE_THRESHOLD)
+          SplitIoClient.configuration.logger.error("The maximum size allowed for the properties is #{EVENTS_SIZE_THRESHOLD}. Current is #{properties_size}. Event not queued")
+          return false
+        end
+      end
+
       begin
-        @events_repository.add(key.to_s, traffic_type_name.downcase, event_type.to_s, (Time.now.to_f * 1000).to_i, value)
+        @events_repository.add(key.to_s, traffic_type_name.downcase, event_type.to_s, (Time.now.to_f * 1000).to_i, value, properties, properties_size)
         true
       rescue StandardError => error
         SplitIoClient.configuration.log_found_exception(__method__.to_s, error)
@@ -164,6 +178,30 @@ module SplitIoClient
 
     private
 
+    def validate_properties(properties)
+      properties_count = 0
+      size = 0
+
+      fixed_properties = properties.each_with_object({}) { |(key, value), result|
+
+        if(key.is_a?(String) || key.is_a?(Symbol))
+          properties_count += 1
+          size += variable_size(key)
+          if value.is_a?(String) || value.is_a?(Symbol) || value.is_a?(Numeric) || value.is_a?(TrueClass) || value.is_a?(FalseClass) || value.nil?
+            result[key] = value
+            size += variable_size(value)
+          else
+            SplitIoClient.configuration.logger.warn("Property #{key} is of invalid type. Setting value to nil")
+            result[key] = nil
+          end
+        end
+      }
+
+      SplitIoClient.configuration.logger.warn('Event has more than 300 properties. Some of them will be trimmed when processed') if properties_count > 300
+
+      return fixed_properties, size
+    end
+
     def valid_client
       if @destroyed
         SplitIoClient.configuration.logger.error('Client has already been destroyed - no calls possible')
@@ -279,5 +317,9 @@ module SplitIoClient
 
       parsed_treatment(multiple, treatment_data)
     end
+
+    def variable_size(value)
+      value.is_a?(String) ? value.length : 0
+    end
   end
 end

data/lib/splitclient-rb/engine/parser/split_adapter.rb

@@ -75,7 +75,7 @@ module SplitIoClient
 
     # Starts thread which loops constantly and sends events to the Split API
     def events_sender
-      EventsSender.new(@events_repository, @api_key).call
+      EventsSender.new(@events_repository).call
     end
   end
 end

data/lib/splitclient-rb/split_factory.rb

@@ -29,7 +29,7 @@ module SplitIoClient
       @segments_repository = SegmentsRepository.new(@cache_adapter)
       @impressions_repository = ImpressionsRepository.new(SplitIoClient.configuration.impressions_adapter)
       @metrics_repository = MetricsRepository.new(SplitIoClient.configuration.metrics_adapter)
-      @events_repository = EventsRepository.new(SplitIoClient.configuration.events_adapter)
+      @events_repository = EventsRepository.new(SplitIoClient.configuration.events_adapter, @api_key)
 
       if SplitIoClient.configuration.mode == :standalone && SplitIoClient.configuration.block_until_ready > 0
         @sdk_blocker = SDKBlocker.new(@splits_repository, @segments_repository)

data/lib/splitclient-rb/validators.rb

@@ -16,11 +16,12 @@ module SplitIoClient
       valid_split_names?(method, split_names)
     end
 
-    def valid_track_parameters(key, traffic_type_name, event_type, value)
+    def valid_track_parameters(key, traffic_type_name, event_type, value, properties)
       valid_track_key?(key) &&
         valid_traffic_type_name?(traffic_type_name) &&
         valid_event_type?(event_type) &&
-        valid_value?(value)
+        valid_value?(value) &&
+        valid_properties?(properties)
     end
 
     def valid_split_parameters(split_name)
@@ -253,5 +254,14 @@ module SplitIoClient
 
       true
     end
+
+    def valid_properties?(properties)
+      unless properties.is_a?(Hash) || properties.nil?
+        SplitIoClient.configuration.logger.error('track: properties must be a Hash')
+        return false
+      end
+
+      true
+    end
   end
 end

data/lib/splitclient-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitIoClient
-  VERSION = '6.3.0'
+  VERSION = '6.4.0.pre.rc1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitclient-rb
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 6.4.0.pre.rc1
 platform: ruby
 authors:
 - Split Software
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-30 00:00:00.000000000 Z
+date: 2019-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: allocation_stats
@@ -403,12 +403,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby client for split SDK.