mongo 2.12.0.rc0 → 2.12.1

data/lib/mongo/crypt/context.rb

@@ -26,11 +26,11 @@ module Mongo
     class Context
       #  Create a new Context object
       #
-      # @param [ FFI::Pointer ] ctx A pointer to a mongocrypt_t object
-      #   used to create a new mongocrypt_ctx_t
-      # @param [ ClientEncryption::IO ] A instance of the IO class
+      # @param [ Mongo::Crypt::Handle ] mongocrypt_handle A handle to libmongocrypt
+      #   used to create a new context object.
+      # @param [ ClientEncryption::IO ] io An instance of the IO class
       #   that implements driver I/O methods required to run the
-      #   state machine
+      #   state machine.
       def initialize(mongocrypt_handle, io)
         # Ideally, this level of the API wouldn't be passing around pointer
         # references between objects, so this method signature is subject to change.

data/lib/mongo/crypt/encryption_io.rb

@@ -29,15 +29,15 @@ module Mongo
       # Creates a new EncryptionIO object with information about how to connect
       # to the key vault.
       #
-      # @param [ Mongo::Client ] client: The client used to connect to the collection
+      # @param [ Mongo::Client ] client The client used to connect to the collection
       #   that stores the encrypted documents, defaults to nil.
-      # @param [ Mongo::Client ] mongocryptd_client: The client connected to mongocryptd,
+      # @param [ Mongo::Client ] mongocryptd_client The client connected to mongocryptd,
       #   defaults to nil.
-      # @param [ Mongo::Client ] key_vault_client: The client connected to the
+      # @param [ Mongo::Client ] key_vault_client The client connected to the
       #   key vault collection.
-      # @param [ String ] key_vault_namespace: The key vault namespace in the format
+      # @param [ String ] key_vault_namespace The key vault namespace in the format
       #   db_name.collection_name.
-      # @param [ Hash ] mongocryptd_options: Options related to mongocryptd.
+      # @param [ Hash ] mongocryptd_options Options related to mongocryptd.
       #
       # @option mongocryptd_options [ Boolean ] :mongocryptd_bypass_spawn
       # @option mongocryptd_options [ String ] :mongocryptd_spawn_path
@@ -105,13 +105,17 @@ module Mongo
           raise ArgumentError, 'mark_command requires mongocryptd_client to have been passed to the constructor, but it was not'
         end
 
+        # Ensure the response from mongocryptd is deserialized with { mode: :bson }
+        # to prevent losing type information in commands
+        options = { execution_options: { deserialize_as_bson: true } }
+
         begin
-          response = @mongocryptd_client.database.command(cmd)
+          response = @mongocryptd_client.database.command(cmd, options)
         rescue Error::NoServerAvailable => e
           raise e if @options[:mongocryptd_bypass_spawn]
 
           spawn_mongocryptd
-          response = @mongocryptd_client.database.command(cmd)
+          response = @mongocryptd_client.database.command(cmd, options)
         end
 
         return response.first
@@ -179,7 +183,8 @@ module Mongo
       def key_vault_collection
         @key_vault_collection ||= @key_vault_client.with(
           database: @key_vault_db_name,
-          read_concern: { level: :majority }
+          read_concern: { level: :majority },
+          write_concern: { w: :majority }
         )[@key_vault_collection_name]
       end
 
@@ -233,8 +238,9 @@ module Mongo
 
       # Provide an SSL socket to be used for KMS calls in a block API
       #
-      # @param [ String ] endpoint The URI at which to connect the SSL socket
-      # @param [ Proc ] block The block to execute
+      # @param [ String ] endpoint The URI at which to connect the SSL socket.
+      # @yieldparam [ OpenSSL::SSL::SSLSocket ] ssl_socket Yields an SSL socket
+      #   connected to the specified endpoint.
       #
       # @raise [ Mongo::Error::KmsError ] If the socket times out or raises
       #   an exception

data/lib/mongo/crypt/explicit_encrypter.rb

@@ -22,9 +22,9 @@ module Mongo
     class ExplicitEncrypter
       # Create a new ExplicitEncrypter object.
       #
-      # @params [ Mongo::Client ] key_vault_client An instance of Mongo::Client
+      # @param [ Mongo::Client ] key_vault_client An instance of Mongo::Client
       #   to connect to the key vault collection.
