mongo 2.5.0.beta → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4e52038faa9ef6ff0419d1c5855800d4ce07066
-  data.tar.gz: a7b342d735714530107b7b513ee91c8d071472ba
+  metadata.gz: 4a0c8476badc0a3215c3e04955d182d0f5d8eff0
+  data.tar.gz: 8e22da76ade8734b4a58a9fbac4aa0524825800e
 SHA512:
-  metadata.gz: eb58160cfaa1676ee31df0fcd375e2cad12953b46ba063b8a5f46c6e9dcbdcbf750a5c299e8b4222b3af57c9a0902c9f64fe4dfc33dc37df689730cf19f88e27
-  data.tar.gz: 97cc226f8bc3fc8fd7bda2d1be3b29be4a8d03f1e444b572dc74008e1276f733a3408851132cef3241df936c4e1613e4bce2ef2b3597e2fb55031ccfed49fb4c
+  metadata.gz: cc6f598c936f2aff4eea3fa9d9eb00eea905912c1d2c587d6b307f3d97655d29bd5fd12dd02a6548a384fe04e82b169ff22c5d9ed7db77ec74e7073793345d27
+  data.tar.gz: 118a7e1f0942d35672138d6a3ab0d1b3967122d14344fe7cc3645d1a3b511dfd7cf6b05ad547e2b04ee19230dd30f8978f004bddec7952c230183948e8180ceb

data/lib/mongo/address.rb

@@ -185,7 +185,7 @@ module Mongo
       error = nil
       ::Socket.getaddrinfo(host, nil, family, ::Socket::SOCK_STREAM).each do |info|
         begin
