Do not send impressions into development

.github/workflows/ci.yml

@@ -1,10 +1,4 @@
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
+on: [push, pull_request]
 
 jobs:
   test:
@@ -14,16 +8,20 @@ jobs:
         image: redis
         ports:
           - 6379:6379
+    strategy:
+      matrix:
+        ruby: [ '2.5.0', '3.1.1' ]
+
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
         with:
           fetch-depth: 0
 
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.5
+          ruby-version: ${{ matrix.ruby }}
 
       - name: Install dependencies
         run: bundle install

.rubocop.yml

@@ -26,20 +26,7 @@ Metrics/ParameterLists:
     - lib/splitclient-rb/engine/sync_manager.rb
 
 Metrics/LineLength:
-  Max: 130
-  Exclude:
-    - spec/sse/**/*
-    - spec/integrations/**/*
-    - spec/engine/sync_manager_spec.rb
-    - spec/engine/auth_api_client_spec.rb
-    - spec/telemetry/synchronizer_spec.rb
-    - spec/splitclient/split_config_spec.rb
-    - spec/engine/push_manager_spec.rb
-
-Style/BracesAroundHashParameters:
-  Exclude:
-    - spec/integrations/push_client_spec.rb
-    - spec/engine/synchronizer_spec.rb
+  Max: 135
 
 Metrics/BlockLength:
   Exclude:
@@ -50,8 +37,24 @@ Naming/FileName:
   Exclude:
     - splitclient-rb.gemspec
 
+Style/OptionalBooleanParameter:
+  Exclude:
+    - lib/splitclient-rb/engine/matchers/between_matcher.rb
+    - lib/splitclient-rb/engine/matchers/combining_matcher.rb
+    - lib/splitclient-rb/engine/matchers/equal_to_matcher.rb
+    - lib/splitclient-rb/engine/matchers/less_than_or_equal_to_matcher.rb
+    - lib/splitclient-rb/engine/matchers/greater_than_or_equal_to_matcher.rb
+
+Style/HashTransformKeys:
+  Exclude:
+    - lib/splitclient-rb/engine/matchers/combining_matcher.rb
+
+Style/RedundantReturn:
+  Exclude:
+    - lib/splitclient-rb/engine/common/impressions_manager.rb
+
 AllCops:
-  TargetRubyVersion: 2.3.6
+  TargetRubyVersion: 2.5
   Exclude:
     - gemfiles/* # excluded as appraisal generates them with errors
     - lib/*
@@ -69,3 +72,5 @@ AllCops:
     - lib/splitclient-rb/engine/synchronizer.rb
     - tmp/**/*
     - lib/splitclient-rb/sse/event_source/client.rb
+    - spec/**/*
+    - .simplecov

CHANGES.txt

@@ -1,5 +1,12 @@
 CHANGES
 
+8.0.0 (May 10, 2022)
+- BREAKING CHANGE: Deprecated support for ruby 2.3 and 2.4 versions. The minimum ruby version required is 2.5 now.
+- Updated redis command for config telemetry, using hset instead of rpush now.
+- Updated dependencies:
+  - rake to ~> 13.0
+  - faraday to >= 1.1, < 2.0
+
 7.3.4 (Feb 21, 2022)
 - Updated streaming events architecture with a new queue logic.
 - Fixed redis integration Pipelining command deprecation warning.

README.md

@@ -1,13 +1,13 @@
 # Split SDK for Ruby
