mongo 2.12.4 → 2.14.0.rc1

data/lib/mongo/collection/view/writable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -39,25 +39,32 @@ module Mongo
         # @option opts [ Hash ] :projection The fields to include or exclude in the returned doc.
         # @option opts [ Hash ] :sort The key and direction pairs by which the result set
         #   will be sorted.
-        # @option opts [ Hash ] :write_concern The write concern options.
-        #   Defaults to the collection's write concern.
         # @option opts [ Hash ] :collation The collation to use.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ Hash | String ] :hint The index to use for this operation.
+        #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         #
         # @return [ BSON::Document, nil ] The document, if found.
         #
         # @since 2.0.0
         def find_one_and_delete(opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           cmd = { :findAndModify => collection.name, :query => filter, :remove => true }
           cmd[:fields] = projection if projection
           cmd[:sort] = sort if sort
           cmd[:maxTimeMS] = max_time_ms if max_time_ms
+          if opts[:bypass_document_validation]
+            cmd[:bypassDocumentValidation] = true
+          end
 
           with_session(opts) do |session|
             applied_write_concern = applied_write_concern(session)
             cmd[:writeConcern] = applied_write_concern.options if applied_write_concern
             write_with_retry(session, applied_write_concern) do |server, txn_num|
               apply_collation!(cmd, server, opts)
+              apply_hint!(cmd, server, opts.merge(write_concern: applied_write_concern))
+
               Operation::Command.new(
                   :selector => cmd,
                   :db_name => database.name,
@@ -83,9 +90,9 @@ module Mongo
         # @option opts [ true, false ] :upsert Whether to upsert if the document doesn't exist.
         # @option opts [ true, false ] :bypass_document_validation Whether or
         #   not to skip document level validation.
-        # @option opts [ Hash ] :write_concern The write concern options.
-        #   Defaults to the collection's write concern.
         # @option opts [ Hash ] :collation The collation to use.
+        # @option opts [ Hash | String ] :hint The index to use for this operation.
+        #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         #
         # @return [ BSON::Document ] The document.
         #
@@ -111,17 +118,19 @@ module Mongo
         # @option opts [ true, false ] :upsert Whether to upsert if the document doesn't exist.
         # @option opts [ true, false ] :bypass_document_validation Whether or
         #   not to skip document level validation.
-        # @option opts [ Hash ] :write_concern The write concern options.
-        #   Defaults to the collection's write concern.
         # @option opts [ Hash ] :collation The collation to use.
         # @option opts [ Array ] :array_filters A set of filters specifying to which array elements
         # an update should apply.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ Hash | String ] :hint The index to use for this operation.
+        #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         #
         # @return [ BSON::Document ] The document.
         #
         # @since 2.0.0
         def find_one_and_update(document, opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           cmd = { :findAndModify => collection.name, :query => filter }
           cmd[:update] = document
           cmd[:fields] = projection if projection
@@ -139,6 +148,8 @@ module Mongo
             write_with_retry(session, applied_write_concern) do |server, txn_num|
               apply_collation!(cmd, server, opts)
               apply_array_filters!(cmd, server, opts)
+              apply_hint!(cmd, server, opts.merge(write_concern: applied_write_concern))
+
               Operation::Command.new(
                   :selector => cmd,
                   :db_name => database.name,
@@ -159,21 +170,34 @@ module Mongo
         #
         # @option opts [ Hash ] :collation The collation to use.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ Hash | String ] :hint The index to use for this operation.
+        #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
+        # @option opts [ Hash ] :write_concern The write concern options.
+        #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
         #
         # @return [ Result ] The response from the database.
         #
         # @since 2.0.0
         def delete_many(opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           delete_doc = { Operation::Q => filter, Operation::LIMIT => 0 }
           with_session(opts) do |session|
-            write_concern = write_concern_with_session(session)
+            write_concern = if opts[:write_concern]
+              WriteConcern.get(opts[:write_concern])
+            else
+              write_concern_with_session(session)
+            end
             nro_write_with_retry(session, write_concern) do |server|
               apply_collation!(delete_doc, server, opts)
+              apply_hint!(delete_doc, server, opts.merge(write_concern: write_concern))
+
               Operation::Delete.new(
                   :deletes => [ delete_doc ],
                   :db_name => collection.database.name,
                   :coll_name => collection.name,
                   :write_concern => write_concern,
+                  :bypass_document_validation => !!opts[:bypass_document_validation],
                   :session => session
               ).execute(server, client: client)
             end
@@ -189,21 +213,34 @@ module Mongo
         #
         # @option opts [ Hash ] :collation The collation to use.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ Hash | String ] :hint The index to use for this operation.
+        #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
+        # @option opts [ Hash ] :write_concern The write concern options.
+        #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
         #
         # @return [ Result ] The response from the database.
         #
         # @since 2.0.0
         def delete_one(opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           delete_doc = { Operation::Q => filter, Operation::LIMIT => 1 }
           with_session(opts) do |session|
-            write_concern = write_concern_with_session(session)
+            write_concern = if opts[:write_concern]
+              WriteConcern.get(opts[:write_concern])
+            else
+              write_concern_with_session(session)
+            end
             write_with_retry(session, write_concern) do |server, txn_num|
               apply_collation!(delete_doc, server, opts)
+              apply_hint!(delete_doc, server, opts.merge(write_concern: write_concern))
+
               Operation::Delete.new(
                   :deletes => [ delete_doc ],
                   :db_name => collection.database.name,
                   :coll_name => collection.name,
                   :write_concern => write_concern,
+                  :bypass_document_validation => !!opts[:bypass_document_validation],
                   :session => session,
                   :txn_num => txn_num
               ).execute(server, client: client)
@@ -225,11 +262,17 @@ module Mongo
         #   not to skip document level validation.
         # @option opts [ Hash ] :collation The collation to use.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ Hash | String ] :hint The index to use for this operation.
+        #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
+        # @option opts [ Hash ] :write_concern The write concern options.
+        #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
         #
         # @return [ Result ] The response from the database.
         #
         # @since 2.0.0
         def replace_one(replacement, opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           update_doc = { Operation::Q => filter,
                          Operation::U => replacement,
                         }
@@ -237,10 +280,16 @@ module Mongo
             update_doc['upsert'] = true
           end
           with_session(opts) do |session|
-            write_concern = write_concern_with_session(session)
+            write_concern = if opts[:write_concern]
+              WriteConcern.get(opts[:write_concern])
+            else
+              write_concern_with_session(session)
+            end
+
             write_with_retry(session, write_concern) do |server, txn_num|
               apply_collation!(update_doc, server, opts)
               apply_array_filters!(update_doc, server, opts)
+              apply_hint!(update_doc, server, opts.merge(write_concern: write_concern))
 
               Operation::Update.new(
                   :updates => [ update_doc ],
@@ -271,11 +320,17 @@ module Mongo
         # @option opts [ Array ] :array_filters A set of filters specifying to
         #   which array elements an update should apply.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ Hash | String ] :hint The index to use for this operation.
+        #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
+        # @option opts [ Hash ] :write_concern The write concern options.
+        #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
         #
         # @return [ Result ] The response from the database.
         #
         # @since 2.0.0
         def update_many(spec, opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           update_doc = { Operation::Q => filter,
                          Operation::U => spec,
                          Operation::MULTI => true,
@@ -284,10 +339,16 @@ module Mongo
             update_doc['upsert'] = true
           end
           with_session(opts) do |session|
-            write_concern = write_concern_with_session(session)
+            write_concern = if opts[:write_concern]
+              WriteConcern.get(opts[:write_concern])
+            else
+              write_concern_with_session(session)
+            end
             nro_write_with_retry(session, write_concern) do |server|
               apply_collation!(update_doc, server, opts)
               apply_array_filters!(update_doc, server, opts)
+              apply_hint!(update_doc, server, opts.merge(write_concern: write_concern))
+
               Operation::Update.new(
                   :updates => [ update_doc ],
                   :db_name => collection.database.name,
@@ -316,11 +377,17 @@ module Mongo
         # @option opts [ Array ] :array_filters A set of filters specifying to
         #   which array elements an update should apply.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ Hash | String ] :hint The index to use for this operation.
+        #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
+        # @option opts [ Hash ] :write_concern The write concern options.
+        #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
         #
         # @return [ Result ] The response from the database.
         #
         # @since 2.0.0
         def update_one(spec, opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           update_doc = { Operation::Q => filter,
                          Operation::U => spec,
                          }
@@ -328,10 +395,15 @@ module Mongo
             update_doc['upsert'] = true
           end
           with_session(opts) do |session|
-            write_concern = write_concern_with_session(session)
+            write_concern = if opts[:write_concern]
+              WriteConcern.get(opts[:write_concern])
+            else
+              write_concern_with_session(session)
+            end
             write_with_retry(session, write_concern) do |server, txn_num|
               apply_collation!(update_doc, server, opts)
               apply_array_filters!(update_doc, server, opts)
+              apply_hint!(update_doc, server, opts.merge(write_concern: write_concern))
 
               Operation::Update.new(
                   :updates => [ update_doc ],
@@ -348,6 +420,28 @@ module Mongo
 
         private
 
+        def apply_hint!(doc, server, opts)
+          if hint = opts[:hint]
+            features = server.with_connection do |connection|
+              connection.description.features
+            end
+
+            write_concern = opts[:write_concern]
+            if write_concern && !write_concern.acknowledged?
+              raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
+            end
+
+            if doc.key?(:findAndModify) &&
+                !features.find_and_modify_option_validation_enabled?
+              raise Error::UnsupportedOption.hint_error
+            elsif !features.update_delete_option_validation_enabled?
+              raise Error::UnsupportedOption.hint_error
+            end
+
+            doc[:hint] = opts[:hint]
+          end
+        end
+
         def apply_array_filters!(doc, server, opts = {})
           if filters = opts[:array_filters] || opts[ARRAY_FILTERS]
             validate_array_filters!(server, filters)
@@ -356,7 +450,7 @@ module Mongo
         end
 
         def validate_array_filters!(server, filters)
-          if filters && !server.features.array_filters_enabled?
+          if filters && !server.with_connection { |connection| connection.features }.array_filters_enabled?
             raise Error::UnsupportedArrayFilters.new
           end
         end

data/lib/mongo/crypt.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB 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/crypt/auto_decryption_context.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB 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/crypt/auto_encrypter.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB 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/crypt/auto_encryption_context.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB 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/crypt/binary.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB 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/crypt/binding.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB 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/crypt/context.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB 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/crypt/data_key_context.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB 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/crypt/encryption_io.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -21,7 +21,7 @@ module Mongo
     # @api private
     class EncryptionIO
 
-      # Timeout used for SSL socket connection, reading, and writing.
+      # Timeout used for TLS socket connection, reading, and writing.
       # There is no specific timeout written in the spec. See SPEC-1394
       # for a discussion and updates on what this timeout should be.
       SOCKET_TIMEOUT = 10
@@ -236,10 +236,10 @@ module Mongo
         end
       end
 
-      # Provide an SSL socket to be used for KMS calls in a block API
+      # Provide a TLS socket to be used for KMS calls in a block API
       #
-      # @param [ String ] endpoint The URI at which to connect the SSL socket.
-      # @yieldparam [ OpenSSL::SSL::SSLSocket ] ssl_socket Yields an SSL socket
+      # @param [ String ] endpoint The URI at which to connect the TLS socket.
+      # @yieldparam [ OpenSSL::SSL::SSLSocket ] ssl_socket Yields a TLS socket
       #   connected to the specified endpoint.
       #
       # @raise [ Mongo::Error::KmsError ] If the socket times out or raises
@@ -251,38 +251,55 @@ module Mongo
         host, port = endpoint.split(':')
         port ||= 443 # Default port for AWS KMS API
 
+        # Create TCPSocket and set nodelay option
+        tcp_socket = TCPSocket.open(host, port)
         begin
-          # Create TCPSocket and set nodelay option
-          tcp_socket = TCPSocket.open(host, port)
           tcp_socket.setsockopt(::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY, 1)
 
           ssl_socket = OpenSSL::SSL::SSLSocket.new(tcp_socket)
-          ssl_socket.sync_close = true # tcp_socket will be closed when ssl_socket is closed
-          ssl_socket.hostname = "#{host}:#{port}" # perform SNI
+          begin
+            # tcp_socket will be closed when ssl_socket is closed
+            ssl_socket.sync_close = true
+            # perform SNI
+            ssl_socket.hostname = "#{host}:#{port}"
+
+            Timeout.timeout(
+              SOCKET_TIMEOUT,
+              Error::SocketTimeoutError,
+              "KMS socket connection timed out after #{SOCKET_TIMEOUT} seconds",
+            ) do
+              ssl_socket.connect
+            end
 
-          Timeout.timeout(
-            SOCKET_TIMEOUT,
-            Error::SocketTimeoutError,
-            'Socket connection timed out'
-          ) do
-            ssl_socket.connect
+            yield(ssl_socket)
+          ensure
+            begin
+              Timeout.timeout(
+                SOCKET_TIMEOUT,
+                Error::SocketTimeoutError,
+                'KMS TLS socket close timed out'
+              ) do
+                ssl_socket.sysclose
+              end
+            rescue
+            end
           end
-
-          yield(ssl_socket)
-        rescue => e
-          raise Error::KmsError, "Error decrypting data key. #{e.class}: #{e.message}"
         ensure
-          # If there is an error during socket creation, the
-          # ssl_socket object won't exist in this scope and this line will
-          # raise an exception
-          Timeout.timeout(
-            SOCKET_TIMEOUT,
-            Error::SocketTimeoutError,
-            'Socket close timed out'
-          ) do
-            ssl_socket.sysclose rescue nil
+          # Still close tcp socket manually in case TLS socket creation
+          # fails.
+          begin
+            Timeout.timeout(
+              SOCKET_TIMEOUT,
+              Error::SocketTimeoutError,
+              'KMS TCP socket close timed out'
+            ) do
+              tcp_socket.close
+            end
+          rescue
           end
         end
+      rescue => e
+        raise Error::KmsError, "Error decrypting data key: #{e.class}: #{e.message}"
       end
     end
   end