active_replicas 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a1293906120bdb5cb8986952874432459e1595f
+  data.tar.gz: 36bfcfcddeeb3eafb1c867780c5fec272784c608
+SHA512:
+  metadata.gz: dc09554ca185d85c1e13198594e24ea0cb5231fefa8cfd50250bbcf0b4f9d62488980be816bde797c3f3ffee1244819691226d103a8a5699a387bd8ed60fbb09
+  data.tar.gz: 5aeed1edb7fcef59b66da87ba322e3d54291e9b7380cdb999da7b04251ac5e3d27bf3a3fb0337b90326494d2d033a8faba87ac7e9f61db91f2c2230a87d10cf3

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,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.3.2
+gemfile:
+  - gemfiles/rails_4.gemfile
+
+script: bundle exec rspec

data/Appraisals

@@ -0,0 +1,3 @@
+appraise 'rails-4' do
+  gem 'rails', '~> 4.0'
+end

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dirk@esherido.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2016, Dirk Gadsden
+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.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+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,35 @@
+# ActiveReplicas
+
+Allows you to automatically send read-only queries to replica databases; writes will automatically go to the primary and "stick" the request into using the primary for any further queries.
+
+This is heavily inspired by [Kickstarter's `replica_pools`](https://github.com/kickstarter/replica_pools) gem. It seeks to improve on that gem by better interfacing with ActiveRecord's connection pools.
+
+## Installation & usage
+
+ActiveReplicas injects itself into ActiveRecord. To start you'll want to add it to your application's `Gemfile`:
+
+```ruby
+gem 'active_replicas'
+```
+
+You then need to instruct it as to which connection to use for the primary and which connection(s) to use for the read replicas:
+
+```ruby
+# config/initializers/active_replicas.rb
+ActiveReplicas::Railtie.hijack_active_record primary: { url: 'mysql2://user@primary/my_app' },
+                                             replicas: {
+                                               replica0: { url: 'mysql2://user@replica/my_app' }
+                                             }
+```
+
+**Note**: ActiveReplicas does not do anything automatically. It only injects itself into ActiveRecord when you tell it do so (see above).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub][]. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+[GitHub]: https://github.com/dirk/active_replicas
+
+## License
+
+Licensed under the 3-clause BSD license. See [LICENSE](LICENSE) for details.

data/Rakefile

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

data/active_replicas.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_replicas/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'active_replicas'
+  spec.version = ActiveReplicas::VERSION
+  spec.authors = [ 'Dirk Gadsden' ]
+  spec.email   = [ 'dirk@esherido.com' ]
+
+  spec.summary     = 'Smart read replicas in ActiveRecord.'
+  spec.description = 'Hooks into ActiveRecord to automatically sends reads to read replicas and writes to primary database.'
+  spec.homepage    = 'https://github.com/dirk/active_replicas'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.require_paths = [ 'lib' ]
+
+  spec.add_dependency 'concurrent-ruby', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'appraisal', '~> 2.1'
+end

data/bin/console

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+# Assumes this is being called from the project directory, not from this
+# `bin/` directory.
+cd example && bundle exec pry -r ./app.rb

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.2.7.1'
+gem 'sqlite3'
+gem 'mysql2'
+gem 'pry'

data/example/Gemfile.lock

