mongo 2.14.0 → 2.15.0.alpha

data/lib/mongo/monitoring.rb

@@ -307,9 +307,9 @@ module Mongo
     # @api private
     def publish_heartbeat(server, awaited: false)
       if monitoring?
-        event = Event::ServerHeartbeatStarted.new(
+        started_event = Event::ServerHeartbeatStarted.new(
           server.address, awaited: awaited)
-        started(SERVER_HEARTBEAT, event)
+        started(SERVER_HEARTBEAT, started_event)
       end
 
       # The duration we publish in heartbeat succeeded/failed events is
@@ -328,14 +328,23 @@ module Mongo
       rescue => exc
         if monitoring?
           event = Event::ServerHeartbeatFailed.new(
-            server.address, Time.now-start_time, exc, awaited: awaited)
+            server.address,
+            Time.now-start_time,
+            exc,
+            awaited: awaited,
+            started_event: started_event,
+          )
           failed(SERVER_HEARTBEAT, event)
         end
         raise
       else
         if monitoring?
           event = Event::ServerHeartbeatSucceeded.new(
-            server.address, Time.now-start_time, awaited: awaited)
+            server.address,
+            Time.now-start_time,
+            awaited: awaited,
+            started_event: started_event,
+          )
           succeeded(SERVER_HEARTBEAT, event)
         end
         result

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

@@ -21,6 +21,29 @@ module Mongo
       # @since 2.7.0
       class ServerHeartbeatFailed < Mongo::Event::Base
 
+        # Create the event.
+        #
+        # @example Create the event.
+        #   ServerHeartbeatSucceeded.new(address, duration)
+        #
+        # @param [ Address ] address The server address.
+        # @param [ Float ] round_trip_time Duration of ismaster call in seconds.
+        # @param [ true | false ] awaited Whether the heartbeat was awaited.
+        # @param [ Monitoring::Event::ServerHeartbeatStarted ] started_event
+        #   The corresponding started event.
+        #
+        # @since 2.7.0
+        # @api private
+        def initialize(address, round_trip_time, error, awaited: false,
+          started_event:
+        )
+          @address = address
+          @round_trip_time = round_trip_time
+          @error = error
+          @awaited = !!awaited
+          @started_event = started_event
+        end
+
         # @return [ Address ] address The server address.
         attr_reader :address
 
@@ -41,23 +64,11 @@ module Mongo
           @awaited
         end
 
-        # Create the event.
-        #
-        # @example Create the event.
-        #   ServerHeartbeatSucceeded.new(address, duration)
-        #
-        # @param [ Address ] address The server address.
-        # @param [ Float ] round_trip_time Duration of ismaster call in seconds.
-        # @param [ true | false ] awaited Whether the heartbeat was awaited.
+        # @return [ Monitoring::Event::ServerHeartbeatStarted ]
+        #   The corresponding started event.
         #
-        # @since 2.7.0
-        # @api private
-        def initialize(address, round_trip_time, error, awaited: false)
-          @address = address
-          @round_trip_time = round_trip_time
-          @error = error
-          @awaited = !!awaited
-        end
+        # @api experimental
+        attr_reader :started_event
 
         # Returns a concise yet useful summary of the event.
         #

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

@@ -21,20 +21,6 @@ module Mongo
       # @since 2.7.0
       class ServerHeartbeatSucceeded < Mongo::Event::Base
 
-        # @return [ Address ] address The server address.
-        attr_reader :address
-
-        # @return [ Float ] round_trip_time Duration of ismaster call in seconds.
-        attr_reader :round_trip_time
-
-        # Alias of round_trip_time.
-        alias :duration :round_trip_time
-
-        # @return [ true | false ] Whether the heartbeat was awaited.
-        def awaited?
-          @awaited
-        end
-
         # Create the event.
         #
         # @example Create the event.
@@ -43,15 +29,40 @@ module Mongo
         # @param [ Address ] address The server address.
         # @param [ Float ] round_trip_time Duration of ismaster call in seconds.
         # @param [ true | false ] awaited Whether the heartbeat was awaited.
+        # @param [ Monitoring::Event::ServerHeartbeatStarted ] started_event
+        #   The corresponding started event.
         #
         # @since 2.7.0
         # @api private
-        def initialize(address, round_trip_time, awaited: false)
+        def initialize(address, round_trip_time, awaited: false,
+          started_event:
+        )
           @address = address
           @round_trip_time = round_trip_time
           @awaited = !!awaited
+          @started_event = started_event
         end
 
