mongo 2.15.0.alpha → 2.16.0

data/lib/mongo/error/unknown_payload_type.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2017-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/error/unmet_dependency.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/error/unsupported_array_filters.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/error/unsupported_collation.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/error/unsupported_features.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/error/unsupported_message_type.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/error/unsupported_option.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/error/write_retryable.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/error.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -165,6 +168,7 @@ module Mongo
 end
 
 require 'mongo/error/auth_error'
+require 'mongo/error/bad_load_balancer_target'
 require 'mongo/error/sdam_error_detection'
 require 'mongo/error/parser'
 require 'mongo/error/write_retryable'
@@ -214,6 +218,7 @@ require 'mongo/error/mismatched_domain'
 require 'mongo/error/mongocryptd_spawn_error'
 require 'mongo/error/multi_index_drop'
 require 'mongo/error/need_primary_server'
+require 'mongo/error/no_service_connection_available'
 require 'mongo/error/no_server_available'
 require 'mongo/error/no_srv_records'
 require 'mongo/error/session_ended'
@@ -232,6 +237,7 @@ require 'mongo/error/missing_file_chunk'
 require 'mongo/error/missing_password'
 require 'mongo/error/missing_resume_token'
 require 'mongo/error/missing_scram_server_signature'
+require 'mongo/error/missing_service_id'
 require 'mongo/error/server_api_conflict'
 require 'mongo/error/server_api_not_supported'
 require 'mongo/error/unknown_payload_type'

data/lib/mongo/event/base.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

data/lib/mongo/event/listeners.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

data/lib/mongo/event/publisher.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/event/subscriber.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/event.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -153,7 +156,7 @@ module Mongo
           # @since 2.0.0
           # @api private
           def assemble(chunks)
-            chunks.reduce(''){ |data, chunk| data << chunk.data.data }
+            chunks.reduce(+''){ |data, chunk| data << chunk.data.data }
           end
 
           # Split the provided data into multiple chunks.

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/grid/file.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/grid/fs_bucket.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -50,7 +53,13 @@ module Mongo
       #   size.
       # @option options [ String ] :fs_name The prefix for the files and chunks
       #   collections.
-      # @option options [ String ] :read The read preference.
+      # @option options [ Hash ] :read The read preference options. The hash
+      #   may have the following items:
+      #   - *:mode* -- read preference specified as a symbol; valid values are
+      #     *:primary*, *:primary_preferred*, *:secondary*, *:secondary_preferred*
+      #     and *:nearest*.
+      #   - *:tag_sets* -- an array of hashes.
+      #   - *:local_threshold*.
       # @option options [ Session ] :session The session to use.
       # @option options [ Hash ] :write Deprecated. Equivalent to :write_concern
       #   option.
@@ -437,14 +446,26 @@ module Mongo
 
       # Get the read preference.
       #
-      # @example Get the read preference.
-      #   fs.read_preference
-      #
-      # @return [ Mongo::ServerSelector ] The read preference.
-      #
-      # @since 2.1.0
+      # @note This method always returns a BSON::Document instance, even though
+      #   the FSBucket constructor specifies the type of :read as a Hash, not
+      #   as a BSON::Document.
+      #
+      # @return [ BSON::Document ] The read preference.
+      #   The document may have the following fields:
+      #   - *:mode* -- read preference specified as a symbol; valid values are
+      #     *:primary*, *:primary_preferred*, *:secondary*, *:secondary_preferred*
+      #     and *:nearest*.
+      #   - *:tag_sets* -- an array of hashes.
+      #   - *:local_threshold*.
       def read_preference
-        @read_preference ||= options[:read] || database.read_preference
+        @read_preference ||= begin
+          pref = options[:read] || database.read_preference
+          if BSON::Document === pref
+            pref
+          else
+            BSON::Document.new(pref)
+          end
+        end
       end
 
       # Get the write concern.
@@ -487,8 +508,27 @@ module Mongo
 
       def ensure_indexes!
         if files_collection.find({}, limit: 1, projection: { _id: 1 }).first.nil?
