mongo 2.5.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a0c8476badc0a3215c3e04955d182d0f5d8eff0
-  data.tar.gz: 8e22da76ade8734b4a58a9fbac4aa0524825800e
+  metadata.gz: 22155206427257fef9e634311719afb58b03f76c
+  data.tar.gz: c156ef4a3569277ad0c398455d7983c3e2475051
 SHA512:
-  metadata.gz: cc6f598c936f2aff4eea3fa9d9eb00eea905912c1d2c587d6b307f3d97655d29bd5fd12dd02a6548a384fe04e82b169ff22c5d9ed7db77ec74e7073793345d27
-  data.tar.gz: 118a7e1f0942d35672138d6a3ab0d1b3967122d14344fe7cc3645d1a3b511dfd7cf6b05ad547e2b04ee19230dd30f8978f004bddec7952c230183948e8180ceb
+  metadata.gz: 4252e5a66f31ee3ba496bd573b37ee08f0dd513b3d1e1b154da01c7d34dc19714fc929de7454cc4ea0415fbb44312a8b1c29cf06c1cfb20adee72e97cd917443
+  data.tar.gz: efb7c93290353223cfc910a383b0a0edd9f2d0cc3b6405389256f48fe1dd1ed3647449db8d07663300303ba07a25a038f46d4c2ee5b1bdc0e804890e73b698b6

data/README.md

@@ -45,6 +45,8 @@ Running Tests
 
 The driver uses RSpec as it's primary testing tool. To run all tests simple run `rspec`.
 
+If you need to run the tests without making any external connections, set the ENV variable EXTERNAL_DISABLED to 'true'.
+
 To run a test at a specific location (where `42` is the line number), use:
 
     rspec path/to/spec.rb:42

data/Rakefile

@@ -15,7 +15,10 @@ Bundler.require(*default_groups)
 
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--profile 5" if ENV['CI']
+end
+
 task :default => :spec
 
 namespace :spec do

data/lib/mongo/address.rb

@@ -185,7 +185,8 @@ module Mongo
       error = nil
       ::Socket.getaddrinfo(host, nil, family, ::Socket::SOCK_STREAM).each do |info|
         begin
-          res = FAMILY_MAP[info[4]].new(host, port, host)
+          _host = (host == LOCALHOST) ? info[3] : host
+          res = FAMILY_MAP[info[4]].new(_host, port, host)
           res.socket(connect_timeout, ssl_options).connect!(connect_timeout).close
           return res
         rescue IOError, SystemCallError, Error::SocketTimeoutError, Error::SocketError => e

data/lib/mongo/client.rb

@@ -96,8 +96,6 @@ module Mongo
     # Delegate subscription to monitoring.
     def_delegators :@monitoring, :subscribe, :unsubscribe
 
-    def_delegators :@cluster, :logical_session_timeout
-
     # Determine if this client is equivalent to another object.
     #
     # @example Check client equality.
@@ -249,32 +247,14 @@ module Mongo
     # @since 2.0.0
     def initialize(addresses_or_uri, options = Options::Redacted.new)
       @monitoring = Monitoring.new(options)
-      Session::SessionPool.create(self)
       if addresses_or_uri.is_a?(::String)
         create_from_uri(addresses_or_uri, validate_options!(options))
       else
         create_from_addresses(addresses_or_uri, validate_options!(options))
       end
-      ObjectSpace.define_finalizer(self, self.class.finalize(@session_pool))
       yield(self) if block_given?
     end
 
-    # Finalize the client for garbage collection. Ends all sessions in the session pool.
-    #
-    # @example Finalize the client.
-    #   Client.finalize(session_pool)
-    #
-    # @param [ Session::SessionPool ] session_pool The session pool.
-    #
-    # @return [ Proc ] The Finalizer.
-    #
-    # @since 2.5.0
-    def self.finalize(session_pool)
-      proc do
-        begin; session_pool.end_sessions; rescue; end
-      end
-    end
-
     # Get an inspection of the client as a string.
     #
     # @example Inspect the client.
@@ -345,7 +325,6 @@ module Mongo
         opts = validate_options!(new_options)
         client.options.update(opts)
         Database.create(client)
