advanced_connection 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5388815e17dd8184ac2da77dd66f12dc8f420c89
-  data.tar.gz: 84e79b7bcaa1806c872f25831c0b688843af0bf8
+  metadata.gz: 40fc0d030c3afc87fe6de323b95e05ee08d7b194
+  data.tar.gz: 53e478d0b9f79a4c419988b1cf68eee4d644830b
 SHA512:
-  metadata.gz: f1f7d22818b463df971f7dde6a17b4f19dcd35c5a048b88863684bf9dbe685e99c8c0a8fdbdd5a044681fd951e779ce0ad06df83dc9e84dab8b251906d8e5024
-  data.tar.gz: c9a8fe419202cca4bce4d552c921cceb53d0e71b7b7ee861391172068d1c4670280d4bcf09ed69ce50500c3adce1369003ee01d2e22d9d4654701eae5de6adae
+  metadata.gz: a6276f4f159d3bae45e449e500bebad258d89058b871e558eacfa1ad04ab32ca8b9ccf063f4367155f454f5ad0f047591bb986110e8488628d984df8e2f5d695
+  data.tar.gz: 6c437a28543af4e8a0bd4a5718435e06d9a91a5f74e8ec11775b86c33d187f593be9d340899d41272f1dabd7821f456d5247189025a9f498f4db248b48cb6bb9

data/.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.rdoc]
+trim_trailing_whitespace = false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    advanced_connection (0.5.6)
+    advanced_connection (0.5.7)
       activerecord (~> 4.1)
       activesupport (~> 4.1)
       rails (~> 4.1)

data/README.md

