mongo 2.18.1 → 2.19.1

data/lib/mongo/crypt/kms/kmip.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2021 MongoDB Inc.
 #
@@ -15,102 +15,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-module Mongo
-  module Crypt
-    module KMS
-      module KMIP
-        # KMIP KMS Credentials object contains credentials for a
-        # remote KMIP KMS provider.
-        #
-        # @api private
-        class Credentials
-          extend Forwardable
-          include KMS::Validations
-
-          # @return [ String ] KMIP KMS endpoint with optional port.
-          attr_reader :endpoint
-
-          # @api private
-          def_delegator :@opts, :empty?
-
-          FORMAT_HINT = "KMIP KMS provider options must be in the format: " +
-                        "{ endpoint: 'ENDPOINT' }"
-
-          # Creates a KMIP KMS credentials object form a parameters hash.
-          #
-          # @param [ Hash ] opts A hash that contains credentials for
-          #   KMIP KMS provider.
-          # @option opts [ String ] :endpoint KMIP endpoint.
-          #
-          # @raise [ ArgumentError ] If required options are missing or incorrectly
-          #   formatted.
-          def initialize(opts)
-            @opts = opts
-            unless empty?
-              @endpoint = validate_param(:endpoint, opts, FORMAT_HINT)
-            end
-          end
-
-          # Convert credentials object to a BSON document in libmongocrypt format.
-          #
-          # @return [ BSON::Document ] Local KMS credentials in libmongocrypt format.
-          def to_document
-            return BSON::Document.new({}) if empty?
-            BSON::Document.new({
-              endpoint: endpoint,
-            })
-          end
-        end
-
-        # KMIP KMS master key document object contains KMS master key parameters.
-        #
-        # @api private
-        class MasterKeyDocument
-          include KMS::Validations
-
-          # @return [ String | nil ] The KMIP Unique Identifier to a 96 byte
-          #   KMIP Secret Data managed object.
-          attr_reader :key_id
-
-          # @return [ String | nil ] KMIP KMS endpoint with optional port.
-          attr_reader :endpoint
-
-          FORMAT_HINT = "KMIP KMS key document must be in the format: " +
-                        "{ key_id: 'KEY-ID', endpoint: 'ENDPOINT' }"
-
-          # Creates a master key document object form a parameters hash.
-          #
-          # @param [ Hash ] opts A hash that contains master key options for
-          #   KMIP KMS provider
-          # @option opts [ String | nil ] :key_id KMIP Unique Identifier to
-          #   a 96 byte KMIP Secret Data managed object, optional. If key_id
-          #   is omitted, the driver creates a random 96 byte identifier.
-          # @option opts [ String | nil ] :endpoint KMIP endpoint, optional.
-          #
-          # @raise [ ArgumentError ] If required options are missing or incorrectly
-          #   formatted.
-          def initialize(opts = {})
-            @key_id = validate_param(
-              :key_id, opts, FORMAT_HINT, required: false
-            )
-            @endpoint = validate_param(
-              :endpoint, opts, FORMAT_HINT, required: false
-            )
-          end
-
-          # Convert master key document object to a BSON document in libmongocrypt format.
-          #
-          # @return [ BSON::Document ] KMIP KMS credentials in libmongocrypt format.
-          def to_document
-            BSON::Document.new({
-              provider: 'kmip',
-            }).tap do |bson|
-              bson.update({ endpoint: endpoint }) unless endpoint.nil?
-              bson.update({ keyId: key_id }) unless key_id.nil?
-            end
-          end
-        end
-      end
-    end
-  end
-end
+require 'mongo/crypt/kms/kmip/credentials'
+require 'mongo/crypt/kms/kmip/master_document'

