mongo 2.4.3 → 2.5.0.beta

data/lib/mongo/server/description.rb

@@ -154,10 +154,22 @@ module Mongo
       # @since 2.1.0
       LOCAL_TIME = 'localTime'.freeze
 
+      # Constant for reading operationTime info from config.
+      #
+      # @since 2.5.0
+      OPERATION_TIME = 'operationTime'.freeze
+
+      # Constant for reading logicalSessionTimeoutMinutes info from config.
+      #
+      # @since 2.5.0
+      LOGICAL_SESSION_TIMEOUT_MINUTES = 'logicalSessionTimeoutMinutes'.freeze
+
       # Fields to exclude when comparing two descriptions.
       #
       # @since 2.0.6
-      EXCLUDE_FOR_COMPARISON = [ LOCAL_TIME, LAST_WRITE ].freeze
+      EXCLUDE_FOR_COMPARISON = [ LOCAL_TIME,
+                                 LAST_WRITE,
+                                 OPERATION_TIME ].freeze
 
       # @return [ Address ] address The server's address.
       attr_reader :address
@@ -382,6 +394,18 @@ module Mongo
         config[LAST_WRITE][LAST_WRITE_DATE] if config[LAST_WRITE]
       end
 
+      # Get the logicalSessionTimeoutMinutes from the config.
+      #
+      # @example Get the logicalSessionTimeoutMinutes value in minutes.
+      #   description.logical_session_timeout
+      #
+      # @return [ Integer, nil ] The logical session timeout in minutes.
+      #
+      # @since 2.5.0
+      def logical_session_timeout
+        config[LOGICAL_SESSION_TIMEOUT_MINUTES] if config[LOGICAL_SESSION_TIMEOUT_MINUTES]
+      end
+
       # Is the server a mongos?
       #
       # @example Is the server a mongos?

data/lib/mongo/server/description/features.rb

