mongo 0.18.1 → 0.18.2

data/lib/mongo/connection.rb

@@ -16,7 +16,7 @@
 
 require 'set'
 require 'socket'
-require 'monitor'
+require 'thread'
 
 module Mongo
 
@@ -31,12 +31,12 @@ module Mongo
     STANDARD_HEADER_SIZE = 16
     RESPONSE_HEADER_SIZE = 20
 
-    attr_reader :logger, :size, :host, :port, :nodes, :sockets, :checked_out, :reserved_connections
+    attr_reader :logger, :size, :host, :port, :nodes, :sockets, :checked_out
 
-    def slave_ok? 
+    def slave_ok?
       @slave_ok
     end
-    
+
     # Counter for generating unique request ids.
     @@current_request_id = 0
 
@@ -45,7 +45,7 @@ module Mongo
     #
     # == Connecting
     # If connecting to just one server, you may specify whether connection to slave is permitted.
-    # 
+    #
     # In all cases, the default host is "localhost" and the default port, is 27017.
     #
     # When specifying a pair, pair_or_host, is a hash with two keys: :left and :right. Each key maps to either
@@ -69,13 +69,15 @@ module Mongo
     # :timeout   :: When all of the connections to the pool are checked out,
     #               this is the number of seconds to wait for a new connection
     #               to be released before throwing an exception.
-    #                
+    #
+    # Note that there are a few issues when using connection pooling with Ruby 1.9 on Windows. These
+    # should be resolved in the next release.
     #
     # === Examples:
     #
     #  # localhost, 27017
     #  Connection.new
-    #   
+    #
     #  # localhost, 27017
     #  Connection.new("localhost")
     #
@@ -85,9 +87,9 @@ module Mongo
     #  # localhost, 3000, where this node may be a slave
     #  Connection.new("localhost", 3000, :slave_ok => true)
     #
-    #  # A pair of servers. The driver will always talk to master. 
+    #  # A pair of servers. The driver will always talk to master.
     #  # On connection errors, Mongo::ConnectionFailure will be raised.
-    #  # See http://www.mongodb.org/display/DOCS/Replica+Pairs+in+Ruby 
+    #  # See http://www.mongodb.org/display/DOCS/Replica+Pairs+in+Ruby
     #  Connection.new({:left  => ["db1.example.com", 27017],
     #                  :right => ["db2.example.com", 27017]})
     #
@@ -100,22 +102,20 @@ module Mongo
 
       # Host and port of current master.
       @host = @port = nil
-      
+
       # Lock for request ids.
       @id_lock = Mutex.new
 
       # Pool size and timeout.
       @size      = options[:pool_size] || 1
-      @timeout   = options[:timeout]   || 1.0
-
-      # Cache of reserved sockets mapped to threads
-      @reserved_connections = {}
+      @timeout   = options[:timeout]   || 5.0
 
       # Mutex for synchronizing pool access
-      @connection_mutex = Monitor.new
+      @connection_mutex = Mutex.new
+      @safe_mutex = Mutex.new
 
       # Condition variable for signal and wait
-      @queue = @connection_mutex.new_cond
+      @queue = ConditionVariable.new
 
       @sockets      = []
       @checked_out  = []
@@ -123,7 +123,7 @@ module Mongo
       if options[:auto_reconnect]
         warn(":auto_reconnect is deprecated. see http://www.mongodb.org/display/DOCS/Replica+Pairs+in+Ruby")
       end
-      
+
       # Slave ok can be true only if one node is specified
       @slave_ok = options[:slave_ok] && @nodes.length == 1
       @logger   = options[:logger] || nil
@@ -177,7 +177,7 @@ module Mongo
     # Increments and returns the next available request id.
     def get_request_id
       request_id = ''
-      @id_lock.synchronize do 
+      @id_lock.synchronize do
         request_id = @@current_request_id += 1
       end
       request_id
@@ -196,7 +196,7 @@ module Mongo
 
 
     ## Connections and pooling ##
-    
+
     # Sends a message to MongoDB.
     #
     # Takes a MongoDB opcode, +operation+, a message of class ByteBuffer,
@@ -211,19 +211,22 @@ module Mongo
     end
 
     # Sends a message to the database, waits for a response, and raises
