mongo 2.9.2 → 2.10.0.rc0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b77d2eec3799354ea1153bac8ce5e4cee16cbab93774e9f877ee441f34aabe47
-  data.tar.gz: 1f9c0ae6afcd403a90cebd1e31d1cc3cd4fb36a927ae6bbcaa1d089868755eb5
+  metadata.gz: '08673c7408cfc3fce9f682577a1156fe312c5f6806b4ea4ecef3d946dd7b0d3b'
+  data.tar.gz: 4811269ce3f01bd7508de797bf32c68bc7f6e858ca3949d12fa604dd011e41ab
 SHA512:
-  metadata.gz: d06d245155dc239304713f24513285ca47c927a222e95d77a36065180ce6e8456510360ddf404bf628f8f59053a188331292b56896552cf29c8437454e8f158a
-  data.tar.gz: 16cfd26917aa33baa71db76308a2c39e0f67c96dfd8981719d3f31c8dda815bdf2c569a5ff17e5bc2a45fdd7349182862adb838137e8e6046246e79f4237ace7
+  metadata.gz: fdfddf7f78f3eabb7d2c0249680ad0bacbfac5425f2ed8719a9dad96fc308cb969ee51edf290df7394a161819bb9c55f5180c765a2edf3f03ef3976c04f2be78
+  data.tar.gz: fe9b0f8aa59ce594ffef9da66a107e99f2d41d50ba29ae8fd318f15e53c9b574411d73c5d12450bdf4be7b6490820c847367a55157acdbbd8f59124cb74c075f

data/lib/mongo.rb

@@ -34,6 +34,7 @@ require 'mongo/bson'
 require 'mongo/semaphore'
 require 'mongo/options'
 require 'mongo/loggable'
+require 'mongo/cluster_time'
 require 'mongo/monitoring'
 require 'mongo/logger'
 require 'mongo/retryable'

data/lib/mongo/auth/user/view.rb

@@ -48,7 +48,7 @@ module Mongo
               user: user,
               db_name: database.name,
               session: session
-            ).execute(next_primary)
+            ).execute(next_primary(nil, session))
           end
         end
 
@@ -83,7 +83,7 @@ module Mongo
               user_name: name,
               db_name: database.name,
               session: session
-            ).execute(next_primary)
+            ).execute(next_primary(nil, session))
           end
         end
 
@@ -107,7 +107,7 @@ module Mongo
               user: user,
               db_name: database.name,
               session: session
-            ).execute(next_primary)
+            ).execute(next_primary(nil, session))
           end
         end
 
@@ -136,7 +136,7 @@ module Mongo
               user_name: name,
               db_name: database.name,
               session: session
-            ).execute(next_primary)
+            ).execute(next_primary(nil, session))
           end
         end
 

data/lib/mongo/bulk_write.rb

@@ -23,7 +23,7 @@ require 'mongo/bulk_write/result_combiner'
 module Mongo
   class BulkWrite
     extend Forwardable
-    include Retryable
+    include Operation::Unpinnable
 
     # @return [ Mongo::Collection ] collection The collection.
     attr_reader :collection
@@ -38,6 +38,8 @@ module Mongo
     def_delegators :@collection,
                    :database,
                    :cluster,
+                   :write_with_retry,
+                   :nro_write_with_retry,
                    :next_primary
 
     def_delegators :database, :client
@@ -58,6 +60,7 @@ module Mongo
       client.send(:with_session, @options) do |session|
         operations.each do |operation|
           if single_statement?(operation)
+            write_concern = write_concern(session)
             write_with_retry(session, write_concern) do |server, txn_num|
               execute_operation(
                   operation.keys.first,
@@ -69,7 +72,7 @@ module Mongo
                   txn_num)
             end
           else
