mongo 2.6.4 → 2.7.0.rc0

data/lib/mongo/operation/users_info.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2018 MongoDB, Inc.
+# Copyright (C) 2015-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.
@@ -26,24 +26,7 @@ module Mongo
     # @since 2.0.0
     class UsersInfo
       include Specifiable
-
-      # Execute the operation.
-      #
-      # @example
-      #   operation.execute(server)
-      #
-      # @param [ Mongo::Server ] server The server to send the operation to.
-      #
-      # @return [ Mongo::Operation::UsersInfo::Result ] The operation result.
-      #
-      # @since 2.0.0
-      def execute(server)
-        if server.features.op_msg_enabled?
-          OpMsg.new(spec).execute(server)
-        else
-          Command.new(spec).execute(server)
-        end
-      end
+      include OpMsgOrCommand
     end
   end
 end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2018 MongoDB, Inc.
+# Copyright (C) 2018-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.

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2018 MongoDB, Inc.
+# Copyright (C) 2018-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.
@@ -21,39 +21,15 @@ module Mongo
       # @api private
       #
       # @since 2.5.2
-      class OpMsg
-        include Specifiable
-        include Executable
-        include SessionsSupported
-
-        # Execute the operation.
-        #
-        # @example
-        #   operation.execute(server)
-        #
-        # @param [ Mongo::Server ] server The server to send the operation to.
-        #
-        # @return [ Mongo::Operation::UsersInfo::Result ] The operation result.
-        #
-        # @since 2.5.2
-        def execute(server)
-          result = Result.new(dispatch_message(server))
-          process_result(result, server)
-          result.validate!
-        rescue Mongo::Error::SocketError => e
-          e.send(:add_label, Mongo::Error::TRANSIENT_TRANSACTION_ERROR_LABEL) if session.in_transaction?
-          raise e
-        end
+      class OpMsg < OpMsgBase
+        include ExecutableTransactionLabel
+        include PolymorphicResult
 
         private
 
         def selector(server)
           { :usersInfo => user_name }
         end
-
-        def message(server)
-          Protocol::Msg.new(flags, options, command(server))
-        end
       end
     end
   end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-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.
@@ -16,7 +16,7 @@ module Mongo
   module Operation
     class UsersInfo
 
-      # Defines custom behaviour of results when using the
+      # Defines custom behavior of results when using the
       # usersInfo command.
       #
       # @since 2.1.0

data/lib/mongo/options.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2018 MongoDB, Inc.
+# Copyright (C) 2015-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.

data/lib/mongo/options/mapper.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2018 MongoDB, Inc.
+# Copyright (C) 2015-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.
@@ -15,7 +15,7 @@
 module Mongo
   module Options
 
-    # Utility class for various options mapping behaviour.
+    # Utility class for various options mapping behavior.
     #
     # @since 2.0.0
     module Mapper
@@ -24,6 +24,9 @@ module Mongo
       # Transforms the provided options to a new set of options given the
       # provided mapping.
       #
+      # Options which are not present in the provided mapping
+      # are returned unmodified.
+      #
       # @example Transform the options.
       #   Mapper.transform({ name: 1 }, { :name => :nombre })
       #
@@ -37,7 +40,11 @@ module Mongo
         map = transform_keys_to_strings(mappings)
         opts = transform_keys_to_strings(options)
         opts.reduce({}) do |transformed, (key, value)|
-          transformed[map[key]] = value if map[key]
+          if map[key]
+            transformed[map[key]] = value
+          else
+            transformed[key] = value
+          end
           transformed
         end
       end

data/lib/mongo/options/redacted.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2018 MongoDB, Inc.
+# Copyright (C) 2015-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.

data/lib/mongo/protocol/bit_vector.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-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.

data/lib/mongo/protocol/compressed.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2018 MongoDB, Inc.
+# Copyright (C) 2017-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.
@@ -59,7 +59,7 @@ module Mongo
         @compressor_id = COMPRESSOR_ID_MAP[compressor]
         @compressed_message = ''
         @zlib_compression_level = zlib_compression_level if zlib_compression_level && zlib_compression_level != -1