-    # and exception if the operation has failed.
+    # an exception if the operation has failed.
     #
     # Takes a MongoDB opcode, +operation+, a message of class ByteBuffer,
     # +message+, the +db_name+, and an optional formatted +log_message+.
-    # Sends the message to the databse, adding the necessary headers.
+    # Sends the message to the database, adding the necessary headers.
     def send_message_with_safe_check(operation, message, db_name, log_message=nil)
       message_with_headers = add_message_headers(operation, message)
       message_with_check   = last_error_message(db_name)
       @logger.debug("  MONGODB #{log_message || message}") if @logger
       sock = checkout
       packed_message = message_with_headers.append!(message_with_check).to_s
-      send_message_on_socket(packed_message, sock)
-      docs, num_received, cursor_id = receive(sock)
+      docs = num_received = cursor_id = ''
+      @safe_mutex.synchronize do
+        send_message_on_socket(packed_message, sock)
+        docs, num_received, cursor_id = receive(sock)
+      end
       checkin(sock)
       if num_received == 1 && error = docs[0]['err']
         raise Mongo::OperationFailure, error
@@ -234,15 +237,18 @@ module Mongo
     # Sends a message to the database and waits for the response.
     #
     # Takes a MongoDB opcode, +operation+, a message of class ByteBuffer,
-    # +message+, and an optional formatted +log_message+. This method 
+    # +message+, and an optional formatted +log_message+. This method
     # also takes an options socket for internal use with #connect_to_master.
     def receive_message(operation, message, log_message=nil, socket=nil)
       packed_message = add_message_headers(operation, message).to_s
       @logger.debug("  MONGODB #{log_message || message}") if @logger
       sock = socket || checkout
 
-      send_message_on_socket(packed_message, sock)
-      result = receive(sock)
+      result = ''
+      @safe_mutex.synchronize do
+        send_message_on_socket(packed_message, sock)
+        result = receive(sock)
+      end
       checkin(sock)
       result
     end
@@ -275,7 +281,7 @@ module Mongo
           socket.close if socket
           false
         end
-      end 
+      end
       raise ConnectionFailure, "failed to connect to any given host:port" unless socket
     end
 
@@ -291,55 +297,25 @@ module Mongo
         sock.close
       end
       @host = @port = nil
-      @sockets.clear   
+      @sockets.clear
       @checked_out.clear
-      @reserved_connections.clear
     end
 
     private
 
-    # Get a socket from the pool, mapped to the current thread.
-    def checkout
-      #return @socket ||= checkout_new_socket if @size == 1
-      if sock = @reserved_connections[Thread.current.object_id]
-        sock
-      else
-        sock = obtain_socket
-        @reserved_connections[Thread.current.object_id] = sock
-      end
-      sock
-    end
-
     # Return a socket to the pool.
     def checkin(socket)
-      @connection_mutex.synchronize do 
-        @reserved_connections.delete Thread.current.object_id
+      @connection_mutex.synchronize do
         @checked_out.delete(socket)
         @queue.signal
       end
       true
     end
 
-    # Releases the connection for any dead threads.
-    # Called when the connection pool grows too large to free up more sockets.
-    def clear_stale_cached_connections!
-      keys = @reserved_connections.keys
-
-      Thread.list.each do |thread|
-        keys.delete(thread.object_id) if thread.alive?
-      end
-      
-      keys.each do |key|
-        next unless @reserved_connections.has_key?(key)
-        checkin(@reserved_connections[key])
-        @reserved_connections.delete(key)
-      end
-    end
-
     # Adds a new socket to the pool and checks it out.
     #
-    # This method is called exclusively from #obtain_socket;
-    # therefore, it runs within a mutex, as it must.
+    # This method is called exclusively from #checkout;
+    # therefore, it runs within a mutex.
     def checkout_new_socket
       begin
       socket = TCPSocket.new(@host, @port)
@@ -354,8 +330,8 @@ module Mongo
 
     # Checks out the first available socket from the pool.
     #
-    # This method is called exclusively from #obtain_socket;
-    # therefore, it runs within a mutex, as it must.
+    # This method is called exclusively from #checkout;
+    # therefore, it runs within a mutex.
     def checkout_existing_socket
       socket = (@sockets - @checked_out).first
       @checked_out << socket
