mongo 1.7.1 → 1.8.0

data/lib/mongo/{sharded_connection.rb → mongo_sharded_client.rb}

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 # --
-# Copyright (C) 2008-2011 10gen Inc.
+# Copyright (C) 2008-2012 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@
 module Mongo
 
   # Instantiates and manages connections to a MongoDB sharded cluster for high availability.
-  class ShardedConnection < ReplSetConnection
+  class MongoShardedClient < MongoReplicaSetClient
 
     SHARDED_CLUSTER_OPTS = [:refresh_mode, :refresh_interval]
 
@@ -34,9 +34,9 @@ module Mongo
     #
     # @option opts [String] :name (nil) The name of the sharded cluster to connect to. You
     #   can use this option to verify that you're connecting to the right sharded cluster.
-    # @option opts [Boolean, Hash] :safe (false) Set the default safe-mode options
-    #   propagated to DB objects instantiated off of this Connection. This
-    #   default can be overridden upon instantiation of any DB by explicitly setting a :safe value
+    # @option opts [Hash] ::w (1), :j (false), :wtimeout (false), :fsync (false) Set the default write concern
+    #   propagated to DB objects instantiated off of this MongoClient. This
+    #   default can be overridden upon instantiation of any DB by explicitly setting a write concern values
     #   on initialization.
     # @option opts [Logger] :logger (nil) Logger instance to receive driver operation log.
     # @option opts [Integer] :pool_size (1) The maximum number of socket connections allowed per
@@ -58,7 +58,7 @@ module Mongo
     # The purpose of seed nodes is to permit the driver to find at least one sharded cluster member even if a member is down.
     #
     # @example Connect to a sharded cluster and provide two seed nodes.
-    #   Mongo::ShardedConnection.new(['localhost:30000', 'localhost:30001'])
+    #   MongoShardedClient.new(['localhost:30000', 'localhost:30001'])
     #
     # @raise [MongoArgumentError] This is raised for usage errors.
     #
@@ -71,14 +71,14 @@ module Mongo
       if nodes.empty? and ENV.has_key?('MONGODB_URI')
         parser = URIParser.new ENV['MONGODB_URI']
         if parser.direct?
-          raise MongoArgumentError, "Mongo::ShardedConnection.new called with no arguments, but ENV['MONGODB_URI'] implies a direct connection."
+          raise MongoArgumentError, "Mongo::MongoShardedClient.new called with no arguments, but ENV['MONGODB_URI'] implies a direct connection."
         end
         opts = parser.connection_options.merge! opts
         nodes = [parser.nodes]
       end
 
       unless nodes.length > 0
-        raise MongoArgumentError, "A ShardedConnection requires at least one seed node."
+        raise MongoArgumentError, "A MongoShardedClient requires at least one seed node."
       end
 
       @seeds = nodes.map do |host_port|
@@ -118,7 +118,7 @@ module Mongo
     end
 
     def inspect
-      "<Mongo::ShardedConnection:0x#{self.object_id.to_s(16)} @seeds=#{@seeds.inspect} " +
+      "<Mongo::MongoShardedClient:0x#{self.object_id.to_s(16)} @seeds=#{@seeds.inspect} " +
           "@connected=#{@connected}>"
     end
 

data/lib/mongo/networking.rb

@@ -18,7 +18,7 @@ module Mongo
     # @return [Integer] number of bytes sent
     def send_message(operation, message, opts={})
       if opts.is_a?(String)
-        warn "Connection#send_message no longer takes a string log message. " +
+        warn "MongoClient#send_message no longer takes a string log message. " +
           "Logging is now handled within the Collection and Cursor classes."
         opts = {}
       end
@@ -56,12 +56,11 @@ module Mongo
     # @see DB#get_last_error for valid last error params.
     #
     # @return [Hash] The document returned by the call to getlasterror.
-    def send_message_with_safe_check(operation, message, db_name, log_message=nil, last_error_params=false)
+    def send_message_with_gle(operation, message, db_name, log_message=nil, write_concern=false)
       docs = num_received = cursor_id = ''
       add_message_headers(message, operation)
 
-      last_error_message = BSON::ByteBuffer.new
-      build_last_error_message(last_error_message, db_name, last_error_params)
+      last_error_message = build_get_last_error_message(db_name, write_concern)
       last_error_id = add_message_headers(last_error_message, Mongo::Constants::OP_QUERY)
 
       packed_message = message.append!(last_error_message).to_s
