splitclient-rb 5.1.3.pre.rc1 → 5.1.3.pre.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7470b6e84f8bf0cef00815acc17c0fa9d1f8ab81e6746676b19e9119ce12ba1f
-  data.tar.gz: 7d95234b01d68aa0da0bdf8a3dd07849836ca3a9194e9a56094bb054e597c0d4
+  metadata.gz: 88734d846f562241cc964056ada17c518d5517d31c4096252b461d600955ca2b
+  data.tar.gz: aa3a438418ba809ca40fdfd0d5149cefd829dd227942cc1d730387dfa89077eb
 SHA512:
-  metadata.gz: bc1135d77d83d1c037716ce4aaa2f9a9f40bcb386cc0efa1665bcd82e2fa2294907d1bc1f42e8fa72541179761d22965c0daee1b51a354677a5ca4bc5d20dc26
-  data.tar.gz: 9bc52d47fb482081015c4849e15105142de7033880f5d3de1cbef5a8766636389a055e35b4dfa5986a6e63136cc760ba945c702d80a31ae16cde8ad655a71906
+  metadata.gz: 6379d29aa2f9bc96b43adfcd14578a9e5f397ff62195085d4325bf9df6f3caa6e5c81c718910d9777437b6acc44128728866e9fc60139e863f04eb4f40d34834
+  data.tar.gz: f8f8003bdaf8a63637ddee8b3735e26f8929694fd6ec8d4112382f7945e6fa80a5f057bc56a979909a1bc8a2fafb4fc07b966e9bdb2437a59079f0c225e1b658

data/.rubocop.yml

@@ -1,3 +1,6 @@
+Documentation:
+    Enabled: false
+
 Metrics/MethodLength:
   Max: 15
 

data/CHANGES.txt

@@ -1,5 +1,5 @@
 5.1.3
-- Add cache wrapper to treatments and segments.
+- Add cache wrapper to splits and segments.
 
 5.1.2 (October 26th, 2018)
 - Add input validation for client API methods

data/NEWS

@@ -1,6 +1,6 @@
 5.1.3
 
-Add cache wrapper to treatments and segments.
+Add cache wrapper to splits and segments.
 
 5.1.2
 

data/lib/splitclient-rb/cache/adapters/redis_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module SplitIoClient
@@ -85,8 +87,8 @@ module SplitIoClient
         end
 
         # Set
-        alias_method :initialize_set, :initialize_map
-        alias_method :find_sets_by_prefix, :find_strings_by_prefix
+        alias initialize_set initialize_map
+        alias find_sets_by_prefix find_strings_by_prefix
 
         def add_to_set(key, val)
           @redis.sadd(key, val)
@@ -126,7 +128,7 @@ module SplitIoClient
         def get_from_queue(key, count)
           items = @redis.lrange(key, 0, count - 1)
           fetched_count = items.size
-          items_to_remove = (fetched_count == count) ? count : fetched_count
+          items_to_remove = fetched_count == count ? count : fetched_count
 
           @redis.ltrim(key, items_to_remove, -1)
 
@@ -148,9 +150,9 @@ module SplitIoClient
           @redis.incrby(key, inc)
         end
 
-        def pipelined(&block)
+        def pipelined
           @redis.pipelined do
-            block.call
+            yield
           end
         end
 
@@ -159,6 +161,10 @@ module SplitIoClient
 
           keys.map { |key| @redis.del(key) }
         end
+
+        def expire(key, seconds)
+          @redis.expire(key, seconds)
+        end
       end
     end
   end

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

@@ -1,42 +1,44 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   module Cache
     module Repositories
       module Impressions
-        class MemoryRepository
-
+        class MemoryRepository < ImpressionsRepository
           def initialize(adapter)
             @adapter = adapter
           end
 
           # Store impression data in the selected adapter
-          def add(split_name, data)
-            @adapter.add_to_queue(feature: split_name, impressions: data)
+          def add(matching_key, bucketing_key, split_name, treatment, time)
+            @adapter.add_to_queue(
+              m: metadata,
+              i: impression_data(
+                matching_key,
+                bucketing_key,
+                split_name,
+                treatment,
+                time
+              )
+            )
           rescue ThreadError # queue is full
             if random_sampler.rand(1..1000) <= 2 # log only 0.2 % of the time
-              SplitIoClient.configuration.logger.warn("Dropping impressions. Current size is #{SplitIoClient.configuration.impressions_queue_size}. " \
-                                  "Consider increasing impressions_queue_size")
+              SplitIoClient.configuration.logger.warn("Dropping impressions. Current size is \
+                #{SplitIoClient.configuration.impressions_queue_size}. " \
+                'Consider increasing impressions_queue_size')
             end
           end
 
           def add_bulk(key, bucketing_key, treatments, time)
             treatments.each do |split_name, treatment|
