activerecord-pgbouncer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec071fbf0fd88fead70eac5b4cd95852e81cc3e7
+  data.tar.gz: e3a2cd338297d973e1cb6e6ab1dbba4da140bc77
+SHA512:
+  metadata.gz: fa183c8b43fb46cdd6eeef003791878b17d461831dd839dca246302a3acf67752d03c62f9353d419678f66d16abe53f25824d499cd78c2732d5856032417766c
+  data.tar.gz: 1ebfee1542d62f54a1bbc936f67a27c737084c3a7cd07c19fda90a30e52422404c78c464cb3f3aa97585c701808d73571c4cb15a77bdc117c94ef00c4a80e7f3

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.4

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-pgbouncer.gemspec
+gemspec
+
+group :development, :test do
+  gem 'activerecord', '4.1.14'
+  gem 'pg'
+end

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2015, Remind101, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,30 @@
+# ActiveRecord PgBouncer Connection Adapter
+
+When using PgBouncer, there are certain considerations to take into account:
+
+* If you're using transaction pooling mode, prepared statements must be disabled.
+* If you're using transaction pooling mode, session level features should not be used.
+
+This is a light layer above the PostgreSQL connection adapter, that helps ensure that you don't make the mistakes above!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-pgbouncer'
+```
+
+## Usage
+
+This adds a `pgbouncer` adapter, which you can use in `config/database.yml` or `ENV['DATABASE_URL']`:
+
+```yaml
+production:
+  adapter: pgbouncer
+  pooling_mode: transaction # Can be `session`, `transaction`, or `statement`
+```
+
+```shell
+export DATABASE_URL=pgbouncer://user:pass@host/db?pooling_mode=transaction
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activerecord-pgbouncer.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/pgbouncer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-pgbouncer"
+  spec.version       = ActiveRecord::PgBouncer::VERSION
+  spec.authors       = ["Eric J. Holmes"]
+  spec.email         = ["eric@remind101.com"]
+
+  spec.summary       = %q{ActiveRecord connection adapter for safe PgBouncer use}
+  spec.description   = %q{ActiveRecord connection adapter for safe PgBouncer use}
+  spec.homepage      = "https://github.com/remind101/activerecord-pgbouncer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", [">= 4.1", "<= 5"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/active_record/connection_adapters/pgbouncer_adapter.rb

@@ -0,0 +1,92 @@
+require 'active_record/connection_adapters/postgresql_adapter'
+
+module ActiveRecord
+  # This is mostly copy pasta from https://github.com/rails/rails/blob/31ab3aa0e881acfd1475abae602455905a4cadf1/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb#L20-L42
+  module ConnectionHandling
+    VALID_PGBOUNCER_CONN_PARAMS = [:host, :hostaddr, :port, :dbname, :user, :password, :connect_timeout,
+                         :client_encoding, :options, :application_name, :fallback_application_name,
+                         :keepalives, :keepalives_idle, :keepalives_interval, :keepalives_count,
+                         :tty, :sslmode, :requiressl, :sslcompression, :sslcert, :sslkey,
+                         :sslrootcert, :sslcrl, :requirepeer, :krbsrvname, :gsslib, :service]
+
+    # Establishes a connection to the database that's used by all Active Record objects
+    def pgbouncer_connection(config)
+      pgbouncer = ConnectionAdapters::PgBouncerAdapter
+
+      conn_params = config.symbolize_keys
+      mode = conn_params[:pooling_mode]
+
+      raise "Unknown pooling mode provided: #{mode}" unless pgbouncer::POOLING_MODES.include?(mode)
+      disable_session = mode == pgbouncer::TRANSACTION_POOLING || mode == pgbouncer::STATEMENT_POOLING
+      raise "Prepared statements cannot be used with pgbouncer in #{mode} pooling mode" if disable_session && conn_params[:prepared_statements]
+      raise "Session level variables cannot be used with pgbouncer in #{mode} pooling mode" if disable_session && conn_params[:variables]
+
+      conn_params.delete_if { |_, v| v.nil? }
+
+      # Map ActiveRecords param names to PGs.
+      conn_params[:user] = conn_params.delete(:username) if conn_params[:username]
+      conn_params[:dbname] = conn_params.delete(:database) if conn_params[:database]
+
+      # Forward only valid config params to PGconn.connect.
+      conn_params.keep_if { |k, _| VALID_CONN_PARAMS.include?(k) }
+
+      # The postgres drivers don't allow the creation of an unconnected PGconn object,
+      # so just pass a nil connection object for the time being.
+      pgbouncer::new(mode, nil, logger, conn_params, config)
+    end
+  end
+end
+
+module ActiveRecord
+  module ConnectionAdapters
+    class PgBouncerAdapter < PostgreSQLAdapter
+      # Most polite method. When client connects, a server connection will be
+      # assigned to it for the whole duration it stays connected. When client
+      # disconnects, the server connection will be put back into pool. This
+      # mode supports all PostgeSQL features.
+      SESSION_POOLING = 'session'.freeze
+
+      # Server connection is assigned to client only during a transaction. When
+      # PgBouncer notices that transaction is over, the server will be put back
+      # into pool. This mode breaks few session-based features of PostgreSQL.
+      # You can use it only when application cooperates by not using features
+      # that break. See the table below for incompatible features.
+      TRANSACTION_POOLING = 'transaction'.freeze
+
+      # Most aggressive method. This is transaction pooling with a twist -
+      # multi-statement transactions are disallowed. This is meant to enforce
+      # "autocommit" mode on client, mostly targeted for PL/Proxy.
+      STATEMENT_POOLING = 'statement'.freeze
+
+      POOLING_MODES = [SESSION_POOLING, TRANSACTION_POOLING, STATEMENT_POOLING]
+
+      attr_reader :pooling_mode
+
+      def initialize(pooling_mode, connection, logger, connection_parameters, config)
+        @pooling_mode = pooling_mode
+        super(connection, logger, connection_parameters, config)
+      end
+
+      # The PostgreSQL adapter sets a number of session level settings. In
+      # transaction pooling mode, this will have undesirable results, since
+      # each `SET` statement is not gauranteed to be executed with the same
+      # backend connection.
+      #
+      # Instead, when using this adapter, you should set a connect_query that sets the following:
+      #
+      #   set client_encoding = 'UTF8'
+      #   set client_min_messages = 'warning'
+      #   set standard_conforming_strings = 'on'
+      #   set timezone = 'UTC'
+      #
+      # See https://github.com/rails/rails/blob/a456acb2f2af8365eb9151c7cd2d5a10c189d191/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb#L648-L678
+      def configure_connection
+        if pooling_mode == TRANSACTION_POOLING || pooling_mode == STATEMENT_POOLING
+          # NOOP
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/active_record/pgbouncer.rb

@@ -0,0 +1,3 @@
+require 'active_record'
+require 'active_record/pgbouncer/version'
+require 'active_record/connection_adapters/pgbouncer_adapter'

data/lib/active_record/pgbouncer/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module PgBouncer
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-pgbouncer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric J. Holmes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActiveRecord connection adapter for safe PgBouncer use
+email:
+- eric@remind101.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- activerecord-pgbouncer.gemspec
+- lib/active_record/connection_adapters/pgbouncer_adapter.rb
+- lib/active_record/pgbouncer.rb
+- lib/active_record/pgbouncer/version.rb
+homepage: https://github.com/remind101/activerecord-pgbouncer
+licenses:
+- MIT
+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
+signing_key: 
+specification_version: 4
+summary: ActiveRecord connection adapter for safe PgBouncer use
+test_files: []