+        # @return [ Address ] address The server address.
+        attr_reader :address
+
+        # @return [ Float ] round_trip_time Duration of ismaster call in seconds.
+        attr_reader :round_trip_time
+
+        # Alias of round_trip_time.
+        alias :duration :round_trip_time
+
+        # @return [ true | false ] Whether the heartbeat was awaited.
+        def awaited?
+          @awaited
+        end
+
+        # @return [ Monitoring::Event::ServerHeartbeatStarted ]
+        #   The corresponding started event.
+        #
+        # @api experimental
+        attr_reader :started_event
+
         # Returns a concise yet useful summary of the event.
         #
         # @return [ String ] String summary of the event.

data/lib/mongo/operation.rb

@@ -1,3 +1,4 @@
+require 'mongo/operation/context'
 require 'mongo/operation/result'
 
 require 'mongo/operation/shared/response_handling'
@@ -5,6 +6,7 @@ require 'mongo/operation/shared/executable'
 require 'mongo/operation/shared/executable_no_validate'
 require 'mongo/operation/shared/executable_transaction_label'
 require 'mongo/operation/shared/polymorphic_lookup'
+require 'mongo/operation/shared/polymorphic_operation'
 require 'mongo/operation/shared/polymorphic_result'
 require 'mongo/operation/shared/read_preference_supported'
 require 'mongo/operation/shared/bypass_document_validation'
@@ -18,8 +20,6 @@ require 'mongo/operation/shared/specifiable'
 require 'mongo/operation/shared/object_id_generator'
 require 'mongo/operation/shared/op_msg_or_command'
 require 'mongo/operation/shared/op_msg_or_find_command'
-require 'mongo/operation/shared/op_msg_or_list_indexes_command'
-require 'mongo/operation/shared/collections_info_or_list_collections'
 
 require 'mongo/operation/op_msg_base'
 require 'mongo/operation/command'

data/lib/mongo/operation/collections_info.rb

@@ -25,7 +25,24 @@ module Mongo
     # @since 2.0.0
     class CollectionsInfo
       include Specifiable
-      include CollectionsInfoOrListCollections
+      include PolymorphicOperation
+      include PolymorphicLookup
+
+      private
+
+      def final_operation(connection)
+         op_class = if connection.features.list_collections_enabled?
+          if connection.features.op_msg_enabled?
+            ListCollections::OpMsg
+          else
+            ListCollections::Command
+          end
+        else
+          CollectionsInfo::Command
+        end
+
+        op_class.new(spec)
+      end
     end
   end
 end

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

@@ -27,9 +27,9 @@ module Mongo
 
         private
 
-        def get_result(connection, client, options = {})
+        def get_result(connection, context, options = {})
           # This is a Mongo::Operation::CollectionsInfo::Result
-          Result.new(*dispatch_message(connection, client), db_name)
+          Result.new(*dispatch_message(connection, context), db_name)
         end
 
         def selector(connection)

data/lib/mongo/operation/context.rb

@@ -0,0 +1,99 @@
+# Copyright (C) 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 Operation
+
+    # Context for operations.
+    #
+    # Holds various objects needed to make decisions about operation execution
+    # in a single container, and provides facade methods for the contained
+    # objects.
+    #
+    # @api private
+    class Context
+      def initialize(client: nil, session: nil, options: nil)
+        if options
+          if client
+            raise ArgumentError, 'Client and options cannot both be specified'
+          end
+
+          if session
+            raise ArgumentError, 'Session and options cannot both be specified'
+          end
+        end
+
+        @client = client
+        @session = session
+        @options = options
+      end
+
+      attr_reader :client
+      attr_reader :session
+      attr_reader :options
+
+      def in_transaction?
+        session&.in_transaction? || false
+      end
+
+      def starting_transaction?
+        session&.starting_transaction? || false
+      end
+
+      def committing_transaction?
+        in_transaction? && session.committing_transaction?
+      end
+
+      def aborting_transaction?
+        in_transaction? && session.aborting_transaction?
+      end
+
+      def modern_retry_writes?
+        client && client.options[:retry_writes]
+      end
+
+      def legacy_retry_writes?
+        client && !client.options[:retry_writes] && client.max_write_retries > 0
+      end
+
+      def any_retry_writes?
+        modern_retry_writes? || legacy_retry_writes?
+      end
+
+      def server_api
+        if client
+          client.options[:server_api]
+        elsif options
+          options[:server_api]
+        end
+      end
+
+      def encrypt?
+        client&.encrypter&.encrypt? || false
+      end
+
+      def decrypt?
+        !!client&.encrypter
+      end
+
+      def encrypter
+        if client&.encrypter
+          client.encrypter
+        else
+          raise Error::InternalDriverError, 'Encrypter should only be accessed when encryption is to be performed'
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/indexes.rb

@@ -27,7 +27,21 @@ module Mongo
     # @since 2.0.0
     class Indexes
       include Specifiable
