advanced_connection 0.5.1

data/lib/advanced_connection/error.rb

@@ -0,0 +1,27 @@
+#
+# 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
+  class Error < StandardError
+    class ConfigError < Error; end
+    class UnableToReleaseConnection < Error; end
+  end
+end

data/lib/advanced_connection/railtie.rb

@@ -0,0 +1,40 @@
+#
+# 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
+  class Railtie < Rails::Railtie
+    config.advanced_connection = ActiveSupport::OrderedOptions.new
+
+    ActiveSupport.on_load(:before_initialize) do
+      ActiveSupport.on_load(:active_record) do
+        # load our intitializer ASAP so we can make use of user defined configuration
+        load Rails.root.join('config', 'initializers', 'advanced_connection.rb')
+        ActiveRecord::Base.send(:include, AdvancedConnection::ActiveRecordExt)
+      end
+    end
+
+    config.after_initialize do
+      if AdvancedConnection.enable_idle_connection_manager && AdvancedConnection.warmup_connections
+        ActiveRecord::Base.connection_handler.connection_pool_list.each(&:warmup_connections)
+      end
+    end
+  end
+end

data/lib/advanced_connection/version.rb

@@ -0,0 +1,29 @@
+#
+# 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
+  MAJOR = 0
+  MINOR = 5
+  PATCH = 1
+
+  VERSION     = "%d.%d.%d" % [ MAJOR, MINOR, PATCH ]
+  GEM_VERSION = Gem::Version.new(VERSION)
+end

data/lib/advanced_connection.rb

@@ -0,0 +1,65 @@
+#
+# 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'
+require 'active_support/concern'
+require 'active_support/hash_with_indifferent_access'
+require 'advanced_connection/version'
+require 'singleton'
+require 'logger'
+
+module AdvancedConnection
+  extend ActiveSupport::Autoload
+
+  eager_autoload do
+    autoload :ActiveRecordExt
+    autoload :Config
+    autoload :Error
+  end
+
+  class << self
+    def to_h
+      config.to_h
+    end
+
+    def configure(overwrite = true)
+      return unless overwrite
+      (yield config).tap {
+        config.loaded!
+      }
+    end
+
+    def config
+      @config ||= Config.instance
+    end
+
+    def method_missing(method, *args, &block)
+      return super unless config.respond_to? method
+      config.public_send(method, *args, &block)
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      config.respond_to?(method) || super
+    end
+  end
+
+  require 'advanced_connection/railtie' if defined?(Rails)
+end

data/lib/generators/advanced_connection/install/USAGE

@@ -0,0 +1,5 @@
+Description:
+  Creates an initializer for Advanced Connection.
+
+Example:
+  `rails generate advanced_connection:install`

data/lib/generators/advanced_connection/install/install_generator.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
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def copy_files
+      template "advanced_connection.rb", File.join("config", "initializers", "advanced_connection.rb")
+    end
+  end
+end

data/lib/generators/advanced_connection/install/templates/advanced_connection.rb