@@ -365,11 +341,17 @@ module Mongo
     # Check out an existing socket or create a new socket if the maximum
     # pool size has not been exceeded. Otherwise, wait for the next
     # available socket.
-    def obtain_socket
-      @connection_mutex.synchronize do 
-        connect_to_master if !connected?
+    def checkout
+      connect_to_master if !connected?
+      start_time = Time.now
+      loop do
+        if (Time.now - start_time) > @timeout
+            raise ConnectionTimeoutError, "could not obtain connection within " +
+              "#{@timeout} seconds. The max pool size is currently #{@size}; " +
+              "consider increasing the pool size or timeout."
+        end
 
-        loop do 
+        @connection_mutex.synchronize do
           socket = if @checked_out.size < @sockets.size
                      checkout_existing_socket
                    elsif @sockets.size < @size
@@ -378,39 +360,10 @@ module Mongo
 
           return socket if socket
 
-          # Try to clear out any stale threads to free up some connections
-          clear_stale_cached_connections!
-          next if @checked_out.size < @sockets.size
-
-          # Otherwise, wait.
-          if wait
-            next
-          else
-
-            # Try to clear stale threads once more before failing.
-            clear_stale_cached_connections!
-            if @size == @sockets.size
-              raise ConnectionTimeoutError, "could not obtain connection within " +
-                "#{@timeout} seconds. The max pool size is currently #{@size}; " +
-                "consider increasing it."
-            end
-          end  # if
-        end # loop
-      end # synchronize
-    end
-
-    if RUBY_VERSION >= '1.9'
-      # Ruby 1.9's Condition Variables don't support timeouts yet;
-      # until they do, we'll make do with this hack. 
-      def wait
-        Timeout.timeout(@timeout) do 
-          @queue.wait
+          # Otherwise, wait
+          @queue.wait(@connection_mutex)
         end
       end
-    else
-      def wait
-        @queue.wait(@timeout)
-      end
     end
 
     def receive(sock)
@@ -424,7 +377,7 @@ module Mongo
       header.put_array(receive_message_on_socket(16, sock).unpack("C*"))
       unless header.size == STANDARD_HEADER_SIZE
         raise "Short read for DB response header: " +
-          "expected #{STANDARD_HEADER_SIZE} bytes, saw #{header.size}" 
+          "expected #{STANDARD_HEADER_SIZE} bytes, saw #{header.size}"
       end
       header.rewind
       size        = header.get_int
@@ -473,7 +426,7 @@ module Mongo
       message.put_array(BSON.serialize({:getlasterror => 1}, false).unpack("C*"))
       add_message_headers(Mongo::Constants::OP_QUERY, message)
     end
-    
+
     # Prepares a message for transmission to MongoDB by
     # constructing a valid message header.
     def add_message_headers(operation, message)
@@ -494,7 +447,7 @@ module Mongo
     end
 
     # Low-level method for sending a message on a socket.
-    # Requires a packed message and an available socket, 
+    # Requires a packed message and an available socket,
     def send_message_on_socket(packed_message, socket)
       begin
       socket.send(packed_message, 0)
@@ -537,7 +490,7 @@ module Mongo
           [['localhost', DEFAULT_PORT]]
       end
     end
-    
+
     # Turns an array containing a host name string and a
     # port number integer into a [host, port] pair array.
     def pair_val_to_connection(a)

data/lib/mongo/constants.rb

@@ -1,8 +1,8 @@
 module Mongo
   module Constants
-    OP_REPLY        = 1   
-    OP_MSG          = 1000 
-    OP_UPDATE       = 2001 
+    OP_REPLY        = 1
+    OP_MSG          = 1000
+    OP_UPDATE       = 2001
     OP_INSERT       = 2002
     OP_QUERY        = 2004
     OP_GET_MORE     = 2005

data/lib/mongo/cursor.rb

@@ -19,7 +19,7 @@ module Mongo
     include Mongo::Conversions
     include Enumerable
 
-    attr_reader :collection, :selector, :admin, :fields, 
+    attr_reader :collection, :selector, :admin, :fields,
       :order, :hint, :snapshot, :timeout,
       :full_collection_name
 
@@ -49,19 +49,17 @@ module Mongo
       @query_run = false
     end
 