-              add(
-                split_name,
-                'keyName' => key,
-                'bucketingKey' => bucketing_key,
-                'treatment' => treatment[:treatment],
-                'label' => SplitIoClient.configuration.labels_enabled ? treatment[:label] : nil,
-                'changeNumber' => treatment[:change_number],
-                'time' => time
-              )
+              add(key, bucketing_key, split_name, treatment, time)
             end
           end
 
-          def get_batch
-            return [] if SplitIoClient.configuration.impressions_bulk_size == 0
-            @adapter.get_batch(SplitIoClient.configuration.impressions_bulk_size).map do |impression|
-              impression.update(ip: SplitIoClient.configuration.machine_ip)
-            end
+          def batch
+            return [] if SplitIoClient.configuration.impressions_bulk_size.zero?
+
+            @adapter.get_batch(SplitIoClient.configuration.impressions_bulk_size)
           end
 
           private

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

@@ -1,75 +1,53 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   module Cache
     module Repositories
       module Impressions
-        class RedisRepository < Repository
+        class RedisRepository < ImpressionsRepository
+          EXPIRE_SECONDS = 3600
 
           def initialize(adapter)
             @adapter = adapter
           end
 
-          # Store impression data in Redis
-          def add(split_name, data)
-            @adapter.add_to_set(
-              impressions_metrics_key("impressions.#{split_name}"),
-              data.to_json
-            )
+          def add(matching_key, bucketing_key, split_name, treatment, time)
+            add_bulk(matching_key, bucketing_key, { split_name => treatment }, time)
           end
 
-          def add_bulk(key, bucketing_key, treatments, time)
-            @adapter.redis.pipelined do
-              treatments.each do |split_name, treatment|
-                add(split_name,
-                    'keyName' => key,
-                    'bucketingKey' => bucketing_key,
-                    'treatment' => treatment[:treatment],
-                    'label' => SplitIoClient.configuration.labels_enabled ? treatment[:label] : nil,
-                    'changeNumber' => treatment[:change_number],
-                    'time' => time)
-              end
+          def add_bulk(matching_key, bucketing_key, treatments, time)
+            impressions = treatments.map do |split_name, treatment|
+              {
+                m: metadata,
+                i: impression_data(
+                  matching_key,
+                  bucketing_key,
+                  split_name,
+                  treatment,
+                  time
+                )
+              }.to_json
             end
-          end
-
-          # Get random impressions from redis in batches of size SplitIoClient.configuration.impressions_bulk_size,
-          # delete fetched impressions afterwards
-          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?
-                SplitIoClient.configuration.logger.warn("Impressions IP parse error for key: #{key}")
-                next
-              end
-              split_name = key.split('.').last
-              members = @adapter.random_set_elements(key, SplitIoClient.configuration.impressions_bulk_size)
-              members.each do |impression|
-                parsed_impression = JSON.parse(impression)
 
-                memo << {
-                  feature: split_name.to_sym,
-                  impressions: parsed_impression,
-                  ip: ip
-                }
-              end
+            impressions_list_size = @adapter.add_to_queue(key, impressions)
 
-              @adapter.delete_from_set(key, members)
+            # Synchronizer might not be running
+            @adapter.expire(key, EXPIRE_SECONDS) if impressions.size == impressions_list_size
+          end
 
+          def batch
+            @adapter.get_from_queue(key, SplitIoClient.configuration.impressions_bulk_size).map do |e|
+              impression = JSON.parse(e, symbolize_names: true)
+              impression[:i][:f] = impression[:i][:f].to_sym
+              impression
             end
-            impressions
           rescue StandardError => e
             SplitIoClient.configuration.logger.error("Exception while clearing impressions cache: #{e}")
-
             []
           end
 
-          private
-
-          # Get all sets by prefix
-          def impression_keys
-            @adapter.find_sets_by_prefix("#{SplitIoClient.configuration.redis_namespace}/*/impressions.*")
-          rescue StandardError => e
-            SplitIoClient.configuration.logger.error("Exception while fetching impression_keys: #{e}")
-
-            []
+          def key
+            @key ||= namespace_key('.impressions')
           end
         end
       end

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

@@ -1,18 +1,46 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   module Cache
     module Repositories
       # Repository which forwards impressions interface to the selected adapter
       class ImpressionsRepository < Repository
         extend Forwardable
-        def_delegators :@adapter, :add, :add_bulk, :get_batch, :empty?
+        def_delegators :@adapter, :add, :add_bulk, :batch, :empty?
 
         def initialize(adapter)
           @adapter = case adapter.class.to_s
