activerecord-bogacs 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d7d0cf56d16097d5faadc25e31228e1e6b6a1040703aa0fed0fd29a49d23622
-  data.tar.gz: 7f00210ced14e5963220980fd749d0c8765d7555deab200c508daa44ca0770c7
+  metadata.gz: a11630875cf14ee4c1ea37721a04a1966eeb488874d23c833075e42c2e435852
+  data.tar.gz: 77016cc2628013c4a1791403fcbf65ad488f8db4f6a091a9659e1e0b523c7e38
 SHA512:
-  metadata.gz: ebc49df8d9f33381b3134b4dec5b5765abb06bb69b353f21ce695e9f0c4869f9ef36ad4005d6a716d2f73bebfe986158cfc237dd477f6247594a57337adb7bef
-  data.tar.gz: adc08a3fd5b9c6a2dde6daf9e75433c29fc7faf6c6832cd90e1fb8cf7f2be8a3df1e054486c13c22e8d5be1d4e3df74f4a42e27453d145b84a086e17f30efae4
+  metadata.gz: 89a482ca85813ef8b769355a0a42ffe0317024022c0da7ad337084029ad455976865199806b6f79fbd0b79c1288ec7f6a1654ec9aea66ec07b544b28329f5dcc
+  data.tar.gz: 624c0fe63b5ff31ef51abeb2dd537fe3ef2bddad81f03cd94df38fb7aafea3b93635a844554bb7597ec08fc551215c016e1c1ebcb3817230220455919db1ade3

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2017 [Karol Bucek](http://kares.org)
+Copyright (c) 2013-2018 [Karol Bucek](http://kares.org)
 
 MIT License
 

data/README.md

@@ -6,7 +6,7 @@ ActiveRecord (all-year) pooling "alternatives" ... in a relaxed 'spa' fashion.
 
 Bogács is a village in Borsod-Abaúj-Zemplén county, Hungary.
 
-**WiP: do not put this on production if you do not understand the consequences!**
+**NOTE: do not put this on production if you do not understand the consequences!**
 
 ## Install
 
@@ -22,8 +22,8 @@ add this line to your application's *Gemfile*:
 
 Bogacs' pools rely on a small monkey-patch that allows to change the AR pool.
 The desired pool class needs to be set before `establish_connection` happens,
-thus an initializer won't work, you might consider setting the pool class at
-the bottom of your *application.rb* e.g. :
+thus an initializer (under Rails) won't work, you might consider setting the 
+pool class at the bottom of your *application.rb* e.g. :
 
 ```ruby
 Bundler.require(*Rails.groups)
@@ -34,19 +34,39 @@ module MyApp
   end
 end
 
-# sample AR-Bogacs setup using the "false" pool :
+# sample AR-Bogacs setup using the "default" pool :
 if Rails.env.production?
-  pool_class = ActiveRecord::Bogacs::FalsePool
+  pool_class = ActiveRecord::Bogacs::DefaultPool
   ActiveRecord::ConnectionAdapters::ConnectionHandler.connection_pool_class = pool_class
 end
 ```
 
-pools are expected to work with older ActiveRecord versions, if not let us know.
+Alternatively, for `FalsePool`, there's a configuration convention (no need to path 
+and set the connection_pool_class) :
+```yaml
+production:
+  adapter: mysql2
+  <% if $servlet_context %>
+  jndi: java:comp/env/jdbc/mydb
+  pool: false # use AR::Bogacs::FalsePool
+  <% else %>
+  port: <%= ENV['DATABASE_PORT'] || 3306 %>
+  database: mydb
+  # ...
+  <% end %>
+```
+
+This works only as long as one doesn't set a custom connection handler, since 
+*Bogacs* only sets up its custom `ActiveRecord::Base.default_connection_handler`.
+
+Pools are expected to work with older ActiveRecord versions: 3.x as well as 4.x.
 
 ### [Default Pool][2]
 
-Meant as a back-port for users stuck with old Rails versions (< 4.0) on production,
-facing potential (pool related) concurrency bugs e.g. with high-loads under JRuby.
+Meant, primarily, as a back-port for users stuck with old Rails versions (< 4.0) 
+on production, facing potential (pool related) concurrency bugs e.g. with highly 
+concurrent loads under JRuby, although it also enhances some of the thread locking
+issues present in 4.x's pool. 
 
 Based on pool code from 4.x (which works much better than any previous version),
 with a few minor tunings and extensions such as `pool_initial: 0.5` which allows
@@ -56,7 +76,7 @@ to specify how many connections to initialize in advance when the pool is create
 
 The false pool won't do any actual pooling, it is assumed that an underlying pool
 is configured. Still, it does maintain a hash of AR connections mapped to threads.
-Ignores pool related configurations such as `pool: 42` or `checkout_timeout: 2.5`.
+Ignores pool related configuration such as `pool: 42` or `checkout_timeout: 2.5`.
 
 **NOTE:** be sure to configure an underlying pool e.g. with Trinidad (using the
 default Tomcat JDBC pool) :
@@ -70,7 +90,7 @@ default Tomcat JDBC pool) :
     mysql_dbpool:
       url: jdbc:mysql:///my_production
       username: root
