mongo 2.11.1 → 2.11.6

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

@@ -185,7 +185,9 @@ module Mongo
           pipeline << { :'$limit' => opts[:limit] } if opts[:limit]
           pipeline << { :'$group' => { _id: 1, n: { :'$sum' => 1 } } }
 
-          opts.select! { |k, _| [:hint, :max_time_ms, :read, :collation, :session].include?(k) }
+          opts = opts.select { |k, _| [:hint, :max_time_ms, :read, :collation, :session].include?(k) }
+          opts[:collation] ||= collation
+
           first = aggregate(pipeline, opts).first
           return 0 unless first
           first['n'].to_i

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

@@ -234,7 +234,7 @@ module Mongo
                          Operation::U => replacement,
                         }
           if opts[:upsert]
-            update_doc[:upsert] = true
+            update_doc['upsert'] = true
           end
           with_session(opts) do |session|
             write_concern = write_concern_with_session(session)
@@ -281,7 +281,7 @@ module Mongo
                          Operation::MULTI => true,
                          }
           if opts[:upsert]
-            update_doc[:upsert] = true
+            update_doc['upsert'] = true
           end
           with_session(opts) do |session|
             write_concern = write_concern_with_session(session)
@@ -325,7 +325,7 @@ module Mongo
                          Operation::U => spec,
                          }
           if opts[:upsert]
-            update_doc[:upsert] = true
+            update_doc['upsert'] = true
           end
           with_session(opts) do |session|
             write_concern = write_concern_with_session(session)

data/lib/mongo/cursor/builder/kill_cursors_command.rb

@@ -92,7 +92,14 @@ module Mongo
           #
           # @since 2.3.0
           def get_cursors_list(spec)
-            spec[:selector][:cursors].map(&:value)
+            spec[:selector][:cursors].map do |value|
+              if value.respond_to?(:value)
+                # bson-ruby >= 4.6.0
+                value = value.value
+              else
+                value = value.instance_variable_get('@integer')
+              end
+            end
           end
         end
       end

data/lib/mongo/cursor/builder/op_kill_cursors.rb

@@ -87,7 +87,14 @@ module Mongo
           #
           # @since 2.3.0
           def get_cursors_list(spec)
-            spec[:cursor_ids].map(&:value)
+            spec[:cursor_ids].map do |value|
+              if value.respond_to?(:value)
+                # bson-ruby >= 4.6.0
+                value.value
+              else
+                value.instance_variable_get('@integer')
+              end
+            end
           end
         end
       end

data/lib/mongo/database.rb

@@ -157,7 +157,7 @@ module Mongo
     # @option opts :read [ Hash ] The read preference for this command.
     # @option opts :session [ Session ] The session to use for this command.
     #
-    # @return [ Hash ] The result of the command execution.
+    # @return [ Mongo::Operation::Result ] The result of the command execution.
     def command(operation, opts = {})
       txn_read_pref = if opts[:session] && opts[:session].in_transaction?
         opts[:session].txn_read_preference

data/lib/mongo/grid/file.rb

@@ -104,6 +104,11 @@ module Mongo
       #   chunk objects and assemble the data. If we have an IO object, then
       #   it's the original file data and we must split it into chunks and set
       #   the original data itself.
+      #
+      # @param [ IO, String, Array<BSON::Document> ] value The file object,
+      #   file contents or chunk documents.
+      #
+      # @return [ Array<Grid::File::Chunk> ] Array of chunks.
       def initialize_chunks!(value)
         if value.is_a?(Array)
           @chunks = value.map{ |doc| Chunk.new(doc) }

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

@@ -151,6 +151,7 @@ module Mongo
           # @return [ String ] The assembled data.
           #
           # @since 2.0.0
+          # @api private
           def assemble(chunks)
             chunks.reduce(''){ |data, chunk| data << chunk.data.data }
           end
@@ -167,6 +168,7 @@ module Mongo
           # @return [ Array<Chunk> ] The chunks of the data.
           #
           # @since 2.0.0
+          # @api private
           def split(io, file_info, offset = 0)
             io = StringIO.new(io) if io.is_a?(String)
             parts = Enumerator.new { |y| y << io.read(file_info.chunk_size) until io.eof? }

data/lib/mongo/grid/fs_bucket.rb

@@ -177,7 +177,7 @@ module Mongo
       #
       # @since 2.0.0
       def prefix
-        @options[:fs_name] || @options[:bucket_name]|| DEFAULT_ROOT
+        @options[:fs_name] || @options[:bucket_name] || DEFAULT_ROOT
       end
 
       # Remove a single file from the GridFS.
@@ -230,7 +230,8 @@ module Mongo
       #
       # @since 2.1.0
       def open_download_stream(id, options = nil)