@@ -0,0 +1,140 @@
+# Advanced Connection
+
+AdvancedConnection is a rails (~> 4.1) plugin that provides advanced management features for Rails' ActiveRecord connection pool. Features include:
+  - Idle Connection Manager
+  - Connection-less Code Blocks
+  - Statement Pooling (**EXPERIMENTAL**)
+
+### Version
+0.5.6
+
+### Installation
+
+You need Gulp installed globally:
+
+```sh
+$ gem install advanced_connection
+```
+
+or in your Gemfile, add:
+
+```ruby
+gem 'advanced_connection', '~> 0.5.6'
+```
+
+Then generate your `AdvancedConnection` configuration by executing:
+
+```sh
+bundle exec rails generate advanced_connection:install
+```
+
+### Usage and Configuration
+
+#### Idle Connection Manager
+
+Enabling this will enable idle connection management. This allows you to specify settings
+to enable automatic warmup of connections on rails startup, min/max idle connections and
+idle connection culling.
+
+```text
+  enable_idle_connection_manager = true | false
+```
+
+Pool queue type determines both how free connections will be checkout out of the pool, as well as how idle connections will be culled. The options are:
+
+<dl>
+  <dt><strong>:fifo</strong></dt>
+    <dd>All connections will have an equal opportunity to be used and culled (default)</dd>
+    <br />
+  <dt><strong>:lifo, :stack</strong></dt>
+    <dd>More frequently used connections will be reused, leaving less frequently used connections to be culled</dd>
+    <br />
+  <dt><strong>:prefer_older</strong></dt>
+    <dd>Longer lived connections will tend to stick around longer, with younger connections being culled</dd>
+    <br />
+  <dt><strong>:prefer_younger</strong></dt>
+    <dd>Younger lived connections will tend to stick around longer, with older connections being culled</dd>
+</dl>
+
+```text
+  connection_pool_queue_type = :fifo | :lifo | :stack | :prefer_older | :prefer_younger
+```
+
+How many connections to prestart on initial startup of rails. This can help to reduce the time it takes a restarted production node to start responding again.
+```text
+  warmup_connections = integer | false
+```
+
+Minimum number of connection to keep idle. If, during the idle check, you have fewer than this many connections idle, then a number of new connections will be created up to this this number.
+```text
+  min_idle_connections = integer
+```
+
+Maximum number of connections that can remain idle without being culled. If you have
+more idle conections than this, only the difference between the total idle and this
+maximum will be culled.
+```text
+  max_idle_connections = integer | Float::INFINITY
+```
+
+How long (in seconds) a connection can remain idle before being culled
+```text
+  max_idle_time = integer
+```
+
+How many seconds between idle checks (defaults to max_idle_time)
+```text
+  idle_check_interval = integer
+```
+
+#### Connection-less Code Blocks
+
+ Enabling this will add a new method to ActiveRecord::Base that allows you to mark a block of code as not requiring a connection. This can be useful in reducing pressure on the pool, especially when you have sections of code that make potentially long-lived external requests. E.g.,
+
+ ```ruby
+ require 'open-uri'
+ results = ActiveRecord::Base.without_connection do
+   open('http://some-slow-site.com/api/')
+ end
+ ```
+
+During the call to the remote site, the db connection is checked in and subsequently checked back out once the block finishes. To enable this feature, uncomment the following:
+
+```ruby
+  enable_without_connection = true | false
+```
+
+<div style="color: rgb(201, 79, 79); padding-bottom: 1em;"> WARNING: this feature cannot be enabled with Statement Pooling.</div>
+
+Additionally, you can hook into the checkin / checkout lifecycle by way of callbacks. This can be extremely useful when employing something like [`Apartment`][apt] to manage switching between tenants.
+
+```ruby
+without_connection_callbacks = {
+  # runs right before the connection is checked back into the pool
+  before:  ->() { },
+  around:  ->(&block) {
+    tenant = Apartment::Tenant.current
+    block.call
+    Apartment::Tenant.switch(tenant)
+  },
+  # runs right after the connection is checked back out of the pool
+  after:  ->() { }
+}
+```
+
+#### Statement Pooling
+
+### Todos
+
+ - Finish development of Statement Pooling
+ - Write Tests
+ - Add Code Comments
+
+License
+----
+
+MIT
+
+
+[//]: # (references)
+   [apt]: <https://github.com/influitive/apartment/>

data/lib/advanced_connection.rb

@@ -40,8 +40,8 @@ module AdvancedConnection
       config.to_h
     end
 
-    def configure(overwrite = true)
-      return unless overwrite
+    def configure(overwrite = false)
+      return config unless overwrite || !config.loaded?
       (yield config).tap { config.loaded! }
     end
 

data/lib/advanced_connection/active_record_ext/abstract_adapter/statement_pooling.rb

@@ -28,7 +28,7 @@ module AdvancedConnection::ActiveRecordExt
 
       module ExecuteWrapper
         def __wrap_adapter_exec_methods(*methods)
-          Array(methods).flatten.collect(&:to_sym).each do |exec_method|
+          Array(methods).flat_map(&:to_sym).each do |exec_method|
             class_eval(<<-EOS, __FILE__, __LINE__ + 1)
               def #{exec_method}_with_callback(sql, *args, &block)
                 if Thread.current[:without_callbacks] || sql =~ /^BEGIN/i || transaction_open? || pool.nil?
@@ -49,7 +49,7 @@ module AdvancedConnection::ActiveRecordExt
         alias_method :__wrap_adapter_exec_method, :__wrap_adapter_exec_methods
 
         def __wrap_without_callbacks(*methods)
-          Array(methods).flatten.collect(&:to_sym).each do |exec_method|
+          Array(methods).flat_map(&:to_sym).each do |exec_method|
             target, punctuation = exec_method.to_s.sub(/([?!=])$/, ''), $1
             class_eval(<<-EOS, __FILE__, __LINE__ + 1)
               def #{target}_with_no_callbacks#{punctuation}(*args, &block)

data/lib/advanced_connection/active_record_ext/connection_pool/idle_manager.rb

@@ -28,8 +28,12 @@ module AdvancedConnection::ActiveRecordExt
         alias_method_chain :initialize, :advanced_connection
         alias_method_chain :checkin, :last_checked_in
 
+        attr_reader :idle_manager
+
         class IdleManager
+          attr_accessor :interval
           attr_reader :thread
+          private :thread
 
           def initialize(pool, interval)
             @pool     = pool
@@ -37,7 +41,25 @@ module AdvancedConnection::ActiveRecordExt
             @thread   = nil
           end
 
-          def run
+          def status
+            if @thread
+              @thread.alive? ? :running : :dead
+            else
+              :stopped
+            end
+          end
+
+          def restart
+            stop.start
+          end
+
+          def stop
+            @thread.kill if @thread.alive?
+            @thread = nil
+            self
+          end
+
+          def start
             return unless @interval > 0
 
             @thread ||= Thread.new(@pool, @interval) { |pool, interval|
@@ -60,6 +82,7 @@ module AdvancedConnection::ActiveRecordExt
                 end
               end
             }
+            self
           end
         end
       end
@@ -76,7 +99,7 @@ module AdvancedConnection::ActiveRecordExt
             Queues::FIFO.new
         end
 
-        @idle_manager = IdleManager.new(self, idle_check_interval).tap(&:run)
+        @idle_manager = IdleManager.new(self, idle_check_interval).tap(&:start)
       end
 
       def queue_type

data/lib/advanced_connection/config.rb

@@ -20,6 +20,7 @@
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 require 'singleton'
+require 'monitor'
 
 module AdvancedConnection
   class Config
@@ -99,17 +100,24 @@ module AdvancedConnection
     def initialize
       @loaded = false
       @config = DEFAULT_CONFIG.deep_dup
+      @mutex  = Monitor.new
     end
 
+    def synchronize
+      @mutex.synchronize { yield }
+    end
+    private :synchronize
+
     def can_enable?
-      # don't enable if we're running rake tasks, in particular db: or assets: tasks
+      # don't enable if we're running rake tasks generally,
+      # and specifically, if it's db: or assets: tasks
       return false if $0.include? 'rake'
       return false if ARGV.grep(/^(assets|db):/).any?
       true
     end
 
     def loaded!
-      @loaded = true
+      synchronize { @loaded = true }
     end
 
     def [](key)
@@ -140,7 +148,7 @@ module AdvancedConnection
       if enable_statement_pooling && !!value
         raise Error::ConfigError, "WithoutConnection blocks conflict with Statement Pooling feature"
       end
-      @config[:enable_without_connection] = !!value
+      synchronize { @config[:enable_without_connection] = !!value }
     end
 
     def enable_statement_pooling
@@ -151,7 +159,7 @@ module AdvancedConnection
       if enable_without_connection && !!value
         raise Error::ConfigError, "Statement Pooling conflicts with WithoutConnection feature"
       end
-      @config[:enable_statement_pooling] = !!value
+      synchronize { @config[:enable_statement_pooling] = !!value }
     end
 
     def enable_idle_connection_manager
@@ -159,7 +167,7 @@ module AdvancedConnection
     end
 
     def enable_idle_connection_manager=(value)
-      @config[:enable_idle_connection_manager] = !!value
+      synchronize { @config[:enable_idle_connection_manager] = !!value }
     end
 
     def warmup_connections
@@ -172,7 +180,7 @@ module AdvancedConnection
                            "or a valid positive integer, but found `#{value.inspect}`"
       end
 
-      @config[:warmup_connections] = value.to_s =~ /^\d+$/ ? value.to_i : false
+      synchronize { @config[:warmup_connections] = value.to_s =~ /^\d+$/ ? value.to_i : false }
     end
 
     def min_idle_connections
@@ -184,7 +192,7 @@ module AdvancedConnection
         fail Error::ConfigError, 'Expected min_idle_connections to be ' \
                            "a valid integer value, but found `#{value.inspect}`"
       end
-      @config[:min_idle_connections] = value.to_i
+      synchronize { @config[:min_idle_connections] = value.to_i }
     end
 
     def max_idle_connections
@@ -196,12 +204,14 @@ module AdvancedConnection
         fail Error::ConfigError, 'Expected max_idle_connections to be ' \
                            "a valid integer value, but found `#{value.inspect}`"
       end
-      @config[:max_idle_connections] = begin
-        value.to_i
-      rescue FloatDomainError
-        raise unless $!.message =~ /infinity/i
-        ::Float::INFINITY
-      end
+      synchronize {
+        @config[:max_idle_connections] = begin
+          value.to_i
+        rescue FloatDomainError
+          raise unless $!.message =~ /infinity/i
+          ::Float::INFINITY
+        end
+      }
     end
 
     def max_idle_time
@@ -213,7 +223,7 @@ module AdvancedConnection
         fail Error::ConfigError, 'Expected max_idle_time to be ' \
                            "a valid integer value, but found `#{value.inspect}`"
       end
-      @config[:max_idle_time] = value.to_i
+      synchronize { @config[:max_idle_time] = value.to_i }
     end
 
     def idle_check_interval
@@ -225,7 +235,7 @@ module AdvancedConnection
         fail Error::ConfigError, 'Expected idle_check_interval to be ' \
                            "a valid integer value, but found `#{value.inspect}`"
       end
-      @config[:idle_check_interval] = value.to_i
+      synchronize { @config[:idle_check_interval] = value.to_i }
     end
 
     def connection_pool_queue_type
@@ -243,7 +253,7 @@ module AdvancedConnection
                            ':fifo, :lifo, :stack, :prefer_younger, or :prefer_older ' \
                            "but found `#{value.inspect}`"
       end
-      @config[:connection_pool_queue_type] = value
+      synchronize { @config[:connection_pool_queue_type] = value }
     end
   end
 end

data/lib/advanced_connection/railtie.rb

@@ -25,11 +25,20 @@ module AdvancedConnection
 
     if AdvancedConnection.can_enable?
       ActiveSupport.on_load(:before_initialize) do
-        ActiveSupport.on_load(:active_record) do
+        ActiveSupport.on_load(:active_record) {
           # load our intitializer ASAP so we can make use of user defined configuration
           load Rails.root.join('config', 'initializers', 'advanced_connection.rb')
+
+          # now override the settings with environment speicific ones
+          AdvancedConnection.configure(true) do |ac_cfg|
+            Rails.configuration.advanced_connection.each { |option, value|
+              ac_cfg[option] = value
+            }
+          end
+
+          # and finally, compose ourself
           ActiveRecord::Base.send(:include, AdvancedConnection::ActiveRecordExt)
-        end
+        }
       end
 
       config.after_initialize do

data/lib/advanced_connection/version.rb

@@ -22,7 +22,7 @@
 module AdvancedConnection
   MAJOR = 0
   MINOR = 5
-  PATCH = 6
+  PATCH = 7
 
   VERSION     = "%d.%d.%d" % [ MAJOR, MINOR, PATCH ]
   GEM_VERSION = Gem::Version.new(VERSION)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: advanced_connection
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors:
 - Carl P. Corliss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-30 00:00:00.000000000 Z
+date: 2016-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -215,6 +215,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".document"
+- ".editorconfig"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -222,7 +223,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - advanced_connection.gemspec
 - gemfiles/jruby/rails4_1.gemfile

data/README.rdoc

@@ -1,3 +0,0 @@
-= AdvancedConnection
-
-This project rocks and uses MIT-LICENSE.