active_replica 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62270bf7218e6092a6784dc3bc70ca520408d72b
+  data.tar.gz: 3a76c3a4c55fdf265f00beb76eefed3b438d191d
+SHA512:
+  metadata.gz: 60b2681df0166bfdc6b0aa92e115f54ac95d10ad9f72d8f313d239042da67d783731e5687c5a8ee4acbc0b458f843e0707b971f5a75c68d23f1047d55b25a88f
+  data.tar.gz: d375463a1adf65a23177f8908abcf7674d1373fd5308846db4dc3166aba08c64cf5e5ae3bca74b4424c23ea0bafbd48dda6d38721f1e31cdc36b1dcc53023205

data/.gitignore

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

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+activereplica

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.2.2
+
+gemfile:
+  - gemfiles/Gemfile.rails-4.2
+  - gemfiles/Gemfile.rails-5.0-beta
+
+script: bundle exec rspec spec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activereplica.gemspec
+gemspec
+
+gem 'rspec'
+gem 'sqlite3'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 GoGoTech
+
+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,46 @@
+# ActiveReplica
+
+[![Build Status](https://travis-ci.org/gogovan/active_replica.svg?branch=master)](https://travis-ci.org/gogovan/active_replica)
+
+ActiveReplica makes it super-easy (and performant) to use a read-only replica with ActiveRecord
+
+## Installation
+
+```ruby
+gem 'activereplica'
+```
+
+## Usage
+
+```
+# add named replicas
+>> ActiveReplica.add_replica(:follower_1, adapter: "sqlite3", database: "replica1.sqlite")
+>> ActiveReplica.add_replica(:follower_2, adapter: "sqlite3", database: "replica2.sqlite")
+
+# get a list of replicas
+>> ActiveReplica.replicas
+=> [:follower_1, :follower_2]
+
+# use a specified replica
+>> ActiveReplica.with_replica(:follower_1) do
+>>   User.count
+>> end
+```
+
+That's it
+
+## Logging
+
+Replica logging is not enabled by default.
+
+If you want it, you can just require it.
+
+```
+require 'active_replica/logging'
+```
+
+Then your logs will get decorated.
+
+```
+[Replica: follower_1]   (6.6ms)  SELECT COUNT(*) FROM "users"
+```

data/Rakefile

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

data/active_replica.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_replica/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_replica"
+  spec.version       = ActiveReplica::VERSION
+  spec.authors       = ["Matthew Rudy Jacobs"]
+  spec.email         = ["matthewrudyjacobs@gmail.com"]
+
+  spec.summary       = %q{Simple, performant Read-Only replicas with ActiveRecord}
+  spec.description   = %q{Add shards, and switch between them for key tasks}
+  spec.homepage      = "https://github.com/gogovan/active_replica"
+  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 'activesupport', '>= 4.2.0', '< 5.1.0'
+  spec.add_dependency 'activerecord', '>= 4.2.0', '< 5.1.0'
+  spec.add_dependency 'concurrent-ruby', '~> 1.0'
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activereplica"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

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

data/gemfiles/Gemfile.rails-4.2

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem "activerecord", "~> 4.2.5"
+gem "activesupport", "~> 4.2.5"
+
+gemspec path: "../"
+
+gem 'rspec'
+gem 'sqlite3'

data/gemfiles/Gemfile.rails-5.0-beta

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem "activerecord", "~> 5.0.0.beta1"
+gem "activesupport", "~> 5.0.0.beta1"
+
+gemspec path: "../"
+
+gem 'rspec'
+gem 'sqlite3'

data/lib/active_replica.rb

@@ -0,0 +1,49 @@
+require 'active_replica/version'
+require 'active_replica/connection_handler'
+require 'active_replica/railtie' if defined?(Rails)
+require 'active_support/core_ext/module/attribute_accessors' # mattr_accessor
+
+module ActiveReplica
+  mattr_accessor :connection_handler
+
+  def self.setup(active_record)
+    default_handler = active_record.default_connection_handler
+    active_handler = ActiveReplica::ConnectionHandler.new(default_handler)
+    self.connection_handler = active_handler
+    ActiveRecord::Base.default_connection_handler = active_handler
+  end
+
+  def self.add_replica(name, config)
+    handler = handler_for_config(config)
+    self.connection_handler.add_shard(name, handler)
+  end
+
+  def self.replicas
+    self.connection_handler.shards
+  end
+
+  def self.active_replica
+    ActiveReplica::RuntimeRegistry.active_replica
+  end
+
+  def self.with_replica(name)
+    before = ActiveReplica::RuntimeRegistry.active_replica
+    ActiveReplica::RuntimeRegistry.active_replica = name
+    self.connection_handler.with_shard(name) do
+      yield
+    end
+  ensure
+    ActiveReplica::RuntimeRegistry.active_replica = before
+  end
+
+  def self.handler_for_config(config)
+    spec = spec_for_config(config)
+    ActiveRecord::ConnectionAdapters::ConnectionHandler.new.tap do |handler|
+      handler.establish_connection(ActiveRecord::Base, spec)
+    end
+  end
+
+  def self.spec_for_config(config)
+    ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new("replica" => config).spec(:replica)
+  end
+end

data/lib/active_replica/connection_handler.rb

@@ -0,0 +1,120 @@
+require 'active_support/core_ext/module/delegation'
+require 'active_replica/runtime_registry'
+require 'concurrent'
+
+module ActiveReplica
+  # This class works the same as the default ActiveRecord ConnectionHandler
+  # with each method carefully copied and delegated appropriately
+  #
+  # for single pool operations it delegates to the current active handler
+  # for operations over the whole connecton pool list, it delegates to each handler
+  #
+  class ConnectionHandler
+    def initialize(default_connection_handler)
+      @shard_to_connection_handler = Concurrent::Map.new(initial_capacity: 2)
+      @default_connection_handler = default_connection_handler
+    end
+
+    # easy failover to the default
+    attr_reader :default_connection_handler
+
+    # the key to the whole thing
+    # let us switch the active connection handler
+    #
+    private def active_connection_handler
+      ActiveReplica::RuntimeRegistry.connection_handler || default_connection_handler
+    end
+
+    private def active_connection_handler=(connection_handler)
+      ActiveReplica::RuntimeRegistry.connection_handler = connection_handler
+    end
+
+    # add a shard with connection handler
+    #
+    def add_shard(shard, connection_handler)
+      @shard_to_connection_handler[shard] = connection_handler
+    end
+
+    # get the list of shard names
+    #
+    def shards
+      @shard_to_connection_handler.keys
+    end
+
+    # get the shard with the connection handler
+    #
+    def get_shard(shard)
+      @shard_to_connection_handler[shard] or fail "no handler for shard #{shard.inspect}"
+    end
+
+    # fetch the shard and use it
+    #
+    def with_shard(shard)
+      connection_handler = get_shard(shard)
+      with_connection_handler(connection_handler) do
+        yield
+      end
+    end
+
+    # switch the handler for the current thread
+    # and ensure its put back at the end
+    #
+    def with_connection_handler(connection_handler)
+      before = active_connection_handler
+      self.active_connection_handler = connection_handler
+      yield
+    ensure
+      self.active_connection_handler = before
+    end
+
+    # grab the full list of connection handlers
+    # to enable clean up methods
+    #
+    private def connection_handler_list
+      @shard_to_connection_handler.values + [default_connection_handler].compact
+    end
+
+    # the connection pool list is used for various cleaning tasks
+    # it should be modified to return the full list
+    # mapped over all children
+    #
+    def connection_pool_list
+      connection_handler_list.flat_map(&:connection_pool_list)
+    end
+    alias :connection_pools :connection_pool_list
+
+    # delegate establishing a connection to the active handler
+    #
+    delegate :establish_connection,
+             to: :active_connection_handler
+
+    # the active connection method should just delegate
+    #
+    def active_connections?
+      connection_handler_list.any?(&:active_connections)
+    end
+
+    # the clear connection methods can be delegated to each connection handler
+    #
+    def clear_active_connections!
+      connection_handler_list.each(&:clear_active_connections!)
+    end
+
+    def clear_reloadable_connections!
+      connection_handler_list.each(&:clear_reloadable_connections!)
+    end
+
+    def clear_all_connections!
+      connection_handler_list.each(&:clear_all_connections!)
+    end
+
+    # individual handler methods
+    # we should just delegate to the active handler
+    #
+    delegate :retrieve_connection,
+             :connected?,
+             :remove_connection,
+             :retrieve_connection_pool,
+             to: :active_connection_handler
+  end
+end

data/lib/active_replica/logging.rb

@@ -0,0 +1,55 @@
+# Implementation courtesy of db-charmer.
+# Via Octopus
+module ActiveReplica
+  module AdapterExtension
+    class InstrumenterDecorator < BasicObject
+      def initialize(adapter, instrumenter)
+        @adapter = adapter
+        @instrumenter = instrumenter
+      end
+
+      def instrument(name, payload = {}, &block)
+        payload[:active_replica] = ::ActiveReplica.active_replica
+        @instrumenter.instrument(name, payload, &block)
+      end
+
+      def method_missing(meth, *args, &block)
+        @instrumenter.send(meth, *args, &block)
+      end
+    end
+
+    def self.included(base)
+      base.alias_method_chain :initialize, :active_replica
+    end
+
+    def active_replica
+      @config[:active_replica]
+    end
+
+    def initialize_with_active_replica(*args)
+      initialize_without_active_replica(*args)
+      @instrumenter = InstrumenterDecorator.new(self, @instrumenter)
+    end
+  end
+
+  module LogSubscriber
+    def self.included(base)
+      base.send(:attr_accessor, :active_replica)
+      base.alias_method_chain :sql, :active_replica
+      base.alias_method_chain :debug, :active_replica
+    end
+
+    def sql_with_active_replica(event)
+      self.active_replica = event.payload[:active_replica]
+      sql_without_active_replica(event)
+    end
+
+    def debug_with_active_replica(msg)
+      conn = active_replica ? color("[Replica: #{active_replica}]", ActiveSupport::LogSubscriber::GREEN, true) : ''
+      debug_without_active_replica(conn + msg)
+    end
+  end
+end
+
+ActiveRecord::LogSubscriber.send(:include, ActiveReplica::LogSubscriber)
+ActiveRecord::ConnectionAdapters::AbstractAdapter.send(:include, ActiveReplica::AdapterExtension)

data/lib/active_replica/railtie.rb

@@ -0,0 +1,17 @@
+require 'active_replica'
+
+begin
+  require 'rails/railtie'
+
+  module ActiveReplica
+    class Railtie < Rails::Railtie # :nodoc:
+      initializer 'active_replica.initialize' do
+        ActiveSupport.on_load(:active_record) do
+          ActiveReplica.setup(ActiveRecord::Base)
+        end
+      end
+    end
+  end
+rescue LoadError
+  warn "can't load railtie"
+end

data/lib/active_replica/runtime_registry.rb

@@ -0,0 +1,19 @@
+require 'active_support/per_thread_registry'
+
+module ActiveReplica
+  # This is a thread locals registry for ActiveReplica.
+  #
+  # Taken from ActiveRecord's equivalent
+  # we use it to switch and access the connection_handler
+  #
+  class RuntimeRegistry # :nodoc:
+    extend ActiveSupport::PerThreadRegistry
+
+    attr_accessor :active_replica, :connection_handler
+
+    [:active_replica, :connection_handler].each do |val|
+      class_eval %{ def self.#{val}; instance.#{val}; end }, __FILE__, __LINE__
+      class_eval %{ def self.#{val}=(x); instance.#{val}=x; end }, __FILE__, __LINE__
+    end
+  end
+end

data/lib/active_replica/version.rb

@@ -0,0 +1,3 @@
+module ActiveReplica
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: active_replica
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Matthew Rudy Jacobs
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !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.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: Add shards, and switch between them for key tasks
+email:
+- matthewrudyjacobs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_replica.gemspec
+- bin/console
+- bin/setup
+- gemfiles/Gemfile.rails-4.2
+- gemfiles/Gemfile.rails-5.0-beta
+- lib/active_replica.rb
+- lib/active_replica/connection_handler.rb
+- lib/active_replica/logging.rb
+- lib/active_replica/railtie.rb
+- lib/active_replica/runtime_registry.rb
+- lib/active_replica/version.rb
+homepage: https://github.com/gogovan/active_replica
+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.8
+signing_key: 
+specification_version: 4
+summary: Simple, performant Read-Only replicas with ActiveRecord
+test_files: []