mongo 2.0.6 → 2.1.0

data/lib/mongo/protocol/update.rb

@@ -52,33 +52,36 @@ module Mongo
       #
       #   Supported flags: +:upsert+, +:multi_update+
       def initialize(database, collection, selector, update, options = {})
+        @database    = database
+        @collection  = collection
         @namespace   = "#{database}.#{collection}"
         @selector    = selector
         @update      = update
         @flags       = options[:flags] || []
+        @upconverter = Upconverter.new(collection, selector, update, flags)
       end
 
-      # The log message for an update operation.
+      # Return the event payload for monitoring.
       #
-      # @example Get the log message.
-      #   update.log_message
+      # @example Return the event payload.
+      #   message.payload
       #
-      # @return [ String ] The log message
+      # @return [ Hash ] The event payload.
       #
-      # @since 2.0.0
-      def log_message
-        fields = []
-        fields << ["%s |", "UPDATE"]
-        fields << ["namespace=%s", namespace]
-        fields << ["selector=%s", selector.inspect]
-        fields << ["udpdate=%s", update.inspect]
-        fields << ["flags=%s", flags.inspect]
-        f, v = fields.transpose
-        f.join(" ") % v
+      # @since 2.1.0
+      def payload
+        {
+          command_name: 'update',
+          database_name: @database,
+          command: upconverter.command,
+          request_id: request_id
+        }
       end
 
       private
 
+      attr_reader :upconverter
+
       # The operation code required to specify an Update message.
       # @return [Fixnum] the operation code.
       def op_code
@@ -106,6 +109,71 @@ module Mongo
       # @!attribute
       # @return [Hash] The update for this Delete message.
       field :update, Document
+
+      # Converts legacy update messages to the appropriare OP_COMMAND style
+      # message.
+      #
+      # @since 2.1.0
+      class Upconverter
+
+        # @return [ String ] collection The name of the collection.
+        attr_reader :collection
+
+        # @return [ Hash ] filter The filter.
+        attr_reader :filter
+
+        # @return [ Hash ] update The update.
+        attr_reader :update
+
+        # @return [ Array<Symbol> ] flags The flags.
+        attr_reader :flags
+
+        # Instantiate the upconverter.
+        #
+        # @example Instantiate the upconverter.
+        #   Upconverter.new(
+        #     'users',
+        #     { name: 'test' },
+        #     { '$set' => { 'name' => 't' }},
+        #     []
+        #   )
+        #
+        # @param [ String ] collection The name of the collection.
+        # @param [ Hash ] filter The filter.
+        # @param [ Hash ] update The update.
+        # @param [ Array<Symbol> ] flags The flags.
+        #
+        # @since 2.1.0
+        def initialize(collection, filter, update, flags)
+          @collection = collection
+          @filter = filter
+          @update = update
+          @flags = flags
+        end
+
+        # Get the upconverted command.
+        #
+        # @example Get the command.
+        #   upconverter.command
+        #
+        # @return [ BSON::Document ] The upconverted command.
+        #
+        # @since 2.1.0
+        def command
+          BSON::Document.new(
+            update: collection,
+            ordered: true,
+            updates: [
+              BSON::Document.new(
+                q: filter,
+                u: update,
+                multi: flags.include?(:multi_update),
+                upsert: flags.include?(:upsert),
+              )
+            ]
+          )
+        end
+      end
     end
   end
 end

data/lib/mongo/retryable.rb

@@ -0,0 +1,83 @@
+# Copyright (C) 2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+
+  # Defines basic behaviour around retrying operations.
+  #
+  # @since 2.1.0
+  module Retryable
+
+    # The not master error message.
+    #
+    # @since 2.1.0
+    NOT_MASTER = 'not master'.freeze
+
+    # Execute a read operation with a retry.
+    #
+    # @example Execute the read.
+    #   read_with_retry do
+    #     ...
+    #   end
+    #
+    # @note This only retries read operations on socket errors.
+    #
+    # @param [ Proc ] block The block to execute.
+    #
+    # @return [ Result ] The result of the operation.
+    #
+    # @since 2.1.0
+    def read_with_retry(&block)
+      begin
+        block.call
+      rescue Error::SocketError, Error::SocketTimeoutError
+        retry_operation(&block)
+      end
+    end
+
+    # Execute a write operation with a retry.
+    #
+    # @example Execute the write.
+    #   write_with_retry do
+    #     ...
+    #   end
+    #
+    # @note This only retries operations on not master failures, since it is
+    #   the only case we can be sure a partial write did not already occur.
+    #
+    # @param [ Proc ] block The block to execute.
+    #
+    # @return [ Result ] The result of the operation.
+    #
+    # @since 2.1.0
+    def write_with_retry(&block)
+      begin
+        block.call
+      rescue Error::OperationFailure => e
+        if e.message.include?(NOT_MASTER)
+          retry_operation(&block)
+        else
+          raise e
+        end
+      end
+    end
+
+    private
+
+    def retry_operation(&block)
+      cluster.scan!
+      block.call
+    end
+  end
+end

