distribute_reads 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b58c208898bdc32763b35155e78946bd6a2cec3f
+  data.tar.gz: 758dbc1bd72a7d2541435f4e1bcca5d795ad230d
+SHA512:
+  metadata.gz: 3c46fd083ba3256c568e89f27c77d22a042fcbae6f56ae7a0b58f0f7f81217cff7f2ca1f189b4052a302238a7e96672bce6ff04ac3964db515be6f46c9fc9b7f
+  data.tar.gz: 0ba5b6f61fca1d3f9825147cdcead1eb8f267df86a05c61022b7f1e4f41b6c75d6c66510ce35cd91ccccfd12a3793688788f46818d69fc7b292b70f1af607cbf

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- First release

data/Gemfile

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

data/README.md

@@ -0,0 +1,84 @@
+# Distribute Reads
+
+Scale database reads to replicas in Rails
+
+:tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'distribute_reads'
+```
+
+## How to Use
+
+[Makara](https://github.com/taskrabbit/makara) does most of the work. First, update `database.yml` to use it:
+
+```yml
+default: &default
+  adapter: postgresql_makara
+  makara:
+    sticky: true
+    connections:
+      - role: master
+        name: primary
+        url: <%= ENV["PRIMARY_DATABASE_URL"] %>
+      - name: replica
+        url: <%= ENV["REPLICA_DATABASE_URL"] %>
+
+development:
+  <<: *default
+
+production:
+  <<: *default
+```
+
+**Note:** You can use the same instance for the primary and replica in development.
+
+By default, all reads go to the primary instance. To use the replica, do:
+
+```ruby
+distribute_reads { User.count }
+```
+
+Works with multiple queries as well.
+
+```ruby
+distribute_reads do
+  User.find_each do |user|                 # replica
+    user.orders_count = user.orders.count  # replica
+    user.save!                             # primary
+  end
+end
+```
+
+## Options
+
+Raise an error when replica lag is too high - *PostgreSQL only*
+
+```ruby
+distribute_reads(max_lag: 3) do
+  # raises DistributeReads::TooMuchLag
+end
+```
+
+Don’t default to primary (default Makara behavior)
+
+```ruby
+DistributeReads.default_to_primary = false
+```
+
+## History
+
+View the [changelog](https://github.com/ankane/distribute_reads/blob/master/CHANGELOG.md)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/distribute_reads/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/distribute_reads/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+end
+
+task default: :test

data/distribute_reads.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "distribute_reads/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "distribute_reads"
+  spec.version       = DistributeReads::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+
+  spec.summary       = "Scale database reads with replicas in Rails"
+  spec.homepage      = "https://github.com/ankane/distribute_reads"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "makara"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pg"
+end

data/lib/distribute_reads/appropriate_pool.rb

@@ -0,0 +1,17 @@
+module DistributeReads
+  module AppropriatePool
+    def _appropriate_pool(*args)
+      if Thread.current[:distribute_reads]
+        if needs_master?(*args) || @slave_pool.completely_blacklisted? || in_transaction?
+          @master_pool
+        else
+          @slave_pool
+        end
+      elsif DistributeReads.default_to_primary
+        @master_pool
+      else
+        super
+      end
+    end
+  end
+end

data/lib/distribute_reads/global_methods.rb

@@ -0,0 +1,16 @@
+module DistributeReads
+  module GlobalMethods
+    def distribute_reads(max_lag: nil)
+      previous_value = Thread.current[:distribute_reads]
+      begin
+        if max_lag && DistributeReads.lag > max_lag
+          raise DistributeReads::TooMuchLag, "Replica lag over #{max_lag} seconds"
+        end
+        Thread.current[:distribute_reads] = true
+        yield
+      ensure
+        Thread.current[:distribute_reads] = previous_value
+      end
+    end
+  end
+end

data/lib/distribute_reads/version.rb

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

data/lib/distribute_reads.rb

@@ -0,0 +1,25 @@
+require "makara"
+require "distribute_reads/appropriate_pool"
+require "distribute_reads/global_methods"
+require "distribute_reads/version"
+
+module DistributeReads
+  class TooMuchLag < StandardError; end
+
+  class << self
+    attr_accessor :default_to_primary
+  end
+  self.default_to_primary = true
+
+  def self.lag
+    conn = ActiveRecord::Base.connection
+    if %w(PostgreSQL PostGIS).include?(conn.adapter_name)
+      conn.execute("SELECT EXTRACT(EPOCH FROM NOW() - pg_last_xact_replay_timestamp()) AS lag").first["lag"].to_f
+    else
+      raise "Option not supported with this adapter"
+    end
+  end
+end
+
+Makara::Proxy.send :prepend, DistributeReads::AppropriatePool
+Object.send :include, DistributeReads::GlobalMethods

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: distribute_reads
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: makara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: minitest
+  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: pg
+  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:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- distribute_reads.gemspec
+- lib/distribute_reads.rb
+- lib/distribute_reads/appropriate_pool.rb
+- lib/distribute_reads/global_methods.rb
+- lib/distribute_reads/version.rb
+homepage: https://github.com/ankane/distribute_reads
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Scale database reads with replicas in Rails
+test_files: []