data/lib/mongo/crypt/kms/local/credentials.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+# Copyright (C) 2019-2021 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  module Crypt
+    module KMS
+      module Local
+        # Local KMS Credentials object contains credentials for using local KMS provider.
+        #
+        # @api private
+        class Credentials
+          extend Forwardable
+          include KMS::Validations
+
+          # @return [ String ] Master key.
+          attr_reader :key
+
+          # @api private
+          def_delegator :@opts, :empty?
+
+          FORMAT_HINT = "Local KMS provider options must be in the format: " +
+                        "{ key: 'MASTER-KEY' }"
+
+          # Creates a local KMS credentials object form a parameters hash.
+          #
+          # @param [ Hash ] opts A hash that contains credentials for
+          #   local KMS provider
+          # @option opts [ String ] :key Master key.
+          #
+          # @raise [ ArgumentError ] If required options are missing or incorrectly
+          #   formatted.
+          def initialize(opts)
+            @opts = opts
+            unless empty?
+              @key = validate_param(:key, opts, FORMAT_HINT)
+            end
+          end
+
+          # @return [ BSON::Document ] Local KMS credentials in libmongocrypt format.
+          def to_document
+            return BSON::Document.new({}) if empty?
+            BSON::Document.new({
+              key: BSON::Binary.new(@key, :generic),
+            })
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/mongo/crypt/kms/local/master_document.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+# Copyright (C) 2019-2021 MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  module Crypt
+    module KMS
+      module Local
+        # Local KMS master key document object contains KMS master key parameters.
+        #
+        # @api private
+        class MasterKeyDocument
+
+          # Creates a master key document object form a parameters hash.
+          # This empty method is to keep a uniform interface for all KMS providers.
+          def initialize(_opts)
+          end
+
+          # Convert master key document object to a BSON document in libmongocrypt format.
+          #
+          # @return [ BSON::Document ] Local KMS credentials in libmongocrypt format.
+          def to_document
+            BSON::Document.new({ provider: "local" })
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/mongo/crypt/kms/local.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2021 MongoDB Inc.
 #
@@ -15,68 +15,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-module Mongo
-  module Crypt
-    module KMS
-      module Local
-        # Local KMS Credentials object contains credentials for using local KMS provider.
-        #
-        # @api private
-        class Credentials
-          extend Forwardable
-          include KMS::Validations
-
-          # @return [ String ] Master key.
-          attr_reader :key
-
-          # @api private
-          def_delegator :@opts, :empty?
-
-          FORMAT_HINT = "Local KMS provider options must be in the format: " +
-                        "{ key: 'MASTER-KEY' }"
-
-          # Creates a local KMS credentials object form a parameters hash.
-          #
-          # @param [ Hash ] opts A hash that contains credentials for
-          #   local KMS provider
-          # @option opts [ String ] :key Master key.
-          #
-          # @raise [ ArgumentError ] If required options are missing or incorrectly
-          #   formatted.
-          def initialize(opts)
-            @opts = opts
-            unless empty?
-              @key = validate_param(:key, opts, FORMAT_HINT)
-            end
-          end
-
-          # @return [ BSON::Document ] Local KMS credentials in libmongocrypt format.
-          def to_document
-            return BSON::Document.new({}) if empty?
-            BSON::Document.new({
-              key: BSON::Binary.new(@key, :generic),
-            })
-          end
-        end
-
-        # Local KMS master key document object contains KMS master key parameters.
-        #
-        # @api private
-        class MasterKeyDocument
-
-          # Creates a master key document object form a parameters hash.
-          # This empty method is to keep a uniform interface for all KMS providers.
-          def initialize(_opts)
-          end
-
-          # Convert master key document object to a BSON document in libmongocrypt format.
-          #
-          # @return [ BSON::Document ] Local KMS credentials in libmongocrypt format.
-          def to_document
-            BSON::Document.new({ provider: "local" })
-          end
-        end
-      end
-    end
-  end
-end
+require 'mongo/crypt/kms/local/credentials'
+require 'mongo/crypt/kms/local/master_document'

data/lib/mongo/crypt/kms/master_key_document.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2021 MongoDB Inc.
 #

data/lib/mongo/crypt/kms.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2021 MongoDB Inc.
 #
@@ -18,6 +18,12 @@
 module Mongo
   module Crypt
     module KMS
+      # This error indicates that we could not obtain credential for
+      # a KMS service.
+      #
+      # @api private
+      class CredentialsNotFound < RuntimeError; end
+
       # This module contains helper methods for validating KMS parameters.
       #
       # @api private