@@ -181,7 +180,7 @@ module Mongo
 
       # unpacks to flags, cursor_id_a, cursor_id_b, starting_from, number_remaining
       flags, cursor_id_a, cursor_id_b, _, number_remaining = header_buf.unpack('VVVVV')
-      
+
       check_response_flags(flags)
       cursor_id = (cursor_id_b << 32) + cursor_id_a
       [number_remaining, cursor_id]
@@ -209,23 +208,28 @@ module Mongo
       [docs, number_received]
     end
 
-    # Constructs a getlasterror message. This method is used exclusively by
-    # Connection#send_message_with_safe_check.
-    #
-    # Because it modifies message by reference, we don't need to return it.
-    def build_last_error_message(message, db_name, opts)
+    def build_command_message(db_name, query, projection=nil, skip=0, limit=-1)
+      message = BSON::ByteBuffer.new
       message.put_int(0)
       BSON::BSON_RUBY.serialize_cstr(message, "#{db_name}.$cmd")
-      message.put_int(0)
-      message.put_int(-1)
-      cmd = BSON::OrderedHash.new
-      cmd[:getlasterror] = 1
-      if opts.is_a?(Hash)
-        opts.assert_valid_keys(:w, :wtimeout, :fsync, :j)
-        cmd.merge!(opts)
+      message.put_int(skip)
+      message.put_int(limit)
+      message.put_binary(BSON::BSON_CODER.serialize(query, false).to_s)
+      message.put_binary(BSON::BSON_CODER.serialize(projection, false).to_s) if projection
+      message
+    end
+
+    # Constructs a getlasterror message. This method is used exclusively by
+    # MongoClient#send_message_with_gle.
+    def build_get_last_error_message(db_name, write_concern)
+      gle = BSON::OrderedHash.new
+      gle[:getlasterror] = 1
+      if write_concern.is_a?(Hash)
+        write_concern.assert_valid_keys(:w, :wtimeout, :fsync, :j)
+        gle.merge!(write_concern)
+        gle.delete(:w) if gle[:w] == 1
       end
-      message.put_binary(BSON::BSON_CODER.serialize(cmd, false).to_s)
-      nil
+      build_command_message(db_name, gle)
     end
 
     # Prepares a message for transmission to MongoDB by
@@ -282,6 +286,7 @@ module Mongo
       end
       total_bytes_sent
       rescue => ex
+        socket.close
         raise ConnectionFailure, "Operation failed with the following exception: #{ex}:#{ex.message}"
       end
     end
@@ -306,7 +311,7 @@ module Mongo
     def receive_data(length, socket)
       message = new_binary_string
       socket.read(length, message)
- 
+
       raise ConnectionFailure, "connection closed" unless message && message.length > 0
       if message.length < length
         chunk = new_binary_string

data/lib/mongo/util/conversions.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 # --
-# Copyright (C) 2008-2011 10gen Inc.
+# Copyright (C) 2008-2012 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/util/core_ext.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 # --
-# Copyright (C) 2008-2011 10gen Inc.
+# Copyright (C) 2008-2012 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/util/logging.rb

@@ -29,17 +29,28 @@ module Mongo
     # Execute the block and log the operation described by name and payload.
     def instrument(name, payload = {})
       start_time = Time.now
-      res = yield
-      log_operation(name, payload, start_time)
+      res = Logging.instrumenter.instrument(name, payload) do
+        yield
+      end
+      duration = Time.now - start_time
+      log_operation(name, payload, duration)
       res
     end
 
+    def self.instrumenter
+      @instrumenter || Instrumenter
+    end
+
+    def self.instrumenter=(instrumenter)
+      @instrumenter = instrumenter
+    end
+
     protected
 
-    def log_operation(name, payload, start_time)
+    def log_operation(name, payload, duration)
       @logger && @logger.debug do
         msg = "MONGODB "
-        msg << "(#{((Time.now - start_time) * 1000).to_i}ms) "
+        msg << "(%.1fms) " % (duration * 1000)
         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]
@@ -49,5 +60,10 @@ module Mongo
       end
     end
 
+    module Instrumenter
+      def self.instrument(name, payload = {})
+        yield
+      end
+    end
   end
 end

data/lib/mongo/util/node.rb

@@ -1,10 +1,10 @@
 module Mongo
   class Node
 
-    attr_accessor :host, :port, :address, :config, :connection, :socket, :last_state
+    attr_accessor :host, :port, :address, :config, :client, :socket, :last_state
 