-            legacy_write_with_retry do |server|
+            nro_write_with_retry(session, write_concern) do |server|
               execute_operation(
                   operation.keys.first,
                   operation.values.flatten,
@@ -139,9 +142,10 @@ module Mongo
     # @return [ WriteConcern ] The write concern.
     #
     # @since 2.1.0
-    def write_concern
+    def write_concern(session = nil)
       @write_concern ||= options[:write_concern] ?
-        WriteConcern.get(options[:write_concern]) : collection.write_concern
+        WriteConcern.get(options[:write_concern]) :
+        collection.write_concern_with_session(session)
     end
 
     private
@@ -158,7 +162,7 @@ module Mongo
       {
         :db_name => database.name,
         :coll_name => collection.name,
-        :write_concern => write_concern,
+        :write_concern => write_concern(session),
         :ordered => ordered?,
         :operation_id => operation_id,
         :bypass_document_validation => !!options[:bypass_document_validation],
@@ -171,15 +175,17 @@ module Mongo
     def execute_operation(name, values, server, operation_id, result_combiner, session, txn_num = nil)
       raise Error::UnsupportedCollation.new if op_combiner.has_collation && !server.features.collation_enabled?
       raise Error::UnsupportedArrayFilters.new if op_combiner.has_array_filters && !server.features.array_filters_enabled?
-      begin
+      unpin_maybe(session) do
         if values.size > server.max_write_batch_size
           split_execute(name, values, server, operation_id, result_combiner, session, txn_num)
         else
           result = send(name, values, server, operation_id, session, txn_num)
           result_combiner.combine!(result, values.size)
         end
-      rescue Error::MaxBSONSize, Error::MaxMessageSize => e
-        raise e if values.size <= 1
+      end
+    rescue Error::MaxBSONSize, Error::MaxMessageSize => e
+      raise e if values.size <= 1
+      unpin_maybe(session) do
         split_execute(name, values, server, operation_id, result_combiner, session, txn_num)
       end
     end

data/lib/mongo/bulk_write/result.rb

@@ -180,7 +180,7 @@ module Mongo
       #
       # @since 2.1.0
       def validate!
-        if @results[Error::WRITE_ERRORS] || @results[Error::WRITE_CONCERN_ERRORS]
+        if @results['writeErrors'] || @results['writeConcernErrors']
           raise Error::BulkWriteError.new(@results)
         else
           self

data/lib/mongo/bulk_write/result_combiner.rb

@@ -112,7 +112,7 @@ module Mongo
       def combine_write_errors!(result)
         if write_errors = result.aggregate_write_errors(count)
           results.merge!(
-            Error::WRITE_ERRORS => ((results[Error::WRITE_ERRORS] || []) << write_errors).flatten
+            'writeErrors' => ((results['writeErrors'] || []) << write_errors).flatten
           )
         else
           result.validate!
@@ -121,7 +121,7 @@ module Mongo
 
       def combine_write_concern_errors!(result)
         if write_concern_errors = result.aggregate_write_concern_errors(count)
-          results[Error::WRITE_CONCERN_ERRORS] = (results[Error::WRITE_CONCERN_ERRORS] || []) +
+          results['writeConcernErrors'] = (results['writeConcernErrors'] || []) +
                                                    write_concern_errors
         end
       end

data/lib/mongo/bulk_write/transformable.rb

@@ -56,8 +56,10 @@ module Mongo
       #
       # @since 2.1.0
       DELETE_MANY_TRANSFORM = ->(doc){
-        { Operation::Q => doc[:filter],
-          Operation::LIMIT => 0 }.tap do |d|
+        {
+          Operation::Q => doc[:filter],
+          Operation::LIMIT => 0,
+        }.tap do |d|
           d[Operation::COLLATION] = doc[:collation] if doc[:collation]
         end
       }
@@ -66,8 +68,10 @@ module Mongo
       #
       # @since 2.1.0
       DELETE_ONE_TRANSFORM = ->(doc){
-        { Operation::Q => doc[:filter],
-          Operation::LIMIT => 1 }.tap do |d|
+        {
+          Operation::Q => doc[:filter],
+          Operation::LIMIT => 1,
+        }.tap do |d|
           d[Operation::COLLATION] = doc[:collation] if doc[:collation]
         end
       }
@@ -86,9 +90,10 @@ module Mongo
         {
           Operation::Q => doc[:filter],
           Operation::U => doc[:replacement],
-          Operation::MULTI => false,
-          Operation::UPSERT => doc.fetch(:upsert, false)
         }.tap do |d|
+          if doc[:upsert]
+            d[:upsert] = true
+          end
           d[Operation::COLLATION] = doc[:collation] if doc[:collation]
         end
       }
@@ -101,8 +106,10 @@ module Mongo
           Operation::Q => doc[:filter],
           Operation::U => doc[:update],
           Operation::MULTI => true,
-          Operation::UPSERT => doc.fetch(:upsert, false)
         }.tap do |d|
+          if doc[:upsert]
+            d[:upsert] = true
+          end
           d[Operation::COLLATION] = doc[:collation] if doc[:collation]
           d[Operation::ARRAY_FILTERS] = doc[:array_filters] if doc[:array_filters]
         end
@@ -115,9 +122,10 @@ module Mongo
         {
           Operation::Q => doc[:filter],
           Operation::U => doc[:update],
-          Operation::MULTI => false,
-          Operation::UPSERT => doc.fetch(:upsert, false)
         }.tap do |d|