-          chunks_collection.indexes.create_one(FSBucket::CHUNKS_INDEX, :unique => true)
-          files_collection.indexes.create_one(FSBucket::FILES_INDEX)
+          create_index_if_missing!(files_collection, FSBucket::FILES_INDEX)
+        end
+
+        if chunks_collection.find({}, limit: 1, projection: { _id: 1 }).first.nil?
+          create_index_if_missing!(chunks_collection, FSBucket::CHUNKS_INDEX, :unique => true)
+        end
+      end
+
+      def create_index_if_missing!(collection, index_spec, options = {})
+        indexes_view = collection.indexes
+        begin
+          if indexes_view.get(index_spec).nil?
+            indexes_view.create_one(index_spec, options)
+          end
+        rescue Mongo::Error::OperationFailure => e
+          # proceed with index creation if a NamespaceNotFound error is thrown
+          if e.code == 26
+            indexes_view.create_one(index_spec, options)
+          else
+            raise
+          end
         end
       end
     end

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -133,16 +136,28 @@ module Mongo
             !@open
           end
 
-          # Get the read preference used when streaming.
-          #
-          # @example Get the read preference.
-          #   stream.read_preference
+          # Get the read preference.
           #
-          # @return [ Mongo::ServerSelector ] The read preference.
+          # @note This method always returns a BSON::Document instance, even
+          #   though the constructor specifies the type of :read as a Hash, not
+          #   as a BSON::Document.
           #
-          # @since 2.1.0
+          # @return [ BSON::Document ] The read preference.
+          #   The document may have the following fields:
+          #   - *:mode* -- read preference specified as a symbol; valid values are
+          #     *:primary*, *:primary_preferred*, *:secondary*, *:secondary_preferred*
+          #     and *:nearest*.
+          #   - *:tag_sets* -- an array of hashes.
+          #   - *:local_threshold*.
           def read_preference
-            @read_preference ||= options[:read] || fs.read_preference
+            @read_preference ||= begin
+              pref = options[:read] || fs.read_preference
+              if BSON::Document === pref
+                pref
+              else
+                BSON::Document.new(pref)
+              end
+            end
           end
 
           # Get the files collection file information document for the file

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/grid/stream.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/grid.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/id.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2016-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
@@ -13,9 +16,10 @@
 # limitations under the License.
 
 module Mongo
-  # This module abstracts the functionality for generating sequential unique integer IDs for
-  # instances of the class. It defines the method #next_id on the class that includes it. The
-  # implementation ensures that the IDs will be unique even when called from multiple threads.
+  # This module abstracts the functionality for generating sequential
+  # unique integer IDs for instances of the class. It defines the method
+  # #next_id on the class that includes it. The implementation ensures that
+  # the IDs will be unique even when called from multiple threads.
   #
   # @example Include the Id module.
   #   class Foo
@@ -26,8 +30,9 @@ module Mongo
   #   foo.next_id # => 1
   #   foo.next_id # => 2
   #
-  # Classes which include Id should _not_ access `@@id` or `@@id_lock` directly; instead, they
-  # should call `#next_id` in `#initialize` and save the result in the instance being created.
+  # Classes which include Id should _not_ access `@@id` or `@@id_lock`
+  # directly; instead, they should call `#next_id` in `#initialize` and save
+  # the result in the instance being created.
   #
   # @example Save the ID in the instance of the including class.
   #   class Bar

data/lib/mongo/index/view.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -126,7 +129,10 @@ module Mongo
       # @option options [ String | Integer ] :commit_quorum Specify how many
       #   data-bearing members of a replica set, including the primary, must
       #   complete the index builds successfully before the primary marks
-      #   the indexes as ready.
+      #   the indexes as ready. Potential values are:
+      #   - an integer from 0 to the number of members of the replica set
+      #   - "majority" indicating that a majority of data bearing nodes must vote
+      #   - "votingMembers" which means that all voting data bearing nodes must vote
       # @option options [ Session ] :session The session to use for the operation.
       #
       # @note Note that the options listed may be subset of those available.
@@ -174,7 +180,10 @@ module Mongo
       #   The following options are accepted:
       #   - commit_quorum: Specify how many data-bearing members of a replica set,
       #     including the primary, must complete the index builds successfully