-      # @params [ String ] key_vault_namespace The namespace of the key vault
+      # @param [ String ] key_vault_namespace The namespace of the key vault
       #   collection in the format "db_name.collection_name".
       # @option options [ Hash ] :kms_providers A hash of key management service
       #   configuration information. Valid hash keys are :local or :aws. There
@@ -44,7 +44,7 @@ module Mongo
       #
       # @param [ String ] kms_provider The KMS provider to use. Valid values are
       #   "aws" and "local".
-      # @params [ Hash ] options
+      # @param [ Hash ] options
       #
       # @option options [ Hash ] :master_key Information about the AWS master key. Required
       #   if kms_provider is "aws".

data/lib/mongo/crypt/explicit_encryption_context.rb

@@ -38,7 +38,7 @@ module Mongo
       #   value. Valid algorithms are "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic"
       #   or "AEAD_AES_256_CBC_HMAC_SHA_512-Random"
       #
-      # @raises [ ArgumentError|Mongo::Error::CryptError ] If invalid options are provided
+      # @raise [ ArgumentError|Mongo::Error::CryptError ] If invalid options are provided
       def initialize(mongocrypt, io, doc, options={})
         super(mongocrypt, io)
 

data/lib/mongo/crypt/handle.rb

@@ -269,10 +269,8 @@ module Mongo
         access_key_id = kms_providers[:aws][:access_key_id]
         secret_access_key = kms_providers[:aws][:secret_access_key]
 
-        valid_access_key_id = access_key_id && access_key_id.is_a?(String)
-        valid_secret_access_key = secret_access_key && secret_access_key.is_a?(String)
-
-        unless valid_access_key_id && valid_secret_access_key
+        unless kms_providers[:aws].key?(:access_key_id) && 
+            kms_providers[:aws].key?(:secret_access_key)
           raise ArgumentError.new(
             "The specified aws kms_providers option is invalid: #{kms_providers[:aws]}. " +
             "kms_providers with :aws key must be in the format: " +
@@ -280,6 +278,30 @@ module Mongo
           )
         end
 
+        %i(access_key_id secret_access_key).each do |key|
+          value = kms_providers[:aws][key]
+          if value.nil?
+            raise ArgumentError.new(
+              "The aws #{key} option must be a String with at least one character; " \
+              "currently have nil"
+            )
+          end
+
+          unless value.is_a?(String)
+            raise ArgumentError.new(
+              "The aws #{key} option must be a String with at least one character; " \
+              "currently have #{value}"
+            )
+          end
+
+          if value.empty?
+            raise ArgumentError.new(
+              "The aws #{key} option must be a String with at least one character; " \
+              "it is currently an empty string"
+            )
+          end
+        end
+
         Binding.setopt_kms_provider_aws(self, access_key_id, secret_access_key)
       end
 

data/lib/mongo/crypt/hooks.rb

@@ -62,7 +62,7 @@ module Mongo
 
       # An HMAC SHA-512 or SHA-256 function
       #
-      # @param [ String ] The name of the digest, either "SHA256" or "SHA512"
+      # @param [ String ] digest_name The name of the digest, either "SHA256" or "SHA512"
       # @param [ String ] key The 32-byte AES encryption key
       # @param [ String ] input The data to be tagged
       #

data/lib/mongo/database.rb

@@ -162,9 +162,18 @@ module Mongo
     #
     # @option opts :read [ Hash ] The read preference for this command.
     # @option opts :session [ Session ] The session to use for this command.
+    # @option opts :execution_options [ Hash ] Options to pass to the code that
+    #   executes this command. This is an internal option and is subject to
+    #   change.
+    #   - :deserialize_as_bson [ Boolean ] Whether to deserialize the response
+    #     to this command using BSON types intead of native Ruby types wherever
+    #     possible.
     #
     # @return [ Mongo::Operation::Result ] The result of the command execution.
     def command(operation, opts = {})
+      opts = opts.dup
+      execution_opts = opts.delete(:execution_options) || {}
+
       txn_read_pref = if opts[:session] && opts[:session].in_transaction?
         opts[:session].txn_read_preference
       else
@@ -182,7 +191,8 @@ module Mongo
           :read => selector,
           :session => session
         )
-        op.execute(server, client: client)
+
+        op.execute(server, client: client, options: execution_opts)
       end
     end
 

data/lib/mongo/error/bulk_write_error.rb

@@ -35,22 +35,24 @@ module Mongo
       # @since 2.0.0
       def initialize(result)
         @result = result
