splitclient-rb 5.0.2 → 5.0.3.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bb4acbfa69102bcb33b4c28f3459450d508c7d8
-  data.tar.gz: beadf92c41e0df352f12952dcacd1d68ddbb83dc
+  metadata.gz: 96c04f6c8f1f039d2e44eaf73b22ef85ae185159
+  data.tar.gz: 6be836b37a412f8cc5fe8065601685da71a9d7ea
 SHA512:
-  metadata.gz: 46987aa37212ce9d6ae6983fcd3863e0f49a38c5c4fad2a47e7ca10c3ba7eba861badaf4e48500cc951f2c6211be231281a9cef449bc433806650214e31f1515
-  data.tar.gz: 2b5561d235e39ac852b63d88ffee096893a61e9d29bd1f9ba4e6875b555235688e84bd89a85ecc24f3a60a98ae0c581582af8ee659238c80cac76b055233b5cb
+  metadata.gz: 30ef29cf085ba8ab284115dc2adaed00d6ec9400f0326d93e454cf0630f4a43231974968d78238c62d5e22c11af856cb080903c246aa72e7c7419e2830b777a4
+  data.tar.gz: c940e12c425db431769f12193544473e90aa956ea02b6e76288038a4c515b4573e480c4aebcf115107508cd115a67668d834eeb2d0680965f4c21bea56611487

data/Detailed-README.md

@@ -136,7 +136,9 @@ split_client.get_treatment('user_id','feature_name', attr: 'val')
 
 **impressions_refresh_rate** : The SDK sends information on who got what treatment at what time back to Split servers to power analytics. This parameter controls how often this data is sent to Split servers in seconds
 
-**impressions_queue_size** : The size of the impressions queue in case of `cache_adapter == :memory` and the size impressions batch to be fetched from Redis in case of `cache_adapter == :redis`. Use `-1` to disable impressions.
+**impressions_queue_size** : The size of the impressions queue in case of `cache_adapter == :memory`.
+
+**impressions_bulk_size** : Max number of impressions to be sent to the backend on each post. Defaults to `impressions_queue_size`.
 
 *default value* = `60`
 

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

@@ -24,19 +24,21 @@ module SplitIoClient
             @current_size.increment
           end
 
-          # Get all items from the queue
           def clear
-            items = []
+            get_batch(@current_size.value)
+          end
 
-            loop do
+          def get_batch(size)
+            items = []
+            size.times do
               items << @queue.pop(true)
-
               @current_size.decrement
             end
-
-          rescue ThreadError
+            items
+            rescue ThreadError
             items
           end
+
         end
       end
     end

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

@@ -3,6 +3,7 @@ module SplitIoClient
     module Repositories
       module Impressions
         class MemoryRepository
+
           def initialize(adapter, config)
             @adapter = adapter
             @config = config
@@ -18,23 +19,25 @@ module SplitIoClient
             end
           end
 
-          def add_bulk(key, bucketing_key, treatments_labels_change_numbers, time)
-            treatments_labels_change_numbers.each do |split_name, treatment_label_number|
+          def add_bulk(key, bucketing_key, treatments, time)
+            treatments.each do |split_name, treatment|
               add(
                 split_name,
                 'keyName' => key,
                 'bucketingKey' => bucketing_key,
-                'treatment' => treatment_label_number[:treatment],
-                'label' => @config.labels_enabled ? treatment_label_number[:label] : nil,
-                'changeNumber' => treatment_label_number[:change_number],
+                'treatment' => treatment[:treatment],
+                'label' => @config.labels_enabled ? treatment[:label] : nil,
+                'changeNumber' => treatment[:change_number],
                 'time' => time
               )
             end
           end
 
-          # Get everything from the queue and leave it empty
-          def clear
-            @adapter.clear.map { |impression| impression.update(ip: @config.machine_ip) }
+          def get_batch
+            return [] if @config.impressions_bulk_size == 0
+            @adapter.get_batch(@config.impressions_bulk_size).map do |impression|
+              impression.update(ip: @config.machine_ip)
+            end
           end
 
           private

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

@@ -3,7 +3,6 @@ module SplitIoClient
     module Repositories
       module Impressions
         class RedisRepository < Repository
-          IMPRESSIONS_SLICE = 1000
 
           def initialize(adapter, config)
             @adapter = adapter
@@ -18,25 +17,23 @@ module SplitIoClient
             )
           end
 
-          def add_bulk(key, bucketing_key, treatments_labels_change_numbers, time)
+          def add_bulk(key, bucketing_key, treatments, time)
             @adapter.redis.pipelined do
-              treatments_labels_change_numbers.each_slice(IMPRESSIONS_SLICE) do |treatments_labels_change_numbers_slice|
-                treatments_labels_change_numbers_slice.each do |split_name, treatment_label_change_number|
-                  add(split_name,
-                      'keyName' => key,
-                      'bucketingKey' => bucketing_key,
-                      'treatment' => treatment_label_change_number[:treatment],
-                      'label' => @config.labels_enabled ? treatment_label_change_number[:label] : nil,
-                      'changeNumber' => treatment_label_change_number[:change_number],
-                      'time' => time)
-                end
+              treatments.each do |split_name, treatment|
+                add(split_name,
+                    'keyName' => key,
+                    'bucketingKey' => bucketing_key,
+                    'treatment' => treatment[:treatment],
+                    'label' => @config.labels_enabled ? treatment[:label] : nil,
+                    'changeNumber' => treatment[:change_number],
+                    'time' => time)
               end
             end
           end
 
-          # Get random impressions from redis in batches of size @config.impressions_queue_size,
+          # Get random impressions from redis in batches of size @config.impressions_bulk_size,
           # delete fetched impressions afterwards