-        @request_id = message.set_request_id
+        @request_id = message.request_id
       end
 
       # Inflate an OP_COMRESSED message and return the original message.

data/lib/mongo/protocol/delete.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-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.

data/lib/mongo/protocol/get_more.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-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.

data/lib/mongo/protocol/insert.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-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.

data/lib/mongo/protocol/kill_cursors.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-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.

data/lib/mongo/protocol/message.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-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.
@@ -40,6 +40,7 @@ module Mongo
     # @abstract
     # @api semiprivate
     class Message
+      include Id
       include Serializers
 
       # The batch size constant.
@@ -73,7 +74,7 @@ module Mongo
       MAX_MESSAGE_SIZE = 50331648.freeze
 
       def initialize(*args) # :nodoc:
-        @request_id = nil
+        set_request_id
       end
 
       # Returns the request id for the message
@@ -190,9 +191,7 @@ module Mongo
       #   server. The server will put this id in the response_to field of
       #   a reply.
       def set_request_id
-        @@id_lock.synchronize do
-          @request_id = @@request_id += 1
-        end
+        @request_id = self.class.next_id
       end
 
       # Default number returned value for protocol messages.
@@ -204,9 +203,6 @@ module Mongo
 
       private
 
-      @@request_id = 0
-      @@id_lock = Mutex.new
-
       # A method for getting the fields for a message class
       #
       # @return [Integer] the fields for the message class
@@ -258,7 +254,6 @@ module Mongo
       # @param buffer [String] Buffer to receive the header
       # @return [String] Serialized header
       def serialize_header(buffer)
-        set_request_id unless @request_id
         Header.serialize(buffer, [0, request_id, 0, op_code])
       end
 

data/lib/mongo/protocol/msg.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2018 MongoDB, Inc.
+# Copyright (C) 2017-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.
@@ -53,7 +53,7 @@ module Mongo
       #
       # @since 2.5.0
       def initialize(flags, options, global_args, *sections)
-        @flags = flags || [ :none ]
+        @flags = flags || []
         @options = options
         @global_args = global_args
         @sections = [ { type: 0, payload: global_args } ] + sections

data/lib/mongo/protocol/query.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-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.

data/lib/mongo/protocol/registry.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2018 MongoDB Inc.
+# Copyright (C) 2009-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.

data/lib/mongo/protocol/reply.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-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.

data/lib/mongo/protocol/serializers.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-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.

data/lib/mongo/protocol/update.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-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.

data/lib/mongo/retryable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2018 MongoDB, Inc.
+# Copyright (C) 2015-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.
@@ -14,7 +14,7 @@
 
 module Mongo
 
-  # Defines basic behaviour around retrying operations.
+  # Defines basic behavior around retrying operations.
   #
   # @since 2.1.0
   module Retryable
@@ -33,8 +33,6 @@ module Mongo
     # @param [ Mongo::Session ] session The session that the operation is being run on.
     # @param [ Proc ] block The block to execute.
     #
-    # @yieldparam [ Server ] server The server to which the write should be sent.
-    #
     # @return [ Result ] The result of the operation.
     #
     # @since 2.1.0
@@ -46,7 +44,7 @@ module Mongo
       rescue Error::SocketError, Error::SocketTimeoutError => e
         raise(e) if attempt > cluster.max_read_retries || (session && session.in_transaction?)
         log_retry(e)
-        cluster.scan!
+        cluster.scan!(false)
         retry
       rescue Error::OperationFailure => e
         if cluster.sharded? && e.retryable? && !(session && session.in_transaction?)
@@ -82,7 +80,17 @@ module Mongo
       yield
     end
 