+        # Exception constructor behaves differently for a nil argument and
+        # for no argument. Avoid passing nil explicitly.
+        super(*[build_message])
       end
 
-      def to_s
-        messages = if errors = result['writeErrors']
-          frag = ': ' + errors[0..10].map do |error|
-            "#{error['errmsg']} (#{error['code']})"
-          end.join(', ')
-          if errors.length > 10
-            frag += '...'
-          else
-            frag
-          end
-        else
-          ''
-        end
-        "#{self.class}: #{messages}" + notes_tail
+      private
+
+      def build_message
+        errors = @result['writeErrors']
+        return nil unless errors
+
+        fragment = errors.first(10).map do |error|
+          "#{error['errmsg']} (#{error['code']})"
+        end.join(', ')
+
+        fragment += '...' if errors.length > 10
+
+        fragment
       end
     end
   end

data/lib/mongo/error/notable.rb

@@ -45,26 +45,11 @@ module Mongo
         @notes << note
       end
 
-      # @api public
-      def message
-        super + notes_tail
-      end
-
       # @api public
       def to_s
         super + notes_tail
       end
 
-      # @api public
-      def inspect
-        msg = super
-        if msg.end_with?('>')
-          msg[0...msg.length-1] + notes_tail + '>'
-        else
-          msg + notes_tail
-        end
-      end
-
       private
 
       # @api private

data/lib/mongo/error/parser.rb

@@ -76,7 +76,7 @@ module Mongo
       # examined because the status (ok: 1) is not part of the document and
       # there is no way to distinguish successful from failed responses using
       # the document itself, and a successful response may legitimately have
-      # {code: 123, codeName: 'foo'} as the contents of a user-inserted
+      # { code: 123, codeName: 'foo' } as the contents of a user-inserted
       # document. The legacy server versions do not fill out code nor codeName
       # thus not reading them does not lose information.
       #

data/lib/mongo/grid/file/info.rb

@@ -204,7 +204,7 @@ module Mongo
         # @note This method is transitional and is provided for backwards compatibility.
         # It will be removed when md5 support is deprecated entirely.
         #
-        # @param [ String ] The bytes to use to update the digest.
+        # @param [ String ] bytes The bytes to use to update the digest.
         #
         # @return [ Digest::MD5 ] The md5 hash object.
         #

data/lib/mongo/monitoring/event/cmap/connection_check_out_failed.rb

@@ -57,7 +57,7 @@ module Mongo
           # Create the event.
           #
           # @param [ Address ] address
-          # @param [ Symbol ] symbol
+          # @param [ Symbol ] reason
           #
           # @since 2.9.0
           # @api private

data/lib/mongo/operation/insert/command.rb

@@ -32,8 +32,9 @@ module Mongo
 
         private
 
-        def get_result(server, client)
-          Result.new(dispatch_message(server, client), @ids)
+        def get_result(server, client, options = {})
+          # This is a Mongo::Operation::Insert::Result
+          Result.new(*dispatch_message(server, client), @ids)
         end
 
         def selector(server)

data/lib/mongo/operation/insert/legacy.rb

@@ -30,7 +30,8 @@ module Mongo
 
         private
 
-        def get_result(server, client)
+        def get_result(server, client, options = {})
+          # This is a Mongo::Operation::Insert::Result
           Result.new(dispatch_message(server, client), @ids)
         end
 

data/lib/mongo/operation/insert/op_msg.rb

@@ -30,7 +30,7 @@ module Mongo
 
         private
 
-        def get_result(server, client)
+        def get_result(server, client, options = {})
           # This is a Mongo::Operation::Insert::Result
           Result.new(dispatch_message(server, client), @ids)
         end

data/lib/mongo/operation/shared/executable.rb

@@ -22,11 +22,11 @@ module Mongo
 
       include ResponseHandling
 
-      def do_execute(server, client)
+      def do_execute(server, client, options = {})
         unpin_maybe(session) do
           add_error_labels do
             add_server_diagnostics(server) do
-              get_result(server, client).tap do |result|
+              get_result(server, client, options).tap do |result|
                 process_result(result, server)
               end
             end
@@ -34,8 +34,8 @@ module Mongo
         end
       end
 
-      def execute(server, client:)
-        do_execute(server, client).tap do |result|
+      def execute(server, client:, options: {})
+        do_execute(server, client, options).tap do |result|
           validate_result(result, server)
         end
       end
