mongo 2.13.1 → 2.14.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd4f9d74906d6f99fd038c0a3b4cfe0ee5cc3a7a4b327debf9c57649112b2cbb
-  data.tar.gz: 052b3f3af1749d9f26d8e3655359650653b4bf71e9198a3d2116afde6d576eb3
+  metadata.gz: 493d0cb29d48d80c7fe4c87691500c078b6667bd214dcc021e0074938229be83
+  data.tar.gz: 44507b68e42abadad6987f50c3b3ae1b8ae70f046812607755ffbe292013ccc4
 SHA512:
-  metadata.gz: c016d60512a77572e58ae6553dc9e61ecf6574abc724785858c43987aa84d7b79199589a9be7da702d6385d48f70f65fe135caa36176f9cf6fb638c3e156afc4
-  data.tar.gz: a5c0dbab135a661a3cec5b0eab3300308693474d4c6662b0a18dd33b303f86753390eb0880232794a09ba511824f5d863f7bf428a8af1ca7b7b511458c078049
+  metadata.gz: ea39c71265e24349b018a8e5f5699b556d1ed43107135da46790ad8496c4bcd8a3917ca6fd0c7b405c5e6cff968d6e18cedf35ac33fe660f19f2869f663cdf64
+  data.tar.gz: 30ca549b30bec1889f622f7002658c918b6686e417bd9a636777bbc7f321d06094278b5a7ff4b04a9395f61bf90e28f99f26ff9ec404b0e3687dbc1b4a77ec1f

data.tar.gz.sig