-        Session::SessionPool.create(client)
         # We can't use the same cluster if some options that would affect it
         # have changed.
         if cluster_modifying?(opts)
@@ -445,7 +424,7 @@ module Mongo
     # Start a session.
     #
     # @example Start a session.
-    #   client.start_session
+    #   client.start_session(causal_consistency: true)
     #
     # @param [ Hash ] options The session options.
     #
@@ -456,42 +435,18 @@ module Mongo
     #
     # @since 2.5.0
     def start_session(options = {})
-      if !sessions_supported?
-        raise Error::InvalidSession.new(Session::SESSIONS_NOT_SUPPORTED)
-      end
-      Session.new(@session_pool.checkout, self, options)
+      cluster.send(:get_session, options.merge(implicit: false)) ||
+        (raise Error::InvalidSession.new(Session::SESSIONS_NOT_SUPPORTED))
     end
 
     private
 
     def get_session(options = {})
-      if options[:session]
-        options[:session].validate!(self)
-        options[:session]
-      elsif sessions_supported?
-        Session.new(@session_pool.checkout, self, options.merge(implicit: true))
-      end
-    end
-
-    def with_session(options = {})
-      if options[:session]
-        options[:session].validate!(self)
-        yield(options[:session])
-      elsif sessions_supported?
-        @session_pool.with_session do |server_session|
-          yield(Session.new(server_session, self, options))
-        end
-      else
-        yield
-      end
+      cluster.send(:get_session, options)
     end
 
-    def sessions_supported?
-      if cluster.servers.empty? && !cluster.topology.single?
-        ServerSelector.get(mode: :primary_preferred).select_server(cluster)
-      end
-      !!logical_session_timeout
-    rescue Error::NoServerAvailable
+    def with_session(options = {}, &block)
+      cluster.send(:with_session, options, &block)
     end
 
     def create_from_addresses(addresses, opts = Options::Redacted.new)

data/lib/mongo/cluster.rb

@@ -75,6 +75,11 @@ module Mongo
     # @since 2.5.0
     attr_reader :cluster_time
 
+    # @private
+    #
+    # @since 2.5.1
+    attr_reader :session_pool
+
     def_delegators :topology, :replica_set?, :replica_set_name, :sharded?,
                    :single?, :unknown?, :member_discovered
     def_delegators :@cursor_reaper, :register_cursor, :schedule_kill_cursor, :unregister_cursor
@@ -173,6 +178,7 @@ module Mongo
       @cluster_time = nil
       @cluster_time_lock = Mutex.new
       @topology = Topology.initial(seeds, monitoring, options)