-          res = FAMILY_MAP[info[4]].new(info[3], port, 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/address/unix.rb

@@ -62,7 +62,7 @@ module Mongo
       # @example Get a Unix socket.
       #   address.socket(5)
       #
-      # @param [ Float ] timeout The socket timeout.
+      # @param [ Float ] socket_timeout The socket timeout.
       # @param [ Hash ] ssl_options SSL options - ignored.
       #
       # @return [ Pool::Socket::Unix ] The socket.

data/lib/mongo/auth/user.rb

@@ -22,11 +22,6 @@ module Mongo
     # @since 2.0.0
     class User
 
-      # The users collection for the database.
-      #
-      # @since 2.0.0
-      COLLECTION = 'system.users'.freeze
-
       # @return [ String ] The authorization source, either a database or
       #   external name.
       attr_reader :auth_source

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

@@ -44,7 +44,7 @@ module Mongo
         def create(user_or_name, options = {})
           user = generate(user_or_name, options)
           client.send(:with_session, options) do |session|
-            Operation::Write::CreateUser.new(
+            Operation::Write::Command::CreateUser.new(
               user: user,
               db_name: database.name,
               session: session
@@ -79,7 +79,7 @@ module Mongo
         # @since 2.0.0
         def remove(name, options = {})
           client.send(:with_session, options) do |session|
-            Operation::Write::RemoveUser.new(
+            Operation::Write::Command::RemoveUser.new(
               user_name: name,
               db_name: database.name,
               session: session
@@ -103,7 +103,7 @@ module Mongo
         def update(user_or_name, options = {})
           client.send(:with_session, options) do |session|
             user = generate(user_or_name, options)
-            Operation::Write::UpdateUser.new(
+            Operation::Write::Command::UpdateUser.new(
               user: user,
               db_name: database.name,
               session: session
@@ -132,7 +132,7 @@ module Mongo
 
         def user_query(name, options = {})
           client.send(:with_session, options) do |session|
-            Operation::Commands::UserQuery.new(
+            Operation::Commands::UsersInfo.new(
               user_name: name,
               db_name: database.name,
               session: session

data/lib/mongo/bulk_write.rb

@@ -53,22 +53,31 @@ module Mongo
     def execute
       operation_id = Monitoring.next_operation_id
       result_combiner = ResultCombiner.new
+      operations = op_combiner.combine
 
       client.send(:with_session, @options) do |session|
-        write_with_retry(session, Proc.new { next_primary }) do |server|
-          operations = op_combiner.combine
-          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?
-
-          operations.each do |operation|
-            execute_operation(
-                operation.keys.first,
-                operation.values.first,
-                server,
-                operation_id,
-                result_combiner,
-                session
-            )
+        operations.each do |operation|
+          if single_statement?(operation)
+            write_with_retry(session, write_concern) do |server, txn_num|
+              execute_operation(
+                  operation.keys.first,
+                  operation.values.first,
+                  server,
+                  operation_id,
+                  result_combiner,
+                  session,
+                  txn_num)
+            end
+          else
+            legacy_write_with_retry do |server|
+              execute_operation(
+                  operation.keys.first,
+                  operation.values.first,
+                  server,
+                  operation_id,
+                  result_combiner,
+                  session)
+            end
           end
         end
       end
@@ -137,6 +146,14 @@ module Mongo
 
     private
 
+    SINGLE_STATEMENT_OPS = [ :delete_one,
+                             :update_one,
+                             :insert_one ].freeze
+
+    def single_statement?(operation)
+      SINGLE_STATEMENT_OPS.include?(operation.keys.first)
+    end
+
     def base_spec(operation_id, session)
       {
         :db_name => database.name,
@@ -151,16 +168,18 @@ module Mongo
       }
     end
 
-    def execute_operation(name, values, server, operation_id, combiner, session)
+    def execute_operation(name, values, server, operation_id, 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
         if values.size > server.max_write_batch_size
-          split_execute(name, values, server, operation_id, combiner, session)
+          split_execute(name, values, server, operation_id, combiner, session, txn_num)
         else
-          combiner.combine!(send(name, values, server, operation_id, session), values.size)
+          combiner.combine!(send(name, values, server, operation_id, session, txn_num), values.size)
         end
       rescue Error::MaxBSONSize, Error::MaxMessageSize => e
         raise e if values.size <= 1
-        split_execute(name, values, server, operation_id, combiner, session)
+        split_execute(name, values, server, operation_id, combiner, session, txn_num)
       end
     end
 
@@ -168,34 +187,43 @@ module Mongo
       @op_combiner ||= ordered? ? OrderedCombiner.new(requests) : UnorderedCombiner.new(requests)
     end
 
-    def split_execute(name, values, server, operation_id, combiner, session)
-      execute_operation(name, values.shift(values.size / 2), server, operation_id, combiner, session)
-      execute_operation(name, values, server, operation_id, combiner, session)
+    def split_execute(name, values, server, operation_id, combiner, session, txn_num)
+      execute_operation(name, values.shift(values.size / 2), server, operation_id, combiner, session, txn_num)
+
+      txn_num = session.next_txn_num if txn_num
+      execute_operation(name, values, server, operation_id, combiner, session, txn_num)
     end
 
-    def delete(documents, server, operation_id, session)
+    def delete_one(documents, server, operation_id, session, txn_num)
       Operation::Write::Bulk::Delete.new(
-        base_spec(operation_id, session).merge(:deletes => documents)
+        base_spec(operation_id, session).merge(:deletes => documents, :txn_num => txn_num)
+      ).execute(server)
+    end
+
+    def delete_many(documents, server, operation_id, session, txn_num)
+      Operation::Write::Bulk::Delete.new(
+          base_spec(operation_id, session).merge(:deletes => documents)
       ).execute(server)
     end
 
-    alias :delete_one :delete
-    alias :delete_many :delete
 
-    def insert_one(documents, server, operation_id, session)
+    def insert_one(documents, server, operation_id, session, txn_num)
       Operation::Write::Bulk::Insert.new(
-        base_spec(operation_id, session).merge(:documents => documents)
+        base_spec(operation_id, session).merge(:documents => documents, :txn_num => txn_num)
       ).execute(server)
     end
 
-    def update(documents, server, operation_id, session)
+    def update_one(documents, server, operation_id, session, txn_num)
       Operation::Write::Bulk::Update.new(
-        base_spec(operation_id, session).merge(:updates => documents)
+        base_spec(operation_id, session).merge(:updates => documents, :txn_num => txn_num)
       ).execute(server)
     end
+    alias :replace_one :update_one
 
-    alias :replace_one :update
-    alias :update_one :update
-    alias :update_many :update
+    def update_many(documents, server, operation_id, session, txn_num)
+      Operation::Write::Bulk::Update.new(
+          base_spec(operation_id, session).merge(:updates => documents)
+      ).execute(server)
+    end
   end
 end

data/lib/mongo/client.rb

@@ -44,6 +44,7 @@ module Mongo
       :id_generator,
       :local_threshold,
       :logger,
+      :max_idle_time,
       :max_pool_size,
       :max_read_retries,
       :min_pool_size,
@@ -53,6 +54,7 @@ module Mongo
       :read,
       :read_retry_interval,
       :replica_set,
+      :retry_writes,
       :server_selection_timeout,
       :socket_timeout,
       :ssl,
@@ -166,6 +168,8 @@ module Mongo
     # @option options [ Integer ] :server_selection_timeout The timeout in seconds
     #   for selecting a server for an operation.
     # @option options [ String ] :password The user's password.
+    # @option options [ Integer ] :max_idle_time The maximum seconds a socket can remain idle
+    #   since it has been checked in to the pool.
     # @option options [ Integer ] :max_pool_size The maximum size of the
     #   connection pool.
     # @option options [ Integer ] :min_pool_size The minimum size of the
@@ -174,8 +178,9 @@ module Mongo
     #   seconds, in the connection pool for a connection to be checked in.
     # @option options [ Float ] :connect_timeout The timeout, in seconds, to
     #   attempt a connection.
-    # @option options [ Array<String> ] :compressors The compressor to use. Currently the driver
-    #   only supports zlib.
+    # @option options [ Array<String> ] :compressors A list of potential compressors to use, in order of preference.
+    #  The driver chooses the first compressor that is also supported by the server. Currently the driver only
+    #   supports 'zlib'.
     # @option options [ Hash ] :read The read preference options. They consist of a
     #   mode specified as a symbol, an array of hashes known as tag_sets,
     #   and local_threshold.
@@ -236,6 +241,10 @@ module Mongo
     #   mongod logs upon establishing a connection in server versions >= 3.4.
     # @option options [ String ] :platform Platform information to include in the
     #   metadata printed to the mongod logs upon establishing a connection in server versions >= 3.4.
+    # @option options [ Integer ] :zlib_compression_level The Zlib compression level to use, if using compression.
+    #   See Ruby's Zlib module for valid levels.
+    # @option options [ true, false ] :retry_writes Retry writes once when connected to a replica set
+    #   or sharded cluster versions 3.6 and up.
     #
     # @since 2.0.0
     def initialize(addresses_or_uri, options = Options::Redacted.new)
@@ -387,11 +396,14 @@ module Mongo
     # @example Get the database names.
     #   client.database_names
     #
+    # @param [ Hash ] filter The filter criteria for getting a list of databases.
+    # @param [ Hash ] opts The command options.
+    #
     # @return [ Array<String> ] The names of the databases.
     #
     # @since 2.0.5
-    def database_names
-      list_databases.collect{ |info| info[Database::NAME] }
+    def database_names(filter = {}, opts = {})
+      list_databases(filter, true, opts).collect{ |info| info[Database::NAME] }
     end
 
     # Get info for each database.
@@ -399,11 +411,35 @@ module Mongo
     # @example Get the info for each database.
     #   client.list_databases
     #
+    # @param [ Hash ] filter The filter criteria for getting a list of databases.
+    # @param [ true, false ] name_only Whether to only return each database name without full metadata.
+    # @param [ Hash ] opts The command options.
+    #
     # @return [ Array<Hash> ] The info for each database.
     #
     # @since 2.0.5
-    def list_databases
-      use(Database::ADMIN).command(listDatabases: 1).first[Database::DATABASES]
+    def list_databases(filter = {}, name_only = false, opts = {})
+      cmd = { listDatabases: 1 }
+      cmd[:nameOnly] = !!name_only
+      cmd[:filter] = filter unless filter.empty?
+      use(Database::ADMIN).command(cmd, opts).first[Database::DATABASES]
+    end
+
+    # Returns a list of Mongo::Database objects.
+    #
+    # @example Get a list of Mongo::Database objects.
+    #   client.list_mongo_databases
+    #
+    # @param [ Hash ] filter The filter criteria for getting a list of databases.
+    # @param [ Hash ] opts The command options.
+    #
+    # @return [ Array<Mongo::Database> ] The list of database objects.
+    #
+    # @since 2.5.0
+    def list_mongo_databases(filter = {}, opts = {})
+      database_names(filter, opts).collect do |name|
+        Database.new(self, name, options)
+      end
     end
 
     # Start a session.
@@ -451,7 +487,7 @@ module Mongo
     end
 
     def sessions_supported?
-      if cluster.servers.empty?
+      if cluster.servers.empty? && !cluster.topology.single?
         ServerSelector.get(mode: :primary_preferred).select_server(cluster)
       end
       !!logical_session_timeout
@@ -465,7 +501,7 @@ module Mongo
     end
 
     def create_from_uri(connection_string, opts = Options::Redacted.new)
-      uri = URI.new(connection_string, opts)
+      uri = URI.get(connection_string, opts)
       @options = validate_options!(Database::DEFAULT_OPTIONS.merge(uri.client_options.merge(opts))).freeze
       @cluster = Cluster.new(uri.servers, @monitoring, options)
       @database = Database.new(self, options[:database], options)

data/lib/mongo/cluster.rb

@@ -13,7 +13,9 @@
 # limitations under the License.
 
 require 'mongo/cluster/topology'
-require 'mongo/cluster/cursor_reaper'
+require 'mongo/cluster/reapers/socket_reaper'
+require 'mongo/cluster/reapers/cursor_reaper'
+require 'mongo/cluster/periodic_executor'
 require 'mongo/cluster/app_metadata'
 
 module Mongo
@@ -189,9 +191,11 @@ module Mongo
       ) if @servers.size > 1
 
       @cursor_reaper = CursorReaper.new
-      @cursor_reaper.run!
+      @socket_reaper = SocketReaper.new(self)
+      @periodic_executor = PeriodicExecutor.new(@cursor_reaper, @socket_reaper)
+      @periodic_executor.run!
 
-      ObjectSpace.define_finalizer(self, self.class.finalize(pools, @cursor_reaper))
+      ObjectSpace.define_finalizer(self, self.class.finalize(pools, @periodic_executor))
     end
 
     # Finalize the cluster for garbage collection. Disconnects all the scoped
@@ -206,10 +210,9 @@ module Mongo
     # @return [ Proc ] The Finalizer.
     #
     # @since 2.2.0
-    def self.finalize(pools, cursor_reaper)
+    def self.finalize(pools, periodic_executor)
       proc do
-        begin; cursor_reaper.kill_cursors; rescue; end
-        cursor_reaper.stop!
+        periodic_executor.stop!
         pools.values.each do |pool|
           pool.disconnect!
         end
@@ -371,8 +374,7 @@ module Mongo
     #
     # @since 2.1.0
     def disconnect!
-      begin; @cursor_reaper.kill_cursors; rescue; end
-      @cursor_reaper.stop!
+      @periodic_executor.stop!
       @servers.each { |server| server.disconnect! } and true
     end
 
@@ -387,7 +389,7 @@ module Mongo
     def reconnect!
       scan!
       servers.each { |server| server.reconnect! }
-      @cursor_reaper.restart! and true
+      @periodic_executor.restart! and true
     end
 
     # Add hosts in a description to the cluster.
@@ -474,7 +476,7 @@ module Mongo
     # @example Update the cluster time.
     #   cluster.update_cluster_time(result)
     #
-    # @param [ Operation::Result ] The operation result containing the cluster time.
+    # @param [ Operation::Result ] result The operation result containing the cluster time.
     #
     # @return [ Object ] The cluster time.
     #
@@ -484,8 +486,8 @@ module Mongo
         @cluster_time_lock.synchronize do
           if @cluster_time.nil?
             @cluster_time = cluster_time_doc
-          else
-            @cluster_time = cluster_time_doc if cluster_time_doc[CLUSTER_TIME] > @cluster_time[CLUSTER_TIME]
+          elsif cluster_time_doc[CLUSTER_TIME] > @cluster_time[CLUSTER_TIME]
+            @cluster_time = cluster_time_doc
           end
         end
       end

data/lib/mongo/cluster/periodic_executor.rb

@@ -0,0 +1,106 @@
+# Copyright (C) 2014-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.
+
+module Mongo
+
+  class Cluster
+
+    # A manager that calls #execute on its executors at a regular interval.
+    #
+    # @api private
+    #
+    # @since 2.5.0
+    class PeriodicExecutor
+
+      # The default time interval for the periodic executor to execute.
+      #
+      # @since 2.5.0
+      FREQUENCY = 5
+
+      # Create a periodic executor.
+      #
+      # @example Create a PeriodicExecutor.
+      #   Mongo::Cluster::PeriodicExecutor.new(reaper, reaper2)
+      #
+      # @api private
+      #
+      # @since 2.5.0
+      def initialize(*executors)
+        @thread = nil
+        @executors = executors
+      end
+
+      # Start the thread.
+      #
+      # @example Start the periodic executor's thread.
+      #   periodic_executor.run!
+      #
+      # @api private
+      #
+      # @since 2.5.0
+      def run!
+        @thread && @thread.alive? ? @thread : start!
+      end
+      alias :restart! :run!
+
+      # Stop the executor's thread.
+      #
+      # @example Stop the executors's thread.
+      #   periodic_executor.stop!
+      #
+      # @api private
+      #
+      # @since 2.5.0
+      def stop!
+        begin; flush; rescue; end
+        @thread.kill && @thread.stop?
+      end
+
+      # Trigger an execute call on each reaper.
+      #
+      # @example Trigger all reapers.
+      #   periodic_executor.execute
+      #
+      # @api private
+      #
+      # @since 2.5.0
+      def execute
+        @executors.each(&:execute) and true
+      end
+
+      # Execute all pending operations.
+      #
+      # @example Execute all pending operations.
+      #   periodic_executor.flush
+      #
+      # @api private
+      #
+      # @since 2.5.0
+      def flush
+        @executors.each(&:flush) and true
+      end
+
+      private
+
+      def start!
+        @thread = Thread.new(FREQUENCY) do |i|
+          loop do
+            sleep(i)
+            execute
+          end
+        end
+      end
+    end
+  end
+end