mongo 1.10.2 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a1eba07acbd5cbdc1ea149bee675c8cb19414fc
-  data.tar.gz: 94ede5709c9ed0d5aef5e05e19f6a4c90f5cc1d1
+  metadata.gz: 047647bfd88def86157a8e4e25df514da21a1364
+  data.tar.gz: 7fd48a7694323f7e4759b94f12058b5e34a6bba4
 SHA512:
-  metadata.gz: 007196c1e574ed834d0cdf44cde761220a531367d303aa1f074955ac112af6cf16a43943f466a00f1b7e955902e702d0ca99c67a33571d9341095b7258d4ef57
-  data.tar.gz: b8fcc33bf2f9119ada0e8b5c3010ad9246dd7cc32daa6240980955dd680ddd4b8474e92f3ea0fcbe9178042e6536e324d42d6a476c9ef042563f2509d35068c2
+  metadata.gz: 3b360776478001d2b41342764c13dd209954c0bbcf73c5b87dc4f2169d3e42bd27c6650514ca281a1146c33d1d2624edf653cf8ddd51e3ff8f9e37c9bf4505d3
+  data.tar.gz: e4a9d033eb058e0424ecae35599a27be0a7c68e56b2a0557dcbc42a331e940a0c42c73f0b1c1eeb3b76d977fe63a84df5b7310bc001feeb2f8441518e163b2eb

data/README.md