-        read_stream(id, options).tap do |stream|
+        options = Hash[(options || {}).map { |k, v| [k.to_sym, v] }]
+        read_stream(id, **options).tap do |stream|
           if block_given?
             begin
               yield stream
@@ -348,15 +349,15 @@ module Mongo
         download_to_stream(open_download_stream_by_name(filename, opts).file_id, io)
       end
 
-      # Opens an upload stream to GridFS to which the contents of a user file came be written.
+      # Opens an upload stream to GridFS to which the contents of a file or
+      # blob can be written.
       #
-      # @example Open a stream to which the contents of a file came be written.
-      #   fs.open_upload_stream('a-file.txt')
-      #
-      # @param [ String ] filename The filename of the file to upload.
+      # @param [ String ] filename The name of the file in GridFS.
       # @param [ Hash ] opts The options for the write stream.
       #
-      # @option opts [ Object ] :file_id An optional unique file id. An ObjectId is generated otherwise.
+      # @option opts [ Object ] :file_id An optional unique file id.
+      #   A BSON::ObjectId is automatically generated if a file id is not
+      #   provided.
       # @option opts [ Integer ] :chunk_size Override the default chunk size.
       # @option opts [ Hash ] :metadata User data for the 'metadata' field of the files
       #   collection document.
@@ -375,7 +376,8 @@ module Mongo
       #
       # @since 2.1.0
       def open_upload_stream(filename, opts = {})
-        write_stream(filename, opts).tap do |stream|
+        opts = Hash[opts.map { |k, v| [k.to_sym, v] }]
+        write_stream(filename, **opts).tap do |stream|
           if block_given?
             begin
               yield stream
@@ -462,12 +464,12 @@ module Mongo
       #
       # @option opts [ BSON::Document ] :file_info_doc For internal
       #   driver use only. A BSON document to use as file information.
-      def read_stream(id, opts = nil)
-        Stream.get(self, Stream::READ_MODE, { file_id: id }.update(options).update(opts || {}))
+      def read_stream(id, **opts)
+        Stream.get(self, Stream::READ_MODE, { file_id: id }.update(options).update(opts))
       end
 
-      def write_stream(filename, opts)
-        Stream.get(self, Stream::WRITE_MODE, { filename: filename }.merge!(options).merge!(opts))
+      def write_stream(filename, **opts)
+        Stream.get(self, Stream::WRITE_MODE, { filename: filename }.update(options).update(opts))
       end
 
       def chunks_name

data/lib/mongo/grid/stream/write.rb

@@ -82,12 +82,12 @@ module Mongo
             @open = true
           end
 
-          # Write to the GridFS bucket from the source stream.
+          # Write to the GridFS bucket from the source stream or a string.
           #
           # @example Write to GridFS.
           #   stream.write(io)
           #
-          # @param [ IO ] io The source io stream to upload from.
+          # @param [ String | IO ] io The string or IO object to upload from.
           #
           # @return [ Stream::Write ] self The write stream itself.
           #
@@ -95,7 +95,13 @@ module Mongo
           def write(io)
             ensure_open!
             @indexes ||= ensure_indexes!
-            @length += io.size
+            @length += if io.respond_to?(:bytesize)
+              # String objects
+              io.bytesize
+            else
+              # IO objects
+              io.size
+            end
             chunks = File::Chunk.split(io, file_info, @n)
             @n += chunks.size
             chunks_collection.insert_many(chunks) unless chunks.empty?

data/lib/mongo/protocol/serializers.rb

@@ -110,7 +110,12 @@ module Mongo
         # @return [String] Buffer with serialized value.
         def self.serialize(buffer, value, validating_keys = BSON::Config.validating_keys?)
           if value.is_a?(BSON::Int32)
-            value = value.value
+            if value.respond_to?(:value)
+              # bson-ruby >= 4.6.0
+              value = value.value
+            else
+              value = value.instance_variable_get('@integer')
+            end
           end
           buffer.put_int32(value)
         end
@@ -138,7 +143,12 @@ module Mongo
         # @return [ String ] Buffer with serialized value.
         def self.serialize(buffer, value, validating_keys = BSON::Config.validating_keys?)
           if value.is_a?(BSON::Int64)
-            value = value.value
+            if value.respond_to?(:value)
+              # bson-ruby >= 4.6.0
+              value = value.value
+            else
+              value = value.instance_variable_get('@integer')
+            end
           end
           buffer.put_int64(value)
         end

data/lib/mongo/server.rb

@@ -306,12 +306,11 @@ module Mongo
       "#<Mongo::Server:0x#{object_id} address=#{address.host}:#{address.port}>"
     end
 
-    # @note This method is experimental and subject to change.
+    # @return [ String ] String representing server status (e.g. PRIMARY).
     #