-          def clear
+          def get_batch
             impressions = impression_keys.each_with_object([]) do |key, memo|
               ip = key.split('/')[-2] # 'prefix/sdk_lang/ip/impressions.name' -> ip
               if ip.nil?
@@ -44,7 +41,7 @@ module SplitIoClient
                 next
               end
               split_name = key.split('.').last
-              members = @adapter.random_set_elements(key, @config.impressions_queue_size)
+              members = @adapter.random_set_elements(key, @config.impressions_bulk_size)
               members.each do |impression|
                 parsed_impression = JSON.parse(impression)
 
@@ -61,6 +58,8 @@ module SplitIoClient
             impressions
           rescue StandardError => e
             @config.logger.error("Exception while clearing impressions cache: #{e}")
+
+            []
           end
 
           private
@@ -70,6 +69,8 @@ module SplitIoClient
             @adapter.find_sets_by_prefix("#{@config.redis_namespace}/*/impressions.*")
           rescue StandardError => e
             @config.logger.error("Exception while fetching impression_keys: #{e}")
+
+            []
           end
         end
       end

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

@@ -4,7 +4,7 @@ module SplitIoClient
       # Repository which forwards impressions interface to the selected adapter
       class ImpressionsRepository < Repository
         extend Forwardable
-        def_delegators :@adapter, :add, :add_bulk, :clear, :empty?
+        def_delegators :@adapter, :add, :add_bulk, :get_batch, :empty?
 
         def initialize(adapter, config)
           @config = config

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

@@ -7,7 +7,7 @@ module SplitIoClient
         end
 
         def call(raw_impressions)
-          impressions = raw_impressions ? raw_impressions : @impressions_repository.clear
+          impressions = raw_impressions ? raw_impressions : @impressions_repository.get_batch
           formatted_impressions = []
           filtered_impressions = filter_impressions(impressions)
 

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

@@ -9,8 +9,7 @@ module SplitIoClient
         end
 
         def call
-          # Disable impressions if @config.impressions_queue_size == -1
-          if @config.impressions_queue_size < 0
+          if @config.disable_impressions
             @config.logger.info('Disabling impressions service by config')
             return
           end

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

@@ -27,7 +27,7 @@ module SplitIoClient
           memo.merge!(name => get_treatment(key, name, attributes, data, false, true, evaluator))
         end
 
-      if @config.impressions_queue_size > 0
+      unless @config.disable_impressions
         time = (Time.now.to_f * 1000.0).to_i
         @impressions_repository.add_bulk(
           matching_key, bucketing_key, treatments_labels_change_numbers, time
@@ -103,7 +103,6 @@ module SplitIoClient
 
       begin
         latency = (Time.now - start) * 1000.0
-        # Disable impressions if @config.impressions_queue_size == -1
         split && store_impression(split_name, matching_key, bucketing_key, treatment_data, store_impressions, attributes)
 
         # Measure
@@ -145,7 +144,7 @@ module SplitIoClient
     def store_impression(split_name, matching_key, bucketing_key, treatment, store_impressions, attributes)
       time = (Time.now.to_f * 1000.0).to_i
 
-      return unless @config.impressions_queue_size > 0 && store_impressions
+      return if @config.disable_impressions || !store_impressions
 
       @impressions_repository.add(split_name,
         'keyName' => matching_key,

data/lib/splitclient-rb/split_config.rb

@@ -21,9 +21,9 @@ module SplitIoClient
     # @option opts [Int] :impressions_refresh_rate
     # @option opts [Object] :logger a logger to user for messages from the client. Defaults to stdout
     # @option opts [Boolean] :debug_enabled (false) The value for the debug flag
-    # @option opts [Int] :impressions_queue_size how big the impressions queue is before dropping impressions. -1 to disable it.
+    # @option opts [Int] :impressions_queue_size Size of the impressions queue in the memory repository. Once reached, newer impressions will be dropped
+    # @option opts [Int] :impressions_bulk_size Max number of impressions to be sent to the backend on each post
     # @option opts [#log] :impression_listener this object will capture all impressions and process them through `#log`
-    #
     # @return [type] SplitConfig with configuration options
     def initialize(opts = {})
       @base_uri = (opts[:base_uri] || SplitConfig.default_base_uri).chomp('/')
@@ -45,6 +45,10 @@ module SplitIoClient
       @impressions_adapter = SplitConfig.init_cache_adapter(
         opts[:cache_adapter] || SplitConfig.default_cache_adapter, :queue_adapter, @redis_url, @impressions_queue_size
       )
+      #Safeguard for users of older SDK versions.
+      @disable_impressions = @impressions_queue_size == -1
+      #Safeguard for users of older SDK versions.
+      @impressions_bulk_size = opts[:impressions_bulk_size] || @impressions_queue_size > 0 ? @impressions_queue_size : 0
 
       @metrics_adapter = SplitConfig.init_cache_adapter(
         opts[:cache_adapter] || SplitConfig.default_cache_adapter, :map_adapter, @redis_url, false
@@ -179,6 +183,8 @@ module SplitIoClient
     #
     # @return [Integer]
     attr_reader :impressions_queue_size
+    attr_reader :impressions_bulk_size
+    attr_reader :disable_impressions
 
     attr_reader :redis_url
     attr_reader :redis_namespace

data/lib/splitclient-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitIoClient
-  VERSION = '5.0.2'
+  VERSION = '5.0.3.pre.rc1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitclient-rb
 version: !ruby/object:Gem::Version
-  version: 5.0.2
+  version: 5.0.3.pre.rc1
 platform: ruby
 authors:
 - Split Software
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-01 00:00:00.000000000 Z
+date: 2018-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -313,12 +313,12 @@ 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.6.8
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Ruby client for split SDK.