-      #     before the primary marks the indexes as ready.
+      #     before the primary marks the indexes as ready. Potential values are:
+      #     - an integer from 0 to the number of members of the replica set
+      #     - "majority" indicating that a majority of data bearing nodes must vote
+      #     - "votingMembers" which means that all voting data bearing nodes must vote
       #   - session: The session to use.
       #
       # @return [ Result ] The result of the command.
@@ -190,17 +199,6 @@ module Mongo
         client.send(:with_session, @options.merge(options)) do |session|
           server = next_primary(nil, session)
 
-          # While server versions 3.4 and newer generally perform option
-          # validation, there was a bug on server versions 4.2.0 - 4.2.5 where
-          # the server would accept the commitQuorum option and use it internally
-          # (see SERVER-47193). As a result, the drivers specifications require
-          # drivers to perform validation and raise an error when the commitQuorum
-          # option is passed to servers that don't support it.
-          description = server.with_connection { |connection| connection.description }
-          if description.max_wire_version < 9 && options[:commit_quorum]
-            raise Error::UnsupportedOption.commit_quorum_error
-          end
-
           indexes = normalize_models(models, server)
           indexes.each do |index|
             if index[:bucketSize] || index['bucketSize']
@@ -213,10 +211,9 @@ module Mongo
             db_name: database.name,
             coll_name: collection.name,
             session: session,
-            commit_quorum: options[:commit_quorum]
-           }
-
-          spec[:write_concern] = write_concern if description.features.collation_enabled?
+            commit_quorum: options[:commit_quorum],
+            write_concern: write_concern,
+          }
 
           Operation::CreateIndex.new(spec).execute(server, context: Operation::Context.new(client: client, session: session))
         end
@@ -289,13 +286,13 @@ module Mongo
       def drop_by_name(name)
         client.send(:with_session, @options) do |session|
           spec = {
-                   db_name: database.name,
-                   coll_name: collection.name,
-                   index_name: name,
-                   session: session
-                 }
+            db_name: database.name,
+            coll_name: collection.name,
+            index_name: name,
+            session: session,
+            write_concern: write_concern,
+          }
           server = next_primary(nil, session)
-          spec[:write_concern] = write_concern if server.with_connection { |connection| connection.features }.collation_enabled?
           Operation::DropIndex.new(spec).execute(server, context: Operation::Context.new(client: client, session: session))
         end
       end
@@ -326,30 +323,17 @@ module Mongo
       end
 
       def normalize_models(models, server)
-        with_generated_names(models, server).map do |model|
-          Options::Mapper.transform(model, OPTIONS)
+        models.map do |model|
+          # Transform options first which gives us a mutable hash
+          Options::Mapper.transform(model, OPTIONS).tap do |model|
+            model[:name] ||= index_name(model.fetch(:key))
+          end
         end
       end
 
       def send_initial_query(server, session)
         initial_query_op(session).execute(server, context: Operation::Context.new(client: client, session: session))
       end
-
-      def with_generated_names(models, server)
-        models.dup.each do |model|
-          validate_collation!(model, server)
-          unless model[:name]
-            model[:name] = index_name(model[:key])
-          end
-        end
-      end
-
-      def validate_collation!(model, server)
-        if (model[:collation] || model[Operation::COLLATION]) &&
-            !server.with_connection { |connection| connection.features }.collation_enabled?
-          raise Error::UnsupportedCollation.new
-        end
-      end
     end
   end
 end

data/lib/mongo/index.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/lint.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongo
 
   # @api private

data/lib/mongo/loggable.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/logger.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/monitoring/cmap_log_subscriber.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

data/lib/mongo/monitoring/command_log_subscriber.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
@@ -28,15 +31,18 @@ module Mongo
           # @since 2.9.0
           attr_reader :address
 
+          # @return [ nil | Object ] The service id, if any.
+          attr_reader :service_id
+
           # Create the event.
           #
-          # @example Create the event.
-          #   PoolCleared.new(address)
+          # @param [ Address ] address
+          # @param [ Object ] service_id The service id, if any.
           #
-          # @since 2.9.0
           # @api private
-          def initialize(address)
+          def initialize(address, service_id: nil)
             @address = address
+            @service_id = service_id
           end
 
           # Returns a concise yet useful summary of the event.

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');