-    # @api experimental
-    # @since 2.7.0
-    def summary
-      status = case
+    # @api private
+    def status
+      case
       when primary?
         'PRIMARY'
       when secondary?
@@ -331,8 +330,16 @@ module Mongo
       else
         # Since the summary method is often used for debugging, do not raise
         # an exception in case none of the expected types matched
-        ''
+        nil
       end
+    end
+
+    # @note This method is experimental and subject to change.
+    #
+    # @api experimental
+    # @since 2.7.0
+    def summary
+      status = self.status || ''
       if replica_set_name
         status += " replica_set=#{replica_set_name}"
       end

data/lib/mongo/server/connection.rb

@@ -103,6 +103,12 @@ module Mongo
         )
       end
 
+      # @return [ Server::Description ] The server description obtained from
+      #   the handshake on this connection.
+      #
+      # @api private
+      attr_reader :description
+
       # @return [ Time ] The last time the connection was checked back into a pool.
       #
       # @since 2.5.0
@@ -181,13 +187,14 @@ module Mongo
 
       # Separate method to permit easier mocking in the test suite.
       def do_connect
-        socket = address.socket(socket_timeout, ssl_options,
-          connect_timeout: address.connect_timeout)
+        socket = address.socket(socket_timeout, ssl_options, address.options)
 
         begin
           handshake!(socket)
-          pending_connection = PendingConnection.new(socket, @server, monitoring, options.merge(id: id))
-          authenticate!(pending_connection)
+          unless description.arbiter?
+            pending_connection = PendingConnection.new(socket, @server, monitoring, options.merge(id: id))
+            authenticate!(pending_connection)
+          end
         rescue Exception
           socket.close
           raise
@@ -314,7 +321,7 @@ module Mongo
               raise exc
             end
           rescue => e
-            log_warn("Failed to handshake with #{address}: #{e.class}: #{e}")
+            log_warn("Failed to handshake with #{address}: #{e.class}: #{e}:\n#{e.backtrace[0..5].join("\n")}")
             raise
           end
         end
@@ -356,8 +363,8 @@ module Mongo
           @auth_mechanism = nil
         end
 
-        new_description = Description.new(address, response, average_rtt)
-        @server.cluster.run_sdam_flow(@server.description, new_description)
+        @description = Description.new(address, response, average_rtt)
+        @server.cluster.run_sdam_flow(@server.description, @description)
       end
 
       def authenticate!(pending_connection)
@@ -371,7 +378,7 @@ module Mongo
             begin
               Auth.get(user).login(pending_connection)
             rescue => e
-              log_warn("Failed to handshake with #{address}: #{e.class}: #{e}")
+              log_warn("Failed to handshake with #{address}: #{e.class}: #{e}:\n#{e.backtrace[0..5].join("\n")}")
               raise
             end
           end

data/lib/mongo/server/connection_base.rb

@@ -29,12 +29,15 @@ module Mongo
       # @return [ Hash ] options The passed in options.
       attr_reader :options
 
+      # @return [ Server ] The server that this connection is for.
+      #
+      # @api private
+      attr_reader :server
+
       # @return [ Mongo::Address ] address The address to connect to.
-      def address
-        @server.address
-      end
+      def_delegators :server, :address
 
-      def_delegators :@server,
+      def_delegators :server,
                      :features,
                      :max_bson_object_size,
                      :max_message_size,

data/lib/mongo/server/description.rb

@@ -33,6 +33,7 @@ module Mongo
       # Constant for reading arbiter info from config.
       #
       # @since 2.0.0
+      # @deprecated
       ARBITER = 'arbiterOnly'.freeze
 
       # Constant for reading arbiters info from config.
@@ -53,16 +54,19 @@ module Mongo
       # Constant for the key for the message value.
       #
       # @since 2.0.0
+      # @deprecated
       MESSAGE = 'msg'.freeze
 
       # Constant for the message that indicates a sharded cluster.
       #
       # @since 2.0.0
+      # @deprecated
       MONGOS_MESSAGE = 'isdbgrid'.freeze
 
       # Constant for determining ghost servers.
       #
       # @since 2.0.0
+      # @deprecated
       REPLICA_SET = 'isreplicaset'.freeze
 
       # Constant for reading max bson size info from config.
@@ -129,6 +133,7 @@ module Mongo
       # Constant for reading primary info from config.
       #
       # @since 2.0.0
+      # @deprecated
       PRIMARY = 'ismaster'.freeze
 
       # Constant for reading primary host field from config.
@@ -139,6 +144,7 @@ module Mongo
       # Constant for reading secondary info from config.
       #
       # @since 2.0.0
+      # @deprecated
       SECONDARY = 'secondary'.freeze
 
       # Constant for reading replica set name info from config.
