mongo 1.2.0 → 1.2.1

data/README.md

@@ -129,7 +129,7 @@ The driver is thread-safe.
 
 ## Connection Pooling
 
-As of v0.18, the driver implements connection pooling. By default, only one
+The driver implements connection pooling. By default, only one
 socket connection will be opened to MongoDB. However, if you're running a
 multi-threaded application, you can specify a maximum pool size and a maximum
 timeout for waiting for old connections to be released to the pool.
@@ -149,12 +149,24 @@ processes will create a new connection to the database. In Passenger, this can b
     if defined?(PhusionPassenger)
       PhusionPassenger.on_event(:starting_worker_process) do |forked|
         if forked
-          # Create new connection here
+          # Reset all connection objects. How you do this depends on where
+          # you keep your connection object. In any case, call the #connect
+          # method on the connection object. For example:
+          # CONN.connect
+          #
+          # If you're using MongoMapper:
+          # MongoMapper.connection.connect
         end
       end
     end
 
-The above code should be put into a Rails initializer or other initialization script.
+In Unicorn, add this to your unicorn.rb file:
+
+    after_fork do |server, worker|
+      # Handle reconnection
+    end
+
+The above code should be put into a Rails initializer or similar initialization script.
 
 ## String Encoding
 

data/docs/FAQ.md

@@ -110,3 +110,7 @@ Without further investigation, it's impossible to know exactly what has caused t
 Because of the indeterminacy involved, the MongoDB drivers will not retry operations on connection failure. How connection failures should be handled is entirely dependent on the application. Therefore, we leave it to the application developers to make the best decision in this case.
 
 The drivers will reconnect on the subsequent operation.
+
+#### I ocassionally get an error saying that responses are out of order. What's happening?
+
+See (this JIRA issue)[http://jira.mongodb.org/browse/RUBY-221].

data/docs/HISTORY.md

@@ -1,14 +1,21 @@
 # MongoDB Ruby Driver History
 
-1.2.0
+### 1.2.1
 2011-1-18
+
+* Enable authentication with connection pooling.
+* Allow custom logging with Connection#instrument (CodeMonkeySteve)
+* Minor fixes and doc improvements.
+
+### 1.2.0
+2011-1-18
+
 * Some minor improvements. See commit history.
-* Since nothing major was reported for the RC, we're releasing.
 
-1.2.rc0
+### 1.2.rc0
 2011-1-5
 
-Lots of cleanp and minor bug fixes.
+Lots of cleanup and minor bug fixes.
 * Issues resolved: http://jira.mongodb.org/browse/RUBY/fixforversion/10222
 * Updated Java BSON to Java driver 2.4.
 * Platform gem for JRuby bson.

data/lib/mongo.rb

@@ -19,7 +19,7 @@
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 module Mongo
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end
 
 module Mongo

data/lib/mongo/collection.rb

@@ -79,7 +79,6 @@ module Mongo
 
       @db, @name  = db, name
       @connection = @db.connection
-      @logger     = @connection.logger
       @cache_time = @db.cache_time
       @cache = Hash.new(0)
       unless pk_factory
@@ -322,12 +321,13 @@ module Mongo
       message.put_int(0)
       message.put_binary(BSON::BSON_CODER.serialize(selector, false, true).to_s)
 
-      @logger.debug("MONGODB #{@db.name}['#{@name}'].remove(#{selector.inspect})") if @logger
-      if safe
-        @connection.send_message_with_safe_check(Mongo::Constants::OP_DELETE, message, @db.name, nil, safe)
-      else
-        @connection.send_message(Mongo::Constants::OP_DELETE, message)
-        true
+      @connection.instrument(:remove, :database => @db.name, :collection => @name, :selector => selector) do
+        if safe
+          @connection.send_message_with_safe_check(Mongo::Constants::OP_DELETE, message, @db.name, nil, safe)
+        else
+          @connection.send_message(Mongo::Constants::OP_DELETE, message)
+          true
+        end
       end
     end
 
@@ -367,11 +367,13 @@ module Mongo
       message.put_int(update_options)
       message.put_binary(BSON::BSON_CODER.serialize(selector, false, true).to_s)
       message.put_binary(BSON::BSON_CODER.serialize(document, false, true).to_s)
-      @logger.debug("MONGODB #{@db.name}['#{@name}'].update(#{selector.inspect}, #{document.inspect})") if @logger
-      if safe
-        @connection.send_message_with_safe_check(Mongo::Constants::OP_UPDATE, message, @db.name, nil, safe)
-      else
-        @connection.send_message(Mongo::Constants::OP_UPDATE, message, nil)
+
+      @connection.instrument(:update, :database => @db.name, :collection => @name, :selector => selector, :document => document) do
+        if safe
+          @connection.send_message_with_safe_check(Mongo::Constants::OP_UPDATE, message, @db.name, nil, safe)
+        else
+          @connection.send_message(Mongo::Constants::OP_UPDATE, message, nil)
+        end
       end
     end
 
@@ -570,9 +572,9 @@ module Mongo
     #   set to true.
     #
     # @return [Array] the command response consisting of grouped items.
-    def group(key, condition={}, initial={}, reduce=nil, finalize=nil)
-      if key.is_a?(Hash)
-        return new_group(key)
+    def group(opts, condition={}, initial={}, reduce=nil, finalize=nil)
+      if opts.is_a?(Hash)
+        return new_group(opts)
       else
         warn "Collection#group no longer take a list of paramters. This usage is deprecated." +
              "Check out the new API at http://api.mongodb.org/ruby/current/Mongo/Collection.html#group-instance_method"
@@ -589,19 +591,19 @@ module Mongo
         }
       }
 
