mongo 2.12.1 → 2.13.0

data/lib/mongo/operation/shared/result/aggregatable.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.

data/lib/mongo/operation/shared/result/use_legacy_error_parser.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/operation/shared/sessions_supported.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-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.
@@ -45,10 +45,10 @@ module Mongo
       # operation (the one which starts the transaction via startTransaction)
       # is allowed to have a read concern, and with it the causal consistency
       # document, specified.
-      def apply_causal_consistency!(selector, server)
+      def apply_causal_consistency!(selector, connection)
         return unless selector[:startTransaction]
 
-        apply_causal_consistency_if_possible(selector, server)
+        apply_causal_consistency_if_possible(selector, connection)
       end
 
       # Adds causal consistency document to the selector, if one can be
@@ -58,8 +58,8 @@ module Mongo
       # causal consistency must be enabled for the session and the session
       # must have the current operation time. Also, topology must be
       # replica set or sharded cluster.
-      def apply_causal_consistency_if_possible(selector, server)
-        if !server.standalone?
+      def apply_causal_consistency_if_possible(selector, connection)
+        if !connection.description.standalone?
           cc_doc = session.send(:causal_consistency_doc)
           if cc_doc
             rc_doc = (selector[:readConcern] || read_concern || {}).merge(cc_doc)
@@ -73,9 +73,12 @@ module Mongo
         acknowledged_write? ? [] : [:more_to_come]
       end
 
-      def apply_cluster_time!(selector, server)
-        if !server.standalone?
-          cluster_time = [server.cluster_time, session && session.cluster_time].compact.max
+      def apply_cluster_time!(selector, connection)
+        if !connection.description.standalone?
+          cluster_time = [
+            connection.cluster_time,
+            session&.cluster_time,
+          ].compact.max
 
           if cluster_time
             selector['$clusterTime'] = cluster_time
@@ -119,20 +122,26 @@ module Mongo
         session.validate_read_preference!(selector) if read_command?(selector)
       end
 
-      def command(server)
-        sel = selector(server).dup
+      def command(connection)
+        if Lint.enabled?
+          unless connection.is_a?(Server::Connection)
+            raise Error::LintError, "Connection is not a Connection instance: #{connection}"
+          end
+        end
+
+        sel = selector(connection).dup
         add_write_concern!(sel)
         sel[Protocol::Msg::DATABASE_IDENTIFIER] = db_name
 
-        add_read_preference(sel, server)
+        add_read_preference(sel, connection)
 
-        if server.features.sessions_enabled?
-          apply_cluster_time!(sel, server)
+        if connection.features.sessions_enabled?
+          apply_cluster_time!(sel, connection)
           if session && (acknowledged_write? || session.in_transaction?)
-            apply_session_options(sel, server)
+            apply_session_options(sel, connection)
           end
         elsif session && session.explicit?
-          apply_session_options(sel, server)
+          apply_session_options(sel, connection)
         end
 
         sel
@@ -150,12 +159,27 @@ module Mongo
       # $readPreference is sent to OP_MSG-grokking replica set members.
       #
       # @param [ Hash ] sel Existing command document which will be mutated.
-      # @param [ Server ] server The server that the command is to be sent to.
-      def add_read_preference(sel, server)
+      # @param [ Server::Connection ] connection The connection that the
+      #   operation will be executed on.
+      def add_read_preference(sel, connection)
+        Lint.assert_type(connection, Server::Connection)
+
         # https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.rst#topology-type-single
-        if server.standalone?
+        if connection.description.standalone?
           # Read preference is never sent to standalones.
-        elsif server.cluster.single?
+        elsif connection.description.mongos?
+          # When server is a mongos:
+          # - $readPreference is never sent when mode is 'primary'
+          # - When mode is 'secondaryPreferred' $readPreference is only sent
+          #   when a non-mode field (i.e. tag_sets) is present
+          # - Otherwise $readPreference is sent
+          if read
+            doc = read.to_mongos
+            if doc
+              sel['$readPreference'] = doc
+            end
+          end
+        elsif connection.server.cluster.single?
           # In Single topology:
           # - If no read preference is specified by the application, the driver
           #   adds mode: primaryPreferred.
@@ -171,21 +195,20 @@ module Mongo
           end
           sel['$readPreference'] = read_doc
         else
