advanced_connection 0.5.1

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

@@ -0,0 +1,60 @@
+#
+# Copyright (C) 2016 Finalsite, LLC
+# Copyright (C) 2016 Carl P. Corliss <carl.corliss@finalsite.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module AdvancedConnection::ActiveRecordExt
+  module ConnectionPool
+    module Queues
+      class Default < ActiveRecord::ConnectionAdapters::ConnectionPool::Queue
+        def size
+          synchronize { @queue.size }
+        end
+      end
+      FIFO = Queues
+
+      class Stack < Default
+        def remove
+          @queue.pop
+        end
+      end
+
+      class AgeSorted < Default
+        def poll(timeout = nil)
+          synchronize do
+            @queue.sort_by!(&:instance_age)
+            no_wait_poll || (timeout && wait_poll(timeout))
+          end
+        end
+      end
+
+      class YoungAgeBiased < AgeSorted
+        def remove
+          @queue.pop
+        end
+      end
+
+      class OldAgeBiased < AgeSorted
+        def remove
+          @queue.shift
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+#
+# Copyright (C) 2016 Finalsite, LLC
+# Copyright (C) 2016 Carl P. Corliss <carl.corliss@finalsite.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module AdvancedConnection::ActiveRecordExt
+  module ConnectionPool
+    module StatementPooling
+      extend ActiveSupport::Concern
+
+      included do
+        alias_method_chain :new_connection, :statement_pooling
+      end
+
+      def new_connection_with_statement_pooling
+        new_connection_without_statement_pooling.tap { |conn|
+          unless conn.respond_to? :around_connection_checkin
+            conn.class.instance_exec {
+              include AbstractAdapter::StatementPooling
+            }
+          end
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+#
+# Copyright (C) 2016 Finalsite, LLC
+# Copyright (C) 2016 Carl P. Corliss <carl.corliss@finalsite.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module AdvancedConnection::ActiveRecordExt
+  module ConnectionPool
+    module WithoutConnection
+      extend ActiveSupport::Concern
+
+      included do
+        include ::ActiveSupport::Callbacks
+        alias_method :retrieve_connection, :connection
+
+        define_callbacks :without_connection
+        set_callback :without_connection, :around, :around_without_connection
+        set_callback :without_connection, :before, :before_without_connection
+        set_callback :without_connection, :after, :after_without_connection
+      end
+
+      def without_connection
+        return unless block_given?
+
+        if AdvancedConnection.callbacks.without_connection.present?
+          run_callbacks(:without_connection) do
+            __without_connection() { yield }
+          end
+        else
+          __without_connection() { yield }
+        end
+      end
+
+    private
+
+      def __without_connection
+        begin
+          # return the connection to the pool for the duration of `yield`
+          release_connection if active_connection?
+          raise Error::UnableToReleaseConnection if active_connection?
+          yield
+        ensure
+          tries = 3
+          begin
+            # attempt to retrieve another connection
+            retrieve_connection
+          rescue ActiveRecord::ConnectionTimeoutError
+            Rails.logger.info "Failed to acquire a connection (#{Thread.current.object_id}) trying #{tries > 1 ? "#{tries} more times" : 'once more'}"
+            retry unless (tries -= 1) < 0
+            Rails.logger.info "Giving up on trying to acquire another connection"
+            raise
+          end
+        end
+      end
+
+      def around_without_connection(&block)
+        callbacks = AdvancedConnection.callbacks.without_connection
+        if callbacks.around.respond_to? :call
+          callbacks.around.call() { block.call }
+        end
+      end
+
+      def before_without_connection
+        callbacks = AdvancedConnection.callbacks.without_connection
+        if callbacks.before.respond_to? :call
+          callbacks.before.call
+        end
+      end
+
+      def after_without_connection
+        callbacks = AdvancedConnection.callbacks.without_connection
+        if callbacks.after.respond_to? :call
+          callbacks.after.call
+        end
+      end
+    end
+  end
+end

data/lib/advanced_connection/active_record_ext/connection_pool.rb

@@ -0,0 +1,38 @@
+#
+# Copyright (C) 2016 Finalsite, LLC
+# Copyright (C) 2016 Carl P. Corliss <carl.corliss@finalsite.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+require 'active_record/connection_adapters/abstract/connection_pool'
+
+module AdvancedConnection
+  module ActiveRecordExt
+    module ConnectionPool
+      extend ActiveSupport::Autoload
+
+      eager_autoload do
+        autoload :Queues
+        autoload :IdleManager
+        autoload :StatementPooling
+        autoload :TransactionEncapsulation
+        autoload :WithoutConnection
+      end
+    end
+  end
+end

data/lib/advanced_connection/active_record_ext/without_connection.rb

@@ -0,0 +1,30 @@
+#
+# Copyright (C) 2016 Finalsite, LLC
+# Copyright (C) 2016 Carl P. Corliss <carl.corliss@finalsite.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module AdvancedConnection
+  module ActiveRecordExt
+    module WithoutConnection
+      def without_connection(&block)
+        connection_pool.without_connection(&block)
+      end
+    end
+  end
+end

data/lib/advanced_connection/active_record_ext.rb

@@ -0,0 +1,59 @@
+#
+# Copyright (C) 2016 Finalsite, LLC
+# Copyright (C) 2016 Carl P. Corliss <carl.corliss@finalsite.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+require 'active_record/connection_adapters/abstract_adapter'
+
+module AdvancedConnection
+  module ActiveRecordExt
+    extend ActiveSupport::Concern
+    extend ActiveSupport::Autoload
+
+    eager_autoload do
+      autoload :AbstractAdapter
+      autoload :ConnectionPool
+      autoload :WithoutConnection
+    end
+
+    included do
+      ActiveRecord::ConnectionAdapters::AbstractAdapter.instance_exec do
+        include AbstractAdapter
+      end
+
+      ActiveRecord::ConnectionAdapters::ConnectionPool.instance_exec do
+        if AdvancedConnection.enable_idle_connection_manager
+          include ConnectionPool::IdleManager
+        end
+
+        if AdvancedConnection.enable_statement_pooling
+          include ConnectionPool::StatementPooling
+        elsif AdvancedConnection.enable_without_connection
+          include ConnectionPool::WithoutConnection
+        end
+      end
+
+      ActiveRecord::Base.instance_exec do
+        if AdvancedConnection.enable_without_connection
+          extend ActiveRecordExt::WithoutConnection unless AdvancedConnection::enable_statement_pooling
+        end
+      end
+    end
+  end
+end

data/lib/advanced_connection/config.rb

@@ -0,0 +1,247 @@
+#
+# Copyright (C) 2016 Finalsite, LLC
+# Copyright (C) 2016 Carl P. Corliss <carl.corliss@finalsite.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+require 'singleton'
+
+module AdvancedConnection
+  class Config
+    include Singleton
+
+    VALID_QUEUE_TYPES = [
+      :fifo, :lifo, :stack, :prefer_younger, :prefer_older
+    ].freeze unless defined? VALID_QUEUE_TYPES
+
+    CALLBACK_TYPES = ActiveSupport::OrderedOptions.new.merge({
+      before: nil,
+      around: nil,
+      after: nil
+    }).freeze unless defined? CALLBACK_TYPES
+
+    DEFAULT_CONFIG = ActiveSupport::OrderedOptions.new.merge({
+      :enable_without_connection      => false,
+      :enable_statement_pooling       => false,
+      :enable_idle_connection_manager => false,
+      :connection_pool_queue_type     => :fifo,
+      :warmup_connections             => false,
+      :min_idle_connections           => 0,
+      :max_idle_connections           => ::Float::INFINITY,
+      :max_idle_time                  => 0,
+      :idle_check_interval            => 0,
+      :callbacks                      => ActiveSupport::OrderedOptions.new
+    }).freeze unless defined? DEFAULT_CONFIG
+
+    class << self
+      def method_missing(method, *args, &block)
+        return super unless instance.include?(method) || instance.respond_to?(method)
+        instance.public_send(method, *args, &block)
+      end
+
+      def respond_to_missing?(method, include_private = false)
+        instance.respond_to?(method) || super
+      end
+
+      def include?(key)
+        instance.include?(key) || super
+      end
+
+      def add_callback(*names)
+        Array(names).flatten.each { |name|
+          class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+            def #{name}_callbacks
+              @config.callbacks.#{name} ||= CALLBACK_TYPES.dup
+            end
+
+            def #{name}_callbacks=(value)
+              if not value.is_a? Hash
+                fail Error::ConfigError, "#{name} callbacks must be a hash"
+              elsif (bad_options = (value.keys.collect(&:to_sym) - CALLBACK_TYPES.keys)).size > 0
+                plural = bad_options .size > 1 ? 's' : ''
+                fail Error::ConfigError, "Unexpected callback option\#{plural}: " \
+                                         " `\#{bad_options.join('`, `')}`"
+              elsif (uncallable = value.select { |k,v| !v.respond_to? :call }).present?
+                plural = uncallable.size > 1 ? 's' : ''
+                fail Error::ConfigError, "Expected #{name} callback\#{plural}" \
+                                         " `\#{uncallable.keys.join('`, `')}` to be callable"
+              end
+
+              @config.callbacks.#{name} = CALLBACK_TYPES.merge(value)
+            end
+          EOS
+          DEFAULT_CONFIG.callbacks[name.to_sym] = CALLBACK_TYPES.dup
+        }
+      end
+      alias_method :add_callbacks, :add_callback
+    end
+
+    add_callbacks :without_connection, :statement_pooling
+
+    def initialize
+      @loaded = false
+      @config = DEFAULT_CONFIG.deep_dup
+    end
+
+    def loaded!
+      @loaded = true
+    end
+
+    def loaded?
+      @loaded
+    end
+
+    def [](key)
+      @config[key.to_sym]
+    end
+
+    def []=(key, value)
+      public_send("#{key}=".to_sym, value)
+    end
+
+    def include?(key)
+      @config.include? key.to_s.tr('=', '').to_sym
+    end
+
+    def to_h
+      @config.dup
+    end
+
+    def callbacks
+      @config.callbacks
+    end
+
+    def enable_without_connection
+      @config[:enable_without_connection]
+    end
+
+    def enable_without_connection=(value)
+      if enable_statement_pooling && !!value
+        raise Error::ConfigError, "WithoutConnection blocks conflict with Statement Pooling feature"
+      end
+      @config[:enable_without_connection] = !!value
+    end
+
+    def enable_statement_pooling
+      @config[:enable_statement_pooling]
+    end
+
+    def enable_statement_pooling=(value)
+      if enable_without_connection && !!value
+        raise Error::ConfigError, "Statement Pooling conflicts with WithoutConnection feature"
+      end
+      @config[:enable_statement_pooling] = !!value
+    end
+
+    def enable_idle_connection_manager
+      @config[:enable_idle_connection_manager]
+    end
+
+    def enable_idle_connection_manager=(value)
+      @config[:enable_idle_connection_manager] = !!value
+    end
+
+    def warmup_connections
+      @config[:warmup_connections]
+    end
+
+    def warmup_connections=(value)
+      unless value.nil? || value === false || value.is_a?(Fixnum) || value =~ /^\d+$/
+        fail Error::ConfigError, 'Expected warmup_connections to be nil, false ' \
+                           "or a valid positive integer, but found `#{value.inspect}`"
+      end
+
+      if value.to_s =~ /^\d+$/
+        @config[:warmup_connections] = value.to_i
+      else
+        @config[:warmup_connections] = false
+      end
+    end
+
+    def min_idle_connections
+      @config[:min_idle_connections]
+    end
+
+    def min_idle_connections=(value)
+      unless value.is_a?(Numeric) || value =~ /^\d+$/
+        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
+    end
+
+    def max_idle_connections
+      @config[:max_idle_connections]
+    end
+
+    def max_idle_connections=(value)
+      unless value.is_a?(Numeric) || value =~ /^\d+$/
+        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 => e
+        raise unless e.message =~ /infinity/i
+        ::Float::INFINITY
+      end
+    end
+
+    def max_idle_time
+      @config[:max_idle_time]
+    end
+
+    def max_idle_time=(value)
+      unless value.is_a?(Numeric) || value =~ /^\d+$/
+        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
+    end
+
+    def idle_check_interval
+      @config[:idle_check_interval]
+    end
+
+    def idle_check_interval=(value)
+      unless value.is_a?(Numeric) || value =~ /^\d+$/
+        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
+    end
+
+    def connection_pool_queue_type
+      @config[:connection_pool_queue_type]
+    end
+
+    def connection_pool_queue_type=(value)
+      unless value.is_a?(String) || value.is_a?(Symbol)
+        fail Error::ConfigError, 'Expected String or Symbol for connection_pool_queue_type ' \
+                           "but found `#{value.class.name}`"
+      end
+
+      unless VALID_QUEUE_TYPES.include? value.to_sym
+        fail Error::ConfigError, 'Expected connection_pool_queue_type to be one of ' \
+                           ':fifo, :lifo, :stack, :prefer_younger, or :prefer_older ' \
+                           "but found `#{value.inspect}`"
+      end
+      @config[:connection_pool_queue_type] = value
+    end
+  end
+end