-      if key.is_a?(Symbol)
+      if opts.is_a?(Symbol)
         raise MongoArgumentError, "Group takes either an array of fields to group by or a JavaScript function" +
           "in the form of a String or BSON::Code."
       end
 
-      unless key.nil?
-        if key.is_a? Array
+      unless opts.nil?
+        if opts.is_a? Array
           key_type = "key"
           key_value = {}
-          key.each { |k| key_value[k] = 1 }
+          opts.each { |k| key_value[k] = 1 }
         else
           key_type  = "$keyf"
-          key_value = key.is_a?(BSON::Code) ? key : BSON::Code.new(key)
+          key_value = opts.is_a?(BSON::Code) ? opts : BSON::Code.new(opts)
         end
 
         group_command["group"][key_type] = key_value
@@ -838,11 +840,12 @@ module Mongo
       end
       raise InvalidOperation, "Exceded maximum insert size of 16,000,000 bytes" if message.size > 16_000_000
 
-      @logger.debug("MONGODB #{@db.name}['#{collection_name}'].insert(#{documents.inspect})") if @logger
-      if safe
-        @connection.send_message_with_safe_check(Mongo::Constants::OP_INSERT, message, @db.name, nil, safe)
-      else
-        @connection.send_message(Mongo::Constants::OP_INSERT, message, nil)
+      @connection.instrument(:insert, :database => @db.name, :collection => collection_name, :documents => documents) do
+        if safe
+          @connection.send_message_with_safe_check(Mongo::Constants::OP_INSERT, message, @db.name, nil, safe)
+        else
+          @connection.send_message(Mongo::Constants::OP_INSERT, message, nil)
+        end
       end
       documents.collect { |o| o[:_id] || o['_id'] }
     end

data/lib/mongo/connection.rb

@@ -35,7 +35,7 @@ module Mongo
     STANDARD_HEADER_SIZE = 16
     RESPONSE_HEADER_SIZE = 20
 
-    attr_reader :logger, :size, :auths, :primary, :safe, :primary_pool, :host_to_try
+    attr_reader :logger, :size, :auths, :primary, :safe, :primary_pool, :host_to_try, :pool_size
 
     # Counter for generating unique request ids.
     @@current_request_id = 0
@@ -61,7 +61,8 @@ module Mongo
     #   on initialization.
     # @option opts [Boolean] :slave_ok (false) Must be set to +true+ when connecting
     #   to a single, slave node.
-    # @option opts [Logger, #debug] :logger (nil) Logger instance to receive driver operation log.
+    # @option opts [Logger, #debug] :logger (nil) A Logger instance for debugging driver ops. Note that
+    #   logging negatively impacts performance; therefore, it should not be used for high-performance apps.
     # @option opts [Integer] :pool_size (1) The maximum number of socket connections allowed per
     #   connection pool. Note: this setting is relevant only for multi-threaded applications.
     # @option opts [Float] :timeout (5.0) When all of the connections a pool are checked out,
@@ -188,10 +189,11 @@ module Mongo
     #
     # @raise [AuthenticationError] raises an exception if any one
     #   authentication fails.
-    def apply_saved_authentication
+    def apply_saved_authentication(opts={})
       return false if @auths.empty?
       @auths.each do |auth|
-        self[auth['db_name']].authenticate(auth['username'], auth['password'], false)
+        self[auth['db_name']].issue_authentication(auth['username'], auth['password'], false,
+          :socket => opts[:socket])
       end
       true
     end
@@ -241,6 +243,14 @@ module Mongo
       true
     end
 