-      jndi: jdbc/BogacsDB
+      jndi: jdbc/MyDB
       initialSize: <%= ENV['POOL_INITIAL'] || 25 %> # connections created on start
       maxActive: <%= ENV['POOL_SIZE'] || 100 %> # default 100 (AR pool: size)
       maxIdle: <%= ENV['POOL_SIZE'] || 100 %> # max connections kept in the pool
@@ -88,7 +108,7 @@ following configuration :
 ```
 production:
   adapter: mysql2
-  jndi: java:/comp/env/jdbc/BogacsDB
+  jndi: java:/comp/env/jdbc/MyDB
 ```
 
 **NOTE:** when using `FalsePool` there's nothing to configure (in *database.yml*)!
@@ -97,7 +117,7 @@ production:
 
 This pool allows for a database connection to be "shared" among threads, this is
 very **dangerous** normally. You will need to understand the underlying driver's
-connection whether it is thread-safe.
+connection implementation (whether its thread-safe).
 
 You'll need to manually declare blocks that run with a shared connection (**make
 sure** only read operations happen within such blocks) similar to the built-in
@@ -109,15 +129,15 @@ cache_fetch( [ 'user', user_id ] ) do
 end
 ```
 
-The pool will only share connections among such blocks and only if it runs out
-of all connections (until than it will always prefer checking out a connection
-just like a "regular" pool).
+The pool "might" share connections among such blocks but only if it runs out of 
+all connections (pool size is reached), until than it will always prefer checking 
+out a connection just like `with_connection` does.
 
-Only tested with ActiveRecord-JDBC-Adapter using the official Postgres' driver.
+Tested with ActiveRecord-JDBC-Adapter using the official Postgres' driver (< 42).
 
 ## Copyright
 
-Copyright (c) 2017 [Karol Bucek](http://kares.org).
+Copyright (c) 2018 [Karol Bucek](http://kares.org).
 See LICENSE (http://en.wikipedia.org/wiki/MIT_License) for details.
 
 [0]: http://res.cloudinary.com/kares/image/upload/c_scale,h_600,w_800/v1406451696/bogacs.jpg

data/lib/active_record/bogacs.rb

@@ -1,6 +1,10 @@
-require 'active_record'
 
 require 'active_record/bogacs/version'
 require 'active_record/bogacs/autoload'
 
-require 'active_record/connection_adapters/pool_class.rb'
+if defined?(Rails::Railtie)
+  require 'active_record/bogacs/railtie'
+else
+  require 'active_record'
+  require 'active_record/connection_adapters/pool_class'
+end

data/lib/active_record/bogacs/connection_handler.rb

@@ -0,0 +1,36 @@
+require 'active_record/version'
+
+require 'active_record/connection_adapters/abstract/connection_pool'
+
+module ActiveRecord
+  module Bogacs
+    class ConnectionHandler < ConnectionAdapters::ConnectionHandler
+
+      if ActiveRecord::VERSION::MAJOR < 5
+
+        def establish_connection(owner, spec)
+          @class_to_pool.clear
+          if spec.config[:pool].eql? false
+            owner_to_pool[owner.name] = ActiveRecord::Bogacs::FalsePool.new(spec)
+          else # super
+            owner_to_pool[owner.name] = ActiveRecord::ConnectionAdapters::ConnectionPool.new(spec)
+          end
+        end
+
+      else
+
+        def establish_connection(config) # (spec) in 5.0
+          pool = super
+          spec = pool.spec
+          if spec.config[:pool].eql? false
+            owner_to_pool[owner.name] = ActiveRecord::Bogacs::FalsePool.new(spec)
+          else
+            pool
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/active_record/bogacs/railtie.rb

@@ -0,0 +1,17 @@
+module ActiveRecord
+  module Bogacs
+    class Railtie < Rails::Railtie
+
+      initializer 'active_record.bogacs', :before => 'active_record.initialize_database' do |_|
+        ActiveSupport.on_load :active_record do
+          require 'active_record/bogacs'
+
+          # support for auto-configuring FalsePool (when config[:pool] set to false) :
+          require 'active_record/bogacs/connection_handler'
+          ActiveRecord::Base.default_connection_handler = ConnectionHandler.new
+        end
+      end
+
+    end
+  end
+end

data/lib/active_record/bogacs/thread_safe.rb

@@ -9,8 +9,8 @@ module ActiveRecord
           begin
             require 'thread_safe'
           rescue
-            warn "activerecord-bogacs needs gem 'concurrent-ruby', '~> 1.0' (or the old 'thread_safe' gem) " <<
-                 "please install or add it to your Gemfile"
+            warn "activerecord-bogacs needs gem 'concurrent-ruby', '~> 1.0' (or the old 'thread_safe' gem)" +
+                 " please install or add it to your Gemfile"
             raise e
           end
         end
@@ -58,8 +58,8 @@ module ActiveRecord
             require 'thread_safe'
           rescue
             return nil unless required
-            warn "activerecord-bogacs needs gem 'concurrent-ruby', '~> 1.0' (or the old 'thread_safe' gem) " <<
-                 "please install or add it to your Gemfile"
+            warn "activerecord-bogacs needs gem 'concurrent-ruby', '~> 1.0' (or the old 'thread_safe' gem)" +
+                 " please install or add it to your Gemfile"
             raise e
           end
         end
@@ -71,6 +71,29 @@ module ActiveRecord
         end
       end
 
+
+      def self.load_monotonic_clock(required = true)
+        return const_get :MONOTONIC_CLOCK if const_defined? :MONOTONIC_CLOCK
+
+        begin
+          require 'concurrent/utility/monotonic_time.rb'
+        rescue LoadError => e
+          return nil unless required
+          warn "activerecord-bogacs needs gem 'concurrent-ruby', '~> 1.0'" +
+               " please install or add it to your Gemfile"
+          raise e
+        end
+
+        if defined? ::Concurrent.monotonic_time
+          const_set :MONOTONIC_CLOCK, ::Concurrent.const_get(:GLOBAL_MONOTONIC_CLOCK)
+        end
+      end
+
+      # @note Only works when {@link #load_monotonic_time} succeeds.
+      #def self.monotonic_time
+      #  MONOTONIC_CLOCK.get_time # java.lang.System.nanoTime() / 1_000_000_000.0
+      #end
+
     end
   end
 end

data/lib/active_record/bogacs/validator.rb

@@ -116,7 +116,7 @@ module ActiveRecord
             logger && logger.info("[validator] connection ##{conn.object_id} failed to validate: #{e.inspect}")
           end
 
-          # TODO support last_use - only validate if certain amount since use passed
+          # TODO support seconds_idle - only validate if certain amount since use passed
 
           logger && logger.debug("[validator] found non-active connection ##{conn.object_id} - removing from pool")
           pool.remove_without_owner conn # not active - remove

data/lib/active_record/bogacs/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Bogacs
-    VERSION = '0.5.1'
+    VERSION = '0.6.0'
   end
 end

data/lib/active_record/connection_adapters/adapter_compat.rb

@@ -8,38 +8,42 @@ module ActiveRecord
 
       if method_defined? :owner # >= 4.2
 
-        attr_reader :last_use
+        if ActiveRecord::VERSION::STRING > '5.2'
 
-        if ActiveRecord::VERSION::MAJOR > 4
+          # THIS IS OUR COMPATIBILITY BASE-LINE
 
-          # @private added @last_use
-          def lease
+        elsif ActiveRecord::VERSION::MAJOR > 4
+
+          # @private added @idle_since
+          # this method must only be called while holding connection pool's mutex
+          def expire
             if in_use?
-              msg = 'Cannot lease connection, '
-              if @owner == Thread.current
-                msg += 'it is already leased by the current thread.'
-              else
-                msg += "it is already in use by a different thread: #{@owner}. Current thread: #{Thread.current}."
+              if @owner != Thread.current
+                raise ActiveRecordError, "Cannot expire connection, " \
+                  "it is owned by a different thread: #{@owner}. " \
+                  "Current thread: #{Thread.current}."
               end
-              raise ActiveRecordError, msg
-            end
 
-            @owner = Thread.current; @last_use = Time.now
+              @owner = nil; @idle_since = monotonic_time
+            else
+              raise ActiveRecordError, "Cannot expire connection, it is not currently leased."
+            end
           end
 
         else
 
-          # @private removed synchronization + added @last_use
+          # @private removed synchronization
           def lease
-            if in_use?
-              if @owner == Thread.current
-                # NOTE: could do a warning if 4.2.x cases do not end up here ...
-              end
-            else
-              @owner = Thread.current; @last_use = Time.now
+            unless in_use?
+              @owner = Thread.current
             end
           end
 
+          # @private added @idle_since
+          def expire
+            @owner = nil; @idle_since = monotonic_time
+          end
+
         end
 
       else
@@ -69,7 +73,7 @@ module ActiveRecord
           end
 
           def expire
-            @in_use = false; @owner = nil
+            @in_use = false; @owner = nil; @idle_since = monotonic_time
           end
 
         else
@@ -83,13 +87,39 @@ module ActiveRecord
           end
 
           def expire
-            @owner = nil
+            @owner = nil; @idle_since = monotonic_time
           end
 
         end
 
       end
 
+      unless method_defined? :seconds_idle # >= 5.2
+
+        if ActiveRecord::Bogacs::ThreadSafe.load_monotonic_clock(false)
+          include ActiveRecord::Bogacs::ThreadSafe
+
+          def monotonic_time; MONOTONIC_CLOCK.get_time end
+          private :monotonic_time
+
+        else
+
+          def monotonic_time; nil end
+          private :monotonic_time
+
+          warn "activerecord-bogacs failed to load 'concurrent-ruby', '~> 1.0', seconds_idle won't work" if $VERBOSE
+
+        end
+
+        # Seconds since this connection was returned to the pool
+        def seconds_idle # :nodoc:
+          return 0 if in_use?
+          time = monotonic_time
+          time - ( @idle_since || time )
+        end
+
+      end
+
     end
   end
-end
+end

data/lib/activerecord-bogacs.rb

@@ -0,0 +1 @@
+require 'active_record/bogacs' # auto-loading with gem '...' declarations

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-bogacs
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Karol Bucek
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-26 00:00:00.000000000 Z
+date: 2018-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -68,9 +68,11 @@ files:
 - activerecord-bogacs.gemspec
 - lib/active_record/bogacs.rb
 - lib/active_record/bogacs/autoload.rb
+- lib/active_record/bogacs/connection_handler.rb
 - lib/active_record/bogacs/default_pool.rb
 - lib/active_record/bogacs/false_pool.rb
 - lib/active_record/bogacs/pool_support.rb
+- lib/active_record/bogacs/railtie.rb
 - lib/active_record/bogacs/reaper.rb
 - lib/active_record/bogacs/shareable_pool.rb
 - lib/active_record/bogacs/thread_safe.rb
@@ -80,6 +82,7 @@ files:
 - lib/active_record/connection_adapters/adapter_compat.rb
 - lib/active_record/connection_adapters/pool_class.rb
 - lib/active_record/shared_connection.rb
+- lib/activerecord-bogacs.rb
 - test/active_record/bogacs/default_pool_test.rb
 - test/active_record/bogacs/false_pool_test.rb
 - test/active_record/bogacs/reaper_test.rb