@@ -1,4 +1 @@
-���_�.�Y��В�,8Q�c|���Sa8�Iy�@T�+�8�%R���\!���|����~��jm����o������\v:�*�*^4�����ϒH�3l/�q%r(�0\�􆕵/�ң�).����
ٞz��)���H�G��'Τaa��~'%,y;��qf
-����
-�P\�?ރ.r\P{�a2+�`J"
-=]�{�<�;7�Mp+��v�)\<r���/h]0`���T`<-��hP]��kW�8ŀu~����+��|�s3_�
+lb~�{������z�x�%����~��n��3G���k�j*R)ڗ0

data/lib/mongo.rb

@@ -51,6 +51,7 @@ require 'mongo/protocol'
 require 'mongo/background_thread'
 require 'mongo/cluster'
 require 'mongo/cursor'
+require 'mongo/caching_cursor'
 require 'mongo/collection'
 require 'mongo/database'
 require 'mongo/crypt'
@@ -60,6 +61,7 @@ require 'mongo/dbref'
 require 'mongo/grid'
 require 'mongo/index'
 require 'mongo/lint'
+require 'mongo/query_cache'
 require 'mongo/server'
 require 'mongo/server_selector'
 require 'mongo/session'
@@ -70,3 +72,10 @@ require 'mongo/uri'
 require 'mongo/version'
 require 'mongo/write_concern'
 require 'mongo/utils'
+
+module Mongo
+  # Clears the driver's OCSP response cache.
+  module_function def clear_ocsp_cache
+    Socket::OcspCache.clear
+  end
+end

data/lib/mongo/address/ipv4.rb

@@ -81,7 +81,7 @@ module Mongo
       # @param [ Hash ] options The options.
       #
       # @option options [ Float ] :connect_timeout Connect timeout.
-      # @option options [ true | false ] :ssl Whether to use SSL.
+      # @option options [ true | false ] :ssl Whether to use TLS.
       # @option options [ String ] :ssl_ca_cert
       #   Same as the corresponding Client/Socket::SSL option.
       # @option options [ Array<OpenSSL::X509::Certificate> ] :ssl_ca_cert_object

data/lib/mongo/address/ipv6.rb

@@ -95,7 +95,7 @@ module Mongo
       # @param [ Hash ] options The options.
       #
       # @option options [ Float ] :connect_timeout Connect timeout.
-      # @option options [ true | false ] :ssl Whether to use SSL.
+      # @option options [ true | false ] :ssl Whether to use TLS.
       # @option options [ String ] :ssl_ca_cert
       #   Same as the corresponding Client/Socket::SSL option.
       # @option options [ Array<OpenSSL::X509::Certificate> ] :ssl_ca_cert_object

data/lib/mongo/bulk_write.rb

@@ -195,6 +195,13 @@ module Mongo
           end
         end
       end
+    # With OP_MSG (3.6+ servers), the size of each section in the message
+    # is independently capped at 16m and each bulk operation becomes
+    # its own section. The size of the entire bulk write is limited to 48m.
+    # With OP_QUERY (pre-3.6 servers), the entire bulk write is sent as a
+    # single document and is thus subject to the 16m document size limit.
+    # This means the splits differ between pre-3.6 and 3.6+ servers, with
+    # 3.6+ servers being able to split less.
     rescue Error::MaxBSONSize, Error::MaxMessageSize => e
       raise e if values.size <= 1
       unpin_maybe(session) do
@@ -214,27 +221,37 @@ module Mongo
     end
 
     def delete_one(documents, connection, operation_id, session, txn_num)
+      QueryCache.clear_namespace(collection.namespace)
+
       spec = base_spec(operation_id, session).merge(:deletes => documents, :txn_num => txn_num)
       Operation::Delete.new(spec).bulk_execute(connection, client: client)
     end
 
     def delete_many(documents, connection, operation_id, session, txn_num)
+      QueryCache.clear_namespace(collection.namespace)
+
       spec = base_spec(operation_id, session).merge(:deletes => documents)
       Operation::Delete.new(spec).bulk_execute(connection, client: client)
     end
 
     def insert_one(documents, connection, operation_id, session, txn_num)
+      QueryCache.clear_namespace(collection.namespace)
+
       spec = base_spec(operation_id, session).merge(:documents => documents, :txn_num => txn_num)
       Operation::Insert.new(spec).bulk_execute(connection, client: client)
     end
 
     def update_one(documents, connection, operation_id, session, txn_num)
+      QueryCache.clear_namespace(collection.namespace)
+
       spec = base_spec(operation_id, session).merge(:updates => documents, :txn_num => txn_num)
       Operation::Update.new(spec).bulk_execute(connection, client: client)
     end
     alias :replace_one :update_one
 
     def update_many(documents, connection, operation_id, session, txn_num)
+      QueryCache.clear_namespace(collection.namespace)
+
       spec = base_spec(operation_id, session).merge(:updates => documents)
       Operation::Update.new(spec).bulk_execute(connection, client: client)
     end

data/lib/mongo/caching_cursor.rb

@@ -0,0 +1,74 @@
+# Copyright (C) 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.
+# 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
+
+  # A Cursor that attempts to load documents from memory first before hitting
+  # the database if the same query has already been executed.
+  #
+  # @api semiprivate
+  class CachingCursor < Cursor
+
+    # @return [ Array <BSON::Document> ] The cursor's cached documents.
+    # @api private
+    attr_reader :cached_docs
+
+    # We iterate over the cached documents if they exist already in the
+    # cursor otherwise proceed as normal.
+    #
+    # @example Iterate over the documents.
+    #   cursor.each do |doc|
+    #     # ...
+    #   end
+    def each
+      if @cached_docs
+        @cached_docs.each do |doc|
+          yield doc
+        end
+
+        unless closed?
+          # StopIteration raised by try_next ends this loop.
+          loop do
+            document = try_next
+            yield document if document
+          end
+        end
+      else
+        super
+      end
+    end
+
+    # Get a human-readable string representation of +Cursor+.
+    #
+    # @example Inspect the cursor.
+    #   cursor.inspect
+    #
+    # @return [ String ] A string representation of a +Cursor+ instance.
+    def inspect
+      "#<Mongo::CachingCursor:0x#{object_id} @view=#{@view.inspect}>"
+    end
+
+    # Acquires the next document for cursor iteration and then
+    # inserts that document in the @cached_docs array.
+    #
+    # @api private
+    def try_next
+      @cached_docs ||= []
+      document = super
+      @cached_docs << document if document
+
+      document
+    end
+  end
+end

data/lib/mongo/client.rb

@@ -101,6 +101,7 @@ module Mongo
       :ssl_verify,
       :ssl_verify_certificate,
       :ssl_verify_hostname,
+      :ssl_verify_ocsp_endpoint,
       :truncate_logs,
       :user,
       :wait_queue_timeout,
@@ -315,7 +316,7 @@ module Mongo
     #   for selecting a server for an operation.
     # @option options [ Float ] :socket_timeout The timeout, in seconds, to
     #   execute operations on a socket.
-    # @option options [ true, false ] :ssl Whether to use SSL.
+    # @option options [ true, false ] :ssl Whether to use TLS.
     # @option options [ String ] :ssl_ca_cert The file containing concatenated
     #   certificate authority certificates used to validate certs passed from the
     #   other end of the connection. Intermediate certificates should NOT be
@@ -462,6 +463,8 @@ module Mongo
         @srv_records = nil
       end
 
+      options = self.class.canonicalize_ruby_options(options)
+
       # Special handling for sdam_proc as it is only used during client
       # construction
       sdam_proc = options.delete(:sdam_proc)
@@ -478,6 +481,12 @@ module Mongo
       end
       options = merged_options
 
+      options.keys.each do |k|
+        if options[k].nil?
+          options.delete(k)
+        end
+      end
+
       @options = validate_new_options!(options)
 =begin WriteConcern object support
       if @options[:write_concern].is_a?(WriteConcern::Base)
@@ -605,15 +614,12 @@ module Mongo
 
     # Get a summary of the client state.
     #
-    # @note This method is experimental and subject to change.
+    # @note The exact format and layout of the returned summary string is
+    #   not part of the driver's public API and may be changed at any time.
     #
-    # @example Inspect the client.
-    #   client.summary
-    #
-    # @return [ String ] Summary string.
+    # @return [ String ] The summary string.
     #
     # @since 2.7.0
-    # @api experimental
     def summary
       "#<Client cluster=#{cluster.summary}>"
     end
@@ -769,7 +775,6 @@ module Mongo
       options[:read_concern]
     end
 
-
     # Get the write concern for this client. If no option was provided, then a
     # default single server acknowledgement will be used.
     #
@@ -1022,6 +1027,23 @@ module Mongo
       end
     end
 
+    class << self
+      # Lowercases auth mechanism properties, if given, in the specified
+      # options, then converts the options to an instance of Options::Redacted.
+      #
+      # @api private
+      def canonicalize_ruby_options(options)
+        Options::Redacted.new(Hash[options.map do |k, v|
+          if k == :auth_mech_properties || k == 'auth_mech_properties'
+            if v
+              v = Hash[v.map { |pk, pv| [pk.downcase, pv] }]
+            end
+          end
+          [k, v]
+        end])
+      end
+    end
+
     private
 
     # Create a new encrypter object using the client's auto encryption options
@@ -1107,6 +1129,23 @@ module Mongo
     # but does not check for interactions between combinations of options.
     def validate_new_options!(opts = Options::Redacted.new)
       return Options::Redacted.new unless opts
+      if opts[:read_concern]
+        # Raise an error for non user-settable options
+        if opts[:read_concern][:after_cluster_time]
+          raise Mongo::Error::InvalidReadConcern.new(
+            'The after_cluster_time read_concern option cannot be specified by the user'
+          )
+        end
+
+        given_keys = opts[:read_concern].keys.map(&:to_s)
+        allowed_keys = ['level']
+        invalid_keys = given_keys - allowed_keys
+        # Warn that options are invalid but keep it and forward to the server
+        unless invalid_keys.empty?
+          log_warn("Read concern has invalid keys: #{invalid_keys.join(',')}.")
+        end
+      end
+
       Lint.validate_underscore_read_preference(opts[:read])
       Lint.validate_read_concern_option(opts[:read_concern])
       opts.each.inject(Options::Redacted.new) do |_options, (k, v)|

data/lib/mongo/cluster.rb

@@ -950,9 +950,9 @@ module Mongo
         # Start SRV monitor
         @srv_monitor_lock.synchronize do
           unless @srv_monitor
-            monitor_options = options.merge(
-              timeout: options[:connect_timeout] || Server::CONNECT_TIMEOUT)
-            @srv_monitor = _srv_monitor = Srv::Monitor.new(self, monitor_options)
+            monitor_options = Utils.shallow_symbolize_keys(options.merge(
+              timeout: options[:connect_timeout] || Server::CONNECT_TIMEOUT))
+            @srv_monitor = _srv_monitor = Srv::Monitor.new(self, **monitor_options)
             finalizer = lambda do
               _srv_monitor.stop!
             end

data/lib/mongo/cluster/topology/single.rb

@@ -133,7 +133,7 @@ module Mongo
 
         def validate_options(options, cluster)
           if cluster.servers_list.length > 1
-            raise ArgumentError, 'Cannot instantiate a single topology with more than one server in the cluster'
+            raise ArgumentError, "Cannot instantiate a single topology with more than one server in the cluster: #{cluster.servers_list.map(&:address).map(&:seed).join(', ')}"
           end
 
           super(options, cluster)

data/lib/mongo/collection.rb

@@ -223,6 +223,7 @@ module Mongo
     # @param [ Hash ] opts The options for the create operation.
     #
     # @option options [ Session ] :session The session to use for the operation.
+    # @option opts [ Hash ] :write_concern The write concern options.
     #
     # @return [ Result ] The result of the command.
     #
@@ -239,6 +240,11 @@ module Mongo
       operation.delete(:write)
       operation.delete(:write_concern)
       client.send(:with_session, opts) do |session|
+        write_concern = if opts[:write_concern]
+          WriteConcern.get(opts[:write_concern])
+        else
+          self.write_concern
+        end
         server = next_primary(nil, session)
         if (options[:collation] || options[Operation::COLLATION]) && !server.with_connection { |connection| connection.features }.collation_enabled?
           raise Error::UnsupportedCollation
@@ -264,12 +270,19 @@ module Mongo
     # @param [ Hash ] opts The options for the drop operation.
     #
     # @option options [ Session ] :session The session to use for the operation.
+    # @option opts [ Hash ] :write_concern The write concern options.
     #
     # @return [ Result ] The result of the command.
     #
     # @since 2.0.0
     def drop(opts = {})
       client.send(:with_session, opts) do |session|
+        temp_write_concern = write_concern
+        write_concern = if opts[:write_concern]
+          WriteConcern.get(opts[:write_concern])
+        else
+          temp_write_concern
+        end
         Operation::Drop.new({
                               selector: { :drop => name },
                               db_name: database.name,
@@ -543,6 +556,8 @@ module Mongo
     #
     # @since 2.0.0
     def insert_one(document, opts = {})
+      QueryCache.clear_namespace(namespace)
+
       client.send(:with_session, opts) do |session|
         write_concern = if opts[:write_concern]
           WriteConcern.get(opts[:write_concern])
@@ -579,6 +594,8 @@ module Mongo
     #
     # @since 2.0.0
     def insert_many(documents, options = {})
+      QueryCache.clear_namespace(namespace)
+
       inserts = documents.map{ |doc| { :insert_one => doc }}
       bulk_write(inserts, options)
     end
@@ -861,5 +878,14 @@ module Mongo
     def namespace
       "#{database.name}.#{name}"
     end
+
+    # Whether the collection is a system collection.
+    #
+    # @return [ Boolean ] Whether the system is a system collection.
+    #
+    # @api private
+    def system_collection?
+      name.start_with?('system.')
+    end
   end
 end

data/lib/mongo/collection/view.rb

@@ -120,27 +120,31 @@ module Mongo
       #   server can write temporary data to disk while executing the find
       #   operation. This option is only available on MongoDB server versions
       #   4.4 and newer.
-      # @option options :comment [ String ] Associate a comment with the query.
-      # @option options :batch_size [ Integer ] The number of docs to return in
-      #   each response from MongoDB.
-      # @option options :projection [ Hash ] The fields to include or exclude in
-      #   returned docs.
-      # @option options :hint [ Hash ] Override default index selection and force
-      #   MongoDB to use a specific index for the query.
-      # @option options :limit [ Integer ] Max number of docs to return.
-      # @option options :max_scan [ Integer ] Constrain the query to only scan the
-      #   specified number of docs. Use to prevent queries from running too long.
-      #   Deprecated as of MongoDB server version 4.0.
-      # @option options :read [ Symbol ] The read preference to use for the query.
-      #   If none is provided, the collection's default read preference is used.
-      # @option options :show_disk_loc [ true, false ] Return disk location info as
-      #   a field in each doc.
-      # @option options :skip [ Integer ] The number of documents to skip.
-      # @option options :snapshot [ true, false ] Prevents returning a doc more than
-      #   once. Deprecated as of MongoDB server version 4.0.
-      # @option options :sort [ Hash ] The key and direction pairs used to sort the
-      #   results.
+      # @option options [ Integer ] :batch_size The number of documents to
+      #   return in each response from MongoDB.
       # @option options [ Hash ] :collation The collation to use.
+      # @option options [ String ] :comment Associate a comment with the query.
+      # @option options [ Hash ] :explain Execute an explain with the provided
+      #   explain options (known options are :verbose and :verbosity) rather
+      #   than a find.
+      # @option options [ Hash ] :hint Override the default index selection and
+      #   force MongoDB to use a specific index for the query.
+      # @option options [ Integer ] :limit Max number of documents to return.
+      # @option options [ Integer ] :max_scan Constrain the query to only scan
+      #   the specified number of documents. Use to prevent queries from
+      #   running for too long. Deprecated as of MongoDB server version 4.0.
+      # @option options [ Hash ] :projection The fields to include or exclude
+      #   in the returned documents.
+      # @option options [ Hash ] :read The read preference to use for the
+      #   query. If none is provided, the collection's default read preference
+      #   is used.
+      # @option options [ true | false ] :show_disk_loc Return disk location
+      #   info as a field in each doc.
+      # @option options [ Integer ] :skip The number of documents to skip.
+      # @option options [ true | false ] :snapshot Prevents returning a
+      #   document more than once. Deprecated as of MongoDB server version 4.0.
+      # @option options [ Hash ] :sort The key and direction pairs used to sort
+      #   the results.
       #
       # @since 2.0.0
       def initialize(collection, filter = {}, options = {})