+    def authenticate_pools
+      @primary_pool.authenticate_existing
+    end
+
+    def logout_pools(db)
+      @primary_pool.logout_existing(db)
+    end
+
     # Return a hash with all database names
     # and their respective sizes on disk.
     #
@@ -411,7 +421,13 @@ module Mongo
       request_id = add_message_headers(message, operation)
       packed_message = message.to_s
       begin
-        sock = socket || (command ? checkout_writer : checkout_reader)
+        if socket
+          sock = socket
+          checkin = false
+        else
+          sock = (command ? checkout_writer : checkout_reader)
+          checkin = true
+        end
 
         result = ''
         @safe_mutexes[sock].synchronize do
@@ -419,7 +435,9 @@ module Mongo
           result = receive(sock, request_id)
         end
       ensure
-        command ? checkin_writer(sock) : checkin_reader(sock)
+        if checkin
+          command ? checkin_writer(sock) : checkin_reader(sock)
+        end
       end
       result
     end
@@ -451,6 +469,7 @@ module Mongo
         raise ConnectionFailure, "Failed to connect to a master node at #{@host_to_try[0]}:#{@host_to_try[1]}"
       end
     end
+    alias :reconnect :connect
 
     def connecting?
       @nodes_to_try.length > 0
@@ -517,6 +536,15 @@ module Mongo
       end
     end
 
+    # Execute the block and log the operation described by name
+    # and payload.
+    # TODO: Not sure if this should take a block.
+    def instrument(name, payload = {}, &blk)
+      res = yield
+      log_operation(name, payload)
+      res
+    end
+
     protected
 
     # Generic initialization code.
@@ -548,7 +576,12 @@ module Mongo
       @primary      = nil
       @primary_pool = nil
 
-      @logger   = opts[:logger] || nil
+      @logger = opts[:logger] || nil
+
+      if @logger
+        @logger.debug("MongoDB logging. Please note that logging negatively impacts performance " +
+        "and should be disabled for high-performance production apps.")
+      end
 
       should_connect = opts.fetch(:connect, true)
       connect if should_connect
@@ -570,6 +603,18 @@ module Mongo
       end
     end
 
+    ## Logging methods
+
+    def log_operation(name, payload)
+      return unless @logger
+      msg = "#{payload[:database]}['#{payload[:collection]}'].#{name}("
+      msg += payload.values_at(:selector, :document, :documents, :fields ).compact.map(&:inspect).join(', ') + ")"
+      msg += ".skip(#{payload[:skip]})"  if payload[:skip]
+      msg += ".limit(#{payload[:limit]})"  if payload[:limit]
+      msg += ".sort(#{payload[:sort]})"  if payload[:sort]
+      @logger.debug "MONGODB #{msg}"
+    end
+
     private
 
     ## Methods for establishing a connection:
@@ -588,7 +633,7 @@ module Mongo
         socket = TCPSocket.new(host, port)
         socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
 
-        config = self['admin'].command({:ismaster => 1}, :sock => socket)
+        config = self['admin'].command({:ismaster => 1}, :socket => socket)
       rescue OperationFailure, SocketError, SystemCallError, IOError => ex
         close
       ensure
@@ -598,16 +643,13 @@ module Mongo
       config
     end
 
-    # Set the specified node as primary, and
-    # apply any saved authentication credentials.
+    # Set the specified node as primary.
     def set_primary(node)
       host, port = *node
       @primary = [host, port]
       @primary_pool = Pool.new(self, host, port, :size => @pool_size, :timeout => @timeout)
-      apply_saved_authentication
     end
 
-
     ## Low-level connection methods.
 
     def receive(sock, expected_response)

data/lib/mongo/cursor.rb

@@ -373,18 +373,21 @@ module Mongo
     end
 
     # Run query the first time we request an object from the wire
+    # TODO: should we be calling instrument_payload even if logging
+    # is disabled?
     def send_initial_query
       if @query_run
         false
       else
         message = construct_query_message
-        @logger.debug query_log_message if @logger
-        results, @n_received, @cursor_id = @connection.receive_message(
-          Mongo::Constants::OP_QUERY, message, nil, @socket, @command)
-        @returned += @n_received
-        @cache += results
-        @query_run = true
-        close_cursor_if_query_complete
+        @connection.instrument(:find, instrument_payload) do
+          results, @n_received, @cursor_id = @connection.receive_message(
+            Mongo::Constants::OP_QUERY, message, nil, @socket, @command)
+          @returned += @n_received
+          @cache += results
+          @query_run = true
+          close_cursor_if_query_complete
+        end
         true
       end
     end
@@ -401,10 +404,13 @@ module Mongo
       message
     end
 