-          when 'SplitIoClient::Cache::Adapters::MemoryAdapter'
-            Repositories::Impressions::MemoryRepository.new(adapter)
-          when 'SplitIoClient::Cache::Adapters::RedisAdapter'
-            Repositories::Impressions::RedisRepository.new(adapter)
-          end
+                     when 'SplitIoClient::Cache::Adapters::MemoryAdapter'
+                       Repositories::Impressions::MemoryRepository.new(adapter)
+                     when 'SplitIoClient::Cache::Adapters::RedisAdapter'
+                       Repositories::Impressions::RedisRepository.new(adapter)
+                     end
+        end
+
+        protected
+
+        def impression_data(matching_key, bucketing_key, split_name, treatment, timestamp)
+          {
+            k: matching_key,
+            b: bucketing_key,
+            f: split_name,
+            t: treatment[:treatment],
+            r: applied_rule(treatment[:label]),
+            c: treatment[:change_number],
+            m: timestamp
+          }
+        end
+
+        def metadata
+          {
+            s: "#{SplitIoClient.configuration.language}-#{SplitIoClient.configuration.version}",
+            i: SplitIoClient.configuration.machine_ip,
+            n: SplitIoClient.configuration.machine_name
+          }
+        end
+
+        def applied_rule(label)
+          SplitIoClient.configuration.labels_enabled ? label : nil
         end
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   module Cache
     module Senders

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   module Cache
     module Senders
@@ -7,29 +9,15 @@ module SplitIoClient
         end
 
         def call(raw_impressions)
-          impressions = raw_impressions ? raw_impressions : @impressions_repository.get_batch
-          formatted_impressions = []
+          impressions = raw_impressions || @impressions_repository.batch
           filtered_impressions = filter_impressions(impressions)
 
           return [] if impressions.empty? || filtered_impressions.empty?
 
           formatted_impressions = unique_features(filtered_impressions).each_with_object([]) do |feature, memo|
-            ip = nil
-            current_impressions =
-              filtered_impressions
-                .select { |impression| impression[:feature] == feature }
-                .map do |impression|
-                  ip = impression[:ip]
-                  {
-                    keyName: impression[:impressions]['keyName'] || impression[:impressions]['key_name'],
-                    treatment: impression[:impressions]['treatment'],
-                    time: impression[:impressions]['time'],
-                    bucketingKey: impression[:impressions]['bucketingKey'] || impression[:impressions]['bucketing_key'],
-                    label: impression[:impressions]['label'],
-                    changeNumber: impression[:impressions]['changeNumber'] || impression[:impressions]['change_number'],
-                  }
-                end
-
+            feature_impressions = feature_impressions(filtered_impressions, feature)
+            ip = feature_impressions.first[:m][:i]
+            current_impressions = current_impressions(feature_impressions)
             memo << {
               testName: feature.to_sym,
               keyImpressions: current_impressions,
@@ -42,8 +30,27 @@ module SplitIoClient
 
         private
 
+        def feature_impressions(filtered_impressions, feature)
+          filtered_impressions.select do |impression|
+            impression[:i][:f] == feature
+          end
+        end
+
+        def current_impressions(feature_impressions)
+          feature_impressions.map do |impression|
+            {
+              keyName: impression[:i][:k],
+              treatment: impression[:i][:t],
+              time: impression[:i][:m],
+              bucketingKey: impression[:i][:b],
+              label: impression[:i][:r],
+              changeNumber: impression[:i][:c]
+            }
+          end
+        end
+
         def unique_features(impressions)
-          impressions.map { |impression| impression[:feature] }.uniq
+          impressions.map { |impression| impression[:i][:f] }.uniq
         end
 
         # Filter seen impressions by impression_hash
@@ -61,11 +68,11 @@ module SplitIoClient
         end
 
         def impression_hash(impression)
-          "#{impression[:feature]}:" \
-          "#{impression[:impressions]['keyName']}:" \
-          "#{impression[:impressions]['bucketingKey']}:" \
-          "#{impression[:impressions]['changeNumber']}:" \
-          "#{impression[:impressions]['treatment']}"
+          "#{impression[:i][:f]}:" \
+          "#{impression[:i][:k]}:" \
+          "#{impression[:i][:b]}:" \
+          "#{impression[:i][:c]}:" \
+          "#{impression[:i][:t]}"
         end
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   module Cache
     module Senders

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   module Cache
     module Senders

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

@@ -136,13 +136,12 @@ module SplitIoClient
 
       return if SplitIoClient.configuration.disable_impressions || !store_impressions
 
-      @impressions_repository.add(split_name,
-        'keyName' => matching_key,
-        'bucketingKey' => bucketing_key,
-        'treatment' => treatment[:treatment],
-        'label' => SplitIoClient.configuration.labels_enabled ? treatment[:label] : nil,
-        'time' => time,
-        'changeNumber' => treatment[:change_number]
+      @impressions_repository.add(
+        matching_key,
+        bucketing_key,
+        split_name,
+        treatment,
+        time
       )
 
       route_impression(split_name, matching_key, bucketing_key, time, treatment, attributes)

data/lib/splitclient-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitIoClient
-  VERSION = '5.1.3.pre.rc1'
+  VERSION = '5.1.3.pre.rc2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitclient-rb
 version: !ruby/object:Gem::Version
-  version: 5.1.3.pre.rc1
+  version: 5.1.3.pre.rc2
 platform: ruby
 authors:
 - Split Software
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-05 00:00:00.000000000 Z
+date: 2018-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: allocation_stats