-      include OpMsgOrListIndexesCommand
+      include PolymorphicOperation
+      include PolymorphicLookup
+
+      private
+
+      def final_operation(connection)
+        cls = if connection.features.op_msg_enabled?
+          polymorphic_class(self.class.name, :OpMsg)
+        elsif connection.features.list_indexes_enabled?
+          polymorphic_class(self.class.name, :Command)
+        else
+          polymorphic_class(self.class.name, :Legacy)
+        end
+        cls.new(spec)
+      end
     end
   end
 end

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

@@ -32,9 +32,9 @@ module Mongo
 
         private
 
-        def get_result(connection, client, options = {})
+        def get_result(connection, context, options = {})
           # This is a Mongo::Operation::Insert::Result
-          Result.new(*dispatch_message(connection, client), @ids)
+          Result.new(*dispatch_message(connection, context), @ids)
         end
 
         def selector(connection)

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

@@ -30,9 +30,9 @@ module Mongo
 
         private
 
-        def get_result(connection, client, options = {})
+        def get_result(connection, context, options = {})
           # This is a Mongo::Operation::Insert::Result
-          Result.new(*dispatch_message(connection, client), @ids)
+          Result.new(*dispatch_message(connection, context), @ids)
         end
 
         def selector

data/lib/mongo/operation/insert/op_msg.rb

@@ -30,9 +30,9 @@ module Mongo
 
         private
 
-        def get_result(connection, client, options = {})
+        def get_result(connection, context, options = {})
           # This is a Mongo::Operation::Insert::Result
-          Result.new(*dispatch_message(connection, client), @ids)
+          Result.new(*dispatch_message(connection, context), @ids)
         end
 
         def selector(connection)

data/lib/mongo/operation/list_collections/result.rb

@@ -88,7 +88,10 @@ module Mongo
               code: parser.code,
               code_name: parser.code_name,
               labels: parser.labels,
-              wtimeout: parser.wtimeout)
+              wtimeout: parser.wtimeout,
+              document: parser.document,
+              server_message: parser.server_message,
+            )
           end
         end
 

data/lib/mongo/operation/result.rb

@@ -332,6 +332,8 @@ module Mongo
           labels: parser.labels,
           wtimeout: parser.wtimeout,
           connection_description: connection_description,
+          document: parser.document,
+          server_message: parser.server_message,
         )
       end
 

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

@@ -23,11 +23,11 @@ module Mongo
 
       include ResponseHandling
 
-      def do_execute(connection, client, options = {})
+      def do_execute(connection, context, options = {})
         unpin_maybe(session) do
-          add_error_labels(client, connection, session) do
+          add_error_labels(connection, context) do
             add_server_diagnostics(connection) do
-              get_result(connection, client, options).tap do |result|
+              get_result(connection, context, options).tap do |result|
                 process_result(result, connection)
               end
             end
@@ -35,15 +35,15 @@ module Mongo
         end
       end
 
-      def execute(connection, client:, options: {})
+      def execute(connection, context:, options: {})
         if Lint.enabled?
           unless connection.is_a?(Mongo::Server::Connection)
             raise Error::LintError, "Connection argument is of wrong type: #{connection}"
           end
         end
 
-        do_execute(connection, client, options).tap do |result|
-          validate_result(result, client, connection)
+        do_execute(connection, context, options).tap do |result|
+          validate_result(result, connection, context)
         end
       end
 
@@ -53,20 +53,30 @@ module Mongo
         Result
       end
 
-      def get_result(connection, client, options = {})
-        result_class.new(*dispatch_message(connection, client, options))
+      def get_result(connection, context, options = {})
+        result_class.new(*dispatch_message(connection, context, options))
       end
 
       # Returns a Protocol::Message or nil as reply.
-      def dispatch_message(connection, client, options = {})
-        message = build_message(connection)
-        message = message.maybe_encrypt(connection, client)
-        reply = connection.dispatch([ message ], operation_id, client, options)
+      def dispatch_message(connection, context, options = {})
+        message = build_message(connection, context)
+        message = message.maybe_encrypt(connection, context)
+        reply = connection.dispatch([ message ], context, options)
         [reply, connection.description]
       end
 
-      def build_message(connection)
-        message(connection)
+      # @param [ Mongo::Server::Connection ] connection The connection on which
+      #   the operation is performed.
+      # @param [ Mongo::Operation::Context ] context The operation context.
+      def build_message(connection, context)
+        msg = message(connection)
+        if (server_api = context.server_api) &&
+          # Commands in a transaction do not allow API parameters.
+          !(context.in_transaction? && !context.starting_transaction?)
+        then
+          msg = msg.maybe_add_server_api(server_api)
+        end
+        msg
       end
 
       def process_result(result, connection)