-    # Execute a write operation with a retry.
+    # Implements write retrying functionality by yielding to the passed
+    # block one or more times.
+    #
+    # If the session is provided (hence, the deployment supports sessions),
+    # and modern retry writes are enabled on the client, the modern retry
+    # logic is invoked. Otherwise the legacy retry logic is invoked.
+    #
+    # If ending_transaction parameter is true, indicating that a transaction
+    # is being committed or aborted, the operation is executed exactly once.
+    # Note that, since transactions require sessions, this method will raise
+    # ArgumentError if ending_transaction is true and session is nil.
     #
     # @api private
     #
@@ -94,21 +102,29 @@ module Mongo
     # @note This only retries operations on not master failures, since it is
     #   the only case we can be sure a partial write did not already occur.
     #
+    # @param [ nil | Hash | WriteConcern::Base ] write_concern The write concern.
     # @param [ true | false ] ending_transaction True if the write operation is abortTransaction or
     #   commitTransaction, false otherwise.
     # @param [ Proc ] block The block to execute.
     #
+    # @yieldparam [ Server ] server The server to which the write should be sent.
+    # @yieldparam [ Integer ] txn_num Transaction number (NOT the ACID kind).
+    #
     # @return [ Result ] The result of the operation.
     #
     # @since 2.1.0
     def write_with_retry(session, write_concern, ending_transaction = false, &block)
-      unless retry_write_allowed?(session, write_concern) || ending_transaction
+      if ending_transaction && !session
+        raise ArgumentError, 'Cannot end a transaction without a session'
+      end
+
+      unless ending_transaction || retry_write_allowed?(session, write_concern)
         return legacy_write_with_retry(nil, session, &block)
       end
 
       server = cluster.next_primary
 
-      unless server.retry_writes? || ending_transaction
+      unless ending_transaction || server.retry_writes?
         return legacy_write_with_retry(server, session, &block)
       end
 
@@ -127,22 +143,32 @@ module Mongo
     private
 
     def retry_write_allowed?(session, write_concern)
-      session && session.retry_writes? &&
-          (write_concern.nil? || write_concern.acknowledged?) or false
+      unless session && session.retry_writes?
+        return false
+      end
+
+      if write_concern.nil?
+        true
+      else
+        unless write_concern.is_a?(WriteConcern::Base)
+          write_concern = WriteConcern.get(write_concern)
+        end
+        write_concern.acknowledged?
+      end
     end
 
     def retry_write(original_error, txn_num, &block)
-      cluster.scan!
+      cluster.scan!(false)
       server = cluster.next_primary
       raise original_error unless (server.retry_writes? && txn_num)
       log_retry(original_error)
       yield(server, txn_num)
     rescue Error::SocketError, Error::SocketTimeoutError => e
-      cluster.scan!
+      cluster.scan!(false)
       raise e
     rescue Error::OperationFailure => e
       raise original_error unless e.write_retryable?
-      cluster.scan!
+      cluster.scan!(false)
       raise e
     rescue
       raise original_error
@@ -161,7 +187,7 @@ module Mongo
         raise(e) if attempt > Cluster::MAX_WRITE_RETRIES
         if e.write_retryable? && !(session && session.in_transaction?)
           log_retry(e)
-          cluster.scan!
+          cluster.scan!(false)
           retry
         else
           raise(e)

data/lib/mongo/semaphore.rb

@@ -0,0 +1,46 @@
+# Copyright (C) 2018-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
+  # This is a semaphore implementation essentially encapsulating the
+  # sample code at https://ruby-doc.org/stdlib-2.0.0/libdoc/thread/rdoc/ConditionVariable.html.
+  #
+  # @api private
+  class Semaphore
+    def initialize
+      @lock = Mutex.new
+      @cv = ConditionVariable.new
+    end
+
+    # Waits for the semaphore to be signaled up to timeout seconds.
+    # If semaphore is not signaled, returns after timeout seconds.
+    def wait(timeout)
+      @lock.synchronize do
+        @cv.wait(@lock, timeout)
+      end
+    end
+
+    def broadcast
+      @lock.synchronize do
+        @cv.broadcast
+      end
+    end
+
+    def signal
+      @lock.synchronize do
+        @cv.signal
+      end
+    end
+  end
+end