@@ -227,7 +233,7 @@ module Mongo
       # @return [ Float ] The moving average time the ismaster call took to complete.
       attr_reader :average_round_trip_time
 
-      # Will return true if the server is an arbiter.
+      # Returns whether this server is an arbiter, per the SDAM spec.
       #
       # @example Is the server an arbiter?
       #   description.arbiter?
@@ -236,7 +242,9 @@ module Mongo
       #
       # @since 2.0.0
       def arbiter?
-        ok? && !!config[ARBITER] && !replica_set_name.nil?
+        ok? &&
+        config['arbiterOnly'] == true &&
+        !!config['setName']
       end
 
       # Get a list of all arbiters in the replica set.
@@ -251,7 +259,7 @@ module Mongo
         @arbiters ||= (config[ARBITERS] || []).map { |s| s.downcase }
       end
 
-      # Is the server a ghost in a replica set?
+      # Whether this server is a ghost, per the SDAM spec.
       #
       # @example Is the server a ghost?
       #   description.ghost?
@@ -260,7 +268,8 @@ module Mongo
       #
       # @since 2.0.0
       def ghost?
-        ok? && !!config[REPLICA_SET]
+        ok? &&
+        config['isreplicaset'] == true
       end
 
       # Will return true if the server is hidden.
@@ -431,7 +440,7 @@ module Mongo
         config[LOGICAL_SESSION_TIMEOUT_MINUTES] if config[LOGICAL_SESSION_TIMEOUT_MINUTES]
       end
 
-      # Is the server a mongos?
+      # Returns whether this server is a mongos, per the SDAM spec.
       #
       # @example Is the server a mongos?
       #   description.mongos?
@@ -440,10 +449,10 @@ module Mongo
       #
       # @since 2.0.0
       def mongos?
-        ok? && config[MESSAGE] == MONGOS_MESSAGE
+        ok? && config['msg'] == 'isdbgrid'
       end
 
-      # Is the description of type other.
+      # Returns whether the server is an other, per the SDAM spec.
       #
       # @example Is the description of type other.
       #   description.other?
@@ -455,11 +464,11 @@ module Mongo
         # The SDAM spec is slightly confusing on what "other" means,
         # but it's referred to it as "RSOther" which means a non-RS member
         # cannot be "other".
-        if unknown? || replica_set_name.nil?
-          return false
-        end
-        (!primary? && !secondary? && !passive? && !arbiter?) ||
-          (hidden? && !replica_set_name.nil?)
+        ok? &&
+        !!config['setName'] && (
+          config['hidden'] == true ||
+          !primary? && !secondary? && !arbiter?
+        )
       end
 
       # Will return true if the server is passive.
@@ -498,7 +507,7 @@ module Mongo
         config[PRIMARY_HOST] && config[PRIMARY_HOST].downcase
       end
 
-      # Will return true if the server is a primary.
+      # Returns whether this server is a primary, per the SDAM spec.
       #
       # @example Is the server a primary?
       #   description.primary?
@@ -508,9 +517,8 @@ module Mongo
       # @since 2.0.0
       def primary?
         ok? &&
-          !!config[PRIMARY] &&
-          (primary_host.nil? || primary_host == address.to_s) &&
-          !replica_set_name.nil?
+        config['ismaster'] == true &&
+        !!config['setName']
       end
 
       # Get the name of the replica set the server belongs to, returns nil if
@@ -538,7 +546,7 @@ module Mongo
         hosts + arbiters + passives
       end
 
-      # Will return true if the server is a secondary.
+      # Returns whether this server is a secondary, per the SDAM spec.
       #
       # @example Is the server a secondary?
       #   description.secondary?
@@ -547,7 +555,9 @@ module Mongo
       #
       # @since 2.0.0
       def secondary?
-        ok? && !!config[SECONDARY] && !replica_set_name.nil?
+        ok? &&
+        config['secondary'] == true &&
+        !!config['setName']
       end
 
       # Returns the server type as a symbol.
@@ -569,7 +579,7 @@ module Mongo
         :unknown
       end
 
-      # Is this server a standalone server?
+      # Returns whether this server is a standalone, per the SDAM spec.
       #
       # @example Is the server standalone?
       #   description.standalone?
@@ -578,10 +588,13 @@ module Mongo
       #
       # @since 2.0.0
       def standalone?
-        replica_set_name.nil? && !mongos? && !ghost? && !unknown?
+        ok? &&
+        config['msg'] != 'isdbgrid' &&
+        config['setName'].nil? &&
+        config['isreplicaset'] != true
       end
 
-      # Is the server description currently unknown?
+      # Returns whether this server is an unknown, per the SDAM spec.
       #
       # @example Is the server description unknown?
       #   description.unknown?