splitclient-rb 3.1.2 → 3.1.3.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b06d31341d8cfe73c6aa77924fa2615553fe2f3
-  data.tar.gz: e64313db0fc86fc2d3e6720ed58bdff449667fa2
+  metadata.gz: cf6a979569b37d8f4fbdb3dd072199b1602c33b0
+  data.tar.gz: f21c0cb168466ae3ff5e7b2939d738e0ef0bf32b
 SHA512:
-  metadata.gz: e32c4fbd33aa6082660d2db98861ecca19c626f86353f41d831d75d25e3c1882d8f9162f729c37311ffcab8a01f32c6ff9b9e97d877eaf8df371a0bc45435455
-  data.tar.gz: a8bd683be8b74302270344c2f5fdff93179b93247f522549dc465fcc3b5513c95eb6f26b9f4500735982b4c5527c9f3727434e87bda5f2e0280163dcdf72008f
+  metadata.gz: e06b3667ff3ec8e06d5abaf20bb25a128f01b9b9a1c784bbb1ab720b35e3d911cbbe132702b9789a6d77793612d966b67df0e2caa0d60fc236341a8ec475ff53
+  data.tar.gz: 97f58dabae2e49fed331bb0d8db5d305ca873a5737e5c6efefc31c63b1bb9e5945f93b168708a0f50922810130875429ca56fe9f18dcb1e21756f2389f5ea8a9

data/CHANGES.txt

@@ -1,3 +1,10 @@
+3.1.4
+- Allow to store block until ready flag in Redis
+
+3.1.3
+- Refactor SplitFactory - split it into separate mangers and client classes
+- Refactor Utilities to comply style guide
+
 3.1.2
 - Fix issue with complex key where get_treatment and get_treatments return different values.
 

data/Detailed-README.md

@@ -76,13 +76,18 @@ new-navigation v3
 To use SDK in the localhost mode you should pass `localhost` as an API key like this:
 
 ```ruby
-factory  = SplitIoClient::SplitFactoryBuilder.build('localhost', path: '/where/to-look-for/<file_name>')
+factory = SplitIoClient::SplitFactoryBuilder.build('localhost', path: '/where/to-look-for/<file_name>')
 split_client = factory.client
 ```
 
-By default SDK will look in your home directory (i.e. `~`) for a `.split` file, but you can specify a different 
+By default SDK will look in your home directory (i.e. `~`) for a `.split` file, but you can specify a different
 file name (full path) to look for the file (note: you must provide absolute path):
 
+When in localhost mode you can make use of the SDK ability to automatically refresh splits from file, to do that just specify reload rate in seconds like this:
+
+```ruby
+factory = SplitIoClient::SplitFactoryBuilder.build('localhost', path: '/where/to-look-for/<file_name>', reload_rate: 3)
+```
 
 ### Ruby on Rails
 ---