@@ -37,6 +37,17 @@ bundle install
 rake install
 ```
 
+To be able to use the driver with Kerberos authentication enabled, install the
+`mongo_kerberos` gem and add it instead of mongo to your application:
+
+```bash
+gem install mongo_kerberos
+```
+
+```ruby
+require 'mongo_kerberos'
+```
+
 Usage
 -----
 Here is a quick example of basic usage for the Ruby driver:
@@ -84,10 +95,10 @@ MRI 1.8.7, 1.9.3, 2.0.0<br>JRuby 1.7.x | Windows<br>Linux<br>OS X | x86<br>x64<b
 Support & Feedback
 -----
 
-For issues, questions or feedback related to the Ruby driver, please look into
-our [support channels](http://www.mongodb.org/about/support). Please
-do not email any of the Ruby developers directly with issues or
-questions - you're more likely to get an answer quickly on the [mongodb-user list](http://groups.google.com/group/mongodb-user) on Google Groups.
+**Support Channels**
+
+For issues, questions or feedback related to the Ruby driver, please look into our [support channels](http://www.mongodb.org/about/support).
+Please do not email any of the Ruby developers directly with issues or questions. You'll get a quicker answer on the [mongodb-user list](http://groups.google.com/group/mongodb-user) Google Group.
 
 Bugs & Feature Requests
 -----
@@ -100,18 +111,41 @@ Do you have a bug to report or a feature request to make?
 
 When reporting an issue, please keep in mind that all information in JIRA for all driver projects (ex. RUBY, CSHARP, JAVA) and the Core Server (ex. SERVER) project is **PUBLICLY** visible.
 
-**PLEASE DO**
+**HOW TO ASK FOR HELP**
 
-* Provide as much information as possible about the issue.
-* Provide detailed steps for reproducing the issue.
-* Provide any applicable code snippets, stack traces and log data.
-* Specify version information for the driver and MongoDB.
+Providing enough information so we can reproduce the issue immediately will reduce roundtrip communications and get you a useful response as quickly as possible.
+That said, please provide the following information when logging an issue:
+
+1. Environment
+2. Ruby version, including patch-level
+3. MongoDB version
+4. A test case or code snippets
+5. Stack traces and log data, keeping in mind that this info is public
 
 **PLEASE DO NOT**
 
 * Provide any sensitive data or server logs.
 * Report potential security issues publicly (see 'Security Issues').
 
+**EXAMPLE BUG REPORT**
+
+Example taken from [RUBY-775](https://jira.mongodb.org/browse/RUBY-775)
+
+```
+There appears to be a recursive locking condition in the replica set connection pooling.
+
+Environment: AWS Linux 3.10.37-47.135.amzn1.x86_64 / jruby-1.7.12 / JDK java-1.7.0-openjdk-1.7.0.55-2.4.7.1.40.amzn1.x86_64
+
+Component: Connection Pooling / Replica set
+
+Here is a stack trace:
+https://gist.githubusercontent.com/cheald/5ed01172c5b2c9943c87/raw/63075158dac4c78c1775cac8bf84ba3b6537bc1e/gistfile1.txt
+
+The original lock occurs [here](https://github.com/mongodb/mongo-ruby-driver/blob/1.x-stable/lib/mongo/connection/pool_manager.rb#L60)
+
+and then the process of reconnecting ends up attempting to resynchronize the same lock [here](https://github.com/mongodb/mongo-ruby-driver/blob/1.x-stable/lib/mongo/connection/pool_manager.rb#L150)
+```
+
 Security Issues
 -----
 

data/VERSION

@@ -1 +1 @@
-1.10.2
+1.11.1

data/lib/mongo.rb

@@ -64,6 +64,7 @@ module Mongo
     INVALID_BSON             = 22
     WRITE_CONCERN_FAILED     = 64
     MULTIPLE_ERRORS_OCCURRED = 65
+    UNAUTHORIZED             = 13
 
     # mongod/s 2.6 and above return code 59 when a command doesn't exist.
     # mongod versions previous to 2.6 and mongos 2.4.x return no error code

data/lib/mongo/collection.rb

@@ -518,8 +518,9 @@ module Mongo
     # @option opts [Boolean] :unique (false) if true, this index will enforce a uniqueness constraint.
     # @option opts [Boolean] :background (false) indicate that the index should be built in the background. This
     #   feature is only available in MongoDB >= 1.3.2.
-    # @option opts [Boolean] :drop_dups (nil) If creating a unique index on a collection with pre-existing records,
-    #   this option will keep the first document the database indexes and drop all subsequent with duplicate values.
+    # @option opts [Boolean] :drop_dups (nil) (DEPRECATED) If creating a unique index on a collection with
+    #   pre-existing records, this option will keep the first document the database indexes and drop all subsequent
+    #   with duplicate values.
     # @option opts [Integer] :bucket_size (nil) For use with geoHaystack indexes. Number of documents to group
     #   together within a certain proximity to a given longitude and latitude.
     # @option opts [Integer] :min (nil) specify the minimum longitude and latitude for a geo index.
@@ -545,15 +546,19 @@ module Mongo
     # @example A geospatial index with alternate longitude and latitude:
     #   @restaurants.create_index([['location', Mongo::GEO2D]], :min => 500, :max => 500)
     #
+    # @note The :drop_dups option is no longer supported by MongoDB starting with server version 2.7.5.
+    #   The option is silently ignored by the server and unique index builds using the option will
+    #   fail if a duplicate value is detected.
+    #
     # @return [String] the name of the index created.
     def create_index(spec, opts={})
-      opts[:dropDups]   = opts[:drop_dups] if opts[:drop_dups]
-      opts[:bucketSize] = opts[:bucket_size] if opts[:bucket_size]
-      field_spec        = parse_index_spec(spec)
-      opts              = opts.dup
-      name              = opts.delete(:name) || generate_index_name(field_spec)
-      name              = name.to_s if name
-      generate_indexes(field_spec, name, opts)
+      options              = opts.dup
+      options[:dropDups]   = options.delete(:drop_dups) if options[:drop_dups]
+      options[:bucketSize] = options.delete(:bucket_size) if options[:bucket_size]
+      field_spec           = parse_index_spec(spec)
+      name                 = options.delete(:name) || generate_index_name(field_spec)
+      name                 = name.to_s if name
+      generate_indexes(field_spec, name, options)
       name
     end
 
@@ -572,17 +577,22 @@ module Mongo
     #   Time t+10min : @posts.ensure_index(:subject => Mongo::ASCENDING) -- calls create_index and
     #     resets the 5 minute counter
     #
+    # @note The :drop_dups option is no longer supported by MongoDB starting with server version 2.7.5.
+    #   The option is silently ignored by the server and unique index builds using the option will
+    #   fail if a duplicate value is detected.
+    #
     # @return [String] the name of the index.
     def ensure_index(spec, opts={})
-      now               = Time.now.utc.to_i
-      opts[:dropDups]   = opts[:drop_dups] if opts[:drop_dups]
-      opts[:bucketSize] = opts[:bucket_size] if opts[:bucket_size]
-      field_spec        = parse_index_spec(spec)
-      name              = opts[:name] || generate_index_name(field_spec)
-      name              = name.to_s if name
+      now                  = Time.now.utc.to_i
+      options              = opts.dup
+      options[:dropDups]   = options.delete(:drop_dups) if options[:drop_dups]
+      options[:bucketSize] = options.delete(:bucket_size) if options[:bucket_size]
+      field_spec           = parse_index_spec(spec)
+      name                 = options.delete(:name) || generate_index_name(field_spec)
+      name                 = name.to_s if name
 
       if !@cache[name] || @cache[name] <= now
-        generate_indexes(field_spec, name, opts)
+        generate_indexes(field_spec, name, options)
       end
 
       # Reset the cache here in case there are any errors inserting. Best to be safe.
@@ -1029,6 +1039,10 @@ module Mongo
     # @option opts [Hash] :query ({}) A query selector for filtering the documents counted.
     # @option opts [Integer] :skip (nil) The number of documents to skip.
     # @option opts [Integer] :limit (nil) The number of documents to limit.
+    # @option opts [String, Array, OrderedHash] :hint hint for query optimizer, usually not necessary if
+    #   using MongoDB > 1.1. This option is only supported with #count in server version > 2.6.
+    # @option opts [String] :named_hint for specifying a named index as a hint, will be overridden by :hint
+    #   if :hint is also provided. This option is only supported with #count in server version > 2.6.
     # @option opts [:primary, :secondary] :read Read preference for this command. See Collection#find for
     #  more details.
     # @option opts [String]  :comment (nil) a comment to include in profiling logs
@@ -1036,12 +1050,13 @@ module Mongo
     # @return [Integer]
     def count(opts={})
       find(opts[:query],
-           :skip  => opts[:skip],
-           :limit => opts[:limit],
-           :read  => opts[:read],
-           :comment => opts[:comment]).count(true)
+           :skip       => opts[:skip],
+           :limit      => opts[:limit],
+           :named_hint => opts[:named_hint] || @hint,
+           :hint       => opts[:hint] || @hint,
+           :read       => opts[:read],
+           :comment    => opts[:comment]).count(true)
     end
-
     alias :size :count
 
     protected

data/lib/mongo/connection/pool.rb

@@ -182,10 +182,6 @@ module Mongo
         raise ConnectionFailure, "Failed to connect to host #{@host} and port #{@port}: #{ex}"
       end
 
-      # If any saved authentications exist, we want to apply those
-      # when creating new sockets and process logouts.
-      check_auths(socket)
-
       @sockets << socket
       @checked_out << socket
       @thread_ids_to_sockets[Thread.current.object_id] = socket
@@ -199,12 +195,8 @@ module Mongo
     #
     # @deprecated This method has been replaced by Pool#check_auths (private)
     # and it isn't necessary to ever invoke this method directly.
+    # Authentication of sockets is handled upon checkout and checkin.
     def authenticate_existing
-      @connection_mutex.synchronize do
-        @sockets.each do |socket|
-          check_auths(socket)
-        end
-      end
     end
 
     # Store the logout op for each existing socket to be applied before
@@ -212,12 +204,8 @@ module Mongo
     #
     # @deprecated This method has been replaced by Pool#check_auths (private)
     # and it isn't necessary to ever invoke this method directly.
+    # Authentication of sockets is handled upon checkout and checkin.
     def logout_existing(database)
-      @connection_mutex.synchronize do
-        @sockets.each do |socket|
-          check_auths(socket)
-        end
-      end
     end
 
     # Checks out the first available socket from the pool.
@@ -291,16 +279,20 @@ module Mongo
           end
 
           if socket
-            check_auths(socket)
-
-            if socket.closed?
-              @checked_out.delete(socket)
-              @sockets.delete(socket)
-              @thread_ids_to_sockets.delete(Thread.current.object_id)
-              socket = checkout_new_socket
+            if !socket.closed?
+              begin
+                check_auths(socket)
+                return socket
+              rescue ConnectionFailure
+                # Socket failed authentication and will be cleaned up below
+              end
             end
 
-            return socket
+            # Socket was closed from earlier network error, or just now from
+            # a network error when authenticating.
+            @checked_out.delete(socket)
+            @sockets.delete(socket)
+            @thread_ids_to_sockets.delete(Thread.current.object_id)
           else
             # Otherwise, wait
             @queue.wait(@connection_mutex)

data/lib/mongo/cursor.rb

@@ -203,7 +203,12 @@ module Mongo
         command.merge!(BSON::OrderedHash["skip", @skip]) if @skip != 0
       end
 
+      if @hint
+        hint = @hint.is_a?(String) ? @hint : generate_index_name(@hint)
+      end
+
       command.merge!(BSON::OrderedHash["fields", @fields])
+      command.merge!(BSON::OrderedHash["hint", hint]) if hint
 
       response = @db.command(command, :read => @read, :comment => @comment)
       return response['n'].to_i if Mongo::Support.ok?(response)
@@ -715,5 +720,13 @@ module Mongo
     def compile_regex?
       @compile_regex
     end
+
+    def generate_index_name(spec)
+      indexes = []
+      spec.each_pair do |field, type|
+        indexes.push("#{field}_#{type}")
+      end
+      indexes.join("_")
+    end
   end
 end

data/lib/mongo/db.rb

@@ -156,7 +156,6 @@ module Mongo
       warn "[DEPRECATED] Disabling the 'save_auth' option no longer has " +
            "any effect. Please see the API documentation for more details " +
            "on this change." unless save_auth.nil?
-
       @client.add_auth(self.name, username, password, source, mechanism, extra)
       true
     end
@@ -220,19 +219,25 @@ module Mongo
     def add_user(username, password=nil, read_only=false, opts={})
       begin
         user_info = command(:usersInfo => username)
-      # MongoDB >= 2.5.3 requires the use of commands to manage users.
-      # "Command not found" error didn't return an error code (59) before
-      # MongoDB 2.4.7 so we assume that a nil error code means the usersInfo
-      # command doesn't exist and we should fall back to the legacy add user code.
+        if user_info.key?('users') && !user_info['users'].empty?
+          create_or_update_user(:updateUser, username, password, read_only, opts)
+        else
+          create_or_update_user(:createUser, username, password, read_only, opts)
+        end
+          # MongoDB >= 2.5.3 requires the use of commands to manage users.
+          # "Command not found" error didn't return an error code (59) before
+          # MongoDB 2.4.7 so we assume that a nil error code means the usersInfo
+          # command doesn't exist and we should fall back to the legacy add user code.
       rescue OperationFailure => ex
-        raise ex unless Mongo::ErrorCode::COMMAND_NOT_FOUND_CODES.include?(ex.error_code)
-        return legacy_add_user(username, password, read_only, opts)
-      end
-
-      if user_info.key?('users') && !user_info['users'].empty?
-        create_or_update_user(:updateUser, username, password, read_only, opts)
-      else
-        create_or_update_user(:createUser, username, password, read_only, opts)
+        if Mongo::ErrorCode::COMMAND_NOT_FOUND_CODES.include?(ex.error_code)
+          legacy_add_user(username, password, read_only, opts)
+        elsif ex.error_code == Mongo::ErrorCode::UNAUTHORIZED
+          # In MongoDB > 2.7 the localhost exception was narrowed, and the usersInfo
+          # command is no longer allowed.  In this case, add the first user.
+          create_or_update_user(:createUser, username, password, read_only, opts)
+        else
+          raise ex
+        end
       end
     end
 

data/lib/mongo/functional.rb

@@ -17,5 +17,3 @@ require 'mongo/functional/logging'
 require 'mongo/functional/read_preference'
 require 'mongo/functional/write_concern'
 require 'mongo/functional/uri_parser'
-
-require 'mongo/functional/sasl_java' if RUBY_PLATFORM =~ /java/

data/lib/mongo/functional/authentication.rb

@@ -166,12 +166,12 @@ module Mongo
     # @param db_name [String] The database name.
     # @param opts [Hash] Hash of optional settings and configuration values.
     #
-    # @option opts [Socket] socket (nil) Optional socket instance to use.
+    # @option opts [Socket] socket Socket instance to use.
     #
     # @raise [MongoDBError] Raised if the logout operation fails.
     # @return [Boolean] The result of the logout operation.
     def issue_logout(db_name, opts={})
-      doc = db(db_name).command({:logout => 1}, :socket => opts[:socket])
+      doc = auth_command({:logout => 1}, opts[:socket], db_name).first
       unless Support.ok?(doc)
         raise MongoDBError, "Error logging out on DB #{db_name}."
       end
@@ -185,7 +185,7 @@ module Mongo
     # @param auth [Hash] The authentication credentials to be used.
     # @param opts [Hash] Hash of optional settings and configuration values.
     #
-    # @option opts [Socket] socket (nil) Optional socket instance to use.
+    # @option opts [Socket] socket Socket instance to use.
     #
     # @raise [AuthenticationError] Raised if the authentication fails.
     # @return [Boolean] Result of the authentication operation.
@@ -217,14 +217,14 @@ module Mongo
     # @param auth [Hash] The authentication credentials to be used.
     # @param opts [Hash] Hash of optional settings and configuration values.
     #
-    # @option opts [Socket] socket (nil) Optional socket instance to use.
+    # @option opts [Socket] socket Socket instance to use.
     #
     # @return [Boolean] Result of the authentication operation.
     #
     # @private
     def issue_cr(auth, opts={})
-      database = db(auth[:source])
-      nonce    = get_nonce(database, opts)
+      db_name = auth[:source]
+      nonce   = get_nonce(auth[:source], opts)
 
       # build auth command document
       cmd = BSON::OrderedHash.new
@@ -234,9 +234,7 @@ module Mongo
       cmd['key'] = Authentication.auth_key(auth[:username],
                                            auth[:password],
                                            nonce)
-
-      database.command(cmd, :check_response => false,
-                            :socket         => opts[:socket])
+      auth_command(cmd, opts[:socket], db_name).first
     end
 
     # Handles issuing authentication commands for the MONGODB-X509 auth mechanism.
@@ -246,15 +244,14 @@ module Mongo
     #
     # @private
     def issue_x509(auth, opts={})
-      database = db('$external')
+      db_name = '$external'
 
       cmd = BSON::OrderedHash.new
       cmd[:authenticate] = 1
       cmd[:mechanism]    = auth[:mechanism]
       cmd[:user]         = auth[:username]
 
-      database.command(cmd, :check_response => false,
-                            :socket         => opts[:socket])
+      auth_command(cmd, opts[:socket], db_name).first
     end
 
     # Handles issuing authentication commands for the PLAIN auth mechanism.
@@ -262,14 +259,14 @@ module Mongo
     # @param auth [Hash] The authentication credentials to be used.
     # @param opts [Hash] Hash of optional settings and configuration values.
     #
-    # @option opts [Socket] socket (nil) Optional socket instance to use.
+    # @option opts [Socket] socket Socket instance to use.
     #
     # @return [Boolean] Result of the authentication operation.
     #
     # @private
     def issue_plain(auth, opts={})
-      database = db(auth[:source])
-      payload  = "\x00#{auth[:username]}\x00#{auth[:password]}"
+      db_name = auth[:source]
+      payload = "\x00#{auth[:username]}\x00#{auth[:password]}"
 
       cmd = BSON::OrderedHash.new
       cmd[:saslStart]     = 1
@@ -277,8 +274,7 @@ module Mongo
       cmd[:payload]       = BSON::Binary.new(payload)
       cmd[:autoAuthorize] = 1
 
-      database.command(cmd, :check_response => false,
-                            :socket         => opts[:socket])
+      auth_command(cmd, opts[:socket], db_name).first
     end
 
     # Handles issuing authentication commands for the GSSAPI auth mechanism.
@@ -288,10 +284,7 @@ module Mongo
     #
     # @private
     def issue_gssapi(auth, opts={})
-      raise NotImplementedError,
-         "The #{auth[:mechanism]} authentication mechanism is only supported " +
-         "for JRuby." unless RUBY_PLATFORM =~ /java/
-      Mongo::Sasl::GSSAPI.authenticate(auth[:username], self, opts[:socket], auth[:extra] || {})
+      raise "In order to use Kerberos, please add the mongo-kerberos gem to your dependencies"
     end
 
     # Helper to fetch a nonce value from a given database instance.
@@ -299,20 +292,37 @@ module Mongo
     # @param database [Mongo::DB] The DB instance to use for issue the nonce command.
     # @param opts [Hash] Hash of optional settings and configuration values.
     #
-    # @option opts [Socket] socket (nil) Optional socket instance to use.
+    # @option opts [Socket] socket Socket instance to use.
     #
     # @raise [MongoDBError] Raised if there is an error executing the command.
     # @return [String] Returns the nonce value.
     #
     # @private
-    def get_nonce(database, opts={})
-      doc = database.command({:getnonce => 1}, :check_response => false,
-                                               :socket         => opts[:socket])
+    def get_nonce(db_name, opts={})
+      cmd = BSON::OrderedHash.new
+      cmd[:getnonce] = 1
+      doc = auth_command(cmd, opts[:socket], db_name).first
+
       unless Support.ok?(doc)
         raise MongoDBError, "Error retrieving nonce: #{doc}"
       end
       doc['nonce']
     end
 
+    def auth_command(selector, socket, db_name)
+      begin
+        message        = build_command_message(db_name, selector)
+        request_id     = add_message_headers(message, Mongo::Constants::OP_QUERY)
+        packed_message = message.to_s
+
+        send_message_on_socket(packed_message, socket)
+        receive(socket, request_id).shift
+      rescue OperationFailure => ex
+        return ex.result
+      rescue ConnectionFailure, OperationTimeout => ex
+        socket.close
+        raise ex
+      end
+    end
   end
 end