+          if doc[:upsert]
+            d[:upsert] = true
+          end
           d[Operation::COLLATION] = doc[:collation] if doc[:collation]
           d[Operation::ARRAY_FILTERS] = doc[:array_filters] if doc[:array_filters]
         end

data/lib/mongo/client.rb

@@ -27,8 +27,22 @@ module Mongo
     #
     # @since 2.1.0
     CRUD_OPTIONS = [
-      :database, :read, :write, :retry_reads, :retry_writes,
-      :max_read_retries, :read_retry_interval, :max_write_retries,
+      :database,
+      :read, :read_concern,
+      :write, :write_concern,
+      :retry_reads, :max_read_retries, :read_retry_interval,
+      :retry_writes, :max_write_retries,
+
+      # Options which cannot currently be here:
+      #
+      # :server_selection_timeout
+      # Server selection timeout is used by cluster constructor to figure out
+      # how long to wait for initial scan in compatibility mode, but once
+      # the cluster is initialized it no longer uses this timeout.
+      # Unfortunately server selector reads server selection timeout out of
+      # the cluster, and this behavior is required by Cluster#next_primary
+      # which takes no arguments. When next_primary is removed we can revsit
+      # using the same cluster object with different server selection timeouts.
     ].freeze
 
     # Valid client options.
@@ -39,6 +53,7 @@ module Mongo
       :auth_mech,
       :auth_mech_properties,
       :auth_source,
+      :cleanup,
       :compressors,
       :connect,
       :connect_timeout,
@@ -84,6 +99,7 @@ module Mongo
       :user,
       :wait_queue_timeout,
       :write,
+      :write_concern,
       :zlib_compression_level,
     ].freeze
 
@@ -231,6 +247,11 @@ module Mongo
     #   done by this client or servers under it. Note: setting this option
     #   to false will make the client non-functional. It is intended for
     #   use in tests which manually invoke SDAM state transitions.
+    # @option options [ true | false ] :cleanup For internal driver use only.
+    #   Set to false to prevent endSessions command being sent to the server
+    #   to clean up server sessions when the cluster is disconnected, and to
+    #   to not start the periodic executor. If :monitoring_io is false,
+    #   :cleanup automatically defaults to false as well.
     # @option options [ String ] :password The user's password.
     # @option options [ String ] :platform Platform information to include in
     #   the metadata printed to the mongod logs upon establishing a connection
@@ -334,8 +355,10 @@ module Mongo
     # @option options [ String ] :user The user name.
     # @option options [ Float ] :wait_queue_timeout The time to wait, in
     #   seconds, in the connection pool for a connection to be checked in.
-    # @option options [ Hash ] :write The write concern options. Can be :w =>
-    #   Integer|String, :fsync => Boolean, :j => Boolean.
+    # @option options [ Hash ] :write Deprecated. Equivalent to :write_concern
+    #   option.
+    # @option options [ Hash ] :write_concern The write concern options.
+    #   Can be :w => Integer|String, :fsync => Boolean, :j => Boolean.
     # @option options [ Integer ] :zlib_compression_level The Zlib compression level to use, if using compression.
     #   See Ruby's Zlib module for valid levels.
     #
@@ -347,13 +370,18 @@ module Mongo
         options = {}
       end
 
-      Lint.validate_underscore_read_preference(options[:read])
-      Lint.validate_read_concern_option(options[:read_concern])
-
       if addresses_or_uri.is_a?(::String)
         uri = URI.get(addresses_or_uri, options)
         addresses = uri.servers
-        options = uri.client_options.merge(options)
+        uri_options = uri.client_options.dup
+        # Special handing for :write and :write_concern: allow client Ruby
+        # options to override URI options, even when the Ruby option uses the
+        # deprecated :write key and the URI option uses the current
+        # :write_concern key
+        if options[:write]
+          uri_options.delete(:write_concern)
+        end
+        options = uri_options.merge(options)
       else
         addresses = addresses_or_uri
       end
@@ -368,16 +396,31 @@ module Mongo
       # Special handling for sdam_proc as it is only used during client
       # construction
       sdam_proc = options.delete(:sdam_proc)
-      @options = validate_options!(Database::DEFAULT_OPTIONS.merge(options)).freeze
+
+      @options = validate_new_options!(Database::DEFAULT_OPTIONS.merge(options))
+=begin WriteConcern object support
+      if @options[:write_concern].is_a?(WriteConcern::Base)
+        # Cache the instance so that we do not needlessly reconstruct it.
+        @write_concern = @options[:write_concern]
+        @options[:write_concern] = @write_concern.options
+      end
+=end
+      @options.freeze
+      validate_options!
+
       @database = Database.new(self, @options[:database], @options)