-          # In replica sets and sharded clusters, read preference is passed
-          # to the server if one is specified by the application, and there
-          # is no default.
+          # In replica sets, read preference is passed to the server if one
+          # is specified by the application, and there is no default.
           if read
             sel['$readPreference'] = read.to_doc
           end
         end
       end
 
-      def apply_session_options(sel, server)
-        apply_cluster_time!(sel, server)
+      def apply_session_options(sel, connection)
+        apply_cluster_time!(sel, connection)
         sel[:txnNumber] = BSON::Int64.new(txn_num) if txn_num
         sel.merge!(lsid: session.session_id)
         apply_start_transaction!(sel)
-        apply_causal_consistency!(sel, server)
+        apply_causal_consistency!(sel, connection)
         apply_autocommit!(sel)
         apply_txn_opts!(sel)
         suppress_read_write_concern!(sel)
@@ -198,12 +221,12 @@ module Mongo
         end
       end
 
-      def build_message(server)
+      def build_message(connection)
         super.tap do |message|
           if session
             # Serialize the message to detect client-side problems,
             # such as invalid BSON keys. The message will be serialized again
-            # later prior to being sent to the server.
+            # later prior to being sent to the connection.
             message.serialize(BSON::ByteBuffer.new)
 
             session.update_state!

data/lib/mongo/operation/shared/specifiable.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.
@@ -325,15 +325,15 @@ module Mongo
         spec[OPERATION_ID]
       end
 
-      # Get the options for the operation.
+      # Get the options for executing the operation on a particular connection.
       #
-      # @example Get the options.
-      #   specifiable.options
+      # @param [ Server::Connection ] connection The connection that the
+      #   operation will be executed on.
       #
       # @return [ Hash ] The options.
       #
       # @since 2.0.0
-      def options(server = nil)
+      def options(connection)
         spec[OPTIONS] || {}
       end
 
@@ -387,15 +387,16 @@ module Mongo
         send(self.class::IDENTIFIER).first[COLLATION]
       end
 
-      # The selector for from the specification.
+      # The selector from the specification for execution on a particular
+      # connection.
       #
-      # @example Get a selector specification.
-      #   specifiable.selector.
+      # @param [ Server::Connection ] connection The connection that the
+      #   operation will be executed on.
       #
       # @return [ Hash ] The selector spec.
       #
       # @since 2.0.0
-      def selector(server = nil)
+      def selector(connection)
         spec[SELECTOR]
       end
 
@@ -478,7 +479,9 @@ module Mongo
       #
       # @since 2.0.0
       def read
-        @read ||= ServerSelector.get(spec[READ]) if spec[READ]
+        @read ||= begin
+          ServerSelector.get(spec[READ]) if spec[READ]
+        end
       end
 
       # Whether the operation is ordered.
@@ -529,28 +532,37 @@ module Mongo
         @spec[:txn_num]
       end
 
-      # The command.
+      # For createIndexes operations, the number of votes that a primary must
+      # wait for before commiting an index. 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
       #
-      # @example Get the command.
-      #   specifiable.command
+      # @return [ nil | Integer | String ] The commitQuorum value of the operation.
+      def commit_quorum
+        @spec[:commit_quorum]
+      end
+
+      # The command.
       #
       # @return [ Hash ] The command.
       #
       # @since 2.5.2
-      def command(server = nil)
-        selector(server)
+      def command(connection)
+        selector(connection)
       end
 
       # The array filters.
       #
-      # @example Get the array filters.
-      #   specifiable.array_filters
+      # @param [ Server::Connection ] connection The connection that the
+      #   operation will be executed on.
       #
-      # @return [ Hash ] The array filters.
+      # @return [ Hash | nil ] The array filters.
       #
       # @since 2.5.2
-      def array_filters
-        selector[Operation::ARRAY_FILTERS] if selector
+      def array_filters(connection)
+        sel = selector(connection)
+        sel[Operation::ARRAY_FILTERS] if sel
       end
 
       # Does the operation have an acknowledged write concern.

data/lib/mongo/operation/shared/write.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-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.
@@ -36,24 +36,28 @@ module Mongo
       #
       # @since 2.5.2
       def execute(server, client:)