@@ -89,7 +95,6 @@ module Mongo
             %i(
               ssl_verify_certificate
               ssl_verify_hostname
-              ssl_verify_ocsp_endpoint
             ).each do |opt|
               if provider_opts[opt] == false
                 raise ArgumentError.new(

data/lib/mongo/crypt/kms_context.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

data/lib/mongo/crypt/rewrap_many_data_key_context.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

data/lib/mongo/crypt/rewrap_many_data_key_result.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2022 MongoDB Inc.
 #

data/lib/mongo/crypt/status.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 ## Copyright (C) 2019-2020 MongoDB Inc.
 #

data/lib/mongo/crypt.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -26,6 +26,7 @@ module Mongo
     autoload(:Context, 'mongo/crypt/context')
     autoload(:DataKeyContext, 'mongo/crypt/data_key_context')
     autoload(:ExplicitEncryptionContext, 'mongo/crypt/explicit_encryption_context')
+    autoload(:ExplicitEncryptionExpressionContext, 'mongo/crypt/explicit_encryption_expression_context')
     autoload(:AutoEncryptionContext, 'mongo/crypt/auto_encryption_context')
     autoload(:ExplicitDecryptionContext, 'mongo/crypt/explicit_decryption_context')
     autoload(:AutoDecryptionContext, 'mongo/crypt/auto_decryption_context')
@@ -35,5 +36,16 @@ module Mongo
     autoload(:ExplicitEncrypter, 'mongo/crypt/explicit_encrypter')
     autoload(:AutoEncrypter, 'mongo/crypt/auto_encrypter')
     autoload(:KMS, 'mongo/crypt/kms')
+
+    def validate_ffi!
+      return if defined?(FFI)
+
+      require 'ffi'
+    rescue LoadError => e
+      raise Error::UnmetDependency, 'Cannot enable encryption because the ffi gem ' \
+                                    "has not been installed. Add \"gem 'ffi'\" to your Gemfile and run " \
+                                    "\"bundle install\" to install the gem. (#{e.class}: #{e})"
+    end
+    module_function :validate_ffi!
   end
 end

data/lib/mongo/cursor/kill_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2021 MongoDB Inc.
 #

data/lib/mongo/cursor.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -76,13 +76,15 @@ module Mongo
       @initial_result = result
       @namespace = result.namespace
       @remaining = limit if limited?
-      @cursor_id = result.cursor_id
+      set_cursor_id(result)
       if @cursor_id.nil?
         raise ArgumentError, 'Cursor id must be present in the result'
       end
       @connection_global_id = result.connection_global_id
       @options = options
       @session = @options[:session]
+      @explicitly_closed = false
+      @lock = Mutex.new
       unless closed?
         register
         ObjectSpace.define_finalizer(self, self.class.finalize(kill_spec(@connection_global_id),
@@ -164,6 +166,9 @@ module Mongo
         # StopIteration raised by try_next ends this loop.
         loop do
           document = try_next
+          if explicitly_closed?
+            raise Error::InvalidCursorOperation, 'Cursor was explicitly closed'
+          end
           yield document if document
         end
         self
@@ -172,6 +177,9 @@ module Mongo
         # StopIteration raised by try_next ends this loop.
         loop do
           document = try_next
+          if explicitly_closed?
+            raise Error::InvalidCursorOperation, 'Cursor was explicitly closed'
+          end
           documents << document if document
         end
         documents
@@ -276,9 +284,6 @@ module Mongo
     # the server.
     #
     # @return [ nil ] Always nil.
-    #
-    # @raise [ Error::OperationFailure ] If the server cursor close fails.
-    # @raise [ Error::SocketError | Error::SocketTimeoutError ] When there is a network error.
     def close
       return if closed?
 
@@ -294,9 +299,14 @@ module Mongo
       end
 
       nil
+    rescue Error::OperationFailure, Error::SocketError, Error::SocketTimeoutError, Error::ServerNotUsable
+      # Errors are swallowed since there is noting can be done by handling them.
     ensure
       end_session
       @cursor_id = 0
+      @lock.synchronize do
+        @explicitly_closed = true
+      end
     end
 
     # Get the parsed collection name.
@@ -387,6 +397,12 @@ module Mongo
 
     private
 
+    def explicitly_closed?
+      @lock.synchronize do
+        @explicitly_closed
+      end
+    end
+
     def batch_size_for_get_more
       if batch_size && use_limit?
         [batch_size, @remaining].min
@@ -449,7 +465,7 @@ module Mongo
       # Thus we need to check both @cursor_id and the cursor_id of the result
       # prior to calling unregister here.
       unregister if !closed? && result.cursor_id == 0
-      @cursor_id = result.cursor_id
+      @cursor_id = set_cursor_id(result)
 
       if result.respond_to?(:post_batch_resume_token)
         @post_batch_resume_token = result.post_batch_resume_token
@@ -487,6 +503,24 @@ module Mongo
       )
       op.execute(@server, context: context)
     end
+
+    # Sets @cursor_id from the operation result.
+    #
+    # In the operation result cursor id can be represented either as Integer
+    # value or as BSON::Int64. This method ensures that the instance variable
+    # is always of type Integer.
+    #
+    # @param [ Operation::Result ] result The result of the operation.
+    #
+    # @api private
+    def set_cursor_id(result)
+      @cursor_id = if result.cursor_id.is_a?(BSON::Int64)
+                     result.cursor_id.value
+                   else
+                     result.cursor_id
+                   end
+    end
+
   end
 end
 

data/lib/mongo/database/view.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -104,6 +104,9 @@ module Mongo
       #   See https://mongodb.com/docs/manual/reference/command/listCollections/
       #   for more information and usage.
       # @option options [ Session ] :session The session to use.
+      # @option options [ Boolean ] :deserialize_as_bson Whether to deserialize
+      #   this message using BSON types instead of native Ruby types wherever
+      #   possible.
       #
       # @return [ Array<Hash> ] Info for each collection in the database.
       #
@@ -141,7 +144,7 @@ module Mongo
       # @param [ Array<Hash> ] pipeline The aggregation pipeline.
       # @param [ Hash ] options The aggregation options.
       #
-      # @return [ Aggregation ] The aggregation object.
+      # @return [ Collection::View::Aggregation ] The aggregation object.
       #
       # @since 2.10.0
       # @api private
@@ -172,7 +175,7 @@ module Mongo
             doc['name'].start_with?('system.') || doc['name'].include?('$')
           end
         else
-          docs = cursor.reject do |doc|
+          cursor.reject do |doc|
             doc['name'].start_with?("#{database.name}.system") || doc['name'].include?('$')
           end
         end
@@ -196,8 +199,42 @@ module Mongo
         Operation::CollectionsInfo.new(collections_info_spec(session, options))
       end
 
+      # Sends command that obtains information about the database.
+      #
+      # This command returns a cursor, so there could be additional commands,
+      # therefore this method is called send *initial* command.
+      #
+      # @param [ Server ] server Server to send the query to.
+      # @param [ Session ] session Session that should be used to send the query.
+      # @param [ Hash ] options
+      # @option options [ Hash | nil ] :filter A query expression to filter
+      #   the list of collections.
+      # @option options [ true | false | nil ] :name_only A flag to indicate
+      #   whether the command should return just the collection/view names
+      #   and type or return both the name and other information.
+      # @option options [ true | false | nil ] :authorized_collections A flag,
+      #   when set to true and used with name_only: true, that allows a user
+      #   without the required privilege (i.e. listCollections
+      #   action on the database) to run the command when access control
+      #   is enforced.
+      # @option options [ Object | nil ] :comment A user-provided comment to attach
+      #   to this command.
+      # @option options [ true | false | nil ] :deserialize_as_bson Whether the
+      #   query results should be deserialized to BSON types, or to Ruby
+      #   types (where possible).
+      #
+      # @return [ Operation::Result ] Result of the query.
       def send_initial_query(server, session, options = {})
-        initial_query_op(session, options).execute(server, context: Operation::Context.new(client: client, session: session))
+        opts = options.dup
+        execution_opts = {}
+        if opts.key?(:deserialize_as_bson)
+          execution_opts[:deserialize_as_bson] = opts.delete(:deserialize_as_bson)
+        end
+        initial_query_op(session, opts).execute(
+          server,
+          context: Operation::Context.new(client: client, session: session),
+          options: execution_opts
+        )
       end
     end
   end

data/lib/mongo/database.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -397,7 +397,7 @@ module Mongo
     #   cursor and this option is therefore not valid.
     # @option options [ Session ] :session The session to use.
     #
-    # @return [ Aggregation ] The aggregation object.
+    # @return [ Collection::View::Aggregation ] The aggregation object.
     #
     # @since 2.10.0
     def aggregate(pipeline, options = {})

data/lib/mongo/dbref.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #

data/lib/mongo/distinguishing_semaphore.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2020 MongoDB Inc.
 #
@@ -23,7 +23,7 @@ module Mongo
   class DistinguishingSemaphore
     def initialize
       @lock = Mutex.new
-      @cv = ConditionVariable.new
+      @cv = ::ConditionVariable.new
       @queue = []
     end
 

data/lib/mongo/error/auth_error.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #

data/lib/mongo/error/bad_load_balancer_target.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2021 MongoDB Inc.
 #

data/lib/mongo/error/bulk_write_error.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/error/change_stream_resumable.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #