hot_tub 0.5.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af5ab22d571fb050b860aa00c6272f9d3e1ca564
-  data.tar.gz: 7aab55538f57d844feca8b389285d705707de8d3
+  metadata.gz: 74ee741ed84ebe1bfdc105cea7cd6ea36d110069
+  data.tar.gz: 213604cfc56cffe9fa593f4a4fe30bd139dafdcd
 SHA512:
-  metadata.gz: 62623f8ff72d0f9fa386e37aab4a023401be235f91478ed9e0e78f4d329787d05bf72baaf8670e5bba6a9a6203f7f2c52e3659bfcb97fe8e002fa6bd4dfae580
-  data.tar.gz: 8ca0674fa6a19f4bb228f083d968ee2067503dc513e4658753af06427c43a8da2b6ba095c6f71808daa596b07298b8d01cd94fb080be1ed5bfb160b92861e7f6
+  metadata.gz: 847dc6a4bd53ed60cddcd7103f341ec3b2f8e1c2fad9f380fd614ee7291cc850d0eb56fe44d8ad85e8f209f4566547fbd4b13225fadb9c8ba9f6159dbbd2056d
+  data.tar.gz: a82fd572a976426711af212b2d5123432883abadea80f75940097b44c1cc7755cefca6659f151c37fb569f5ec1a04fccb51143fc137aa34490b85ea418665e00

data/.travis.yml

@@ -2,9 +2,9 @@ sudo: false
 cache: bundler
 language: ruby
 rvm:
-  - 2.2
-  - 2.1
-  - 2.0.0
+  - 2.2.4
+  - 2.1.8
+  - 2.0.0-p648
   - ruby-head
   - rbx-2
   - jruby-head

data/HISTORY.md

@@ -3,7 +3,14 @@ HotTub Changelog
 
 Head
 =======
-- None yet
+- None yet.
+
+1.0.0
+=======
+- Allow setting a default client for HotTub::Sessions
+- Deprecate HotTub.new
+- Call pool.shutdown! when deleting a session
+- Add Sessions.stage to lazy load pools
 
 0.5.3
 =======

data/README.md

@@ -1,28 +1,6 @@
 # HotTub [![Build Status](https://travis-ci.org/JoshMcKin/hot_tub.png?branch=master)](https://travis-ci.org/JoshMcKin/hot_tub) [![Coverage Status](https://coveralls.io/repos/JoshMcKin/hot_tub/badge.png?branch=master)](https://coveralls.io/r/JoshMcKin/hot_tub)
 
-Flexible, thread-safe, connection pooling for Ruby. Configurable for any client you desire. Built in reaper th built in support for Net::HTTP and [Excon](https://github.com/excon/excon).
-
-## Features
-
-### HotTub::Pool
-
-* Thread safe
-* Lazy, pool starts off at 0 and grows as necessary.
-* Non-Blocking, can be configured to always return a connection if your pool runs out under load. Overflow connections are returned to the pool for reuse. Once load dies, the pool is reaped down to size.
-* Support for cleaning dirty resources, no one likes a dirty `HotTub`
-* Support for closing resources on shutdown
-* Support for process forking
-
-
-### HotTub::Sessions
-
-A synchronized hash where keys are mapped to a HotTub::Pools that are managed by a single HotTub::Reaper.
-
-
-### HotTub::Reaper
-
-A separate thread thats manages your pool(s). All HotTub::Pools managed by HotTub::Sessions share a single reaper. One-off HotTub::Pools have their own reaper. The reaper periodically checks pool(s) based on the `:reap_timeout` set for the pool or session. Over-flow connections or connections deemed reap-able ready are pulled from the pool and closed.
-
+Flexible, thread-safe, connection pooling for Ruby. Configurable for any client you desire with built in support for Net::HTTP and [Excon](https://github.com/excon/excon).
 
 ### Requirements
 
@@ -60,51 +38,66 @@ HotTub::Sessions are used to manage multiple pools with a single object and usin
 A global Sessions object is available from the HotTub module and has several helper methods.
   
     require 'hot_tub'
-    require 'net/http'
-    require 'excon'
-    require 'redis'
-
-    # Add a HotTub::Pool of Net::HTTP connections to our sessions with a size of 12.
-    # We are using the url as the key but could use anything.
-    # we are not setting :max_size so our connections will grow to match our currency.
-    # Once load dies down our pool will be reaped back down to 12 connections
-
-    URL = "https://google.com"
-    pool = HotTub.get_or_set(URL, { :size => 12 }) do 
-      uri = URI.parse(URL)
+
+    # Lets configure HotTub global sessions to use NetHTTP as our default client
+
+    HotTub.default_client = lambda { |url| 
+      uri = URI.parse(url)
       http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = false
       http.start
       http 
+    }
+
+    # Add a HotTub::Pool for "https://www.google.com" and use it.
+    HotTub.run("https://www.google.com") do |clnt|    
+      puts clnt.get('/').code
+    end
+
+    # Re-uses the previously defined pool
+    HotTub.run("https://www.google.com") do |clnt|    
+      puts clnt.get('/').code
     end
 
-    # A separate HotTub::Pool of Excon connections.
+    # Add another HotTub::Pool for "https://www.yahoo.com" and use it
+    HotTub.run("https://www.yahoo.com") do |clnt|    
+      puts clnt.get('/').code
+    end
 
-    HotTub.get_or_set('yahoo', { :size => 5 }) { Excon.new("https://yahoo.com") }
+    # We can add more HotTub::Pools with unique settings.
+    # Lets add another HotTub::Pool of Excon clients with a pool size of 12.
+    # HotTub.stage sets the options passed to a settings cache, the pool is
+    # created the first time we call HotTub.run. We are not setting :max_size 
+    # so our connections will grow to match our currency. Once load dies down 
+    # our pool will be reaped back down to 12 connections
+
+    HotTub.stage('excon_yahoo', { :size => 12} ) do
+     Excon.new("https://yahoo.com", :thread_safe_sockets => false )
+    end
 
     # Lets add Redis too. HotTub.add returns the pool created for that key so we
     # can store that in an constant for easy access.
     # We don't want too many connections so we set our :max_size. Under load our pool
     # can grow to 30 connections. Once load dies down our pool can be reaped back down to 5
 
-    REDIS = HotTub.get_or_set("redis", :size => 5, :max_size => 30) { Redis.new } 
+    REDIS = HotTub.add("redis", :size => 5, :max_size => 30) { Redis.new } 
       
-    # Now we can call any of our pools using the key we set any where in our code.
-
-    HotTub.run(url) do |clnt|    
-      puts clnt.head('/').code
-    end
+    # Now we can call any of our pools using the key we set.
 
-    HotTub.run('yahoo') do |clnt|    
-      puts clnt.get(:path => "/some_stuff", :query => {:foo => 'bar'}).body
+    HotTub.run('excon_yahoo') do |clnt|    
+      puts clnt.get.status
     end
 
-    # Since our REDIS contast was set to HotTub::Pool instance return from HotTub.add 
+    # Since our REDIS constant was set to HotTub::Pool instance return from HotTub.add 
     # we do not need the key when calling #run
     REDIS.run do |clnt|
       clnt.set('hot', 'stuff')
     end
 
+    # Re-use "https://www.google.com" we created earlier
+    HotTub.run("https://www.google.com") do |clnt|    
+      puts clnt.get('/').code
+    end
+
 
 ## Single Pool
     
@@ -123,22 +116,21 @@ A global Sessions object is available from the HotTub module and has several hel
 
 HotTub has built in support for closing NetHTTP and Excon. If you need more control or have 
 a different library you would like to use, HotTub can be configured to support your needs 
-using `:close`, `:clean`, and `:reap?` options in a pools settings.
+using `:close`, `:clean`, and `:reap?` options in a pools settings, and each option can accept
+a lambda that accepts the client as an argument or symbol representing a method to call on the client.
 
 `:close` is used to define how a connections should be closed at shutdown and upon reaping.
-reaped.
 
 `:clean` is called on each existing connection as its pulled from the pool.
 
 `:reap?` is used to determine if a connection in the pool is ready for reaping.
 
-EX:
     pool_options = {
       :size     => 5
       :max_size => 10
-      :close    => lambda { |clnt| clnt.close_it }, # could also use :close_id symbol instead of a lambda
+      :close    => :close
       :clean    => lambda { |clnt| clnt.reconnect if clnt.dirty? },
-      :reap?    => lambda { |clnt| clnt.stail? }
+      :reap?    => :stale? # returns truthy if we want to reap
     }
 
     HotTub.add('offBrand', pool_options) { MyCoolClient.new }

data/benchmarks/block_passing.rb

@@ -1,5 +1,5 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'benchmark'
+require 'benchmark/ips'
 
 puts `ruby -v`
 
@@ -29,68 +29,72 @@ class BlockTest
 end
 
 
-n = 1_000_000
-Benchmark.bmbm do |x|
+Benchmark.ips do |x|
   x.report("block yield") do
-    n.times do
-      BlockTest.block_yield { "foo" }
-    end
+    BlockTest.block_yield { "foo" }
   end
   x.report("block call") do
-    n.times do
-      BlockTest.block_call { "foo" }
-    end
+    BlockTest.block_call { "foo" }
   end
   x.report("block to yield") do
-    n.times do
-      BlockTest.block_to_yield { "foo" }
-    end
+    BlockTest.block_to_yield { "foo" }
   end
   x.report("block to call") do
-    n.times do
-      BlockTest.block_to_call { "foo" }
-    end
+    BlockTest.block_to_call { "foo" }
   end
+  x.compare!
 end
 
 # ruby 2.2.3p173 (2015-08-18 revision 51636) [x86_64-darwin14]
-# Rehearsal --------------------------------------------------
-# block yield      0.170000   0.000000   0.170000 (  0.169354)
-# block call       0.670000   0.010000   0.680000 (  0.670445)
-# block to yield   0.650000   0.000000   0.650000 (  0.645591)
-# block to call    0.750000   0.000000   0.750000 (  0.753102)
-# ----------------------------------------- total: 2.250000sec
-
-#                      user     system      total        real
-# block yield      0.170000   0.000000   0.170000 (  0.166196)
-# block call       0.670000   0.000000   0.670000 (  0.663034)
-# block to yield   0.640000   0.000000   0.640000 (  0.644746)
-# block to call    0.740000   0.000000   0.740000 (  0.747084)
+# Calculating -------------------------------------
+#          block yield   108.249k i/100ms
+#           block call    64.448k i/100ms
+#       block to yield    64.881k i/100ms
+#        block to call    60.643k i/100ms
+# -------------------------------------------------
+#          block yield      4.655M (± 3.2%) i/s -     23.274M
+#           block call      1.262M (± 3.2%) i/s -      6.316M
+#       block to yield      1.370M (± 3.8%) i/s -      6.877M
+#        block to call      1.174M (± 2.1%) i/s -      5.882M
+
+# Comparison:
+#          block yield:  4655424.9 i/s
+#       block to yield:  1369839.7 i/s - 3.40x slower
+#           block call:  1261742.0 i/s - 3.69x slower
+#        block to call:  1173741.8 i/s - 3.97x slower
 
 # rubinius 2.5.8 (2.1.0 bef51ae3 2015-07-14 3.5.1 JI) [x86_64-darwin14.4.0]
-# Rehearsal --------------------------------------------------
-# block yield      0.153971   0.007521   0.161492 (  0.123423)
-# block call       0.482452   0.001687   0.484139 (  0.404527)
-# block to yield   0.421112   0.001725   0.422837 (  0.317573)
-# block to call    0.515777   0.001130   0.516907 (  0.454804)
-# ----------------------------------------- total: 1.585375sec
-
-#                      user     system      total        real
-# block yield      0.054358   0.000111   0.054469 (  0.054250)
-# block call       0.368271   0.000868   0.369139 (  0.368516)
-# block to yield   0.281076   0.000553   0.281629 (  0.281446)
-# block to call    0.428372   0.000901   0.429273 (  0.428916)
+# Calculating -------------------------------------
+#          block yield   148.685k i/100ms
+#           block call   140.704k i/100ms
+#       block to yield   163.061k i/100ms
+#        block to call   126.667k i/100ms
+# -------------------------------------------------
+#          block yield      4.162M (± 3.0%) i/s -     20.816M
+#           block call      1.886M (± 2.8%) i/s -      9.427M
+#       block to yield      2.358M (± 2.1%) i/s -     11.903M
+#        block to call      1.678M (± 1.8%) i/s -      8.487M
+
+# Comparison:
+#          block yield:  4162250.5 i/s
+#       block to yield:  2357928.4 i/s - 1.77x slower
+#           block call:  1885832.8 i/s - 2.21x slower
+#        block to call:  1678439.6 i/s - 2.48x slower
 
 # jruby 9.0.3.0 (2.2.2) 2015-10-21 633c9aa Java HotSpot(TM) 64-Bit Server VM 23.5-b02 on 1.7.0_09-b05 +jit [darwin-x86_64]
-# Rehearsal --------------------------------------------------
-# block yield      0.400000   0.010000   0.410000 (  0.265343)
-# block call       0.370000   0.000000   0.370000 (  0.300598)
-# block to yield   0.280000   0.010000   0.290000 (  0.238879)
-# block to call    0.400000   0.000000   0.400000 (  0.288711)
-# ----------------------------------------- total: 1.470000sec
-
-#                      user     system      total        real
-# block yield      0.190000   0.000000   0.190000 (  0.185705)
-# block call       0.230000   0.000000   0.230000 (  0.227818)
-# block to yield   0.200000   0.000000   0.200000 (  0.206645)
-# block to call    0.250000   0.000000   0.250000 (  0.244579)
+# Calculating -------------------------------------
+#          block yield   109.774k i/100ms
+#           block call   114.963k i/100ms
+#       block to yield   125.225k i/100ms
+#        block to call   109.991k i/100ms
+# -------------------------------------------------
+#          block yield      4.998M (± 6.1%) i/s -     24.919M
+#           block call      3.980M (± 5.4%) i/s -     19.889M
+#       block to yield      4.532M (± 7.4%) i/s -     22.541M
+#        block to call      3.771M (± 4.7%) i/s -     18.808M
+
+# Comparison:
+#          block yield:  4997696.4 i/s
+#       block to yield:  4531931.2 i/s - 1.10x slower
+#           block call:  3979846.8 i/s - 1.26x slower
+#        block to call:  3771261.6 i/s - 1.33x slower

data/benchmarks/compare_concurrent.rb

@@ -0,0 +1,99 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'benchmark/ips'
+require 'hot_tub'
+require 'connection_pool'
+
+class MocClient;end
+
+puts `ruby -v`
+
+Benchmark.ips do |b|
+
+  ht_no_max = HotTub::Pool.new(:size => 5, :name => "Match Concurrency") { MocClient.new }
+  b.report("HotTub::Pool - *") do
+    threads = []
+    20.times do
+      threads << Thread.new do
+        ht_no_max.run { |conn| sleep(0.01)}
+      end
+    end
+    threads.each do |t|
+      t.join
+    end
+  end
+
+  ht_sized = HotTub::Pool.new(:size => 5, :max_size => 5, :name => "Limited") { MocClient.new }
+  b.report("HotTub::Pool - 5") do
+    threads = []
+    20.times do
+      threads << Thread.new do
+        ht_sized.run { |conn| sleep(0.01)}
+      end
+    end
+    threads.each do |t|
+      t.join
+    end
+  end
+
+  cp_t = ConnectionPool.new(:size => 5) { MocClient.new }
+  b.report("ConnectionPool - 5") do
+    threads = []
+    20.times do
+      threads << Thread.new do
+        cp_t.with { |conn| sleep(0.01)}
+      end
+    end
+    threads.each do |t|
+      t.join
+    end
+  end
+
+  b.compare!
+end
+
+# ruby 2.2.3p173 (2015-08-18 revision 51636) [x86_64-darwin14]
+# Calculating -------------------------------------
+#     HotTub::Pool - *     7.000  i/100ms
+#     HotTub::Pool - 5     2.000  i/100ms
+#   ConnectionPool - 5     2.000  i/100ms
+# -------------------------------------------------
+#     HotTub::Pool - *     80.183  (± 2.5%) i/s -    406.000 
+#     HotTub::Pool - 5     22.229  (± 0.0%) i/s -    112.000 
+#   ConnectionPool - 5     21.886  (± 0.0%) i/s -    110.000 
+
+# Comparison:
+#     HotTub::Pool - *:       80.2 i/s
+#     HotTub::Pool - 5:       22.2 i/s - 3.61x slower
+#   ConnectionPool - 5:       21.9 i/s - 3.66x slower
+
+
+# jruby 9.0.3.0 (2.2.2) 2015-10-21 633c9aa Java HotSpot(TM) 64-Bit Server VM 23.5-b02 on 1.7.0_09-b05 +jit [darwin-x86_64]
+# Calculating -------------------------------------
+#     HotTub::Pool - *     6.000  i/100ms
+#     HotTub::Pool - 5     2.000  i/100ms
+#   ConnectionPool - 5     2.000  i/100ms
+# -------------------------------------------------
+#     HotTub::Pool - *     69.232  (± 8.7%) i/s -    342.000 
+#     HotTub::Pool - 5     22.064  (± 4.5%) i/s -    112.000 
+#   ConnectionPool - 5     22.036  (± 0.0%) i/s -    112.000 
+
+# Comparison:
+#     HotTub::Pool - *:       69.2 i/s
+#     HotTub::Pool - 5:       22.1 i/s - 3.14x slower
+#   ConnectionPool - 5:       22.0 i/s - 3.14x slower
+
+
+# rubinius 2.5.8 (2.1.0 bef51ae3 2015-07-14 3.5.1 JI) [x86_64-darwin14.4.0]
+# Calculating -------------------------------------
+#     HotTub::Pool - *     8.000  i/100ms
+#     HotTub::Pool - 5     2.000  i/100ms
+#   ConnectionPool - 5     2.000  i/100ms
+# -------------------------------------------------
+#     HotTub::Pool - *     84.235  (± 3.6%) i/s -    424.000 
+#     HotTub::Pool - 5     22.255  (± 0.0%) i/s -    112.000 
+#   ConnectionPool - 5     22.259  (± 0.0%) i/s -    112.000 
+
+# Comparison:
+#     HotTub::Pool - *:       84.2 i/s
+#   ConnectionPool - 5:       22.3 i/s - 3.78x slower
+#     HotTub::Pool - 5:       22.3 i/s - 3.78x slower

data/benchmarks/compare_serial.rb

@@ -0,0 +1,60 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'benchmark/ips'
+require 'hot_tub'
+require 'connection_pool'
+
+class MocClient;end
+
+puts `ruby -v`
+
+Benchmark.ips do |b|
+
+  ht_1 = HotTub::Pool.new(:size => 1) { MocClient.new }
+  b.report("HotTub::Pool") do
+    ht_1.run { |conn| }
+  end
+
+  cp_1 = ConnectionPool.new(:size => 1) { MocClient.new }
+  b.report("ConnectionPool") do
+    cp_1.with { |conn| }
+  end
+  b.compare!
+end
+
+# ruby 2.2.3p173 (2015-08-18 revision 51636) [x86_64-darwin14]
+# Calculating -------------------------------------
+#         HotTub::Pool    26.909k i/100ms
+#       ConnectionPool    10.413k i/100ms
+# -------------------------------------------------
+#         HotTub::Pool    351.352k (± 1.9%) i/s -      1.776M
+#       ConnectionPool    122.342k (± 1.2%) i/s -    614.367k
+
+# Comparison:
+#         HotTub::Pool:   351352.4 i/s
+#       ConnectionPool:   122341.6 i/s - 2.87x slower
+
+
+# jruby 9.0.3.0 (2.2.2) 2015-10-21 633c9aa Java HotSpot(TM) 64-Bit Server VM 23.5-b02 on 1.7.0_09-b05 +jit [darwin-x86_64]
+# Calculating -------------------------------------
+#         HotTub::Pool    16.145k i/100ms
+#       ConnectionPool     6.260k i/100ms
+# -------------------------------------------------
+#         HotTub::Pool    304.280k (± 3.7%) i/s -      1.534M
+#       ConnectionPool    106.788k (± 2.6%) i/s -    538.360k
+
+# Comparison:
+#         HotTub::Pool:   304279.7 i/s
+#       ConnectionPool:   106788.5 i/s - 2.85x slower
+
+
+# rubinius 2.5.8 (2.1.0 bef51ae3 2015-07-14 3.5.1 JI) [x86_64-darwin14.4.0]
+# Calculating -------------------------------------
+#         HotTub::Pool    12.259k i/100ms
+#       ConnectionPool     8.771k i/100ms
+# -------------------------------------------------
+#         HotTub::Pool    415.132k (± 2.9%) i/s -      2.072M
+#       ConnectionPool    172.584k (± 1.7%) i/s -    868.329k
+
+# Comparison:
+#         HotTub::Pool:   415131.6 i/s
+#       ConnectionPool:   172584.0 i/s - 2.41x slower