-[![Build Status](https://travis-ci.com/splitio/ruby-client.svg?branch=master)](https://travis-ci.com/splitio/ruby-client)
+![Build Status](https://github.com/splitio/ruby-client/actions/workflows/ci.yml/badge.svg?branch=master)
 
 ## Overview
 This SDK is designed to work with Split, the platform for controlled rollouts, which serves features to your users via a Split feature flag to manage your complete customer experience.
 
 [![Twitter Follow](https://img.shields.io/twitter/follow/splitsoftware.svg?style=social&label=Follow&maxAge=1529000)](https://twitter.com/intent/follow?screen_name=splitsoftware)
 
 ## Compatibility
-The Ruby SDK support Ruby version 2.3.0 or later and JRuby or 9.1.17 o later.
+The Ruby SDK support Ruby version 2.5.0 or later and JRuby or 9.1.17 o later.
 
 Also the Ruby SDK has been tested as a standalone app as well as using the following web servers:
  - Puma

Rakefile

@@ -3,7 +3,6 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
-require 'appraisal'
 
 Dir['tasks/**/*.rake'].each { |rake| load rake }
 
@@ -26,10 +25,4 @@ else
   end
 end
 
-if !ENV['APPRAISAL_INITIALIZED']
-  task :default do
-    sh 'appraisal install && rake appraisal && rake rubocop'
-  end
-else
-  task default: %i[spec rubocop]
-end
+task default: %i[spec rubocop]

lib/splitclient-rb.rb

@@ -12,8 +12,11 @@
 require 'splitclient-rb/cache/adapters/redis_adapter'
 require 'splitclient-rb/cache/fetchers/segment_fetcher'
 require 'splitclient-rb/cache/fetchers/split_fetcher'
+require 'splitclient-rb/cache/filter/bloom_filter'
+require 'splitclient-rb/cache/filter/filter_adapter'
 require 'splitclient-rb/cache/hashers/impression_hasher'
 require 'splitclient-rb/cache/observers/impression_observer'
+require 'splitclient-rb/cache/observers/noop_impression_observer'
 require 'splitclient-rb/cache/repositories/repository'
 require 'splitclient-rb/cache/repositories/segments_repository'
 require 'splitclient-rb/cache/repositories/splits_repository'
@@ -28,6 +31,9 @@
 require 'splitclient-rb/cache/senders/events_sender'
 require 'splitclient-rb/cache/senders/impressions_count_sender'
 require 'splitclient-rb/cache/senders/localhost_repo_cleaner'
+require 'splitclient-rb/cache/senders/impressions_sender_adapter'
+require 'splitclient-rb/cache/senders/impressions_adapter/memory_sender'
+require 'splitclient-rb/cache/senders/impressions_adapter/redis_sender'
 require 'splitclient-rb/cache/stores/localhost_split_builder'
 require 'splitclient-rb/cache/stores/localhost_split_store'
 require 'splitclient-rb/cache/stores/store_utils'
@@ -43,7 +49,6 @@
 require 'splitclient-rb/split_factory_registry'
 
 require 'splitclient-rb/engine/api/faraday_middleware/gzip'
-require 'splitclient-rb/engine/api/faraday_adapter/patched_net_http_persistent'
 require 'splitclient-rb/engine/api/client'
 require 'splitclient-rb/engine/api/impressions'
 require 'splitclient-rb/engine/api/segments'
@@ -52,6 +57,7 @@
 require 'splitclient-rb/engine/api/telemetry_api'
 require 'splitclient-rb/engine/common/impressions_counter'
 require 'splitclient-rb/engine/common/impressions_manager'
+require 'splitclient-rb/engine/common/noop_impressions_counter'
 require 'splitclient-rb/engine/parser/condition'
 require 'splitclient-rb/engine/parser/partition'
 require 'splitclient-rb/engine/parser/evaluator'
@@ -79,6 +85,8 @@
 require 'splitclient-rb/engine/matchers/equal_to_matcher'
 require 'splitclient-rb/engine/matchers/matches_string_matcher'
 require 'splitclient-rb/engine/evaluator/splitter'
+require 'splitclient-rb/engine/impressions/noop_unique_keys_tracker'
+require 'splitclient-rb/engine/impressions/unique_keys_tracker'
 require 'splitclient-rb/engine/metrics/binary_search_latency_tracker'
 require 'splitclient-rb/engine/models/split'
 require 'splitclient-rb/engine/models/label'

lib/splitclient-rb/cache/fetchers/segment_fetcher.rb

@@ -30,16 +30,16 @@ def fetch_segments_if_not_exists(names, cache_control_headers = false)
               fetch_segment(name, fetch_options) if change_number == -1
             end
           end
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
         end
 
         def fetch_segment(name, fetch_options = { cache_control_headers: false, till: nil })
           @semaphore.synchronize do
             segments_api.fetch_segments_by_names([name], fetch_options)
           end
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
         end
 
         def fetch_segments
@@ -48,8 +48,8 @@ def fetch_segments
 
             true
           end
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
           false
         end
 

lib/splitclient-rb/cache/fetchers/split_fetcher.rb

@@ -36,8 +36,8 @@ def fetch_splits(fetch_options = { cache_control_headers: false, till: nil })
 
             { segment_names: data[:segment_names], success: true }
           end
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
           { segment_names: [], success: false }
         end
 

lib/splitclient-rb/cache/filter/bloom_filter.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'bitarray'
+
+module SplitIoClient
+  module Cache
+    module Filter
+      class BloomFilter
+        def initialize(capacity, false_positive_probability = 0.001)
+          @capacity = capacity.round
+          m = best_m(capacity, false_positive_probability)
+          @ba = BitArray.new(m.round)
+          @k = best_k(capacity)
+        end
+
+        def add(string)
+          return false if contains?(string)
+
+          positions = hashes(string)
+
+          positions.each { |position| @ba[position] = 1 }
+
+          true
+        end
+
+        def contains?(string)
+          !hashes(string).any? { |ea| @ba[ea] == 0 }
+        end
+
+        def clear
+          @ba.size.times { |i| @ba[i] = 0 }
+        end
+
+        private
+
+        # m is the required number of bits in the array
+        def best_m(capacity, false_positive_probability)
+          -(capacity * Math.log(false_positive_probability)) / (Math.log(2) ** 2)
+        end
+
+        # k is the number of hash functions that minimizes the probability of false positives
+        def best_k(capacity)
+          (Math.log(2) * (@ba.size / capacity)).round
+        end
+
+        def hashes(data)
+          m = @ba.size
+          h = Digest::MD5.hexdigest(data.to_s).to_i(16)
+          x = h % m
+          h /= m
+          y = h % m
+          h /= m
+          z = h % m
+          [x] + 1.upto(@k - 1).collect do |i|
+            x = (x + y) % m
+            y = (y + z) % m
+            x
+          end
+        end
+      end
+    end
+  end
+end

lib/splitclient-rb/cache/filter/filter_adapter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Cache
+    module Filter
+      class FilterAdapter
+        def initialize(config, filter)
+          @config = config
+          @filter = filter
+        end
+
+        def add(feature_name, key)
+          @filter.add("#{feature_name}#{key}")
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
+        end
+
+        def contains?(feature_name, key)
+          @filter.contains?("#{feature_name}#{key}")
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
+        end
+
+        def clear
+          @filter.clear
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
+        end
+      end
+    end
+  end
+end

lib/splitclient-rb/cache/observers/noop_impression_observer.rb

@@ -0,0 +1,10 @@
+module SplitIoClient
+  module Observers
+    class NoopImpressionObserver
+      def test_and_set(impression)
+        # no-op
+      end
+    end
+  end
+end
+

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

@@ -19,8 +19,8 @@ def add(key, traffic_type, event_type, time, value, properties, event_size)
             post_events if @size >= EVENTS_MAX_SIZE_BYTES || @adapter.length == @config.events_queue_size
 
             @telemetry_runtime_producer.record_events_stats(Telemetry::Domain::Constants::EVENTS_QUEUED, 1)
-          rescue StandardError => error
-            @config.log_found_exception(__method__.to_s, error)
+          rescue StandardError => e
+            @config.log_found_exception(__method__.to_s, e)
             @telemetry_runtime_producer.record_events_stats(Telemetry::Domain::Constants::EVENTS_DROPPED, 1)
           end
 

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

@@ -21,8 +21,8 @@ def initialize(config, api_key, telemetry_runtime_producer)
 
         def post_events
           events_api.post(self.clear)
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
         end
 
         protected

lib/splitclient-rb/cache/repositories/segments_repository.rb

@@ -78,8 +78,8 @@ def segment_keys_count
           end
 
           keys
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
+        rescue StandardError => e
+          @config.log_found_exception(__method__.to_s, e)
           0
         end