upperkut 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4710b6cb7fe25d82ec581c0500b37a02abfc22edf75f7b25a57c7b67c111e347
-  data.tar.gz: 6a07d95e388588def062c04d229546a98396afb16ab7d929418d921ff54f50ce
+  metadata.gz: 01ee5c00ec69139f31e74694a53163296cea3e8ee0b483f678a322d965bc76e1
+  data.tar.gz: df6c73408d00851951d85b5464f7ba689dcf7adc5551ce3cea3762188dd33256
 SHA512:
-  metadata.gz: e8c47b5c1fefbaaa0b22539eda6f0c7add81dbc484593d93fa999548ea161736f8af7fa81d3905523c3376213ebe4bb40e7b36220eb10a0b2b30dfcfb9204ef9
-  data.tar.gz: 1755c8d9b63b21f4baf735843c21431ad86d378408e2b938591a3344e68a2db3e246d30331b7031309367e187ea20a74244c08d97a0eebe3c60b46b39a306e19
+  metadata.gz: '08bfd143bd18e122c704b44724e81c68e80f4d247611fc52ecc119ff96a4ae3a6fa3ffd03aa04582b2b4ca0e89b98fc91f56a418ed0daf5326e538cafdfac76e'
+  data.tar.gz: 44baf1f326ec0993fa7ff7288dbdc680bcb57189f187a7de7c850b606fae90a0f33584a37499d0cd0a81f03626023ae5169702b1edd5fda1a0a436942c59a524

data/CHANGELOG.md

@@ -1,8 +1,15 @@
 # Upperkut changes
 
+0.6.x
+---------
+- Set redis url when env var REDIS_URL is set thanks to @lucaskds #22
+- Enable users to pass their own connection pool also thanks to @lucaskds #21
+- Sets default concurrency to 1
+- Creates connection pools by default;
+- Simplifies API to enable extension via Strategy;
+
 0.5.x
 ----------
-
 - Introducing client middlewares.
 - Fix issue that prevented worker to run.
 - Fix thread-unsafe code that was overwriting worker configurations when

data/Gemfile.lock

@@ -1,13 +1,15 @@
 PATH
   remote: .
   specs:
-    upperkut (0.5.2)
+    upperkut (0.6.0)
+      connection_pool (~> 2.2, >= 2.2.2)
       redis (>= 3.3.3, < 5)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.2)
+    connection_pool (2.2.2)
     diff-lcs (1.3)
     docile (1.3.1)
     fakeredis (0.7.0)

data/README.md

@@ -34,8 +34,7 @@ Examples:
 
     setup_upperkut do |config|
       # Define which redis instance you want to use
-      redis = Redis.new(url: ENV['ANOTHER_REDIS_INSTANCE_URL'])
-      config.strategy = Upperkut::Strategy.new(self, redis)
+      config.strategy = Upperkut::Strategy.new(self, redis: { url: ENV['ANOTHER_REDIS_INSTANCE_URL']) })
 
       # Define the amount of items must be accumulated
       config.batch_size = 2_000 # The default value is 1_000

data/lib/upperkut.rb

@@ -15,7 +15,10 @@ require 'redis'
 #
 #     setup_upperkut do |config|
 #       # Define which redis instance you want to use
-#       config.redis = Redis.new(url: ENV['ANOTHER_REDIS_INSTANCE_URL'])
+#       config.strategy = Upperkut::Strategy.new(
+#         self,
+#         redis: { url: ENV['ANOTHER_REDIS_URL'] }
+#       )
 #
 #       # Define the amount of items must be accumulated
 #       config.batch_size = 2_000 # The default value is 1_000

data/lib/upperkut/manager.rb

@@ -9,7 +9,7 @@ module Upperkut
 
     def initialize(opts = {})
       self.worker = opts.fetch(:worker).constantize
-      @concurrency = opts.fetch(:concurrency, 25)
+      @concurrency = opts.fetch(:concurrency, 1)
       @logger = opts.fetch(:logger, Upperkut::Logging.logger)
 
       @stopped = false

data/lib/upperkut/redis_pool.rb

