mongo_ha 1.12.0 → 1.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad71f9ce35d35356156317b4b046a7de1b67540f
-  data.tar.gz: e6f9363d0ce50cd150f6bf5c47d54dc0de558973
+  metadata.gz: 24001e509a2bf4c267e910c0086d4600092aeeff
+  data.tar.gz: 4af9185eaf2cdcad47e53786c4c27776702734c7
 SHA512:
-  metadata.gz: ac614677db69523d94534597f73a861c4806e9deb01a58af3f4bdb24805d74aa32676f717aabc5e5ccbd44380557bd1f54b32c5842a60c40adf60bd2e073a8ec
-  data.tar.gz: 7336be2ce42a935d22ef7f79a4478db128a127a3e100e5a4c9da2a607facca9ec0140f6f6d1039813d7c5f1704ddaaac64f788e02fe997e40608d16f08157f09
+  metadata.gz: 4eb4feae513d86c118d01b00d0e274a9668d551f83e456ea9abf946d05080800d0fddb1c20faa62dde4aa7d8b012dd845268c5d2aa8c60670aba31a442f6efbb
+  data.tar.gz: 0cd992c13c58cd09b7f32168c21189ef86456a4bba5546ebbae1530a0879d4954b6a8e9c9315f294b3dd742e59defe346b2bbb80c596f3e65b4b357a4bee1f07

data/README.md

@@ -153,7 +153,7 @@ Using the above default values, will result in retry connects at the following i
 
 There is really only one place to test something like `mongo_ha` and that is in
 a high volume mission critical production environment.
-The initial code in this gem was created over 2 years with MongoDB running in an
+This gem was created and tested with MongoDB running in an
 enterprise production environment with hundreds of connections to Mongo servers
 in remote data centers across a WAN. It adds high availability to standalone
 MongoDB servers, replica-sets, and sharded clusters.

data/lib/mongo_ha.rb

@@ -7,14 +7,12 @@ Mongo::MongoClient.send(:include, MongoHA::MongoClient::InstanceMethods)
 
 # Wrap critical Mongo methods with retry_on_connection_failure
 {
-  Mongo::Collection                => [
-    :aggregate, :count, :capped?, :distinct, :drop, :drop_index, :drop_indexes,
-    :ensure_index, :find_one, :find_and_modify, :group, :index_information,
-    :options, :stats, :map_reduce
-  ],
-  Mongo::CollectionOperationWriter => [:send_write_operation, :batch_message_send],
-  Mongo::CollectionCommandWriter   => [:send_write_command, :batch_message_send]
+  # Most calls use a cursor under the covers to return the result
+  # If the primary is lost and it connects to a different server an expired cursor exception is raised
+  Mongo::Cursor     => [:refresh],
 
+  # These methods do not use a Cursor
+  Mongo::Collection => [:insert, :remove, :update]
 }.each_pair do |klass, methods|
   methods.each do |method|
     original_method = "#{method}_original".to_sym

data/lib/mongo_ha/mongo_client.rb

@@ -1,7 +1,7 @@
 require 'mongo'
 module MongoHA
   module MongoClient
-    CONNECTION_RETRY_OPTS = [:reconnect_attempts, :reconnect_retry_seconds, :reconnect_retry_multiplier, :reconnect_max_retry_seconds]
+    CONNECTION_RETRY_OPTS    = [:reconnect_attempts, :reconnect_retry_seconds, :reconnect_retry_multiplier, :reconnect_max_retry_seconds]
 
     # The following errors occur when mongos cannot connect to the shard
     # They require a retry to resolve them
@@ -50,8 +50,6 @@ module MongoHA
             end
           end
 
-          alias_method :receive_message_original, :receive_message
-          alias_method :connect_original, :connect
           alias_method :valid_opts_original, :valid_opts
           alias_method :setup_original, :setup
 
@@ -60,22 +58,6 @@ module MongoHA
           # Prevent multiple threads from trying to reconnect at the same time during
           # connection failures
           @@failover_mutex = Mutex.new
-          # Wrap internal networking calls with retry logic
-
-          # Do not stub out :send_message_with_gle or :send_message
-          # It modifies the message, see CollectionWriter#send_write_operation
-
-          def receive_message(*args)
-            retry_on_connection_failure do
-              receive_message_original *args
-            end
-          end
-
-          def connect(*args)
-            retry_on_connection_failure do
-              connect_original *args
-            end
-          end
 
           protected
 
@@ -103,19 +85,21 @@ module MongoHA
       # Example:
       #   connection.retry_on_connection_failure { |retried| connection.ping }
       def retry_on_connection_failure(&block)
-        raise "Missing mandatory block parameter on call to Mongo::Connection#retry_on_connection_failure" unless block
-        retried = false
+        raise 'Missing mandatory block parameter on call to Mongo::Connection#retry_on_connection_failure' unless block
+        # No need to double retry calls
+        return block.call(false) if Thread.current[:mongo_ha_active?]
+        retried        = false
         mongos_retries = 0
         begin
