ar_preconnect 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73b2e902a43eaac8b8c50c79d61510affc1cb90a
+  data.tar.gz: cf6608f52194f084e6b20e28e7abdcbb48b23ccf
+SHA512:
+  metadata.gz: 73eb0f3fa4b41bad4e95a07d63ce8599926b313e77e6794de0f70814d8049f5a0b46aa770628f1d54b09346b3c08216f39672b41f701df1ed64354c6831a5dfe
+  data.tar.gz: a9fcffd2872b72552a97b8882534cd92e8f7d6e6368989cf0c6798636f2292760f5b6385fb61647dd3a0871af0981677bac5f11daf263d905bf0ffed17b4d2ac

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Michael van Rooijen
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,116 @@
+## ActiveRecord Preconnect
+
+This library adds the `preconnect!` method to `ActiveRecord::ConnectionAdapters::ConnectionPool`. Use this when you want all of your connections in your connection pool to eagerly connect to the database, rather than lazily.
+
+
+### Why
+
+When using [Postgres] on [Heroku] with [PGBouncer] you can run into situations where your [process will hang indefinitely]. This issue occurs when using ActiveRecord, Sequel and potentially other database mappers.
+
+The solution in Sequel is to set the `preconnect` option to `true`. This option tells Sequel to open all database connection eagerly, rather than lazily, and avoids potential deadlocks. I couldn't find an equivalent option in ActiveRecord so I wrote this small library to provide a method to do so.
+
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```rb
+gem "ar_preconnect"
+```
+
+### Usage
+
+With [Sidekiq]:
+
+```rb
+# ./config/initializers/sidekiq.rb
+Sidekiq.configure_server do |config|
+  ActiveRecord::Base.connection.pool.preconnect!
+end
+```
+
+With [Passenger] in cluster-mode.
+
+```rb
+# ./config/initializers/passenger.rb
+if defined?(PhusionPassenger)
+  PhusionPassenger.on_event(:starting_worker_process) do |forked|
+    if forked
+      ActiveRecord::Base.establish_connection
+      ActiveRecord::Base.connection.pool.preconnect!
+    end
+  end
+end
+```
+
+With [Unicorn] in cluster-mode.
+
+```rb
+# ./config/initializers/unicorn.rb
+before_fork do |server, worker|
+  ActiveRecord::Base.connection.disconnect!
+end
+
+after_fork do |server, worker|
+  ActiveRecord::Base.establish_connection
+  ActiveRecord::Base.connection.pool.preconnect!
+end
+```
+
+With [Puma] in cluster-mode.
+
+```rb
+# ./config/initializers/puma.rb
+on_worker_boot do
+  ActiveSupport.on_load(:active_record) do
+    ActiveRecord::Base.establish_connection
+    ActiveRecord::Base.connection.pool.preconnect!
+  end
+end
+```
+
+With [Clockwork]:
+
+```rb
+# ./clock.rb
+require "clockwork"
+require_relative "config/boot"
+require_relative "config/environment"
+
+ActiveRecord::Base.connection.pool.preconnect!
+
+module Clockwork
+  every(1.minute, "do something") do
+    MyWorker.perform_async
+  end
+end
+```
+
+### Verify 
+
+Verify that this works:
+
+```rb
+pool = ActiveRecord::Base.connection.pool
+
+puts "#{pool.connections.count} connections established."
+pool.preconnect!
+puts "#{pool.connections.count} connections established."
+```
+
+
+### Author / License
+
+Released under the [MIT License] by [Michael van Rooijen].
+
+[Postgres]: http://www.postgresql.org
+[Heroku]: https://www.heroku.com
+[PGBouncer]: https://pgbouncer.github.io
+[Sidekiq]: http://sidekiq.org
+[Passenger]: https://www.phusionpassenger.com
+[Unicorn]: http://unicorn.bogomips.org
+[Puma]: http://puma.io
+[Clockwork]: https://github.com/tomykaira/clockwork
+[process will hang indefinitely]: https://github.com/heroku/heroku-buildpack-pgbouncer/issues/29
+[MIT License]: https://github.com/meskyanichi/ar_preconnect/blob/master/LICENSE
+[Michael van Rooijen]: http://michael.vanrooijen.io

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/ar_preconnect.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "ar_preconnect"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Michael van Rooijen"]
+  spec.email         = ["michael@vanrooijen.io"]
+
+  spec.summary       = %q{Adds the `preconnect!` method to `ActiveRecord::ConnectionAdapters::ConnectionPool`.}
+  spec.description   = spec.summary + " With it you can eagerly connect all connection pool connections to the database, rather than lazily."
+  spec.homepage      = "https://github.com/meskyanichi/ar_preconnect"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/ar_preconnect.rb

@@ -0,0 +1,9 @@
+class ActiveRecord::ConnectionAdapters::ConnectionPool
+
+  def preconnect!
+    (size - 1)
+      .times
+      .map { checkout }
+      .each { |c| checkin(c) }
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: ar_preconnect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael van Rooijen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Adds the `preconnect!` method to `ActiveRecord::ConnectionAdapters::ConnectionPool`.
+  With it you can eagerly connect all connection pool connections to the database,
+  rather than lazily.
+email:
+- michael@vanrooijen.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ar_preconnect.gemspec
+- lib/ar_preconnect.rb
+homepage: https://github.com/meskyanichi/ar_preconnect
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Adds the `preconnect!` method to `ActiveRecord::ConnectionAdapters::ConnectionPool`.
+test_files: []