+      Session::SessionPool.create(self)
 
       publish_sdam_event(
         Monitoring::TOPOLOGY_OPENING,
@@ -195,7 +201,7 @@ module Mongo
       @periodic_executor = PeriodicExecutor.new(@cursor_reaper, @socket_reaper)
       @periodic_executor.run!
 
-      ObjectSpace.define_finalizer(self, self.class.finalize(pools, @periodic_executor))
+      ObjectSpace.define_finalizer(self, self.class.finalize(pools, @periodic_executor, @session_pool))
     end
 
     # Finalize the cluster for garbage collection. Disconnects all the scoped
@@ -204,14 +210,16 @@ module Mongo
     # @example Finalize the cluster.
     #   Cluster.finalize(pools)
     #
-    # @param [ Hash<Address, Server::ConnectionPool> ] pools The connection
-    #   pools.
+    # @param [ Hash<Address, Server::ConnectionPool> ] pools The connection pools.
+    # @param [ PeriodicExecutor ] periodic_executor The periodic executor.
+    # @param [ SessionPool ] session_pool The session pool.
     #
     # @return [ Proc ] The Finalizer.
     #
     # @since 2.2.0
-    def self.finalize(pools, periodic_executor)
+    def self.finalize(pools, periodic_executor, session_pool)
       proc do
+        session_pool.end_sessions
         periodic_executor.stop!
         pools.values.each do |pool|
           pool.disconnect!
@@ -495,6 +503,28 @@ module Mongo
 
     private
 
+    def get_session(options = {})
+      return options[:session].validate!(self) if options[:session]
+      if sessions_supported?
+        Session.new(@session_pool.checkout, self, { implicit: true }.merge(options))
+      end
+    end
+
+    def with_session(options = {})
+      session = get_session(options)
+      yield(session)
+    ensure
+      session.end_session if (session && session.implicit?)
+    end
+
+    def sessions_supported?
+      if servers.empty? && !topology.single?
+        ServerSelector.get(mode: :primary_preferred).select_server(self)
+      end
+      !!logical_session_timeout
+    rescue Error::NoServerAvailable
+    end
+
     def direct_connection?(address)
       address.seed == @topology.seed
     end

data/lib/mongo/cluster/reapers/socket_reaper.rb

@@ -29,7 +29,7 @@ module Mongo
       # @example Initialize the socket reaper.
       #   SocketReaper.new(cluster)
       #
-      # @params [ Mongo::Cluster ] cluster The cluster whose pools' stale sockets
+      # @param [ Mongo::Cluster ] cluster The cluster whose pools' stale sockets
       #  need to be reaped at regular intervals.
       #
       # @since 2.5.0

data/lib/mongo/cluster/topology/replica_set.rb

@@ -217,7 +217,9 @@ module Mongo
         # @since 2.0.6
         def remove_server?(description, server)
           remove_self?(description, server) ||
-            (member_of_this_set?(description) && !description.lists_server?(server))
+            (member_of_this_set?(description) &&
+                !description.servers.empty? &&
+                  !description.lists_server?(server))
         end
 
         # A replica set topology is not sharded.

data/lib/mongo/collection.rb

@@ -410,23 +410,23 @@ module Mongo
     #   collection.insert_one({ name: 'test' })
     #
     # @param [ Hash ] document The document to insert.
-    # @param [ Hash ] options The insert options.
+    # @param [ Hash ] opts The insert options.
     #
-    # @option options [ Session ] :session The session to use for the operation.
+    # @option opts [ Session ] :session The session to use for the operation.
     #
     # @return [ Result ] The database response wrapper.
     #
     # @since 2.0.0
-    def insert_one(document, options = {})
-      client.send(:with_session, options) do |session|
+    def insert_one(document, opts = {})
+      client.send(:with_session, opts) do |session|
         write_with_retry(session, write_concern) do |server, txn_num|
           Operation::Write::Insert.new(
               :documents => [ document ],
               :db_name => database.name,
               :coll_name => name,
               :write_concern => write_concern,
-              :bypass_document_validation => !!options[:bypass_document_validation],
-              :options => options,
+              :bypass_document_validation => !!opts[:bypass_document_validation],
+              :options => opts,
               :id_generator => client.options[:id_generator],
               :session => session,
               :txn_num => txn_num

data/lib/mongo/collection/view.rb

@@ -199,10 +199,8 @@ module Mongo
 
       def view; self; end
 
-      def with_session(opts = {})
-        client.send(:with_session, @options.merge(opts)) do |session|
-          yield(session)
-        end
+      def with_session(opts = {}, &block)
+        client.send(:with_session, @options.merge(opts), &block)
       end
     end
   end

data/lib/mongo/cursor.rb

@@ -69,7 +69,8 @@ module Mongo
       ObjectSpace.define_finalizer(self, self.class.finalize(result.cursor_id,
                                                              cluster,
                                                              kill_cursors_op_spec,
-                                                             server))
+                                                             server,
+                                                             @session))
     end
 
 
@@ -87,8 +88,11 @@ module Mongo
     # @return [ Proc ] The Finalizer.
     #
     # @since 2.3.0
-    def self.finalize(cursor_id, cluster, op_spec, server)
-      proc { cluster.schedule_kill_cursor(cursor_id, op_spec, server) }
+    def self.finalize(cursor_id, cluster, op_spec, server, session)
+      proc do
+        cluster.schedule_kill_cursor(cursor_id, op_spec, server)
+        session.end_session if session && session.implicit?
+      end
     end
 
     # Get a human-readable string representation of +Cursor+.
@@ -219,7 +223,7 @@ module Mongo
     end
 
     def end_session
-      @session.end_implicit_session if @session
+      @session.end_session if @session && @session.implicit?
     end
 
     def kill_cursors_operation