-    # Return the next object or nil if there are no more. Raises an error
-    # if necessary.
-    def next_object
+    # Return the next document or nil if there are no more.
+    def next_document
       refill_via_get_more if num_remaining == 0
-      o = @cache.shift
+      doc = @cache.shift
 
-      if o && o['$err']
-        err = o['$err']
+      if doc && doc['$err']
+        err = doc['$err']
 
         # If the server has stopped being the master (e.g., it's one of a
         # pair but it has died or something like that) then we close that
-        # connection. If the db has auto connect option and a pair of
-        # servers, next request will re-open on master server.
+        # connection. The next request will re-open on master server.
         if err == "not master"
           raise ConnectionFailure, err
           @connection.close
@@ -70,12 +68,17 @@ module Mongo
         raise OperationFailure, err
       end
 
-      o
+      doc
+    end
+
+    def next_object
+      warn "Cursor#next_object is deprecated; please use Cursor#next_document instead."
+      next_document
     end
 
-    # Get the size of the results set for this query.
+    # Get the size of the result set for this query.
     #
-    # Returns the number of objects in the results set for this query. Does
+    # Returns the number of objects in the result set for this query. Does
     # not take limit and skip into account. Raises OperationFailure on a
     # database error.
     def count
@@ -88,17 +91,17 @@ module Mongo
       raise OperationFailure, "Count failed: #{response['errmsg']}"
     end
 
-    # Sort this cursor's result
+    # Sort this cursor's results.
     #
     # Takes either a single key and a direction, or an array of [key,
-    # direction] pairs. Directions should be specified as Mongo::ASCENDING
-    # or Mongo::DESCENDING (or :ascending or :descending) (or :asc or :desc).
+    # direction] pairs. Directions should be specified as Mongo::ASCENDING / Mongo::DESCENDING
+    # (or :ascending / :descending, :asc / :desc).
     #
     # Raises InvalidOperation if this cursor has already been used. Raises
-    # InvalidSortValueError if specified order is invalid.
+    # InvalidSortValueError if the specified order is invalid.
     #
     # This method overrides any sort order specified in the Collection#find
-    # method, and only the last sort applied has an effect
+    # method, and only the last sort applied has an effect.
     def sort(key_or_list, direction=nil)
       check_modifiable
 
@@ -130,7 +133,7 @@ module Mongo
 
     # Skips the first +number_to_skip+ results of this cursor.
     # Returns the current number_to_skip if no parameter is given.
-    # 
+    #
     # Raises InvalidOperation if this cursor has already been used.
     #
     # This method overrides any skip specified in the Collection#find method,
@@ -151,15 +154,15 @@ module Mongo
     def each
       num_returned = 0
       while more? && (@limit <= 0 || num_returned < @limit)
-        yield next_object()
+        yield next_document
         num_returned += 1
       end
     end
 
     # Return all of the documents in this cursor as an array of hashes.
     #
-    # Raises InvalidOperation if this cursor has already been used (including
-    # any previous calls to this method).
+    # Raises InvalidOperation if this cursor has already been used or if
+    # this methods has already been called on the cursor.
     #
     # Use of this method is discouraged - iterating over a cursor is much
     # more efficient in most cases.
@@ -168,22 +171,22 @@ module Mongo
       rows = []
       num_returned = 0
       while more? && (@limit <= 0 || num_returned < @limit)
-        rows << next_object()
+        rows << next_document
         num_returned += 1
       end
       rows
     end
 
-    # Returns an explain plan record for this cursor.
+    # Returns an explain plan document for this cursor.
     def explain
       c = Cursor.new(@collection, query_options_hash.merge(:limit => -@limit.abs, :explain => true))
-      explanation = c.next_object
+      explanation = c.next_document
       c.close
 
       explanation
     end
 
-    # Close the cursor.
+    # Closes the cursor.
     #
     # Note: if a cursor is read until exhausted (read until Mongo::Constants::OP_QUERY or
     # Mongo::Constants::OP_GETMORE returns zero for the cursor id), there is no need to
@@ -211,20 +214,20 @@ module Mongo
     # See http://www.mongodb.org/display/DOCS/Mongo+Wire+Protocol#MongoWireProtocol-Mongo::Constants::OPQUERY
     def query_opts
       timeout  = @timeout ? 0 : Mongo::Constants::OP_QUERY_NO_CURSOR_TIMEOUT
