knockoff 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0025a70e9bc0d93706b972c83a1bf27ed62a836
+  data.tar.gz: 7eada472ea6751980a6109d047f7600cce5590a3
+SHA512:
+  metadata.gz: 7743e8ea20c39af558a3425d4b2e565dad7b9f38967833eeaece006874aba0662d364b8383b87c699448750feca896eced1e4bd54de7b9831c55f82cc2fcbcad
+  data.tar.gz: 6d1a25ea1b2578529e59b22ac11668a1d13355b2857000a83a169f91eb28cc2e3bcdff94356e0c5544df9de81503fb100acffc27503bae3168b38d41a9f04e22

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,7 @@
+language: ruby
+notifications:
+  email: false
+rvm:
+  - 2.2.4
+  - 2.3.1
+  - ruby-head

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in knockoff.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Scott Ringwelski
+
+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,53 @@
+# Knockoff (WIP)
+
+[![Build Status](https://travis-ci.org/sgringwe/knockoff.svg?branch=master)](https://travis-ci.org/sgringwe/knockoff)
+
+A gem for easily using read replicas. Heavily based off of https://github.com/kenn/slavery and https://github.com/kickstarter/replica_pools gem.
+
+## Library Goals
+
+* Minimal ActiveRecord monkey-patching
+* Easy run-time configuration using ENV variables
+* Opt-in usage of replicas
+* No need to change code when adding/removing replicas
+* Be thread safe
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'knockoff'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install knockoff
+
+## Usage
+
+TODO
+
+### Usage Notes
+
+* Do not use prepared statements with this gem
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/knockoff.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "knockoff"
+
+# 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/ci/install_modern_sqlite.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+set -e # halt script on error
+
+sudo apt-get autoremove sqlite3
+sudo apt-get install python-software-properties
+sudo apt-add-repository -y ppa:travis-ci/sqlite3
+sudo apt-get -y update
+sudo apt-cache show sqlite3
+sudo apt-get install sqlite3=3.7.15.1-1~travis1
+sudo sqlite3 -version
+sudo psql --version
+sudo mysql --version
+gem update bundler

data/knockoff.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'knockoff/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "knockoff"
+  spec.version       = Knockoff::VERSION
+  spec.authors       = ["Scott Ringwelski"]
+  spec.email         = ["me@sgringwe.com"]
+
+  spec.summary       = %q{A gem for easily using read replicas}
+  spec.homepage      = "https://github.com/sgringwe/knockoff"
+  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_runtime_dependency 'activerecord', '>= 4.0.0'
+  spec.add_runtime_dependency 'request_store_rails', '>= 1.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'sqlite3'
+end

data/lib/knockoff.rb

@@ -0,0 +1,52 @@
+require 'active_record'
+require 'request_store_rails'
+require 'knockoff/version'
+require 'knockoff/base'
+require 'knockoff/config'
+require 'knockoff/error'
+require 'knockoff/replica_connection_pool'
+require 'knockoff/active_record/base'
+require 'knockoff/active_record/relation'
+
+module Knockoff
+  class << self
+    attr_accessor :enabled
+    attr_writer :spec_key
+
+    def spec_key
+      case @spec_key
+      when String   then @spec_key
+      when NilClass then @spec_key = "#{ActiveRecord::ConnectionHandling::RAILS_ENV.call}_replica"
+      end
+    end
+
+    def on_replica(&block)
+      Base.new(:replica).run(&block)
+    end
+
+    def on_primary(&block)
+      Base.new(:primary).run(&block)
+    end
+
+    def replica_pool
+      @replica_pool ||= ReplicaConnectionPool.new(config.replica_uris)
+    end
+
+    def config
+      @config ||= Config.new
+    end
+
+    def base_transaction_depth
+      @base_transaction_depth ||= begin
+        testcase = ActiveSupport::TestCase
+        if defined?(testcase) &&
+            testcase.respond_to?(:use_transactional_fixtures) &&
+            testcase.try(:use_transactional_fixtures)
+          1
+        else
+          0
+        end
+      end
+    end
+  end
+end

data/lib/knockoff/active_record/base.rb

@@ -0,0 +1,28 @@
+module ActiveRecord
+  class Base
+    class << self
+      alias_method :original_connection, :connection
+
+      def connection
+        case RequestLocals.fetch(:knockoff) { nil }
+        when :replica
+          # Attempts to use a random replica connection, but otherwise falls back to primary
+          Knockoff.replica_pool.random_replica_connection.original_connection
+        when :primary, NilClass
+          original_connection
+        else
+          raise Knockoff::Error, "Invalid target: #{RequestLocals.fetch(:knockoff)}"
+        end
+      end
+
+      # Generate scope at top level e.g. User.on_replica
+      def on_replica
+        # Why where(nil)?
+        # http://stackoverflow.com/questions/18198963/with-rails-4-model-scoped-is-deprecated-but-model-all-cant-replace-it
+        context = where(nil)
+        context.knockoff_target = :replica
+        context
+      end
+    end
+  end
+end

data/lib/knockoff/active_record/relation.rb

@@ -0,0 +1,28 @@
+module ActiveRecord
+  class Relation
+    attr_accessor :knockoff_target
+
+    # Supports queries like User.on_replica.to_a
+    alias_method :exec_queries_without_knockoff, :exec_queries
+
+    def exec_queries
+      if knockoff_target == :replica
+        Knockoff.on_replica { exec_queries_without_knockoff }
+      else
+        exec_queries_without_knockoff
+      end
+    end
+
+
+    # Supports queries like User.on_replica.count
+    alias_method :calculate_without_knockoff, :calculate
+
+    def calculate(*args)
+      if knockoff_target == :replica
+        Knockoff.on_replica { calculate_without_knockoff(*args) }
+      else
+        calculate_without_knockoff(*args)
+      end
+    end
+  end
+end

data/lib/knockoff/base.rb

@@ -0,0 +1,36 @@
+module Knockoff
+  class Base
+    def initialize(target)
+      @target = decide_with(target)
+    end
+
+    def run(&block)
+      run_on @target, &block
+    end
+
+  private
+
+    def decide_with(target)
+      raise Knockoff::Error.new('on_slave cannot be used inside transaction block!') if inside_transaction?
+
+      if Knockoff.enabled
+        target
+      else
+        :primary
+      end
+    end
+
+    def inside_transaction?
+      open_transactions = run_on(:primary) { ActiveRecord::Base.connection.open_transactions }
+      open_transactions > Knockoff.base_transaction_depth
+    end
+
+    def run_on(target)
+      backup = RequestLocals.fetch(:knockoff) { nil } # Save for recursive nested calls
+      RequestLocals.store[:knockoff] = target
+      yield
+    ensure
+      RequestLocals.store[:knockoff] = backup
+    end
+  end
+end

data/lib/knockoff/config.rb

@@ -0,0 +1,46 @@
+module Knockoff
+  class Config
+    # The current environment. Normally set to Rails.env, but
+    # will default to 'development' outside of Rails apps.
+    attr_accessor :environment
+
+    # An array of URIs to use for the replica pool.
+    # TODO: Add support for inheriting from database.yml
+    attr_accessor :replica_uris
+
+    def initialize
+      @environment = 'development'
+      set_replica_uris
+    end
+
+    def replica_env_keys
+      if ENV['KNOCKOFF_REPLICA_ENVS'].nil?
+        []
+      else
+        ENV['KNOCKOFF_REPLICA_ENVS'].split(',').map(&:strip)
+      end
+    end
+
+    private
+
+    def set_replica_uris
+      @replica_uris ||= parse_knockoff_replica_envs_to_uris
+    end
+
+    def parse_knockoff_replica_envs_to_uris
+      # As a basic prevention of crashes, attempt to parse each DB uri
+      # and don't add the uri to the final list if it can't be parsed
+      replica_env_keys.map do |env_key|
+        begin
+          URI.parse(ENV[env_key])
+        rescue URI::InvalidURIError
+          Rails.logger.info "LOG NOTIFIER: Invalid URL specified in follower_env_keys. Not including URI, which may result in no followers used." # URI is purposely not printed to logs
+          # Return a 'nil' which will be removed from
+          # configs with `compact`, resulting in no configs and no followers,
+          # therefore disabled since this env will not be in environments list.
+          nil
+        end
+      end.compact
+    end
+  end
+end

data/lib/knockoff/error.rb

@@ -0,0 +1,4 @@
+module Knockoff
+  class Error < StandardError
+  end
+end

data/lib/knockoff/replica_connection_pool.rb

@@ -0,0 +1,34 @@
+module Knockoff
+  class ReplicaConnectionPool
+    attr_reader :pool
+
+    def initialize(uris)
+      @pool = Concurrent::Hash.new
+
+      uris.each_with_index do |uri, index|
+        @pool["replica_#{index}"] = connection_class(index, uri)
+      end
+    end
+
+    def random_replica_connection
+      @pool[@pool.keys.sample]
+    end
+
+    # Based off of code from replica_pools gem
+    # generates a unique ActiveRecord::Base subclass for a single replica
+    def connection_class(replica_index, uri)
+      class_name = "Replica#{replica_index}"
+
+      # TODO: Hardcoding the uri string feels meh. Either set the database config
+      # or reference ENV instead
+      Knockoff.module_eval %Q{
+        class #{class_name} < ActiveRecord::Base
+          self.abstract_class = true
+          establish_connection '#{uri}'
+        end
+      }, __FILE__, __LINE__
+
+      Knockoff.const_get(class_name)
+    end
+  end
+end

data/lib/knockoff/version.rb

@@ -0,0 +1,3 @@
+module Knockoff
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: knockoff
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Scott Ringwelski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: request_store_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: 
+email:
+- me@sgringwe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ci/install_modern_sqlite.sh
+- knockoff.gemspec
+- lib/knockoff.rb
+- lib/knockoff/active_record/base.rb
+- lib/knockoff/active_record/relation.rb
+- lib/knockoff/base.rb
+- lib/knockoff/config.rb
+- lib/knockoff/error.rb
+- lib/knockoff/replica_connection_pool.rb
+- lib/knockoff/version.rb
+homepage: https://github.com/sgringwe/knockoff
+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: A gem for easily using read replicas
+test_files: []