data/lib/mongo/server/connectable.rb

@@ -19,7 +19,11 @@ module Mongo
     #
     # @since 2.0.0
     module Connectable
-      include Loggable
+
+      # The ssl option prefix.
+      #
+      # @since 2.1.0
+      SSL = 'ssl'.freeze
 
       # The default time in seconds to timeout a connection attempt.
       #
@@ -35,6 +39,19 @@ module Mongo
       # @return [ Integer ] pid The process id when the connection was created.
       attr_reader :pid
 
+      # Determine if the server is connectable. This will check not only if the
+      # connection exists, but if messages can send to it successfully.
+      #
+      # @example Is the server connectable?
+      #   connection.connectable?
+      #
+      # @return [ true, false ] If the connection is connectable.
+      #
+      # @since 2.1.0
+      def connectable?
+        begin; ping; rescue; false; end
+      end
+
       # Determine if the connection is currently connected.
       #
       # @example Is the connection connected?
@@ -42,32 +59,11 @@ module Mongo
       #
       # @return [ true, false ] If connected.
       #
-      # @since 2.0.0
+      # @deprecated Use #connectable? instead
       def connected?
         !!@socket && @socket.alive?
       end
 
-      # Dispatch the provided messages to the connection. If the last message
-      # requires a response a reply will be returned.
-      #
-      # @example Dispatch the messages.
-      #   connection.dispatch([ insert, command ])
-      #
-      # @note This method is named dispatch since 'send' is a core Ruby method on
-      #   all objects.
-      #
-      # @param [ Array<Message> ] messages The messages to dispatch.
-      #
-      # @return [ Protocol::Reply ] The reply if needed.
-      #
-      # @since 2.0.0
-      def dispatch(messages)
-        log_debug(messages) do |msgs|
-          write(msgs)
-          msgs.last.replyable? ? read : nil
-        end
-      end
-
       # Get the connection timeout.
       #
       # @example Get the connection timeout.
@@ -90,10 +86,10 @@ module Mongo
 
       def ensure_connected
         ensure_same_process!
-        connect! if socket.nil? || !socket.alive?
+        connect!
         begin
           yield socket
-        rescue Error::SocketError, Error::SocketTimeoutError => e
+        rescue Exception => e
           disconnect!
           raise e
         end

data/lib/mongo/server/connection.rb

@@ -20,8 +20,24 @@ module Mongo
     # @since 2.0.0
     class Connection
       include Connectable
+      include Monitoring::Publishable
       extend Forwardable
 
+      # The ping command.
+      #
+      # @since 2.1.0
+      PING = { :ping => 1 }.freeze
+
+      # Ping message.
+      #
+      # @since 2.1.0
+      PING_MESSAGE = Protocol::Query.new(Database::ADMIN, Database::COMMAND, PING, :limit => -1)
+
+      # The ping message as raw bytes.
+      #
+      # @since 2.1.0
+      PING_BYTES = PING_MESSAGE.serialize.freeze
+
       # @return [ Mongo::Auth::CR, Mongo::Auth::X509, Mongo::Auth:LDAP, Mongo::Auth::SCRAM ]
       #   authenticator The authentication strategy.
       attr_reader :authenticator
@@ -59,7 +75,7 @@ module Mongo
       def connect!
         unless socket
           @socket = address.socket(timeout, ssl_options)
-          @socket.connect!
+          socket.connect!
           if authenticator
             authenticator.login(self)
             @authenticated = true
@@ -88,36 +104,91 @@ module Mongo
         true
       end
 
+      # Dispatch the provided messages to the connection. If the last message
+      # requires a response a reply will be returned.
+      #
+      # @example Dispatch the messages.
+      #   connection.dispatch([ insert, command ])
+      #
+      # @note This method is named dispatch since 'send' is a core Ruby method on
+      #   all objects.
+      #
+      # @param [ Array<Message> ] messages The messages to dispatch.
+      # @param [ Integer ] operation_id The operation id to link messages.
+      #
+      # @return [ Protocol::Reply ] The reply if needed.
+      #
+      # @since 2.0.0
+      def dispatch(messages, operation_id = nil)
+        if monitoring.subscribers?(Monitoring::COMMAND)
+          publish_command(messages, operation_id || Monitoring.next_operation_id) do |msgs|
+            deliver(msgs)
+          end
+        else
+          deliver(messages)
+        end
+      end
+
       # Initialize a new socket connection from the client to the server.
       #