-      slave_ok = @connection.slave_ok? ? Mongo::Constants::OP_QUERY_SLAVE_OK : 0 
+      slave_ok = @connection.slave_ok? ? Mongo::Constants::OP_QUERY_SLAVE_OK : 0
       slave_ok + timeout
     end
 
-    # Returns the query options set on this Cursor.
+    # Returns the query options for this Cursor.
     def query_options_hash
       { :selector => @selector,
-        :fields   => @fields,   
-        :admin    => @admin,   
-        :skip     => @skip_num, 
-        :limit    => @limit_num, 
-        :order    => @order,   
-        :hint     => @hint,   
-        :snapshot => @snapshot, 
+        :fields   => @fields,
+        :admin    => @admin,
+        :skip     => @skip_num,
+        :limit    => @limit_num,
+        :order    => @order,
+        :hint     => @hint,
+        :snapshot => @snapshot,
         :timeout  => @timeout }
     end
 
@@ -245,7 +248,7 @@ module Mongo
       end
     end
 
-    # Set query selector hash. If the selector is a Code or String object, 
+    # Set the query selector hash. If the selector is a Code or String object,
     # the selector will be used in a $where clause.
     # See http://www.mongodb.org/display/DOCS/Server-side+Code+Execution
     def convert_selector_for_query(selector)
@@ -266,20 +269,21 @@ module Mongo
       @order || @explain || @hint || @snapshot
     end
 
+    # Return a number of documents remaining for this cursor.
     def num_remaining
       refill_via_get_more if @cache.length == 0
       @cache.length
     end
 
     # Internal method, not for general use. Return +true+ if there are
-    # more records to retrieve. This methods does not check @limit;
-    # #each is responsible for doing that.
+    # more records to retrieve. This method does not check @limit;
+    # Cursor#each is responsible for doing that.
     def more?
       num_remaining > 0
     end
 
     def refill_via_get_more
-      return if send_query_if_needed || @cursor_id.zero?
+      return if send_initial_query || @cursor_id.zero?
       message = ByteBuffer.new
       # Reserved.
       message.put_int(0)
@@ -290,7 +294,7 @@ module Mongo
 
       # Number of results to return; db decides for now.
       message.put_int(0)
-        
+
       # Cursor id.
       message.put_long(@cursor_id)
       results, @n_received, @cursor_id = @connection.receive_message(Mongo::Constants::OP_GET_MORE, message, "cursor.get_more()", @socket)
@@ -299,13 +303,13 @@ module Mongo
     end
 
     # Run query the first time we request an object from the wire
-    def send_query_if_needed
+    def send_initial_query
       if @query_run
         false
       else
         message = construct_query_message
-        results, @n_received, @cursor_id = @connection.receive_message(Mongo::Constants::OP_QUERY, message, 
-            (query_log_message if @connection.logger), @socket)  
+        results, @n_received, @cursor_id = @connection.receive_message(Mongo::Constants::OP_QUERY, message,
+            (query_log_message if @connection.logger), @socket)
         @cache += results
         @query_run = true
         close_cursor_if_query_complete
@@ -331,7 +335,7 @@ module Mongo
 
     def query_log_message
       "#{@admin ? 'admin' : @db.name}.#{@collection.name}.find(#{@selector.inspect}, #{@fields ? @fields.inspect : '{}'})" +
-      "#{@skip != 0 ? ('.skip(' + @skip.to_s + ')') : ''}#{@limit != 0 ? ('.limit(' + @limit.to_s + ')') : ''}" 
+      "#{@skip != 0 ? ('.skip(' + @skip.to_s + ')') : ''}#{@limit != 0 ? ('.limit(' + @limit.to_s + ')') : ''}"
     end
 
     def selector_with_special_query_fields
@@ -349,7 +353,7 @@ module Mongo
         when String, Symbol then string_as_sort_parameters(@order)
         when Array then array_as_sort_parameters(@order)
         else
-          raise InvalidSortValueError, "Illegal sort clause, '#{@order.class.name}'; must be of the form " + 
+          raise InvalidSortValueError, "Illegal sort clause, '#{@order.class.name}'; must be of the form " +
             "[['field1', '(ascending|descending)'], ['field2', '(ascending|descending)']]"
       end
     end