RUBY-1904 Consolidate response handling code in operations layer (#1506)

Author: p-mongo

lib/mongo/bulk_write.rb

@@ -23,7 +23,7 @@
 module Mongo
   class BulkWrite
     extend Forwardable
-    include Operation::Unpinnable
+    include Operation::ResponseHandling
 
     # @return [ Mongo::Collection ] collection The collection.
     attr_reader :collection

lib/mongo/operation.rb

@@ -1,5 +1,6 @@
 require 'mongo/operation/result'
 
+require 'mongo/operation/shared/response_handling'
 require 'mongo/operation/shared/executable'
 require 'mongo/operation/shared/executable_no_validate'
 require 'mongo/operation/shared/executable_transaction_label'
@@ -13,7 +14,6 @@
 require 'mongo/operation/shared/causal_consistency_supported'
 require 'mongo/operation/shared/write'
 require 'mongo/operation/shared/idable'
-require 'mongo/operation/shared/unpinnable'
 require 'mongo/operation/shared/specifiable'
 require 'mongo/operation/shared/object_id_generator'
 require 'mongo/operation/shared/op_msg_or_command'

lib/mongo/operation/insert/command.rb

@@ -24,28 +24,18 @@ class Insert
       class Command
         include Specifiable
         include Executable
+        include ExecutableNoValidate
         include Idable
         include Limited
         include WriteConcernSupported
         include BypassDocumentValidation
 
-        # Execute the operation.
-        #
-        # @example
-        #   operation.execute(server)
-        #
-        # @param [ Mongo::Server ] server The server to send the operation to.
-        #
-        # @return [ Mongo::Operation::Insert::Result ] The operation result.
-        #
-        # @since 2.5.2
-        def execute(server)
-          result = Result.new(dispatch_message(server), @ids)
-          process_result(result, server)
-        end
-
         private
 
+        def get_result(server)
+          Result.new(dispatch_message(server), @ids)
+        end
+
         def selector(server)
           { insert: coll_name,
             documents: send(IDENTIFIER),

lib/mongo/operation/insert/legacy.rb

@@ -28,24 +28,12 @@ class Legacy
         include Executable
         include Idable
 
-        # Execute the operation.
-        #
-        # @example
-        #   operation.execute(server)
-        #
-        # @param [ Mongo::Server ] server The server to send the operation to.
-        #
-        # @return [ Mongo::Operation::Insert::Result ] The operation result.
-        #
-        # @since 2.5.2
-        def execute(server)
-          result = Result.new(dispatch_message(server), @ids)
-          process_result(result, server)
-          result.validate!
-        end
-
         private
 
+        def get_result(server)
+          Result.new(dispatch_message(server), @ids)
+        end
+
         def selector
           send(IDENTIFIER).first
         end

lib/mongo/operation/shared/executable.rb

@@ -20,6 +20,8 @@ module Operation
     # @since 2.5.2
     module Executable
 
+      include ResponseHandling
+
       def do_execute(server)
         unpin_maybe(session) do
           add_error_labels do

lib/mongo/operation/shared/response_handling.rb

@@ -0,0 +1,80 @@
+# Copyright (C) 2019 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
+
+    # Shared behavior of response handling for operations.
+    #
+    # @api private
+    module ResponseHandling
+
+      private
+
+      def validate_result(result)
+        unpin_maybe(session) do
+          add_error_labels do
+            result.validate!
+          end
+        end
+      end
+
+      # Adds error labels to exceptions raised in the yielded to block,
+      # which should perform MongoDB operations and raise Mongo::Errors on
+      # failure. This method handles network errors (Error::SocketError)
+      # and server-side errors (Error::OperationFailure); it does not
+      # handle server selection errors (Error::NoServerAvailable), for which
+      # labels are added in the server selection code.
+      def add_error_labels
+        begin
+          yield
+        rescue Mongo::Error::SocketError => e
+          if session && session.in_transaction? && !session.committing_transaction?
+            e.add_label('TransientTransactionError')
+          end
+          if session && session.committing_transaction?
+            e.add_label('UnknownTransactionCommitResult')
+          end
+          raise e
+        rescue Mongo::Error::OperationFailure => e
+          if session && session.committing_transaction?
+            if e.write_retryable? || e.wtimeout? || (e.write_concern_error? &&
+                !Session::UNLABELED_WRITE_CONCERN_CODES.include?(e.write_concern_error_code)
+            ) || e.max_time_ms_expired?
+              e.add_label('UnknownTransactionCommitResult')
+            end
+          end
+          raise e
+        end
+      end
+
+      # Unpins the session if the session is pinned and the yielded to block
+      # raises errors that are required to unpin the session.
+      #
+      # @note This method takes the session as an argument because this module
+      #   is included in BulkWrite which does not store the session in the
+      #   receiver (despite Specifiable doing so).
+      #
+      # @param [ Session | nil ] Session to consider.
+      def unpin_maybe(session)
+        yield
+      rescue Mongo::Error => e
+        if session
+          session.unpin_maybe(e)
+        end
+        raise
+      end
+    end
+  end
+end

lib/mongo/operation/shared/specifiable.rb

@@ -20,7 +20,6 @@ module Operation
     #
     # @since 2.0.0
     module Specifiable
-      include Unpinnable
 
       # The field for database name.
       #
@@ -565,45 +564,6 @@ def array_filters
       def acknowledged_write?
         write_concern.nil? || write_concern.acknowledged?
       end
-
-      private
-
-      def validate_result(result)
-        unpin_maybe(session) do
-          add_error_labels do
-            result.validate!
-          end
-        end
-      end
-
-      # Adds error labels to exceptions raised in the yielded to block,
-      # which should perform MongoDB operations and raise Mongo::Errors on
-      # failure. This method handles network errors (Error::SocketError)
-      # and server-side errors (Error::OperationFailure); it does not
-      # handle server selection errors (Error::NoServerAvailable), for which
-      # labels are added in the server selection code.
-      def add_error_labels
-        begin
-          yield
-        rescue Mongo::Error::SocketError => e
-          if session && session.in_transaction? && !session.committing_transaction?
-            e.add_label('TransientTransactionError')
-          end
-          if session && session.committing_transaction?
-            e.add_label('UnknownTransactionCommitResult')
-          end
-          raise e
-        rescue Mongo::Error::OperationFailure => e
-          if session && session.committing_transaction?
-            if e.write_retryable? || e.wtimeout? || (e.write_concern_error? &&
-                !Session::UNLABELED_WRITE_CONCERN_CODES.include?(e.write_concern_error_code)
-            ) || e.max_time_ms_expired?
-              e.add_label('UnknownTransactionCommitResult')
-            end
-          end
-          raise e
-        end
-      end
     end
   end
 end

lib/mongo/operation/shared/unpinnable.rb

@@ -20,6 +20,8 @@ module Operation
     # @since 2.5.2
     module Write
 
+      include ResponseHandling
+
       # Execute the operation.
       #
       # @example