@@ -0,0 +1,142 @@
+#
+# Advanced Connection Configuration
+#
+AdvancedConnection.configure do |config|
+  #
+  ## Idle 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.
+  # config.enable_idle_connection_manager = <%= AdvancedConnection::Config::DEFAULT_CONFIG.enable_idle_connection_manager.inspect %>
+
+  # 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:
+  #
+  #  :fifo           - All connections will have an equal opportunity to be used and culled (default)
+  #  :lifo/:stack    - More frequently used connections will be reused, leaving less frequently used
+  #                    connections to be culled
+  #  :prefer_older   - Longer lived connections will tend to stick around longer, with younger
+  #                    connections being culled
+  #  :prefer_younger - Younger lived connections will tend to stick around longer, with older
+  #                    connections being culled
+  #
+  # config.connection_pool_queue_type     = <%= AdvancedConnection::Config::DEFAULT_CONFIG.connection_pool_queue_type.inspect %>
+
+  # 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.
+  #
+  # config.warmup_connections             = <%= AdvancedConnection::Config::DEFAULT_CONFIG.warmup_connections.inspect %>
+
+  # 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.
+  #
+  # config.min_idle_connections           = <%= AdvancedConnection::Config::DEFAULT_CONFIG.min_idle_connections.inspect %>
+
+  # 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.
+  #
+  # config.max_idle_connections           = ::Float::INFINITY
+
+  # How long (in seconds) a connection can remain idle before being culled
+  #
+  # config.max_idle_time                  = 90
+
+  # How many seconds between idle checks (defaults to max_idle_time)
+  #
+  # config.idle_check_interval            = 90
+
+  #
+  ## Without Connection
+  #
+  # 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.,
+  #
+  # require 'open-uri'
+  # results = ActiveRecord::Base.without_connection do
+  #   open('http://some-slow-site.com/api/foo')
+  # 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:
+  #
+  # config.enable_without_connection = true
+  #
+  # WARNING: this feature cannot be enabled with Statement Pooling.
+  #
+  # Additionally, you can hook into the checkin / chekcout lifecycle by way of callbacks. This
+  # can be extremely useful when employing something like Apartment to manage switching
+  # between tenants.
+  #
+  # config.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
+  #
+  # **** WARNING **** EXPERIMENTAL **** WARNING **** EXPERIMENTAL ****
+  #
+  # THIS FEATURE IS HIGHLY EXPERIMENTAL AND PRONE TO FAILURE. DO NOT USE UNLESS
+  # YOU PLAN TO AIDE IN IT'S DEVELOPMENT.
+  #
+  # When enabled, this feature causes your connections to immediately be returned to
+  # the pool upon completion of each query (with the exception of transactions, where
+  # the connection is returned after transaction commit/rollback). This can help to
+  # reduce pressure on the pool, as well as the number of the connections to the
+  # backend by making more efficient use of existing connections.
+  #
+  # WARNING: this cannot be enabled with Without Connection.
+  #
+  # To enable, simply uncomment the following:
+  #
+  # config.enable_statement_pooling = true
+  #
+  # Additionally, callbacks are provided around the connection checkin. This can
+  # be extremely useful when in a multi-tenant situation using something like
+  # Apartment, e.g.:
+  #
+  # lib/apartment/elevators/my_elevator.rb:
+  # module Apartment::Elevators
+  #   class MyElevator < Generic
+  #     def call(env)
+  #       super
+  #     ensure
+  #       Thread.current[:tenant] = nil
+  #       Apartment::Tenant.reset
+  #     end
+  #
+  #     def parse_tenant_name(request)
+  #       request.host.split('.').first.tap do |tenant|
+  #         Thread.current[:tenant] = tenant
+  #       end
+  #     end
+  #   end
+  #   . . .
+  # end
+  #
+  # and then set your statement_pooling_callbacks like so:
+  #
+  # config.statement_pooling_callbacks = {
+  #   # switch back to the stored tenant prior to executing sql
+  #   before:  ->() {
+  #     if Thread.current[:tenant]
+  #       Apartment::Tenant.switch(Thread.current[:tenant])
+  #     end
+  #   }
+  # }
+end

data/lib/tasks/advanced_connection_tasks.rake

@@ -0,0 +1,25 @@
+#
+# 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.
+#
+# desc "Explaining what the task does"
+# task :advanced_connection do
+#   # Task goes here
+# end

data/spec/config/database.yml

@@ -0,0 +1,18 @@
+default: &default
+  adapter: postgresql
+  database: advanced_connection_test
+<%- if RUBY_ENGINE == 'jruby' -%>
+  driver: org.postgresql.Driver
+  url: jdbc:postgresql://localhost:5432/advanced_connection_test
+<%- end -%>
+  pool: 50
+  timeout: 5000
+  pool_queue_type: lifo
+  max_idle_time: 5
+  max_idle_connections: 10
+  min_idle_connections: 5
+  prestart_connections: 10
+  dead_connection_timeout: 30
+
+test:
+  <<: *default

data/spec/config/database.yml.erb

@@ -0,0 +1,54 @@
+default: &default
+  pool: 20
+  timeout: 5000
+  pool_queue_type: fifo
+  max_idle_time: 5
+  min_idle_connections: 5
+  max_idle_connections: 10
+  prestart_connections: 10
+  dead_connection_timeout: 30
+
+default_mysql: &default_mysql
+  <<: *default
+  adapter: mysql2
+  database: advanced_connection_test
+  username: root
+  min_messages: WARNING
+
+default_postgresql: &default_postgresql
+  <<: *default
+  adapter: postgresql
+  database: advanced_connection_test
+  username: postgres
+  min_messages: WARNING
+
+<% if defined?(JRUBY_VERSION) %>
+connections:
+  postgresql:
+    <<: *default_postgresql
+    driver: org.postgresql.Driver
+    url: jdbc:postgresql://localhost:5432/advanced_connection_test
+
+  mysql:
+    <<: *default_mysql
+    adapter: mysql
+    driver: com.mysql.jdbc.Driver
+    url: jdbc:mysql://localhost:3306/advanced_connection_test
+
+<% else %>
+connections:
+  postgresql:
+    <<: *default_postgresql
+    schema_search_path: public
+    password:
+
+  mysql:
+    <<: *default_mysql
+    adapter: mysql2
+    password:
+
+  sqlite:
+    <<: *default
+    adapter: sqlite3
+    database: <%= File.expand_path('../spec/dummy/db', __FILE__) %>/default.sqlite3
+<% end %>