@@ -25,6 +25,9 @@ module Mongo
         #
         # @since 2.0.0
         MAPPINGS = {
+          :array_filters => 6,
+          :op_msg => 6,
+          :sessions => 6,
           :collation => 5,
           :max_staleness => 5,
           :find_command => 4,
@@ -38,7 +41,7 @@ module Mongo
         # The wire protocol versions that this version of the driver supports.
         #
         # @since 2.0.0
-        DRIVER_WIRE_VERSIONS = (0..5).freeze
+        DRIVER_WIRE_VERSIONS = (0..6).freeze
 
         # Create the methods for each mapping to tell if they are supported.
         #

data/lib/mongo/server/monitor.rb

@@ -23,6 +23,7 @@ module Mongo
     # @since 2.0.0
     class Monitor
       include Loggable
+      extend Forwardable
 
       # The default time for a server to refresh its status is 10 seconds.
       #
@@ -58,6 +59,10 @@ module Mongo
       # @since 2.4.0
       attr_reader :last_scan
 
+      # The compressor is determined during the handshake, so it must be an attribute
+      # of the connection.
+      def_delegators :connection, :compressor
+
       # Force the monitor to immediately do a check of its server.
       #
       # @example Force a scan.

data/lib/mongo/server/monitor/connection.rb

@@ -22,22 +22,38 @@ module Mongo
       class Connection
         include Retryable
         include Connectable
+        include Loggable
 
         # The command used for determining server status.
         #
         # @since 2.2.0
         ISMASTER = { :ismaster => 1 }.freeze
 
+        # The command used for determining server status formatted for an OP_MSG (server versions >= 3.6).
+        #
+        # @since 2.5.0
+        ISMASTER_OP_MSG = { :ismaster => 1, '$db' => Database::ADMIN }.freeze
+
         # The constant for the ismaster command.
         #
         # @since 2.2.0
         ISMASTER_MESSAGE = Protocol::Query.new(Database::ADMIN, Database::COMMAND, ISMASTER, :limit => -1)
 
+        # The constant for the ismaster command as an OP_MSG (server versions >= 3.6).
+        #
+        # @since 2.5.0
+        ISMASTER_OP_MSG_MESSAGE = Protocol::Msg.new([:none], {}, ISMASTER_OP_MSG)
+
         # The raw bytes for the ismaster message.
         #
         # @since 2.2.0
         ISMASTER_BYTES = ISMASTER_MESSAGE.serialize.to_s.freeze
 
+        # The raw bytes for the ismaster OP_MSG message (server versions >= 3.6).
+        #
+        # @since 2.5.0
+        ISMASTER_OP_MSG_BYTES = ISMASTER_OP_MSG_MESSAGE.serialize.to_s.freeze
+
         # The default time in seconds to timeout a connection attempt.
         #
         # @since 2.1.2
@@ -45,6 +61,23 @@ module Mongo
         # @deprecated Please use Server::CONNECT_TIMEOUT instead. Will be removed in 3.0.0
         CONNECT_TIMEOUT = 10.freeze
 
+        # Key for compression algorithms in the response from the server during handshake.
+        #
+        # @since 2.5.0
+        COMPRESSION = 'compression'.freeze
+
+        # Warning message that the server has no compression algorithms in common with those requested
+        #   by the client.
+        #
+        # @since 2.5.0
+        COMPRESSION_WARNING = 'The server has no compression algorithms in common with those requested. ' +
+                                'Compression will not be used.'.freeze
+
+        # The compressor, which is determined during the handshake.
+        #
+        # @since 2.5.0
+        attr_reader :compressor
+
         # Send the preserialized ismaster call.
         #
         # @example Send a preserialized ismaster message.
@@ -57,7 +90,7 @@ module Mongo
           ensure_connected do |socket|
             read_with_one_retry do
               socket.write(ISMASTER_BYTES)
-              Protocol::Reply.deserialize(socket).documents[0]
+              Protocol::Message.deserialize(socket).documents[0]
             end
           end
         end
@@ -122,6 +155,7 @@ module Mongo
           @ssl_options = options.reject { |k, v| !k.to_s.start_with?(SSL) }
           @socket = nil
           @pid = Process.pid
+          @compressor = nil
         end
 
         # Get the socket timeout.
@@ -142,10 +176,24 @@ module Mongo
 
         private
 
+        def set_compressor!(reply)
+          server_compressors = reply[COMPRESSION]
+
+          if options[:compressors]
+            if intersection = (server_compressors & options[:compressors])
+              @compressor = intersection[0]
+            else
+              log_warn(COMPRESSION_WARNING)
+            end
+          end
+        end
+
         def handshake!
           if @app_metadata
             socket.write(@app_metadata.ismaster_bytes)
-            Protocol::Reply.deserialize(socket, Mongo::Protocol::Message::MAX_MESSAGE_SIZE).documents[0]
+            reply = Protocol::Message.deserialize(socket, Mongo::Protocol::Message::MAX_MESSAGE_SIZE).documents[0]
+            set_compressor!(reply)
+            reply
           end
         end
       end

data/lib/mongo/server_selector/nearest.rb

@@ -22,6 +22,11 @@ module Mongo
     class Nearest
       include Selectable
 
+      # Name of the this read preference in the server's format.
+      #
+      # @since 2.5.0
+      SERVER_FORMATTED_NAME = 'nearest'.freeze
+
       # Get the name of the server mode type.
       #
       # @example Get the name of the server mode for this preference.
@@ -65,11 +70,12 @@ module Mongo
       #
       # @since 2.0.0
       def to_mongos
-        preference = { :mode => 'nearest' }
-        preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
-        preference.merge!({ maxStalenessSeconds: max_staleness }) if max_staleness
-        preference
+        @doc ||= (preference = { :mode => SERVER_FORMATTED_NAME }
+          preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
+          preference.merge!({ maxStalenessSeconds: max_staleness }) if max_staleness
+          preference)
       end
+      alias :to_doc :to_mongos
 
       private
 

data/lib/mongo/server_selector/primary.rb

@@ -23,6 +23,11 @@ module Mongo
     class Primary
       include Selectable
 
+      # Name of the this read preference in the server's format.
+      #
+      # @since 2.5.0
+      SERVER_FORMATTED_NAME = 'primary'.freeze
+
       # Get the name of the server mode type.
       #
       # @example Get the name of the server mode for this preference.
@@ -69,6 +74,21 @@ module Mongo
         nil
       end
 
+      # Convert this server preference definition into a format appropriate
+      #   for a mongodb server.
+      #
+      # @example Convert this server preference definition into a format
+      #   for a server.
+      #   preference = Mongo::ServerSelector::Primary.new
+      #   preference.to_doc
+      #
+      # @return [ Hash ] The server preference formatted for a mongodb server.
+      #
+      # @since 2.5.0
+      def to_doc
+        @doc ||= { mode: SERVER_FORMATTED_NAME }
+      end
+
       private
 
       # Select the primary server from a list of candidates.

data/lib/mongo/server_selector/primary_preferred.rb

@@ -23,6 +23,11 @@ module Mongo
     class PrimaryPreferred
       include Selectable
 
+      # Name of the this read preference in the server's format.
+      #
+      # @since 2.5.0
+      SERVER_FORMATTED_NAME = 'primaryPreferred'.freeze
+
       # Get the name of the server mode type.
       #
       # @example Get the name of the server mode for this preference.
@@ -66,11 +71,12 @@ module Mongo
       #
       # @since 2.0.0
       def to_mongos
-        preference = { :mode => 'primaryPreferred' }
-        preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
-        preference.merge!({ maxStalenessSeconds: max_staleness }) if max_staleness
-        preference
+        @doc ||= (preference = { :mode => SERVER_FORMATTED_NAME }
+          preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
+          preference.merge!({ maxStalenessSeconds: max_staleness }) if max_staleness
+          preference)
       end
+      alias :to_doc :to_mongos
 
       private
 

data/lib/mongo/server_selector/secondary.rb

@@ -23,6 +23,11 @@ module Mongo
     class Secondary
       include Selectable
 
+      # Name of the this read preference in the server's format.
+      #
+      # @since 2.5.0
+      SERVER_FORMATTED_NAME = 'secondary'.freeze
+
       # Get the name of the server mode type.
       #
       # @example Get the name of the server mode for this preference.
@@ -66,11 +71,12 @@ module Mongo
       #
       # @since 2.0.0
       def to_mongos
-        preference = { :mode => 'secondary' }
-        preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
-        preference.merge!({ maxStalenessSeconds: max_staleness }) if max_staleness
-        preference
+        @doc ||= (preference = { :mode => SERVER_FORMATTED_NAME }
+          preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
+          preference.merge!({ maxStalenessSeconds: max_staleness }) if max_staleness
+          preference)
       end
+      alias :to_doc :to_mongos
 
       private
 

data/lib/mongo/server_selector/secondary_preferred.rb

@@ -23,6 +23,11 @@ module Mongo
     class SecondaryPreferred
       include Selectable
 
+      # Name of the this read preference in the server's format.
+      #
+      # @since 2.5.0
+      SERVER_FORMATTED_NAME = 'secondaryPreferred'.freeze
+
       # Get the name of the server mode type.
       #
       # @example Get the name of the server mode for this preference.
@@ -69,10 +74,25 @@ module Mongo
       # @since 2.0.0
       def to_mongos
         return nil if tag_sets.empty? && max_staleness.nil?
-        preference = { mode: 'secondaryPreferred' }
-        preference.merge!({ tags: tag_sets }) unless tag_sets.empty?
-        preference.merge!({ maxStalenessSeconds: max_staleness }) if max_staleness
-        preference
+        to_doc
+      end
+
+      # Convert this server preference definition into a format appropriate
+      #   for a server.
+      #
+      # @example Convert this server preference definition into a format
+      #   for a server.
+      #   preference = Mongo::ServerSelector::SecondaryPreferred.new
+      #   preference.to_doc
+      #
+      # @return [ Hash ] The server preference formatted for a server.
+      #
+      # @since 2.5.0
+      def to_doc
+        @doc ||= (preference = { mode: SERVER_FORMATTED_NAME }
+          preference.merge!({ tags: tag_sets }) unless tag_sets.empty?
+          preference.merge!({ maxStalenessSeconds: max_staleness }) if max_staleness
+          preference)
       end
 
       private

data/lib/mongo/session.rb

@@ -0,0 +1,180 @@
+# Copyright (C) 2017 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.
+
+require 'mongo/session/session_pool'
+require 'mongo/session/server_session'
+
+module Mongo
+
+  # A logical client session representing a set of sequential operations executed
+  #   by an application that are related in some way.
+  #
+  # @since 2.5.0
+  class Session
+    extend Forwardable
+
+    # Get the options for this session.
+    #
+    # @since 2.5.0
+    attr_reader :options
+
+    # Get the client through which this session was created.
+    #
+    # @since 2.5.0
+    attr_reader :client
+
+    def_delegators :@server_session, :session_id
+
+    # Error message describing that the session was attempted to be used by a client different from the
+    # one it was originally associated with.
+    #
+    # @since 2.5.0
+    MISTMATCHED_CLUSTER_ERROR_MSG = 'The client used to create this session does not match that of client ' +
+        'initiating this operation. Please only use this session for operations through its parent client.'.freeze
+
+    # Error message describing that the session cannot be used because it has already been ended.
+    #
+    # @since 2.5.0
+    SESSION_ENDED_ERROR_MSG = 'This session has ended and cannot be used. Please create a new one.'.freeze
+
+    # Error message describing that sessions are not supported by the server version.
+    #
+    # @since 2.5.0
+    SESSIONS_NOT_SUPPORTED = 'Sessions are not supported by the connected servers.'.freeze
+
+    # Initialize a Session.
+    #
+    # @example
+    #   Session.new(server_session, client, options)
+    #
+    # @param [ ServerSession ] server_session The server session this client session is associated with.
+    # @param [ Client ] client The client through which this session is created.
+    # @param [ Hash ] options The options for this session.
+    #
+    # @since 2.5.0
+    def initialize(server_session, client, options = {})
+      @server_session = server_session
+      @client = client
+      @options = options
+    end
+
+    # End this session.
+    #
+    # @example
+    #   session.end_session
+    #
+    # @return [ nil ] Always nil.
+    #
+    # @since 2.5.0
+    def end_session
+      if !ended? && @client
+        @client.instance_variable_get(:@session_pool).checkin(@server_session)
+        nil
+      end
+    ensure
+      @server_session = nil
+    end
+
+    # End this session if it's an implicit session.
+    #
+    # @example
+    #   session.end_implicit_session
+    #
+    # @return [ nil ] Always nil.
+    #
+    # @since 2.5.0
+    def end_implicit_session
+      end_session if implicit_session?
+    end
+
+    # Whether this session has ended.
+    #
+    # @example
+    #   session.ended?
+    #
+    # @return [ true, false ] Whether the session has ended.
+    #
+    # @since 2.5.0
+    def ended?
+      @server_session.nil?
+    end
+
+    # Add this session's id to a command document.
+    #
+    # @example
+    #   session.add_id!(cmd)
+    #
+    # @return [ Hash, BSON::Document ] The command document.
+    #
+    # @since 2.5.0
+    def add_id!(command)
+      command.merge!(lsid: session_id)
+    end
+
+    # Validate the session.
+    #
+    # @example
+    #   session.validate!(client)
+    #
+    # @param [ Client ] client The client the session is attempted to be used with.
+    #
+    # @return [ nil ] nil if the session is valid.
+    #
+    # @raise [ Mongo::Error::InvalidSession ] Raise error if the session is not valid.
+    #
+    # @since 2.5.0
+    def validate!(client)
+      check_matching_client!(client)
+      check_if_ended!
+    end
+
+    # Process a response from the server that used this session.
+    #
+    # @example Process a response from the server.
+    #   session.process(result)
+    #
+    # @param [ Operation::Result ] The result from the operation.
+    #
+    # @return [ Operation::Result ] The result.
+    #
+    # @since 2.5.0
+    def process(result)
+      set_operation_time(result)
+      @server_session.set_last_use!
+      result
+    end
+
+    private
+
+    def implicit_session?
+      @implicit_session ||= !!(@options.key?(:implicit) && @options[:implicit] == true)
+    end
+
+    def set_operation_time(result)
+      if result && result.operation_time
+        @operation_time = result.operation_time
+      end
+    end
+
+    def check_if_ended!
+      raise Mongo::Error::InvalidSession.new(SESSION_ENDED_ERROR_MSG) if ended?
+    end
+
+    def check_matching_client!(client)
+      if @client != client
+        raise Mongo::Error::InvalidSession.new(MISTMATCHED_CLUSTER_ERROR_MSG)
+      end
+    end
+  end
+end