-    def query_log_message
-      "#{@db.name}['#{@collection.name}'].find(#{@selector.inspect}, #{@fields ? @fields.inspect : '{}'})" +
-      "#{@skip != 0 ? ('.skip(' + @skip.to_s + ')') : ''}#{@limit != 0 ? ('.limit(' + @limit.to_s + ')') : ''}" +
-      "#{@order ? ('.sort(' + @order.inspect + ')') : ''}"
+    def instrument_payload
+      log = { :database => @db.name, :collection => @collection.name, :selector => selector }
+      log[:fields] = @fields  if @fields
+      log[:skip] = @skip  if @skip && (@skip > 0)
+      log[:limit] = @limit  if @limit && (@limit > 0)
+      log[:order] = @order  if @order
+      log
     end
 
     def construct_query_spec

data/lib/mongo/db.rb

@@ -92,7 +92,8 @@ module Mongo
     # @param [String] password
     # @param [Boolean] save_auth
     #   Save this authentication to the connection object using Connection#add_auth. This
-    #   will ensure that the authentication will be applied on database reconnect.
+    #   will ensure that the authentication will be applied on database reconnect. Note
+    #   that this value must be true when using connection pooling.
     #
     # @return [Boolean]
     #
@@ -100,8 +101,19 @@ module Mongo
     #
     # @core authenticate authenticate-instance_method
     def authenticate(username, password, save_auth=true)
-      doc = command({:getnonce => 1}, :check_response => false)
-      raise "error retrieving nonce: #{doc}" unless ok?(doc)
+      if @connection.pool_size > 1
+        if !save_auth
+          raise MongoArgumentError, "If using connection pooling, :save_auth must be set to true."
+        end
+        @connection.authenticate_pools
+      end
+
+      issue_authentication(username, password, save_auth)
+    end
+
+    def issue_authentication(username, password, save_auth=true, opts={})
+      doc = command({:getnonce => 1}, :check_response => false, :socket => opts[:socket])
+      raise MongoDBError, "Error retrieving nonce: #{doc}" unless ok?(doc)
       nonce = doc['nonce']
 
       auth = BSON::OrderedHash.new
@@ -109,7 +121,7 @@ module Mongo
       auth['user'] = username
       auth['nonce'] = nonce
       auth['key'] = Mongo::Support.auth_key(username, password, nonce)
-      if ok?(self.command(auth, :check_response => false))
+      if ok?(self.command(auth, :check_response => false, :socket => opts[:socket]))
         if save_auth
           @connection.add_auth(@name, username, password)
         end
@@ -121,7 +133,7 @@ module Mongo
 
     # Adds a stored Javascript function to the database which can executed  
     # server-side in map_reduce, db.eval and $where clauses.
-    # 
+    #
     # @param [String] function_name
     # @param [String] code
     #
@@ -179,14 +191,22 @@ module Mongo
     end
 
     # Deauthorizes use for this database for this connection. Also removes
-    # any saved authorization in the connection class associated with this
+    # any saved authentication in the connection class associated with this
     # database.
     #
     # @raise [MongoDBError] if logging out fails.
     #
     # @return [Boolean]
-    def logout
-      doc = command(:logout => 1)
+    def logout(opts={})
+      if @connection.pool_size > 1
+        @connection.logout_pools(@name)
+      end
+
+      issue_logout(opts)
+    end
+
+    def issue_logout(opts={})
+      doc = command({:logout => 1}, :socket => opts[:socket])
       if ok?(doc)
         @connection.remove_auth(@name)
         true
@@ -455,14 +475,14 @@ module Mongo
     #
     # @option opts [Boolean] :check_response (true) If +true+, raises an exception if the
     # command fails.
-    # @option opts [Socket] :sock a socket to use for sending the command. This is mainly for internal use.
+    # @option opts [Socket] :socket a socket to use for sending the command. This is mainly for internal use.
     #
     # @return [Hash]
     #
     # @core commands command_instance-method
     def command(selector, opts={})
       check_response = opts.fetch(:check_response, true)
-      sock           = opts[:sock]
+      socket         = opts[:socket]
       raise MongoArgumentError, "command must be given a selector" unless selector.is_a?(Hash) && !selector.empty?
       if selector.keys.length > 1 && RUBY_VERSION < '1.9' && selector.class != BSON::OrderedHash
         raise MongoArgumentError, "DB#command requires an OrderedHash when hash contains multiple keys"
@@ -470,7 +490,7 @@ module Mongo
 
       begin
         result = Cursor.new(system_command_collection,
-          :limit => -1, :selector => selector, :socket => sock).next_document
+          :limit => -1, :selector => selector, :socket => socket).next_document
       rescue OperationFailure => ex
         raise OperationFailure, "Database command '#{selector.keys.first}' failed: #{ex.message}"
       end