+      # @api private
+      #
       # @example Create the connection.
       #   Connection.new(server)
       #
+      # @note Connection must never be directly instantiated outside of a
+      #   Server.
+      #
       # @param [ Mongo::Server ] server The server the connection is for.
       # @param [ Hash ] options The connection options.
       #
       # @since 2.0.0
       def initialize(server, options = {})
         @address = server.address
+        @monitoring = server.monitoring
         @options = options.freeze
         @server = server
-        @ssl_options = options.reject { |k, v| !k.to_s.start_with?('ssl') }
+        @ssl_options = options.reject { |k, v| !k.to_s.start_with?(SSL) }
         @socket = nil
         @pid = Process.pid
         setup_authentication!
       end
 
+      # Ping the connection to see if the server is responding to commands.
+      # This is non-blocking on the server side.
+      #
+      # @example Ping the connection.
+      #   connection.ping
+      #
+      # @note This uses a pre-serialized ping message for optimization.
+      #
+      # @return [ true, false ] If the server is accepting connections.
+      #
+      # @since 2.1.0
+      def ping
+        ensure_connected do |socket|
+          socket.write(PING_BYTES)
+          reply = Protocol::Reply.deserialize(socket)
+          reply.documents[0][Operation::Result::OK] == 1
+        end
+      end
+
       private
 
+      def deliver(messages)
+        write(messages)
+        messages.last.replyable? ? read : nil
+      end
+
       def setup_authentication!
         if options[:user]
           default_mechanism = @server.features.scram_sha_1_enabled? ? :scram : :mongodb_cr
-          user = Auth::User.new({ :auth_mech => default_mechanism }.merge(options))
+          user = Auth::User.new(Options::Redacted.new(:auth_mech => default_mechanism).merge(options))
           @authenticator = Auth.get(user)
         end
       end
 
-      def write(messages, buffer = '')
+      def write(messages, buffer = ''.force_encoding(BSON::BINARY))
         start_size = 0
         messages.each do |message|
           message.serialize(buffer, max_bson_object_size)

data/lib/mongo/server/connection_pool/queue.rb

@@ -63,6 +63,21 @@ module Mongo
           end
         end
 
+        # Disconnect all connections in the queue.
+        #
+        # @example Disconnect all connections.
+        #   queue.disconnect!
+        #
+        # @return [ true ] Always true.
+        #
+        # @since 2.1.0
+        def disconnect!
+          mutex.synchronize do
+            queue.each{ |connection| connection.disconnect! }
+            true
+          end
+        end
+
         # Enqueue a connection in the queue.
         #
         # @example Enqueue a connection.

data/lib/mongo/server/connection_pool.rb

@@ -54,6 +54,18 @@ module Mongo
         queue.dequeue
       end
 
+      # Disconnect the connection pool.
+      #
+      # @example Disconnect the connection pool.
+      #   pool.disconnect!
+      #
+      # @return [ true ] true.
+      #
+      # @since 2.1.0
+      def disconnect!
+        queue.disconnect!
+      end
+
       # Create the new connection pool.
       #
       # @example Create the new connection pool.

data/lib/mongo/server/description/features.rb

@@ -28,7 +28,8 @@ module Mongo
           :list_collections => 3,
           :list_indexes => 3,
           :scram_sha_1 => 3,
-          :write_command => 2
+          :write_command => 2,
+          :users_info => 2
         }.freeze
 
         # The wire protocol versions that this version of the driver supports.

data/lib/mongo/server/description.rb

@@ -84,6 +84,11 @@ module Mongo
       # @since 2.0.0
       MAX_WRITE_BATCH_SIZE = 'maxWriteBatchSize'.freeze
 
+      # Constant for reading the me field.
+      #
+      # @since 2.1.0
+      ME = 'me'.freeze
+
       # Default max write batch size.
       #
       # @since 2.0.0
@@ -124,10 +129,20 @@ module Mongo
       # @since 2.0.0
       TAGS = 'tags'.freeze
 
+      # Constant for reading electionID info from config.
+      #
+      # @since 2.1.0
+      ELECTION_ID = 'electionId'.freeze
+
+      # Constant for reading localTime info from config.
+      #
+      # @since 2.1.0
+      LOCAL_TIME = 'localTime'.freeze
+
       # Fields to exclude when comparing two descriptions.
       #
       # @since 2.0.6
-      EXCLUDE_FOR_COMPARISON = [ 'localTime' ]
+      EXCLUDE_FOR_COMPARISON = [ LOCAL_TIME, ELECTION_ID ]
 
       # @return [ Address ] address The server's address.
       attr_reader :address