@@ -46,16 +46,16 @@ module Mongo
         Result
       end
 
-      def get_result(server, client)
-        result_class.new(dispatch_message(server, client))
+      def get_result(server, client, options = {})
+        result_class.new(dispatch_message(server, client, options))
       end
 
-      # Returns a Protocol::Message or nil
-      def dispatch_message(server, client)
+      # Returns a Protocol::Message or nil as reply.
+      def dispatch_message(server, client, options = {})
         server.with_connection do |connection|
           message = build_message(server)
           message = message.maybe_encrypt(server, client)
-          connection.dispatch([ message ], operation_id, client)
+          connection.dispatch([ message ], operation_id, client, options)
         end
       end
 

data/lib/mongo/operation/shared/op_msg_or_command.rb

@@ -22,9 +22,9 @@ module Mongo
     module OpMsgOrCommand
       include PolymorphicLookup
 
-      def execute(server, client:)
+      def execute(server, client:, options: {})
         operation = final_operation(server)
-        operation.execute(server, client: client)
+        operation.execute(server, client: client, options: options)
       end
 
       private

data/lib/mongo/operation/shared/read_preference_supported.rb

@@ -15,19 +15,83 @@
 module Mongo
   module Operation
 
-    # Shared behavior of operations that support read preference.
+    # Read preference handling for pre-OP_MSG operation implementations.
+    #
+    # This module is not used by OP_MSG operation classes (those deriving
+    # from OpMsgBase). Instead, read preference for those classes is handled
+    # in SessionsSupported module.
     #
     # @since 2.5.2
+    # @api private
     module ReadPreferenceSupported
 
       private
 
-      SLAVE_OK = :slave_ok
-
+      # Get the options for executing the operation on a particular server.
+      #
+      # @param [ Server ] server The server that the operation will be
+      #   executed on.
+      #
+      # @return [ Hash ] The options.
+      #
+      # @since 2.0.0
       def options(server)
-        update_options_for_slave_ok(super, server)
+        add_slave_ok_flag_maybe(super, server)
+      end
+
+      # Adds :slave_ok flag to options based on the read preference specified
+      # in the operation or implied by the topology that the server is a
+      # part of.
+      #
+      # @param [ Hash ] options The options calculated so far.
+      #
+      # @return [ Hash ] The new options.
+      def add_slave_ok_flag_maybe(options, server)
+        add_flag =
+          # https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.rst#topology-type-single
+          if server.standalone?
+            # Read preference is never sent to standalones.
+            false
+          elsif server.cluster.single?
+            # In Single topology the driver forces primaryPreferred read
+            # preference mode (via the slave_ok flag, in case of old servers)
+            # so that the query is satisfied.
+            true
+          else
+            # In replica sets and sharded clusters, read preference is passed
+            # to the server if one is specified by the application, and there
+            # is no default.
+            read && read.slave_ok?
+          end
+
+        if add_flag
+          options= options.dup
+          (options[:flags] ||= []) << :slave_ok
+        end
+
+        options
       end
 
+      def command(server)
+        sel = super
+        update_selector_for_read_pref(sel, server)
+      end
+
+      # Adds $readPreference field to the command document.
+      #
+      # $readPreference is only sent when the server is a mongos,
+      # following the rules described in
+      # https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.rst#passing-read-preference-to-mongos.
+      # The topology does not matter for figuring out whether to send
+      # $readPreference since the decision is always made based on
+      # server type.
+      #
+      # $readPreference is not sent to pre-OP_MSG replica set members.
+      #
+      # @param [ Hash ] sel Existing command document.
+      # @param [ Server ] server The server that the command is to be sent to.
+      #
+      # @return [ Hash ] New command document to send to the server.
       def update_selector_for_read_pref(sel, server)
         if read && server.mongos? && read_pref = read.to_mongos
           Mongo::Lint.validate_camel_case_read_preference(read_pref)
@@ -37,21 +101,6 @@ module Mongo
           sel
         end
       end
-
-      def update_options_for_slave_ok(opts, server)
-        if (server.cluster.single? && !server.mongos?) || (read && read.slave_ok?)
-          opts.dup.tap do |o|
-            (o[:flags] ||= []) << SLAVE_OK
-          end
-        else
-          opts
-        end
-      end
-
-      def command(server)
-        sel = super
-        update_selector_for_read_pref(sel, server)
-      end
     end
   end
 end