+
       # Temporarily set monitoring so that event subscriptions can be
       # set up without there being a cluster
       @monitoring = Monitoring.new(@options)
+
       if sdam_proc
         sdam_proc.call(self)
       end
+
       @server_selection_semaphore = Semaphore.new
       @cluster = Cluster.new(addresses, @monitoring, cluster_options)
+
       # Unset monitoring, it will be taken out of cluster from now on
       remove_instance_variable('@monitoring')
 
@@ -472,7 +515,11 @@ module Mongo
     #
     # @since 2.5.0
     def server_selector
-      @server_selector ||= ServerSelector.get(read_preference || ServerSelector::PRIMARY)
+      @server_selector ||= if read_preference
+        ServerSelector.get(read_preference)
+      else
+        ServerSelector.primary
+      end
     end
 
     # Get the read preference from the options passed to the client.
@@ -532,8 +579,7 @@ module Mongo
     # @since 2.0.0
     def with(new_options = Options::Redacted.new)
       clone.tap do |client|
-        opts = validate_options!(new_options)
-        client.options.update(opts)
+        opts = client.update_options(new_options)
         Database.create(client)
         # We can't use the same cluster if some options that would affect it
         # have changed.
@@ -543,6 +589,36 @@ module Mongo
       end
     end
 
+    # Updates this client's options from new_options, validating all options.
+    #
+    # The new options may be transformed according to various rules.
+    # The final hash of options actually applied to the client is returned.
+    #
+    # If options fail validation, this method may warn or raise an exception.
+    # If this method raises an exception, the client should be discarded
+    # (similarly to if a constructor raised an exception).
+    #
+    # @param [ Hash ] new_options The new options to use.
+    #
+    # @return [ Hash ] Modified new options written into the client.
+    #
+    # @api private
+    def update_options(new_options)
+      validate_new_options!(new_options).tap do |opts|
+        # Our options are frozen
+        options = @options.dup
+        if options[:write] && opts[:write_concern]
+          options.delete(:write)
+        end
+        if options[:write_concern] && opts[:write]
+          options.delete(:write_concern)
+        end
+        options.update(opts)
+        @options = options.freeze
+        validate_options!
+      end
+    end
+
     # Get the read concern for this client.
     #
     # @example Get the client read concern.
@@ -566,7 +642,7 @@ module Mongo
     #
     # @since 2.0.0
     def write_concern
-      @write_concern ||= WriteConcern.get(options[:write])
+      @write_concern ||= WriteConcern.get(options[:write_concern] || options[:write])
     end
 
     # Close all connections.
@@ -614,7 +690,7 @@ module Mongo
     #
     # @since 2.0.5
     def database_names(filter = {}, opts = {})
-      list_databases(filter, true, opts).collect{ |info| info[Database::NAME] }
+      list_databases(filter, true, opts).collect{ |info| info['name'] }
     end
 
     # Get info for each database.
@@ -633,7 +709,7 @@ module Mongo
       cmd = { listDatabases: 1 }
       cmd[:nameOnly] = !!name_only
       cmd[:filter] = filter unless filter.empty?
-      use(Database::ADMIN).database.read_command(cmd, opts).first[Database::DATABASES]
+      use(Database::ADMIN).command(cmd, opts).first[Database::DATABASES]
     end
 
     # Returns a list of Mongo::Database objects.
@@ -754,8 +830,14 @@ module Mongo
       end
     end
 
-    def validate_options!(opts = Options::Redacted.new)
+    # Validates options in the provided argument for validity.
+    # The argument may contain a subset of options that the client will
+    # eventually have; this method validates each of the provided options
+    # but does not check for interactions between combinations of options.
+    def validate_new_options!(opts = Options::Redacted.new)
       return Options::Redacted.new unless opts
+      Lint.validate_underscore_read_preference(opts[:read])
+      Lint.validate_read_concern_option(opts[:read_concern])
       opts.each.inject(Options::Redacted.new) do |_options, (k, v)|
         key = k.to_sym
         if VALID_OPTIONS.include?(key)
@@ -774,6 +856,15 @@ module Mongo
       end
     end
 
+    # Validates all options after they are set on the client.
+    # This method is intended to catch combinations of options which do are
+    # not allowed.
+    def validate_options!
+      if options[:write] && options[:write_concern] && options[:write] != options[:write_concern]
+        raise ArgumentError, "If :write and :write_concern are both given, they must be identical: #{options.inspect}"
+      end
+    end
+
     def valid_compressors(compressors)
       compressors.select do |compressor|
         if !VALID_COMPRESSORS.include?(compressor)