RUBY-1340 Provide Transactions example for Docs (#976)

Author: saghm

lib/mongo/error.rb

@@ -69,6 +69,43 @@ class Error < StandardError
     #
     # @since 2.2.3
     CURSOR_NOT_FOUND = 'Cursor not found.'
+
+    # Error label describing commitTransaction errors that may or may not occur again if a commit is
+    # manually retried by the user.
+    #
+    # @since 2.6.0
+    UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL = 'UnknownTransactionCommitResult'.freeze
+
+    # Error label describing errors that will likely not occur if a transaction is manually retried
+    # from the start.
+    #
+    # @since 2.6.0
+    TRANSIENT_TRANSACTION_ERROR_LABEL = 'TransientTransactionError'.freeze
+
+    def initialize(msg = nil)
+      @labels = []
+      super(msg)
+    end
+
+    # Does the error have the given label?
+    #
+    # @example
+    #   error.label?(label)
+    #
+    # @param [ String ] label The label to check if the error has.
+    #
+    # @return [ true, false ] Whether the error has the given label.
+    #
+    # @since 2.6.0
+    def label?(label)
+      @labels.include?(label)
+    end
+
+    private
+
+    def add_label(label)
+      @labels << label unless label?(label)
+    end
   end
 end
 

lib/mongo/error/no_server_available.rb

@@ -27,35 +27,13 @@ class NoServerAvailable < Error
       #
       # @param [ Hash ] server_selector The server preference that could not be
       #   satisfied.
-      # @param [ Array<String> ] labels A set of labels describing the error.
       #
       # @since 2.0.0
-      def initialize(server_selector, labels = nil)
-        @labels = labels || []
+      def initialize(server_selector)
         super("No server is available matching preference: #{server_selector.inspect} " +
                 "using server_selection_timeout=#{server_selector.server_selection_timeout} " +
                 "and local_threshold=#{server_selector.local_threshold}")
       end
-
-      # Does the error have the given label?
-      #
-      # @example
-      #   error.label?(label)
-      #
-      # @param [ String ] label The label to check if the error has.
-      #
-      # @return [ true, false ] Whether the error has the given label.
-      #
-      # @since 2.6.0
-      def label?(label)
-        @labels.include?(label)
-      end
-
-      private
-
-      def add_label(label)
-        @labels << label unless label?(label)
-      end
     end
   end
 end

lib/mongo/error/operation_failure.rb

@@ -162,21 +162,6 @@ def change_stream_resumable_code?
       end
       private :change_stream_resumable_code?
 
-      # Does the error have the given label?
-      #
-      # @example
-      #   error.label?(label)
-      #
-      # @param [ String ] label The label to check if the error has.
-      #
-      # @return [ true, false ] Whether the error has the given label.
-      #
-      # @since 2.6.0
-      def label?(label)
-        @labels.include?(label) ||
-          (@result.send(:first_document) && @result.send(:first_document)['errorLabels'])
-      end
-
       # Create the operation failure.
       #
       # @example Create the error object
@@ -197,15 +182,8 @@ def initialize(message = nil, result = nil, options = {})
         @result = result
         @code = options[:code]
         @code_name = options[:code_name]
-        @labels = options[:labels] || []
         super(message)
       end
-
-      private
-
-      def add_label(label)
-        @labels << label unless label?(label)
-      end
     end
   end
 end

lib/mongo/error/socket_error.rb

@@ -20,37 +20,6 @@ class Error
     # @since 2.0.0
     class SocketError < Error
       include WriteRetryable
-
-      # Instantiate the new exception.
-      #
-      # @example Instantiate the exception.
-      #   Mongo::Error::SocketError.new(msg)
-      #
-      # @param [ String ] msg The error message.
-      #
-      # @since 2.0.0
-      def initialize(msg = nil, labels = nil)
-        @labels = labels || []
-        super(msg) if msg
-      end
-
-      # Does the error have the given label?
-      #
-      # @example
-      #   error.label?(label)
-      #
-      # @return [ true, false ] Whether the error has the given label.
-      #
-      # @since 2.6.0
-      def label?(label)
-        @labels.include?(label)
-      end
-
-      private
-
-      def add_label(label)
-        @labels << label unless label?(label)
-      end
     end
   end
 end

lib/mongo/operation/aggregate/op_msg.rb

@@ -42,7 +42,7 @@ def execute(server)
           process_result(result, server)
           result.validate!
         rescue Mongo::Error::SocketError => e
-          e.send(:add_label, Mongo::Session::TRANSIENT_TRANSACTION_ERROR_LABEL) if session.in_transaction?
+          e.send(:add_label, Mongo::Error::TRANSIENT_TRANSACTION_ERROR_LABEL) if session.in_transaction?
           raise e
         end
 

lib/mongo/operation/create/op_msg.rb

@@ -31,7 +31,7 @@ def execute(server)
           process_result(result, server)
           result.validate!
         rescue Mongo::Error::SocketError => e
-          e.send(:add_label, Mongo::Session::TRANSIENT_TRANSACTION_ERROR_LABEL) if session.in_transaction?
+          e.send(:add_label, Mongo::Error::TRANSIENT_TRANSACTION_ERROR_LABEL) if session.in_transaction?
           raise e
         end
 

lib/mongo/operation/create_index/op_msg.rb

@@ -31,7 +31,7 @@ def execute(server)
           process_result(result, server)
           result.validate!
         rescue Mongo::Error::SocketError => e
-          e.send(:add_label, Mongo::Session::TRANSIENT_TRANSACTION_ERROR_LABEL) if session.in_transaction?
+          e.send(:add_label, Mongo::Error::TRANSIENT_TRANSACTION_ERROR_LABEL) if session.in_transaction?
           raise e
         end
 

lib/mongo/operation/create_user/op_msg.rb

@@ -31,7 +31,7 @@ def execute(server)
           process_result(result, server)
           result.validate!
         rescue Mongo::Error::SocketError => e
-          e.send(:add_label, Mongo::Session::TRANSIENT_TRANSACTION_ERROR_LABEL) if session.in_transaction?
+          e.send(:add_label, Mongo::Error::TRANSIENT_TRANSACTION_ERROR_LABEL) if session.in_transaction?
           raise e
         end
 

lib/mongo/operation/delete/op_msg.rb

@@ -41,7 +41,7 @@ def execute(server)
           result = Result.new(dispatch_message(server))
           process_result(result, server)
         rescue Mongo::Error::SocketError => e
-          e.send(:add_label, Mongo::Session::TRANSIENT_TRANSACTION_ERROR_LABEL) if session.in_transaction?
+          e.send(:add_label, Mongo::Error::TRANSIENT_TRANSACTION_ERROR_LABEL) if session.in_transaction?
           raise e
         end
 

lib/mongo/operation/distinct/op_msg.rb

@@ -32,7 +32,7 @@ def execute(server)
           process_result(result, server)
           result.validate!
         rescue Mongo::Error::SocketError => e
-          e.send(:add_label, Mongo::Session::TRANSIENT_TRANSACTION_ERROR_LABEL) if session.in_transaction?
+          e.send(:add_label, Mongo::Error::TRANSIENT_TRANSACTION_ERROR_LABEL) if session.in_transaction?
           raise e
         end