-          result = block.call(retried)
-          retried = false
+          Thread.current[:mongo_ha_active?] = true
+          result                      = block.call(retried)
+          retried                     = false
           result
         rescue Mongo::ConnectionFailure => exc
           # Retry if reconnected, but only once to prevent an infinite loop
           logger.warn "Connection Failure: '#{exc.message}' [#{exc.error_code}]"
           if !retried && _reconnect
             retried = true
-            # TODO There has to be a way to flush the connection pool of all inactive connections
             retry
           end
           raise exc
@@ -125,7 +109,7 @@ module MongoHA
           # it sometimes gets: "not master and slaveok=false"
           if exc.result
             error = exc.result['err'] || exc.result['errmsg']
-            close if error && error.include?("not master")
+            close if error && error.include?('not master')
           end
 
           # These get returned when connected to a local mongos router when it in turn
@@ -140,13 +124,16 @@ module MongoHA
             retried = true
             Kernel.sleep(0.5)
             logger.warn "[#{primary.inspect}] Router Connection Failure. Retry ##{mongos_retries}. Exc: '#{exc.message}' [#{exc.error_code}]"
-            # TODO Is there a way to flush the connection pool of all inactive connections
             retry
           end
           raise exc
+        ensure
+          Thread.current[:mongo_ha_active?] = false
         end
       end
 
+      protected
+
       # Call this method whenever a Mongo::ConnectionFailure Exception
       # has been raised to re-establish the connection
       #
@@ -155,35 +142,35 @@ module MongoHA
       #
       # Returns whether the connection is connected again
       def _reconnect
-        logger.debug "Going to reconnect"
+        logger.debug 'Going to reconnect'
 
         # Prevent other threads from invoking reconnect logic at the same time
         @@failover_mutex.synchronize do
           # Another thread may have already failed over the connection by the
           # time this threads gets in
+          begin
+            ping
+          rescue Mongo::ConnectionFailure
+            # Connection still not available, run code below
+          end
+
           if active?
             logger.info "Connected to: #{primary.inspect}"
             return true
           end
 
-          # Close all sockets that are not checked out so that other threads not
-          # currently waiting on Mongo, don't get bad connections and have to
-          # retry each one in turn
-          @primary_pool.close if @primary_pool
-
           if reconnect_attempts > 0
             # Wait for other threads to finish working on their sockets
-            retries = 1
+            retries       = 1
             retry_seconds = reconnect_retry_seconds
             begin
               logger.warn "Connection unavailable. Waiting: #{retry_seconds} seconds before retrying"
               sleep retry_seconds
-              # Call original connect method since it is already within a retry block
-              connect_original
+              ping
             rescue Mongo::ConnectionFailure => exc
               if retries < reconnect_attempts
-                retries += 1
-                retry_seconds *=  reconnect_retry_multiplier
+                retries       += 1
+                retry_seconds *= reconnect_retry_multiplier
                 retry_seconds = reconnect_max_retry_seconds if retry_seconds > reconnect_max_retry_seconds
                 retry
               end
@@ -195,9 +182,8 @@ module MongoHA
           end
           connected?
         end
-
       end
 
     end
   end
-end
+end

data/lib/mongo_ha/version.rb

@@ -1,3 +1,3 @@
 module MongoHA #:nodoc
-  VERSION = "1.12.0"
+  VERSION = '1.12.1'
 end

data/test/readme.md

@@ -0,0 +1,48 @@
+## Testing
+
+Unfortunately the only way to properly test mongo_ha is to startup a console with connections
+active and to stop / restart the mongo servers in the replicaset as follows:
+
+
+#### Run the following code in a console
+
+```ruby
+collection = Cache::Identity.database['test']
+collection.drop
+threads = 5.times.collect do |i|
+  Thread.new do
+    100.times do |j|
+      1_000.times do |k|
+        collection.insert(_id: "#{i}-#{j}-#{k}")
+        collection.find_one(_id: "#{i}-#{j}-#{k}")
+        puts("#{i}-#{j}-#{k}") if k % 1000 == 0
+      end
+      puts "#{i}-#{j} pausing"
+      sleep 5
+    end
+    puts "#{i} Complete"
+  end
+end
+```
+
+#### Steps
+
+While running the above code in the console
+
+* Stop 1 slave server
+
+Nothing should appear in the logs and everything should process fine
+
+* Stop another slave
+
+The logs should show retries
+
+* Start up one of the 2 slaves that were stopped
+
+The processing should resume successfully
+
+#### To stop the test
+
+```ruby
+threads.each(&:kill)
+```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongo_ha
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.12.1
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-21 00:00:00.000000000 Z
+date: 2015-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.10'
 description: Automatic reconnects and recovery when replica-set changes, or connections
   are lost, with transparent recovery
 email:
@@ -37,6 +37,7 @@ files:
 - lib/mongo_ha.rb
 - lib/mongo_ha/mongo_client.rb
 - lib/mongo_ha/version.rb
+- test/readme.md
 homepage: https://github.com/reidmorrison/mongo_ha
 licenses:
 - Apache License V2.0
@@ -57,8 +58,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: High availability for the mongo ruby driver
-test_files: []
+test_files:
+- test/readme.md