@@ -251,6 +255,7 @@ module Mongo
       @coll_name ||= result.namespace.sub("#{database.name}.", '') if result.namespace
       unregister if result.cursor_id == 0
       @cursor_id = result.cursor_id
+      end_session if !more?
       result.documents
     end
 

data/lib/mongo/error.rb

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'forwardable'
+
 module Mongo
   # Base error class for all Mongo related errors.
   #

data/lib/mongo/operation/uses_command_op_msg.rb

@@ -58,7 +58,7 @@ module Mongo
             apply_session_id!(selector)
             apply_causal_consistency!(selector, server)
           end
-        elsif session && !session.send(:implicit_session?)
+        elsif session && !session.implicit?
           apply_cluster_time!(selector, server)
           apply_session_id!(selector)
           apply_causal_consistency!(selector, server)

data/lib/mongo/server.rb

@@ -81,6 +81,9 @@ module Mongo
                    :cluster_time,
                    :update_cluster_time
 
+    def_delegators :features,
+                   :check_driver_support!
+
     # Is this server equal to another?
     #
     # @example Is the server equal to the other?

data/lib/mongo/server/description.rb

@@ -264,7 +264,7 @@ module Mongo
       def initialize(address, config = {}, average_round_trip_time = 0)
         @address = address
         @config = config
-        @features = Features.new(wire_versions, me)
+        @features = Features.new(wire_versions, me || @address.to_s)
         @average_round_trip_time = average_round_trip_time
       end
 

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

@@ -88,21 +88,27 @@ module Mongo
         # @since 2.0.0
         def initialize(server_wire_versions, address = nil)
           @server_wire_versions = server_wire_versions
-          check_driver_support!(address) unless server_wire_versions == ZERO_RANGE
+          @address = address
         end
 