@@ -292,6 +307,18 @@ module Mongo
         config[MIN_WIRE_VERSION] || LEGACY_WIRE_VERSION
       end
 
+      # Get the me field value.
+      #
+      # @example Get the me field value.
+      #   description.me
+      #
+      # @return [ String ] The me field.
+      #
+      # @since 2.1.0
+      def me
+        config[ME]
+      end
+
       # Get the tags configured for the server.
       #
       # @example Get the tags.
@@ -304,6 +331,18 @@ module Mongo
         config[TAGS] || {}
       end
 
+      # Get the electionId from the config.
+      #
+      # @example Get the electionId.
+      #   description.election_id
+      #
+      # @return [ BSON::ObjectId ] The election id.
+      #
+      # @since 2.1.0
+      def election_id
+        config[ELECTION_ID]
+      end
+
       # Is the server a mongos?
       #
       # @example Is the server a mongos?
@@ -489,6 +528,18 @@ module Mongo
         !(standalone? || mongos?)
       end
 
+      # Check if there is a mismatch between the address host and the me field.
+      #
+      # @example Check if there is a mismatch.
+      #   description.me_mismatch?
+      #
+      # @return [ true, false ] If there is a mismatch between the me field and the address host.
+      #
+      # @since 2.0.6
+      def me_mismatch?
+        !!(address.to_s != me if me)
+      end
+
       # Check equality of two descriptions.
       #
       # @example Check description equality.

data/lib/mongo/server/monitor/connection.rb

@@ -36,7 +36,7 @@ module Mongo
         def connect!
           unless socket
             @socket = address.socket(timeout, ssl_options)
-            @socket.connect!
+            socket.connect!
           end
           true
         end
@@ -60,11 +60,35 @@ module Mongo
           true
         end
 
+        # Dispatch the provided messages to the connection. If the last message
+        # requires a response a reply will be returned.
+        #
+        # @example Dispatch the messages.
+        #   connection.dispatch([ insert, command ])
+        #
+        # @note This method is named dispatch since 'send' is a core Ruby method on
+        #   all objects.
+        #
+        # @param [ Array<Message> ] messages The messages to dispatch.
+        #
+        # @return [ Protocol::Reply ] The reply if needed.
+        #
+        # @since 2.0.0
+        def dispatch(messages)
+          write(messages)
+          messages.last.replyable? ? read : nil
+        end
+
         # Initialize a new socket connection from the client to the server.
         #
+        # @api private
+        #
         # @example Create the connection.
         #   Connection.new(address)
         #
+        # @note Connection must never be directly instantiated outside of a
+        #   Monitor.
+        #
         # @param [ Mongo::Address ] address The address the connection is for.
         # @param [ Hash ] options The connection options.
         #
@@ -72,7 +96,7 @@ module Mongo
         def initialize(address, options = {})
           @address = address
           @options = options.freeze
-          @ssl_options = options.reject { |k, v| !k.to_s.start_with?('ssl') }
+          @ssl_options = options.reject { |k, v| !k.to_s.start_with?(SSL) }
           @socket = nil
           @pid = Process.pid
         end

data/lib/mongo/server/monitor.rb

@@ -91,9 +91,13 @@ module Mongo
 
       # Create the new server monitor.
       #
+      # @api private
+      #
       # @example Create the server monitor.
       #   Mongo::Server::Monitor.new(address, listeners)
       #
+      # @note Monitor must never be directly instantiated outside of a Server.
+      #
       # @param [ Address ] address The address to monitor.
       # @param [ Event::Listeners ] listeners The event listeners.
       # @param [ Hash ] options The options.
@@ -112,7 +116,7 @@ module Mongo
       # server.
       #
       # @example Run the monitor.
-      #   monito.run
+      #   monitor.run
       #
       # @return [ Thread ] The thread the monitor runs on.
       #
@@ -136,7 +140,19 @@ module Mongo
       #
       # @since 2.0.0
       def stop!
-        @thread.kill && @thread.stop?
+        connection.disconnect! && @thread.kill && @thread.stop?
+      end
+
+      # Restarts the server monitor unless the current thread is alive.
+      #
+      # @example Restart the monitor.
+      #   monitor.restart!
+      #
+      # @return [ Thread ] The thread the monitor runs on.
+      #
+      # @since 2.1.0
+      def restart!
+        @thread.alive? ? @thread : run!
       end
 
       private
@@ -157,7 +173,7 @@ module Mongo
             result = connection.dispatch([ ISMASTER ]).documents[0]
             return result, calculate_average_round_trip_time(start)
           rescue Exception => e
-            log_debug([ e.message ])
+            log_debug(e.message)
             return {}, calculate_average_round_trip_time(start)
           end
         end