@@ -327,6 +332,7 @@ SDK can be ran in `producer` mode both in the scope of the application (e.g. as
 :redis_url: 'redis://127.0.0.1:6379/0'
 ```
 
+
 - Install binstubs
 ```ruby
 bundle binstubs splitclient-rb
@@ -337,7 +343,15 @@ bundle binstubs splitclient-rb
 bundle exec bin/splitio -c ~/path/to/config/file.yml
 ```
 
-That's it!
+Also, you can pass options directly to the cli command, like this:
+```
+bundle exec bin/splitio -c ~/path/to/config/file.yml --debug
+```
+
+Note: options passed through cli have higher priority than those specified in the configuration file. To see the full list of supported options you can run:
+```
+bundle exec bin/splitio -h
+```
 
 ## Development
 
@@ -349,10 +363,11 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 The gem uses rspec for unit testing. Under the default `/spec` folder you will find the files for the unit tests and the specs helper file ( spec_helper.rb ). If a new spec file with new unit tests is required you just simply need to create it under the spec folder and all its test will be executed on the next rspec execution.
 
-To run the suite of unit tests a rake task is provided. It's executed with the following command:
+To run the suite of unit tests a rake task is provided.
 
+Make sure redis is running in localhost at redis://127.0.0.1:6379/0 and then just run:
 ```bash
-  $ rake spec
+  SPLITCLIENT_ENV=test bundle exec rspecrake spec
 ```
 
 Also, simplecov is used for coverage reporting. After the execution of the rake task it will create the `/coverage` folder with coverage reports in pretty HTML format.

data/exe/splitio

@@ -9,12 +9,61 @@ require_relative '../lib/splitclient-rb'
 
 ARGV << '-h' if ARGV.empty?
 
+config_path = ''
 options = {}
 opt_parser = OptionParser.new do |opts|
   opts.banner = "Usage: splitio [options]"
 
   opts.on("-cPATH", "--config=PATH", "Set the path to splitio.yml config file") do |c|
-    options[:config_path] = c
+    config_path = c
+  end
+
+  opts.on("--base-uri=BASE_URI", "Set the base uri for Split SDK") do |c|
+    options[:base_uri] = c
+  end
+
+  opts.on("--events-uri=EVENTS_URI", "Set the events uri for Split SDK") do |c|
+    options[:events_uri] = c
+  end
+
+  opts.on("--read-timeout=READ_TIMEOUT", "Read timeout in seconds") do |c|
+    options[:read_timeout] = c
+  end
+
+  opts.on("--connection-timeout=CONNECTION_TIMEOUT", "Connection timeout in seconds") do |c|
+    options[:connection_timeout] = c
+  end
+
+  opts.on("--features-refresh-rate=FEATURES_REFRESH_RATE", "Features refresh rate in seconds") do |c|
+    options[:features_refresh_rate] = c
+  end
+
+  opts.on("--segments-refresh-rate=SEGMENTS_REFRESH_RATE", "Segments refresh rate in seconds") do |c|
+    options[:segments_refresh_rate] = c
+  end
+
+  opts.on("--metrics-refresh-rate=METRICS_REFRESH_RATE", "Metrics refresh rate in seconds") do |c|
+    options[:metrics_refresh_rate] = c
+  end
+
+  opts.on("--impressions-refresh-rate=IMPRESSIONS_REFRESH_RATE", "Impressions refresh rate in seconds") do |c|
+    options[:impressions_refresh_rate] = c
+  end
+
+  opts.on("--block-until-ready=SECONDS", "Seconds to block the app until SDK is ready or false to run in non-blocking mode") do |c|
+    options[:block_until_ready] = c
+  end
+
+  opts.on("--redis-url=REDIS_URL", "Set base uri for Split SDK") do |c|
+    options[:redis_url] = c
+  end
+
+  opts.on("--transport-debug", "Enable transport debug") do
+    options[:transport_debug_enabled] = true
+  end
+
+  opts.on("-d", "--debug", "Enable debug mode") do
+    options[:debug_enabled] = true
   end
 
   opts.on_tail("-h", "--help", "Prints this help") do
@@ -31,7 +80,9 @@ begin
    exit(1)
  end
 
-config = YAML.load_file(options[:config_path])
-config.merge!(mode: :producer, cache_adapter: :redis)
+config = YAML.load_file(config_path)
+config
+  .merge!(mode: :producer, cache_adapter: :redis)
+  .merge!(options)
 
 SplitIoClient::SplitFactory.new(config[:api_key], config)

data/lib/cache/adapters/memory_adapters/map_adapter.rb

@@ -116,6 +116,12 @@ module SplitIoClient
               @map.delete(key)
             end
           end
+
+          # This method is used in Redis adapter
+          # "stubbing" it here to keep the interface
+          def pipelined(&block)
+            block.call
+          end
         end
       end
     end

data/lib/cache/adapters/redis_adapter.rb

@@ -1,4 +1,3 @@
-require 'redis'
 require 'json'
 
 module SplitIoClient
@@ -121,6 +120,12 @@ module SplitIoClient
         def inc(key, inc = 1)
           @redis.incrby(key, inc)
         end
+
+        def pipelined(&block)
+          @redis.pipelined do
+            block.call
+          end
+        end
       end
     end
   end

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

@@ -18,9 +18,15 @@ module SplitIoClient
             end
           end
 
-          def add_bulk(key, treatments, time)
+          def add_bulk(key, bucketing_key, treatments, time)
             treatments.each do |split_name, treatment|
-              add(split_name, 'key_name' => key, 'treatment' => treatment, 'time' => time)
+              add(
+                split_name,
+                'key_name' => key,
+                'bucketing_key' => bucketing_key,
+                'treatment' => treatment,
+                'time' => time
+              )
             end
           end
 

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

@@ -17,11 +17,11 @@ module SplitIoClient
             )
           end
 
-          def add_bulk(key, treatments, time)
+          def add_bulk(key, bucketing_key, treatments, time)
             @adapter.redis.pipelined do
               treatments.each_slice(IMPRESSIONS_SLICE) do |treatments_slice|
                 treatments_slice.each do |split_name, treatment|
-                  add(split_name, 'key_name' => key, 'treatment' => treatment, 'time' => time)
+                  add(split_name, 'key_name' => key, 'bucketing_key' => bucketing_key, 'treatment' => treatment, 'time' => time)
                 end
               end
             end

data/lib/cache/repositories/impressions_repository.rb

@@ -1,3 +1,5 @@
+require 'forwardable'
+
 module SplitIoClient
   module Cache
     module Repositories
@@ -7,6 +9,7 @@ module SplitIoClient
         def_delegators :@adapter, :add, :add_bulk, :clear, :empty?
 
         def initialize(adapter, config)
+          @config = config
           @adapter = case adapter.class.to_s
           when 'SplitIoClient::Cache::Adapters::MemoryAdapter'
             Repositories::Impressions::MemoryRepository.new(adapter, config)

data/lib/cache/repositories/metrics_repository.rb

@@ -8,6 +8,7 @@ module SplitIoClient
                        :clear_counts, :clear_latencies, :clear_gauges
 
         def initialize(adapter, config)
+          @config = config
           @adapter = case adapter.class.to_s
           when 'SplitIoClient::Cache::Adapters::MemoryAdapter'
             Repositories::Metrics::MemoryRepository.new(adapter, config)

data/lib/cache/repositories/repository.rb

@@ -12,7 +12,7 @@ module SplitIoClient
       protected
 
       def namespace_key(key)
-        "SPLITIO.#{key}"
+        "#{@config.redis_namespace}/#{key}"
       end
     end
   end

data/lib/cache/repositories/segments_repository.rb

@@ -4,8 +4,11 @@ module SplitIoClient
       class SegmentsRepository < Repository
         KEYS_SLICE = 3000
 
-        def initialize(adapter)
+        attr_reader :adapter
+
+        def initialize(adapter, config)
           @adapter = adapter
+          @config = config
 
           @adapter.set_bool(namespace_key('ready'), false)
         end
@@ -40,6 +43,18 @@ module SplitIoClient
           @adapter.string(namespace_key("segment.#{name}.till")) || -1
         end
 
+        def ready?
+          @adapter.string(namespace_key('cache.ready.segments')).to_i != -1
+        end
+
+        def not_ready!
+          @adapter.set_string(namespace_key('cache.ready.segments'), -1)
+        end
+
+        def ready!
+          @adapter.set_string(namespace_key('cache.ready.segments'), Time.now.utc.to_i)
+        end
+
         private
 
         def segment_data(name)

data/lib/cache/repositories/splits_repository.rb

@@ -6,10 +6,13 @@ module SplitIoClient
       class SplitsRepository < Repository
         SPLITS_SLICE = 10
 
-        def initialize(adapter)
+        attr_reader :adapter
+
+        def initialize(adapter, config)
           @adapter = adapter
+          @config = config
 
-          @adapter.set_string(namespace_key('split.till'), '-1')
+          @adapter.set_string(namespace_key('splits.till'), '-1')
           @adapter.initialize_map(namespace_key('segments.registered'))
         end
 
@@ -54,19 +57,18 @@ module SplitIoClient
           splits_hash
         end
 
-        # Return an array of Split Names excluding control keys like split.till
+        # Return an array of Split Names excluding control keys like splits.till
         def split_names
-          @adapter.find_strings_by_prefix(namespace_key('split'))
-            .reject { |split| split == namespace_key('split.till') }
+          @adapter.find_strings_by_prefix(namespace_key('split.'))
             .map { |split| split.gsub(namespace_key('split.'), '') }
         end
 
         def set_change_number(since)
-          @adapter.set_string(namespace_key('split.till'), since)
+          @adapter.set_string(namespace_key('splits.till'), since)
         end
 
         def get_change_number
-          @adapter.string(namespace_key('split.till'))
+          @adapter.string(namespace_key('splits.till'))
         end
 
         def set_segment_names(names)
@@ -80,6 +82,18 @@ module SplitIoClient
         def exists?(name)
           @adapter.exists?(namespace_key("split.#{name}"))
         end
+
+        def ready?
+          @adapter.string(namespace_key('cache.ready.splits')).to_i != -1
+        end
+
+        def not_ready!
+          @adapter.set_string(namespace_key('cache.ready.splits'), -1)
+        end
+
+        def ready!
+          @adapter.set_string(namespace_key('cache.ready.splits'), Time.now.utc.to_i)
+        end
       end
     end
   end

data/lib/cache/senders/impressions_sender.rb

@@ -18,13 +18,11 @@ module SplitIoClient
           if ENV['SPLITCLIENT_ENV'] == 'test'
             post_impressions
           else
-            Thread.new do
-              @config.logger.info('Starting impressions service')
+            impressions_thread
 
-              loop do
-                post_impressions
-
-                sleep(randomize_interval(@config.impressions_refresh_rate))
+            if defined?(PhusionPassenger)
+              PhusionPassenger.on_event(:starting_worker_process) do |forked|
+                impressions_thread if forked
               end
             end
           end
@@ -32,6 +30,18 @@ module SplitIoClient
 
         private
 
+        def impressions_thread
+          Thread.new do
+            @config.logger.info('Starting impressions service')
+
+            loop do
+              post_impressions
+
+              sleep(::Utilities.randomize_interval(@config.impressions_refresh_rate))
+            end
+          end
+        end
+
         def post_impressions
           impressions_client.post
         rescue StandardError => error
@@ -45,12 +55,6 @@ module SplitIoClient
         def impressions_client
           SplitIoClient::Api::Impressions.new(@api_key, @config, formatted_impressions)
         end
-
-        def randomize_interval(interval)
-          @random_generator ||=  Random.new
-          random_factor = @random_generator.rand(50..100)/100.0
-          interval * random_factor
-        end
       end
     end
   end

data/lib/cache/senders/metrics_sender.rb

@@ -0,0 +1,41 @@
+module SplitIoClient
+  module Cache
+    module Senders
+      class MetricsSender
+        def initialize(metrics_repository, config, api_key)
+          @metrics_repository = metrics_repository
+          @config = config
+          @api_key = api_key
+        end
+
+        def call
+          return if ENV['SPLITCLIENT_ENV'] == 'test'
+
+          post_metrics
+          
+          Thread.new do
+            @config.logger.info('Starting metrics service')
+
+            loop do
+              post_metrics
+
+              sleep(::Utilities.randomize_interval(@config.metrics_refresh_rate))
+            end
+          end
+        end
+
+        private
+
+        def post_metrics
+          metrics_client.post
+        rescue StandardError => error
+          @config.log_found_exception(__method__.to_s, error)
+        end
+
+        def metrics_client
+          SplitIoClient::Api::Metrics.new(@api_key, @config, @metrics_repository)
+        end
+      end
+    end
+  end
+end

data/lib/cache/stores/sdk_blocker.rb

@@ -5,29 +5,30 @@ module SplitIoClient
   module Cache
     module Stores
       class SDKBlocker
-        attr_reader :splits_ready
+        attr_reader :splits_repository
         attr_writer :splits_thread, :segments_thread
 
-        def initialize(config)
+        def initialize(config, splits_repository, segments_repository)
           @config = config
+          @splits_repository = splits_repository
+          @segments_repository = segments_repository
 
-          @splits_ready = false
-          @segments_ready = false
+          @splits_repository.not_ready!
+          @segments_repository.not_ready!
         end
 
         def splits_ready!
-          @splits_ready = true
+          @splits_repository.ready!
         end
 
         def segments_ready!
-          @segments_ready = true
+          @segments_repository.ready!
         end
 
         def block
           begin
             Timeout::timeout(@config.block_until_ready) do
               sleep 0.1 until ready?
-              sleep 0.1 until ready?
             end
           rescue Timeout::Error
             fail SDKBlockerTimeoutExpiredException, 'SDK start up timeout expired'
@@ -39,7 +40,7 @@ module SplitIoClient
         end
 
         def ready?
-          @splits_ready && @segments_ready
+          @splits_repository.ready? && @segments_repository.ready?
         end
       end
     end