-        private
-
-        ZERO_RANGE = (0..0).freeze
-
-        def check_driver_support!(address)
-          if DRIVER_WIRE_VERSIONS.min > server_wire_versions.max
-            raise Error::UnsupportedFeatures.new(SERVER_TOO_OLD % [address,
-                                                                   server_wire_versions.max,
+        # Check that there is an overlap between the driver supported wire version range
+        #   and the server wire version range.
+        #
+        # @example Verify the wire version overlap.
+        #   features.check_driver_support!
+        #
+        # @raise [ Error::UnsupportedFeatures ] If the wire version range is not covered
+        #   by the driver.
+        #
+        # @since 2.5.1
+        def check_driver_support!
+          if DRIVER_WIRE_VERSIONS.min > @server_wire_versions.max
+            raise Error::UnsupportedFeatures.new(SERVER_TOO_OLD % [@address,
+                                                                   @server_wire_versions.max,
                                                                    DRIVER_WIRE_VERSIONS.min])
-          elsif DRIVER_WIRE_VERSIONS.max < server_wire_versions.min
-            raise Error::UnsupportedFeatures.new(DRIVER_TOO_OLD % [address,
-                                                                   server_wire_versions.min,
+          elsif DRIVER_WIRE_VERSIONS.max < @server_wire_versions.min
+            raise Error::UnsupportedFeatures.new(DRIVER_TOO_OLD % [@address,
+                                                                   @server_wire_versions.min,
                                                                    DRIVER_WIRE_VERSIONS.max])
           end
         end

data/lib/mongo/server_selector/selectable.rb

@@ -105,8 +105,12 @@ module Mongo
             # There is no point pinging a standalone as the subsequent scan is
             # not going to change anything about the cluster.
             if ping && !cluster.single?
-              return server if server.connectable?
+              if server.connectable?
+                server.check_driver_support!
+                return server
+              end
             else
+              server.check_driver_support!
               return server
             end
           end

data/lib/mongo/session.rb

@@ -17,7 +17,7 @@ require 'mongo/session/server_session'
 
 module Mongo
 
-  # A logical client session representing a set of sequential operations executed
+  # A logical session representing a set of sequential operations executed
   #   by an application that are related in some way.
   #
   # @since 2.5.0
@@ -29,10 +29,10 @@ module Mongo
     # @since 2.5.0
     attr_reader :options
 
-    # Get the client through which this session was created.
+    # Get the cluster through which this session was created.
     #
-    # @since 2.5.0
-    attr_reader :client
+    # @since 2.5.1
+    attr_reader :cluster
 
     # The cluster time for this session.
     #
@@ -44,14 +44,13 @@ module Mongo
     # @since 2.5.0
     attr_reader :operation_time
 
-    def_delegators :client, :cluster
-
-    # Error message describing that the session was attempted to be used by a client different from the
-    # one it was originally associated with.
+    # Error message indicating that the session was retrieved from a client with a different cluster than that of the
+    # client through which it is currently being used.
     #
     # @since 2.5.0
-    MISMATCHED_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
+    MISMATCHED_CLUSTER_ERROR_MSG = 'The configuration of the client used to create this session does not match that ' +
+        'of the client owning 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.
     #
@@ -66,16 +65,16 @@ module Mongo
     # Initialize a Session.
     #
     # @example
-    #   Session.new(server_session, client, options)
+    #   Session.new(server_session, cluster, 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 [ ServerSession ] server_session The server session this session is associated with.
+    # @param [ Cluster ] cluster The cluster through which this session is created.
     # @param [ Hash ] options The options for this session.
     #
     # @since 2.5.0
-    def initialize(server_session, client, options = {})
+    def initialize(server_session, cluster, options = {})
       @server_session = server_session
-      @client = client
+      @cluster = cluster
       @options = options.dup.freeze
       @cluster_time = nil
     end
@@ -101,26 +100,13 @@ module Mongo
     #
     # @since 2.5.0
     def end_session
-      if !ended? && @client
-        @client.instance_variable_get(:@session_pool).checkin(@server_session)
-        nil
+      if !ended? && @cluster
+        @cluster.session_pool.checkin(@server_session)
       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
@@ -148,18 +134,19 @@ module Mongo
     # Validate the session.
     #
     # @example
-    #   session.validate!(client)
+    #   session.validate!(cluster)
     #
-    # @param [ Client ] client The client the session is attempted to be used with.
+    # @param [ Cluster ] cluster The cluster 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)
+    def validate!(cluster)
+      check_matching_cluster!(cluster)
       check_if_ended!
+      self
     end
 
     # Process a response from the server that used this session.
@@ -173,7 +160,7 @@ module Mongo
     #
     # @since 2.5.0
     def process(result)
-      unless implicit_session?
+      unless implicit?
         set_operation_time(result)
         set_cluster_time(result)
       end
@@ -229,7 +216,7 @@ module Mongo
     #
     # @since 2.5.0
     def retry_writes?
-      !!client.options[:retry_writes] && (cluster.replica_set? || cluster.sharded?)
+      !!cluster.options[:retry_writes] && (cluster.replica_set? || cluster.sharded?)
     end
 
     # Get the session id.
@@ -247,7 +234,7 @@ module Mongo
     # Increment and return the next transaction number.
     #
     # @example Get the next transaction number.
-    #   server_session.next_txn_num
+    #   session.next_txn_num
     #
     # @return [ Integer ] The next transaction number.
     #
@@ -256,6 +243,18 @@ module Mongo
       @server_session.next_txn_num if @server_session
     end
 
+    # Is this session an implicit one (not user-created).
+    #
+    # @example Is the session implicit?
+    #   session.implicit?
+    #
+    # @return [ true, false ] Whether this session is implicit.
+    #
+    # @since 2.5.1
+    def implicit?
+      @implicit_session ||= !!(@options.key?(:implicit) && @options[:implicit] == true)
+    end
+
     private
 
     def causal_consistency_doc(read_concern)
@@ -274,10 +273,6 @@ module Mongo
                                end)
     end
 
-    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
@@ -298,8 +293,8 @@ module Mongo
       raise Mongo::Error::InvalidSession.new(SESSION_ENDED_ERROR_MSG) if ended?
     end
 
-    def check_matching_client!(client)
-      if @client != client
+    def check_matching_cluster!(cluster)
+      if @cluster != cluster
         raise Mongo::Error::InvalidSession.new(MISMATCHED_CLUSTER_ERROR_MSG)
       end
     end