-    def initialize(connection, host_port)
-      @connection = connection
+    def initialize(client, host_port)
+      @client = client
       @host, @port = split_node(host_port)
       @address = "#{@host}:#{@port}"
       @config = nil
@@ -29,11 +29,11 @@ module Mongo
     # return nil.
     def connect
       begin
-        socket = @connection.socket_class.new(@host, @port, 
-          @connection.op_timeout, @connection.connect_timeout
+        socket = @client.socket_class.new(@host, @port, 
+          @client.op_timeout, @client.connect_timeout
         )
       rescue OperationTimeout, ConnectionFailure, OperationFailure, SocketError, SystemCallError, IOError => ex
-        @connection.log(:debug, "Failed connection to #{host_string} with #{ex.class}, #{ex.message}.")
+        @client.log(:debug, "Failed connection to #{host_string} with #{ex.class}, #{ex.message}.")
         socket.close if socket
       end
 
@@ -54,7 +54,7 @@ module Mongo
 
     def active?
       begin
-        result = @connection['admin'].command({:ping => 1}, :socket => @socket)
+        result = @client['admin'].command({:ping => 1}, :socket => @socket)
       rescue OperationFailure, SocketError, SystemCallError, IOError
         return nil
       end
@@ -66,16 +66,16 @@ module Mongo
     # matches with the name provided.
     def set_config
       begin
-        @config = @connection['admin'].command({:ismaster => 1}, :socket => @socket)
+        @config = @client['admin'].command({:ismaster => 1}, :socket => @socket)
 
         if @config['msg']
-          @connection.log(:warn, "#{config['msg']}")
+          @client.log(:warn, "#{config['msg']}")
         end
 
         check_set_membership(config)
         check_set_name(config)
       rescue ConnectionFailure, OperationFailure, OperationTimeout, SocketError, SystemCallError, IOError => ex
-        @connection.log(:warn, "Attempted connection to node #{host_string} raised " +
+        @client.log(:warn, "Attempted connection to node #{host_string} raised " +
                             "#{ex.class}: #{ex.message}")
 
         # Socket may already be nil from issuing command
@@ -145,12 +145,12 @@ module Mongo
       end
 
       host = host_port[0]
-      port = host_port[1].nil? ? Connection::DEFAULT_PORT : host_port[1].to_i
+      port = host_port[1].nil? ? MongoClient::DEFAULT_PORT : host_port[1].to_i
 
       [host, port]
     end
 
-    # Ensure that this node is a healty member of a replica set.
+    # Ensure that this node is a healthy member of a replica set.
     def check_set_membership(config)
       if !config.has_key?('hosts')
         message = "Will not connect to #{host_string} because it's not a member " +
@@ -165,13 +165,13 @@ module Mongo
 
     # Ensure that this node is part of a replica set of the expected name.
     def check_set_name(config)
-      if @connection.replica_set_name
+      if @client.replica_set_name
         if !config['setName']
-          @connection.log(:warn, "Could not verify replica set name for member #{host_string} " +
+          @client.log(:warn, "Could not verify replica set name for member #{host_string} " +
             "because ismaster does not return name in this version of MongoDB")
-        elsif @connection.replica_set_name != config['setName']
+        elsif @client.replica_set_name != config['setName']
           message = "Attempting to connect to replica set '#{config['setName']}' on member #{host_string} " +
-            "but expected '#{@connection.replica_set_name}'"
+            "but expected '#{@client.replica_set_name}'"
           raise ReplicaSetConnectionError, message
         end
       end

data/lib/mongo/util/pool.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 # --
-# Copyright (C) 2008-2011 10gen Inc.
+# Copyright (C) 2008-2012 10gen Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -21,12 +21,17 @@ module Mongo
     MAX_PING_TIME  = 1_000_000
     PRUNE_INTERVAL = 10_000
 
-    attr_accessor :host, :port, :address,
-      :size, :timeout, :safe, :checked_out, :connection
+    attr_accessor :host,
+                  :port,
+                  :address,
+                  :size,
+                  :timeout,
+                  :checked_out,
+                  :client
 
     # Create a new pool of connections.
-    def initialize(connection, host, port, opts={})
-      @connection  = connection
+    def initialize(client, host, port, opts={})
+      @client = client
 
       @host, @port = host, port
 
@@ -43,25 +48,28 @@ module Mongo
       # Mutex for synchronizing pool access
       @connection_mutex = Mutex.new
 
+      # Mutex for synchronizing pings
+      @ping_mutex = Mutex.new
+
       # Condition variable for signal and wait
       @queue = ConditionVariable.new
 
       # Operations to perform on a socket
       @socket_ops = Hash.new { |h, k| h[k] = [] }
 
-      @sockets      = []
-      @pids         = {}
-      @checked_out  = []
-      @ping_time    = nil
-      @last_ping    = nil
-      @closed       = false
+      @sockets            = []
+      @pids               = {}
+      @checked_out        = []
+      @ping_time          = nil
+      @last_ping          = nil
+      @closed             = false
       @threads_to_sockets = {}
       @checkout_counter   = 0
     end
 
     # Close this pool.
     #
-    # @option opts [Boolean] :soft (false) If true,
+    # @option opts [Boolean]:soft (false) If true,
     #   close only those sockets that are not checked out.
     def close(opts={})
       @connection_mutex.synchronize do
@@ -85,6 +93,29 @@ module Mongo
       @closed
     end
 
+    def up?
+      !@closed
+    end
+
+    def matches_mode(mode)
+      if mode == :primary && @node.secondary? ||
+        mode == :secondary && @node.primary?
+        false
+      else
+        true
+      end
+    end
+
+    def matches_tag_set(tag_set)
+      tag_set.all? do |tag, value|
+        tags.has_key?(tag) && tags[tag] == value
+      end
+    end
+
+    def matches_tag_sets(tag_sets)
+      tag_sets.all? {|set| matches_tag_set(set)}
+    end
+
     def inspect
       "#<Mongo::Pool:0x#{self.object_id.to_s(16)} @host=#{@host} @port=#{port} " +
         "@ping_time=#{@ping_time} #{@checked_out.size}/#{@size} sockets available " +
@@ -102,15 +133,13 @@ module Mongo
     # Refresh ping time only if we haven't
     # checked within the last five minutes.
     def ping_time
-      if !@last_ping
-        @last_ping = Time.now
-        @ping_time = refresh_ping_time
-      elsif Time.now - @last_ping > 300
-        @last_ping = Time.now
-        @ping_time = refresh_ping_time
-      else
-        @ping_time
+      @ping_mutex.synchronize do
+        if !@last_ping || (Time.now - @last_ping) > 300
+          @ping_time = refresh_ping_time
+          @last_ping = Time.now
+        end
       end
+      @ping_time
     end
 
     # Return the time it takes on average
@@ -139,7 +168,7 @@ module Mongo
 
     def ping
       begin
-        return self.connection['admin'].command({:ping => 1}, :socket => @node.socket, :timeout => 1)
+        return self.client['admin'].command({:ping => 1}, :socket => @node.socket, :timeout => MAX_PING_TIME)
       rescue ConnectionFailure, OperationFailure, SocketError, SystemCallError, IOError
         return false
       end
@@ -163,7 +192,7 @@ module Mongo
     # therefore, it runs within a mutex.
     def checkout_new_socket
       begin
-        socket = @connection.socket_class.new(@host, @port, @connection.op_timeout)
+        socket = @client.socket_class.new(@host, @port, @client.op_timeout)
         socket.pool = self
       rescue => ex
         socket.close if socket
@@ -173,7 +202,7 @@ module Mongo
 
       # If any saved authentications exist, we want to apply those
       # when creating new sockets.
-      @connection.apply_saved_authentication(:socket => socket)
+      @client.apply_saved_authentication(:socket => socket)
 
       @sockets << socket
       @pids[socket] = Process.pid
@@ -190,7 +219,7 @@ module Mongo
       @connection_mutex.synchronize do
         @sockets.each do |socket|
           @socket_ops[socket] << Proc.new do
-            @connection.apply_saved_authentication(:socket => socket)
+            @client.apply_saved_authentication(:socket => socket)
           end
         end
       end
@@ -202,7 +231,7 @@ module Mongo
       @connection_mutex.synchronize do
         @sockets.each do |socket|
           @socket_ops[socket] << Proc.new do
-            @connection.db(db).issue_logout(:socket => socket)
+            @client.db(db).issue_logout(:socket => socket)
           end
         end
       end
@@ -246,7 +275,7 @@ module Mongo
     # pool size has not been exceeded. Otherwise, wait for the next
     # available socket.
     def checkout
-      @connection.connect if !@connection.connected?
+      @client.connect if !@client.connected?
       start_time = Time.now
       loop do
         if (Time.now - start_time) > @timeout
@@ -297,7 +326,7 @@ module Mongo
 
               socket = checkout_new_socket
             end
-            
+
             return socket
           else
             # Otherwise, wait