-        validate!
-        op = if server.features.op_msg_enabled?
-            self.class::OpMsg.new(spec)
-          elsif !acknowledged_write?
-            self.class::Legacy.new(spec)
-          else
-            self.class::Command.new(spec)
-          end
-        result = op.execute(server, client: client)
-        validate_result(result, server)
+        server.with_connection do |connection|
+          validate!(connection)
+          op = if connection.features.op_msg_enabled?
+              self.class::OpMsg.new(spec)
+            elsif !acknowledged_write?
+              self.class::Legacy.new(spec)
+            else
+              self.class::Command.new(spec)
+            end
+
+          result = op.execute(connection, client: client)
+          validate_result(result, client, connection)
+        end
       end
 
       # Execute the bulk write operation.
       #
       # @example
-      #   operation.bulk_execute(server, client: nil)
+      #   operation.bulk_execute(connection, client: nil)
       #
-      # @param [ Mongo::Server ] server The server to send the operation to.
+      # @param [ Mongo::Server::Connection ] connection The connection over
+      #   which to send the operation.
       # @param [ Mongo::Client ] client The client that will be used to
       #   perform auto-encryption if it is necessary to encrypt the command
       #   being executed (optional).
@@ -63,23 +67,25 @@ module Mongo
       #           Mongo::Operation::Update::BulkResult ] The bulk result.
       #
       # @since 2.5.2
-      def bulk_execute(server, client:)
-        if server.features.op_msg_enabled?
-          self.class::OpMsg.new(spec).execute(server, client: client).bulk_result
+      def bulk_execute(connection, client:)
+        Lint.assert_type(connection, Server::Connection)
+
+        if connection.features.op_msg_enabled?
+          self.class::OpMsg.new(spec).execute(connection, client: client).bulk_result
         else
-          self.class::Command.new(spec).execute(server, client: client).bulk_result
+          self.class::Command.new(spec).execute(connection, client: client).bulk_result
         end
       end
 
       private
 
-      def validate!
+      def validate!(connection)
         if !acknowledged_write?
           if collation
             raise Error::UnsupportedCollation.new(
                 Error::UnsupportedCollation::UNACKNOWLEDGED_WRITES_MESSAGE)
           end
-          if array_filters
+          if array_filters(connection)
             raise Error::UnsupportedArrayFilters.new(
                 Error::UnsupportedArrayFilters::UNACKNOWLEDGED_WRITES_MESSAGE)
           end

data/lib/mongo/operation/shared/write_concern_supported.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-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.
@@ -22,14 +22,14 @@ module Mongo
 
       private
 
-      def write_concern_supported?(server); true; end
+      def write_concern_supported?(connection); true; end
 
-      def command(server)
-        add_write_concern!(super, server)
+      def command(connection)
+        add_write_concern!(super, connection)
       end
 
-      def add_write_concern!(sel, server)
-        if write_concern && write_concern_supported?(server)
+      def add_write_concern!(sel, connection)
+        if write_concern && write_concern_supported?(connection)
           sel[:writeConcern] = write_concern.options
         end
         sel

data/lib/mongo/operation/update.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-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/operation/update/bulk_result.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.

data/lib/mongo/operation/update/command.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-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.
@@ -32,14 +32,14 @@ module Mongo
 
         private
 
-        def selector(server)
+        def selector(connection)
           { update: coll_name,
             updates: send(IDENTIFIER),
             ordered: ordered? }
         end
 
-        def message(server)
-          Protocol::Query.new(db_name, Database::COMMAND, command(server), options)
+        def message(connection)
+          Protocol::Query.new(db_name, Database::COMMAND, command(connection), options(connection))
         end
       end
     end

data/lib/mongo/operation/update/legacy.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-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.
@@ -34,7 +34,7 @@ module Mongo
           send(IDENTIFIER).first
         end
 
-        def message(server)
+        def message(connection)
           flags = []
           flags << :multi_update if selector[Operation::MULTI]
           flags << :upsert if selector[Operation::UPSERT]

data/lib/mongo/operation/update/legacy/result.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-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/operation/update/op_msg.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-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.
@@ -29,15 +29,15 @@ module Mongo
 
         private
 
-        def selector(server)
+        def selector(connection)
           { update: coll_name,
             Protocol::Msg::DATABASE_IDENTIFIER => db_name,
             ordered: ordered? }
         end
 
-        def message(server)
+        def message(connection)
           section = Protocol::Msg::Section1.new(IDENTIFIER, send(IDENTIFIER))
-          Protocol::Msg.new(flags, {}, command(server), section)
+          Protocol::Msg.new(flags, {}, command(connection), section)
         end
       end
     end