@@ -0,0 +1,117 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.7.1)
+      actionview (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      globalid (>= 0.3.0)
+    activemodel (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+    activerecord (4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      arel (~> 6.0)
+    activesupport (4.2.7.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.2)
+    erubis (2.7.0)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.9.1)
+    mysql2 (0.4.5)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.5)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.7.1)
+      actionmailer (= 4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activerecord (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.7.1)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (11.3.0)
+    slop (3.6.0)
+    sprockets (3.7.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.12)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mysql2
+  pry
+  rails (~> 4.2.7.1)
+  sqlite3
+
+BUNDLED WITH
+   1.13.6

data/example/README.md

@@ -0,0 +1,19 @@
+# Sample app
+
+This is for development and testing purposes.
+
+## Getting started
+
+The sample app uses Bundler and MySQL to power a trivial single-file Rails application:
+
+```sh
+# cd example
+bundle install
+./setup_database.sh
+
+# To launch a console:
+bundle exec pry -r ./app.rb
+
+# To start a server:
+bundle exec rackup config.ru
+```

data/example/app.rb

@@ -0,0 +1,55 @@
+# Based off an example single-file Rails application:
+#   https://gist.github.com/shawndrost/1629835
+
+require 'rails/all'
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'active_replicas'
+
+require 'logger'
+Rails.logger = ActiveRecord::Base.logger = Logger.new STDOUT
+
+class Tester < Rails::Application
+  config.secret_key_base = 'abc123'
+end
+
+ActiveReplicas::Railtie.hijack_active_record primary: { url: 'mysql2://root@localhost/active_replicas' },
+                                             replicas: {
+                                               replica0: { url: 'mysql2://root@localhost/active_replicas' }
+                                             }
+
+# require 'sqlite3'
+# database_file = File.join(File.dirname(__FILE__), 'test.sqlite3')
+# SQLite3::Database.new(database_file).tap do |database|
+#   database.execute("drop table users;") rescue nil
+#   database.execute("create table users (id integer primary key autoincrement, email varchar(100), server_id integer);")
+# end
+# ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: database_file
+
+class User < ActiveRecord::Base
+end
+
+class UsersController < ActionController::Base
+  def index
+    # Will go to the primary but will let subsequent queries use replicas.
+    count = User.connection.with_primary { User.count }
+
+    # Will go to a replica.
+    users = User.all.map(&:email)
+
+    User.transaction do
+      # This will go to the primary.
+      User.create! email: Time.now.to_s
+    end
+
+    # Will also go to the primary since we didn't explicitly use the
+    # `with_primary` wrapper.
+    last_user = User.last&.email
+
+    render text: { count: count, users: users, last_user: last_user }.inspect
+  end
+end
+
+Tester.routes.draw do
+  root to: 'users#index'
+end

data/example/config.ru

@@ -0,0 +1,2 @@
+require './app'
+run Tester

data/example/setup_database.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+mysql -u root <<SQL
+  CREATE DATABASE IF NOT EXISTS active_replicas;
+  USE active_replicas;
+
+  DROP TABLE IF EXISTS users;
+  CREATE TABLE users (id INTEGER PRIMARY KEY AUTO_INCREMENT, email VARCHAR(255));
+SQL

data/gemfiles/rails_4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.gemfile.lock

@@ -0,0 +1,134 @@
+PATH
+  remote: ../
+  specs:
+    active_replicas (0.1.0)
+      concurrent-ruby (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.7.1)
+      actionview (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      globalid (>= 0.3.0)
+    activemodel (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+    activerecord (4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      arel (~> 6.0)
+    activesupport (4.2.7.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (6.0.3)
+    builder (3.2.2)
+    concurrent-ruby (1.0.2)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.9.1)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    rack (1.6.5)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.7.1)
+      actionmailer (= 4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activerecord (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.7.1)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    sprockets (3.7.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_replicas!
+  appraisal (~> 2.1)
+  bundler (~> 1.13)
+  rails (~> 4.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.13.6

data/lib/active_replicas/log_subscriber.rb

@@ -0,0 +1,56 @@
+require 'active_record/log_subscriber'
+
+module ActiveReplicas
+  class LogSubscriber < ActiveRecord::LogSubscriber
+    def sql(event)
+      self.class.runtime += event.duration
+      return unless logger.debug?
+
+      payload = event.payload
+
+      return if IGNORE_PAYLOAD_NAMES.include?(payload[:name])
+
+      pool  = nil
+      name  = "#{payload[:name]} (#{event.duration.round(1)}ms)"
+      sql   = payload[:sql]
+      binds = nil
+
+      proxy = ActiveRecord::Base.connection_handler.proxying_connection_pool
+      connection_pool = proxy.pool_which_owns_connection payload[:connection_id]
+      if connection_pool
+        role =
+          if proxy.primary_pool? connection_pool
+            'primary'
+          elsif proxy.replica_pool? connection_pool
+            pool_name = proxy.replica_pools.key connection_pool
+            "replica=#{pool_name}"
+          else
+            'unknown'
+          end
+
+        pool = "[#{role}] "
+      end
+
+      unless (payload[:binds] || []).empty?
+        binds = ' ' + payload[:binds].map { |column, value| render_bind(column, value) }.inspect
+      end
+
+      debug "#{pool}#{name} #{sql}#{binds}"
+    end
+
+    def logger
+      ActiveRecord::Base.logger
+    end
+
+    # Take over logging duties from `ActiveRecord::LogSubscriber`.
+    def self.hijack_active_record
+      self.attach_to :active_record
+
+      subscriber = ActiveSupport::Notifications.notifier.listeners_for('sql.active_record').find do |subscriber|
+        ActiveRecord::LogSubscriber === subscriber.instance_eval { @delegate }
+      end
+
+      ActiveSupport::Notifications.notifier.unsubscribe(subscriber) if subscriber
+    end
+  end
+end

data/lib/active_replicas/proxying_connection.rb

@@ -0,0 +1,64 @@
+module ActiveReplicas
+  class ProxyingConnection
+    def initialize(connection:, is_primary:, proxy:)
+      @connection = connection
+      @is_primary = is_primary
+      @proxy      = proxy
+    end
+
+    # Forwards a call to its own connection or back up to the proxy pool's
+    # primary connection.
+    #
+    # role   - Either `:primary` or `:replica`: indicates which database role
+    #          is necessary to execute this command.
+    # method - Symbol of method to send to a connection.
+    def delegate_to(role, method, *args, &block)
+      if @is_primary
+        @connection.send method, *args, &block
+      else
+        if role == :primary
+          # Need to get a primary connection from the proxy pool.
+          @proxy.primary_connection.send method, *args, &block
+        else
+          @connection.send method, *args, &block
+        end
+      end
+    end
+
+    # Helper method to easily use the primary pool from any model:
+    #
+    #   MyModel.connection.with_primary { ... }
+    def with_primary
+      @proxy.with_primary { yield }
+    end
+
+    # Returns the underlying proxied database connection.
+    def proxied_connection
+      @connection
+    end
+
+    class << self
+      # Partially cribbed from:
+      #    https://github.com/kickstarter/replica_pools/blob/master/lib/replica_pools/connection_proxy.rb#L20
+      def generate_replica_delegations
+        Railtie.replica_delegated_methods.each do |method|
+          generate_delegation method, :replica
+        end
+      end
+
+      def generate_primary_delegations
+        Railtie.primary_delegated_methods.each do |method|
+          generate_delegation method, :primary
+        end
+      end
+
+      def generate_delegation(method_name, role)
+        class_eval <<-END, __FILE__, __LINE__ + 1
+          def #{method_name}(*args, &block)
+            delegate_to(:#{role}, :#{method_name}, *args, &block)
+          end
+        END
+      end
+    end
+  end
+end

data/lib/active_replicas/proxying_connection_pool.rb

@@ -0,0 +1,146 @@
+module ActiveReplicas
+  # Manages connection pools to the primary and replica databases. Returns
+  # proxy connection instances from those pools on request.
+  #
+  # Also hanldes the internal state of switching back and forth from replica
+  # to primary connections based on heuristics or overrides.
+  class ProxyingConnectionPool
+    attr_reader :primary_pool, :replica_pools
+
+    def initialize(proxy_configuration)
+      @primary_pool = ProxyingConnectionPool.connection_pool_for_spec proxy_configuration[:primary]
+
+      @replica_pools = (proxy_configuration[:replicas] || {}).map do |name, config_spec|
+        [ name, ProxyingConnectionPool.connection_pool_for_spec(config_spec) ]
+      end.to_h
+
+      # Calls to `with_primary` will increment and decrement this.
+      @primary_depth = 0
+      # Current connection pool.
+      @current_pool = nil
+      # Thread-safe map of the connections from each pool. Cleared in tandem
+      # with the connection pools.
+      @connections = Concurrent::Map.new
+    end
+
+    # Returns an instance of `ActiveRecord::ConnectionAdapters::ConnectionPool`
+    # configured with the given specification.
+    def self.connection_pool_for_spec(spec)
+      @@resolver ||= ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new({})
+
+      # Turns a hash configuration into a `ConnectionSpecification` that can
+      # be passed to a `ConnectionPool`.
+      spec = @@resolver.spec config_spec.with_indifferent_access
+
+      ActiveRecord::ConnectionAdapters::ConnectionPool.new spec
+    end
+
+    # ConnectionPool interface methods
+    # ================================
+
+    def connection
+      pool = current_pool
+
+      @connections[pool] ||= begin
+        conn = pool.connection
+        return unless conn
+
+        ProxyingConnection.new connection: conn,
+                               is_primary: pool == @primary_pool,
+                               proxy:      self
+      end
+    end
+
+    def release_connection
+      each_pool &:release_connection
+
+      @primary_depth = 0
+      @current_pool = nil
+      @connections.clear
+    end
+
+    def connected?
+      current_pool.connected?
+    end
+
+    def disconnect!
+      each_pool &:disconnect!
+    end
+
+    def current_pool
+      if @current_pool == nil
+        @current_pool = next_pool
+      end
+
+      @current_pool
+    end
+
+    # Additional methods
+    # ==================
+
+    def with_primary
+      previous_pool = @current_pool
+
+      @primary_depth += 1
+      @current_pool = @primary_pool
+
+      yield connection
+    ensure
+      @primary_depth = [@primary_depth - 1, 0].max
+      @current_pool = previous_pool
+    end
+
+    # Quick accessor to a primary connection.
+    #
+    # NOTE: If this is not already in a `with_primary` block then calling this
+    #   will irreversably place the proxying pool in the primary state until
+    #   `clear_active_connections!` is called! If you want to *temporarily*
+    #   use the primary then explicitly do so using `with_primary`.
+    def primary_connection
+      if @primary_depth == 0
+        @primary_depth += 1
+        @current_pool = @primary_pool
+      end
+
+      connection
+    end
+
+    def each_pool
+      yield @primary_pool
+
+      @replica_pools.each do |_name, pool|
+        yield pool
+      end
+    end
+
+    def pool_which_owns_connection(object_id)
+      return @primary_pool if @primary_pool.connections.any? { |c| c.object_id == object_id }
+
+      @replica_pools.values.each do |pool|
+        return pool if pool.connections.any? { |c| c.object_id == object_id }
+      end
+
+      nil
+    end
+
+    def primary_pool?(pool)
+      pool == @primary_pool
+    end
+
+    def replica_pool?(pool)
+      @replica_pools.values.include? pool
+    end
+
+    private
+
+    def next_pool
+      replicas = @replica_pools.values
+
+      if replicas.empty?
+        @primary_pool
+      else
+        replicas.sample
+      end
+    end
+  end
+end

data/lib/active_replicas/rails4/connection_handler.rb

@@ -0,0 +1,52 @@
+require 'concurrent/map'
+
+module ActiveReplicas
+  module Rails4
+    # Wraps around Rails' `ActiveRecord::ConnectionAdapters::ConnectionHandler`
+    # to provide proxy wrappers around requested connections.
+    class ConnectionHandler
+      def initialize(proxy_configuration:, delegate: nil, overrides: nil)
+        @proxy_configuration = proxy_configuration
+        @delegate            = delegate
+        @overrides           = Set.new(overrides || [])
+
+        # Each process will get its own map of connection keys to database
+        # connection instances.
+        @process_to_connection_pool = Concurrent::Map.new
+      end
+
+      def establish_connection(owner, _spec)
+        raise "ActiveReplicas cannot establish connection for #{owner.name}"
+      end
+
+      def clear_active_connections!
+        proxying_connection_pool.release_connection
+      end
+
+      # Cribbed from:
+      #   https://github.com/rails/rails/blob/4-2-stable/activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb#L568
+      def retrieve_connection(klass)
+        pool = retrieve_connection_pool klass
+        raise ConnectionNotEstablished, "No connection pool for #{klass}" unless pool
+        conn = pool.connection
+        raise ConnectionNotEstablished, "No connection for #{klass} in connection pool" unless conn
+        conn
+      end
+
+      def retrieve_connection_pool(klass)
+        proxying_connection_pool
+      end
+
+      def connected?(klass)
+        pool = retrieve_connection_pool klass
+        pool && pool.connected?
+      end
+
+      def proxying_connection_pool
+        @process_to_connection_pool[Process.pid] ||= ProxyingConnectionPool.new(@proxy_configuration)
+      end
+    end
+  end
+
+  ConnectionHandler = Rails4::ConnectionHandler
+end

data/lib/active_replicas/railtie.rb

@@ -0,0 +1,41 @@
+module ActiveReplicas
+  class Railtie < Rails::Railtie
+    cattr_reader :connection_handler
+
+    cattr_accessor :replica_delegated_methods
+    cattr_accessor :primary_delegated_methods
+
+    @@replica_delegated_methods = [
+      :active?, :clear_query_cache, :column_name_for_operation, :columns,
+      :disable_query_cache!, :disconnect!, :enable_query_cache!,
+      :query_cache_enabled, :quote_column_name, :quote_table_name,
+      :raw_connection, :reconnect!, :sanitize_limit, :schema_cache, :select,
+      :select_all, :select_one, :select_rows, :select_value, :select_values,
+      :substitute_at, :to_sql, :verify!
+    ]
+
+    @@primary_delegated_methods = [
+      :insert, :next_sequence_value, :prefetch_primary_key?,
+      :transaction, :transaction_state, :update
+    ]
+
+    def self.hijack_active_record(proxy_configuration, overrides: [])
+      ProxyingConnection.generate_replica_delegations
+      ProxyingConnection.generate_primary_delegations
+
+      @@connection_handler =
+        ConnectionHandler.new proxy_configuration: proxy_configuration,
+                              delegate: ActiveRecord::Base.connection_handler,
+                              overrides: overrides
+
+      ActiveRecord::Base.class_eval do
+        def self.connection_handler
+          ActiveReplicas::Railtie.connection_handler
+        end
+      end
+
+      # Take over logging duties now that we're the main connection handler.
+      LogSubscriber.hijack_active_record
+    end
+  end
+end

data/lib/active_replicas/version.rb

@@ -0,0 +1,3 @@
+module ActiveReplicas
+  VERSION = "0.1.0"
+end

data/lib/active_replicas.rb

@@ -0,0 +1,16 @@
+require 'active_replicas/version'
+require 'active_replicas/log_subscriber'
+require 'active_replicas/proxying_connection'
+require 'active_replicas/proxying_connection_pool'
+
+if defined? ActiveRecord
+  version = ActiveRecord::VERSION::MAJOR
+
+  if version == 4
+    require 'active_replicas/rails4/connection_handler'
+  else
+    raise "Unsupported ActiveRecord version: #{version}"
+  end
+end
+
+require 'active_replicas/railtie' if defined? Rails

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: active_replicas
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dirk Gadsden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Hooks into ActiveRecord to automatically sends reads to read replicas
+  and writes to primary database.
+email:
+- dirk@esherido.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- active_replicas.gemspec
+- bin/console
+- bin/setup
+- example/Gemfile
+- example/Gemfile.lock
+- example/README.md
+- example/app.rb
+- example/config.ru
+- example/setup_database.sh
+- gemfiles/rails_4.gemfile
+- gemfiles/rails_4.gemfile.lock
+- lib/active_replicas.rb
+- lib/active_replicas/log_subscriber.rb
+- lib/active_replicas/proxying_connection.rb
+- lib/active_replicas/proxying_connection_pool.rb
+- lib/active_replicas/rails4/connection_handler.rb
+- lib/active_replicas/railtie.rb
+- lib/active_replicas/version.rb
+homepage: https://github.com/dirk/active_replicas
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Smart read replicas in ActiveRecord.
+test_files: []