@@ -0,0 +1,30 @@
+require 'connection_pool'
+require 'redis'
+
+module Upperkut
+  class RedisPool
+
+    DEFAULT_OPTIONS = {
+      pool_timeout:     1,    # pool related option
+      size:             2,    # pool related option
+      connect_timeout:  0.2,
+      read_timeout:     5.0,
+      write_timeout:    0.5,
+      url:              ENV['REDIS_URL'],
+    }.freeze
+
+    def initialize(options)
+      @options      = DEFAULT_OPTIONS.merge(options)
+
+      # Extract pool related options
+      @size         = @options.delete(:size)
+      @pool_timeout = @options.delete(:pool_timeout)
+    end
+
+    def create
+      ConnectionPool.new(:timeout => @pool_timeout, :size => @size) do
+        Redis.new(@options)
+      end
+    end
+  end
+end

data/lib/upperkut/strategy.rb

@@ -1,28 +1,33 @@
 require_relative 'util'
+require_relative 'redis_pool'
 
 module Upperkut
   class Strategy
     include Upperkut::Util
 
-    attr_accessor :worker, :redis
+    attr_reader :options
 
-    def initialize(worker, redis = Redis.new)
-      self.worker = worker
-      self.redis  = redis
+    def initialize(worker, options = {})
+      @options    = options
+      @redis_options = options.fetch(:redis, {})
+      @redis_pool = setup_redis_pool
+      @worker     = worker
     end
 
     def push_items(items = [])
       items = [items] if items.is_a?(Hash)
       return false if items.empty?
-      redis.rpush(key, encode_json_items(items))
+      redis do |conn|
+        conn.rpush(key, encode_json_items(items))
+      end
     end
 
     def fetch_items(batch_size = 1000)
       stop = [batch_size, size].min
 
-      items = redis.multi do
-        stop.times do
-          redis.lpop(key)
+      items = redis do |conn|
+        conn.multi do
+          stop.times { conn.lpop(key) }
         end
       end
 
@@ -30,11 +35,13 @@ module Upperkut
     end
 
     def size
-      redis.llen(key)
+      redis do |conn|
+        conn.llen(key)
+      end
     end
 
     def latency
-      item = redis.lrange(key, 0, 0)
+      item = redis { |conn| conn.lrange(key, 0, 0) }
       item = decode_json_items(item).first
       return 0 unless item
       now = Time.now.to_f
@@ -42,13 +49,25 @@ module Upperkut
     end
 
     def clear
-      redis.del(key)
+      redis { |conn| conn.del(key) }
     end
 
     private
 
+    def setup_redis_pool
+      return @redis_options if @redis_options.is_a?(ConnectionPool)
+      RedisPool.new(options.fetch(:redis, {})).create
+    end
+
+    def redis
+      raise ArgumentError, "requires a block" unless block_given?
+      @redis_pool.with do |conn|
+        yield conn
+      end
+    end
+
     def key
-      "upperkut:buffers:#{to_underscore(worker.name)}"
+      "upperkut:buffers:#{to_underscore(@worker.name)}"
     end
   end
 end

data/lib/upperkut/version.rb

@@ -1,3 +1,3 @@
 module Upperkut
-  VERSION = '0.5.2'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/lib/upperkut/worker.rb

@@ -14,7 +14,7 @@ module Upperkut
       extend Forwardable
 
       def_delegators :setup, :strategy, :server_middlewares, :client_middlewares
-      def_delegators :strategy, :push_items, :size, :latency, :clear, :redis
+      def_delegators :strategy, :push_items, :size, :latency, :clear
 
       def push_items(items)
         client_middlewares.invoke(self, items) do

data/upperkut.gemspec

@@ -22,7 +22,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.2.2'
 
-  spec.add_dependency 'redis', '>= 3.3.3', '< 5'
+  spec.add_dependency 'redis',           '>= 3.3.3', '< 5'
+  spec.add_dependency 'connection_pool', '~> 2.2', '>= 2.2.2'
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upperkut
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Nando Sousa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-30 00:00:00.000000000 Z
+date: 2018-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -30,6 +30,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +123,7 @@ files:
 - lib/upperkut/middlewares/new_relic.rb
 - lib/upperkut/middlewares/rollbar.rb
 - lib/upperkut/processor.rb
+- lib/upperkut/redis_pool.rb
 - lib/upperkut/strategy.rb
 - lib/upperkut/util.rb
 - lib/upperkut/version.rb