active_replicas 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e56f8bd047e2f96b83a8246b4cdbcd428dd4e095
-  data.tar.gz: e02a7e2680c7bc60aa47c2cd75a25ca704f3a5c5
+  metadata.gz: e5449461c40a999c9979801ce9395a9a7f3c43d3
+  data.tar.gz: 3a222a36c5715a2ae8709f7359d77ec3210114a3
 SHA512:
-  metadata.gz: f430544ad26fd4f894addafb5961ea1cfc5aabf99fc565a206556bf70d302efe7afc4b4ae4447345c95c4ec1793d95d109400aa1995b7e72bfe4c1c644d2276e
-  data.tar.gz: 755fc9c0a43f3860d4c8f2f5b7ef984740f401a51b10dc50c29f0da1bf964648df7d813457272529ab9da73177ce4e2a94db7e64b9e03d622fa305b0e8c57f66
+  metadata.gz: 3ce1364563eff9ec842ad01446747f45c0815cca827a251411158f3b7d67d481a930e6af8bedddc32219b561e311753c9406cfe3e5873a0cccc1afcfb5b55e57
+  data.tar.gz: 17314509e2bdfdc639bc9c608d03e050a5f291f1a2cead0057e4ebd05ff3bbf5d90809bbdd3def2d21581bd0be1526205c86b19fc47acaee6a5389b7d5bbce2c

data/README.md

@@ -1,6 +1,8 @@
 # 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.
+[![Build Status](https://travis-ci.org/dirk/active_replicas.svg?branch=master)](https://travis-ci.org/dirk/active_replicas)
+
+Drop-in read-replica querying in ActiveRecord. It proxies around ActiveRecord's connection to 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.
 
@@ -24,6 +26,20 @@ ActiveReplicas::Railtie.hijack_active_record primary: { url: 'mysql2://user@prim
 
 **Note**: ActiveReplicas does not do anything automatically. It only injects itself into ActiveRecord when you tell it do so (see above).
 
+## How it works
+
+A few things happen when you call [`hijack_active_record`](http://www.rubydoc.info/github/dirk/active_replicas/master/ActiveReplicas/Railtie#hijack_active_record-class_method):
+
+- It defines delegations for the [connection](http://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters.html) methods that can be sent to replicas and the methods that must be sent to a primary.
+- It sets up a [`ConnectionHandler`](http://www.rubydoc.info/github/dirk/active_replicas/master/ActiveReplicas/Rails4/ConnectionHandler) that will act in place of ActiveRecord's normal connection handler.
+- It replaces ActiveRecord's log subscriber with its own [`LogSubscriber`](http://www.rubydoc.info/github/dirk/active_replicas/master/ActiveReplicas/LogSubscriber) which adds information about replica/primary status to logging messages.
+
+The new connection handler manages connection pools for each configured primary and replica database(s). Externally it provides instances of [`ProxyingConnectionPool`](http://www.rubydoc.info/github/dirk/active_replicas/master/ActiveReplicas/ProxyingConnectionPool) in place of normal connection pools. Those proxying pools then forward connection methods to primary or replica pools.
+
+### Using it with Ruby on Rails
+
+ActiveReplicas works seamlessly within the Rails request lifecycle. It extends the [`clear_active_connections!` called in ActiveRecord's middleware](https://github.com/rails/rails/blob/4-2-stable/activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb#L645-L663) to not only clear the active connections (releasing them back to their respective pool) but also resets the primary/replica state. That way the next connection will start out using a replica.
+
 ## 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.

data/lib/active_replicas/rails4/process_local_connection_handler.rb

@@ -13,12 +13,7 @@ module ActiveReplicas
 
       def initialize(proxy_configuration)
         @proxy_configuration = proxy_configuration
-
-        @primary_pool = Helpers.connection_pool_for_spec @proxy_configuration[:primary]
-
-        @replica_pools = (@proxy_configuration[:replicas] || {}).map do |name, config_spec|
-          [name, Helpers.connection_pool_for_spec(config_spec)]
-        end.to_h
+        initialize_pools
 
         # Each thread gets its own `ProxyingConnectionPool`.
         @reserved_proxies = Concurrent::Map.new
@@ -33,10 +28,23 @@ module ActiveReplicas
 
       def establish_connection(owner, spec)
         prefix = '[ActiveReplicas::Rails4::ConnectionHandler#establish_connection]'
-        ActiveRecord::Base.logger&.warn "#{prefix} Ignoring spec for #{owner.inspect}: #{spec.inspect}"
-        ActiveRecord::Base.logger&.info "#{prefix} Called from:\n" + Kernel.caller.first(5).map {|t| "  #{t}" }.join("\n")
+        details = "#{spec.config.inspect} (owner: #{owner.inspect})"
 
-        current_proxy
+        synchronize do
+          if @proxy_configuration[:primary] == spec.config
+            ActiveRecord::Base.logger&.warn "#{prefix} Ignoring new spec as it matches existing primary spec: #{details}"
+          else
+            ActiveRecord::Base.logger&.warn "#{prefix} Overwriting connection spec: #{details}"
+            ActiveRecord::Base.logger&.info "#{prefix} Called from:\n" + Kernel.caller.map {|t| "  #{t}" }.join("\n")
+            @proxy_configuration = { primary: spec.config }
+          end
+
+          clear_all_connections!
+          initialize_pools
+
+          # Rails returns a connection pool.
+          retrieve_connection_pool owner
+        end
       end
 
       def active_connections?
@@ -114,6 +122,18 @@ module ActiveReplicas
       def current_thread_id
         Thread.current.object_id
       end
+
+      private
+
+      # Sets up `@primary_pool` and `@replica_pools` from the current
+      # `@proxy_configuration`.
+      def initialize_pools
+        @primary_pool = Helpers.connection_pool_for_spec @proxy_configuration[:primary]
+
+        @replica_pools = (@proxy_configuration[:replicas] || {}).map do |name, config_spec|
+          [name, Helpers.connection_pool_for_spec(config_spec)]
+        end.to_h
+      end
     end
   end
 end

data/lib/active_replicas/version.rb

@@ -1,3 +1,3 @@
 module ActiveReplicas
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/lib/active_replicas.rb

@@ -7,7 +7,6 @@ if defined? ActiveRecord
   version = ActiveRecord::VERSION::MAJOR
 
   if version == 4
-    require 'active_replicas/rails4/helpers'
     require 'active_replicas/rails4/connection_handler'
   else
     raise "Unsupported ActiveRecord version: #{version}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_replicas
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Dirk Gadsden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-04 00:00:00.000000000 Z
+date: 2016-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby