mongo 2.7.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 214950396907cff6d304b018e77a65ced231d8afcb281efda921d077dc88ece7
-  data.tar.gz: dcdec16fe1704883635275793cff2220fcce139d7df695e325c1cb0cbff040da
+  metadata.gz: f14ee6d7ece598841ae7a4a02261946837f515d4ce4106846ba33bda33756901
+  data.tar.gz: a574886854063a619a26581b45a963e57fb3e2f55c322cbf65329aa19559e7c9
 SHA512:
-  metadata.gz: 1ae9252559ab6ffe1c9b30cea9928b6dd597364528686f009bd463b0a8612ddf0bd13f9d470d5e0f47cb47087e103d2d3a13a6c5717cc09ef7daa1865b5ececd
-  data.tar.gz: a9c69b2c4f25828118560939851059775daf91b911d95d579c8e7b61f57e7a71dd8a8e102030b95cbc57f0123eb4adc83f8ceb7f6914bc99592e58da4ee8eae5
+  metadata.gz: 8c4898202c6b0982b353c1f569945cda95d726488bd632c3eb5270bc54a6f1f2f8608f2b6a0c4bec548192bed998e34a2c1381b8fe6095a0710113f47e2c9f7a
+  data.tar.gz: afff4ce90e7501db6eb63e111efb9814bfeec03aa171a6daf2dc2c4d3a9b621b0ea5161bf55ff8e3fc45548e86345baff35ee8f3038beb0ae53e5d19e6a6e207

data/README.md

@@ -2,24 +2,27 @@ MongoDB Ruby Driver [![Build Status][travis-img]][travis-url] [![Code Climate][c
 -----
 The officially supported Ruby driver for [MongoDB](http://www.mongodb.org).
 
+
 Documentation
------
+-------------
 
 High level documentation and usage examples are located
 [here](http://docs.mongodb.org/ecosystem/drivers/ruby/).
 
 API docs can be found [here](http://api.mongodb.org/ruby/).
 
+
 Support & Feedback
------
+------------------
 
 For issues, questions or feedback related to the Ruby driver, please look into
 our [support channels](http://www.mongodb.org/about/support). Please
 do not email any of the Ruby developers directly with issues or
 questions - you're more likely to get an answer quickly on the [mongodb-user list](http://groups.google.com/group/mongodb-user) on Google Groups.
 
+
 Bugs & Feature Requests
------
+-----------------------
 
 Do you have a bug to report or a feature request to make?
 
@@ -41,30 +44,52 @@ When reporting an issue, please keep in mind that all information in JIRA for al
 * Provide any sensitive data or server logs.
 * Report potential security issues publicly (see 'Security Issues').
 
+
+Security Issues
+---------------
+
+If you’ve identified a potential security related issue in a driver or any other
+MongoDB project, please report it by following the [instructions here](http://docs.mongodb.org/manual/tutorial/create-a-vulnerability-report).
+
+
 Running Tests
------
+-------------
 
-The driver uses RSpec as it's primary testing tool. To run all tests simple run `rspec`.
+The driver uses RSpec as its primary testing tool. Most tests require a
+running MongoDB server. To test the driver against a single-node (standalone)
+deployment, first launch a server:
 
-If you need to run the tests without making any external connections, set the ENV variable EXTERNAL_DISABLED to 'true'.
+    mkdir /tmp/mrb
+    mongod --dbpath /tmp/mrb --bind_ip 127.0.0.1 --setParameter enableTestCommands=1
 
-To run a test at a specific location (where `42` is the line number), use:
+... then run the tests:
 
-    rspec path/to/spec.rb:42
+    bundle exec rake
 
-Security Issues
------
+It is possible to run tests in a specific file, as well as use other
+test invocations supported by RSpec:
+
+    bundle exec rspec path/to/spec.rb:42
+
+Note that certain user accounts have to be created for individual tests to
+succeed, and they are not created when the individual tests are run. The
+user accounts are created if you run `rake` as mentioned above, and you can
+also create them by running:
+
+    bundle exec rake spec:prepare
+
+For further information about supported cluster configurations and how to
+configure the test suite, please see the README in the spec directory.
 
-If you’ve identified a potential security related issue in a driver or any other
-MongoDB project, please report it by following the [instructions here](http://docs.mongodb.org/manual/tutorial/create-a-vulnerability-report).
 
 Release History
------
+---------------
 
 Full release notes and release history are available [here](https://github.com/mongodb/mongo-ruby-driver/releases).
 
+
 License
------
+-------
 
  Copyright (C) 2009-2019 MongoDB, Inc.
 

data/Rakefile

@@ -25,6 +25,7 @@ end
 task :default => ['spec:prepare', :spec]
 
 namespace :spec do
+  desc 'Creates necessary user accounts in the cluster'
   task :prepare do
     $: << File.join(File.dirname(__FILE__), 'spec')
 

data/lib/mongo/auth.rb

@@ -84,7 +84,10 @@ module Mongo
       #
       # @since 2.0.0
       def initialize(mechanism)
-        super("#{mechanism.inspect} is invalid, please use mongodb_cr, mongodb_x509, gssapi or plain.")
+        known_mechanisms = SOURCES.keys.sort.map do |key|
+          key.inspect
+        end.join(', ')
+        super("#{mechanism.inspect} is invalid, please use one of the following mechanisms: #{known_mechanisms}")
       end
     end
 

data/lib/mongo/client.rb

@@ -589,10 +589,11 @@ module Mongo
     # @example Start a session.
     #   client.start_session(causal_consistency: true)
     #
-    # @param [ Hash ] options The session options.
+    # @param [ Hash ] options The session options. Accepts the options
+    #   that Session#initialize accepts.
     #
-    # @note A Session cannot be used by multiple threads at once; session objects are not
-    #   thread-safe.
+    # @note A Session cannot be used by multiple threads at once; session
+    #   objects are not thread-safe.
     #
     # @return [ Session ] The session.
     #

data/lib/mongo/cluster.rb

@@ -337,7 +337,7 @@ module Mongo
     def summary
       "#<Cluster " +
       "topology=#{topology.summary} "+
-      "servers=[#{servers.map(&:summary).join(',')}]>"
+      "servers=[#{servers_list.map(&:summary).join(',')}]>"
     end
 
     # @api private

data/lib/mongo/collection/view/readable.rb

@@ -122,6 +122,7 @@ module Mongo
         #   command to run.
         # @option opts [ Hash ] :read The read preference options.
         # @option opts [ Hash ] :collation The collation to use.
+        # @option opts [ Mongo::Session ] :session The session to use for the operation.
         #
         # @return [ Integer ] The document count.
         #
@@ -182,8 +183,10 @@ module Mongo
           pipeline << { :'$limit' => opts[:limit] } if opts[:limit]
           pipeline << { :'$group' => { _id: nil, n: { :'$sum' => 1 } } }
 
-          opts.select! { |k, _| [:hint, :max_time_ms, :read, :collation].include?(k) }
-          aggregate(pipeline, opts).first['n'].to_i
+          opts.select! { |k, _| [:hint, :max_time_ms, :read, :collation, :session].include?(k) }
+          first = aggregate(pipeline, opts).first
+          return 0 unless first
+          first['n'].to_i
         end
 
         # Gets an estimate of the count of documents in a collection using collection metadata.

data/lib/mongo/database.rb

@@ -150,6 +150,7 @@ module Mongo
     # @param [ Hash ] opts The command options.
     #
     # @option opts :read [ Hash ] The read preference for this command.
+    # @option opts :session [ Session ] The session to use for this command.
     #
     # @return [ Hash ] The result of the command execution.
     def command(operation, opts = {})

data/lib/mongo/error/invalid_server_preference.rb

@@ -33,6 +33,7 @@ module Mongo
       # Error message for when the max staleness is not at least twice the heartbeat frequency.
       #
       # @since 2.4.0
+      # @deprecated
       INVALID_MAX_STALENESS = "`max_staleness` value is too small. It must be at least " +
         "`ServerSelector::SMALLEST_MAX_STALENESS_SECONDS` and (the cluster's heartbeat_frequency " +
           "setting + `Cluster::IDLE_WRITE_PERIOD_SECONDS`).".freeze

data/lib/mongo/error/operation_failure.rb

@@ -182,8 +182,18 @@ module Mongo
         @code = options[:code]
         @code_name = options[:code_name]
         @labels = options[:labels]
+        @wtimeout = !!options[:wtimeout]
         super(message)
       end
+
+      # Whether the error was a write concern timeout.
+      #
+      # @return [ true | false ] Whether the error was a write concern timeout.
+      #
+      # @since 2.7.1
+      def wtimeout?
+        @wtimeout
+      end
     end
   end
 end

data/lib/mongo/error/parser.rb

@@ -66,6 +66,9 @@ module Mongo
       # @since 2.7.0
       attr_reader :labels
 
+      # @api private
+      attr_reader :wtimeout
+
       # Create the new parser with the returned document.
       #
       # @example Create the new parser.
@@ -93,6 +96,7 @@ module Mongo
         parse_flag(@message)
         parse_code
         parse_labels
+        parse_wtimeout
       end
 
       def parse_single(message, key, doc = document)
@@ -156,6 +160,12 @@ module Mongo
       def parse_labels
         @labels = document['errorLabels'] || []
       end
+
+      def parse_wtimeout
+        @wtimeout = document[WRITE_CONCERN_ERROR] &&
+          document[WRITE_CONCERN_ERROR]['errInfo'] &&
+          document[WRITE_CONCERN_ERROR]['errInfo']['wtimeout']
+      end
     end
   end
 end

data/lib/mongo/event.rb

@@ -24,8 +24,7 @@ module Mongo
     # When a server is elected primary.
     #
     # @since 2.0.0
-    #
-    # @deprecated. Will be removed in 3.0
+    # @deprecated Will be removed in 3.0
     PRIMARY_ELECTED = 'primary_elected'.freeze
 
     # When a server is discovered to be a member of a topology.

data/lib/mongo/operation/result.rb

@@ -267,7 +267,10 @@ module Mongo
         raise Error::OperationFailure.new(
           parser.message,
           self,
-          :code => parser.code, :code_name => parser.code_name, :labels => parser.labels)
+          code: parser.code,
+          code_name: parser.code_name,
+          labels: parser.labels,
+          wtimeout: parser.wtimeout)
       end
       private :raise_operation_failure
 

data/lib/mongo/operation/shared/executable_transaction_label.rb

@@ -26,7 +26,9 @@ module Mongo
       def execute(server)
         super
       rescue Mongo::Error::SocketError => e
-        e.send(:add_label, Mongo::Error::TRANSIENT_TRANSACTION_ERROR_LABEL) if session.in_transaction?
+        if session && session.in_transaction?
+          e.send(:add_label, Mongo::Error::TRANSIENT_TRANSACTION_ERROR_LABEL)
+        end
         raise e
       end
     end

data/lib/mongo/operation/shared/sessions_supported.rb

@@ -128,7 +128,7 @@ module Mongo
       end
 
       def command(server)
-        sel = selector(server)
+        sel = selector(server).dup
         add_write_concern!(sel)
         sel[Protocol::Msg::DATABASE_IDENTIFIER] = db_name
         sel['$readPreference'] = read.to_doc if read

data/lib/mongo/protocol/msg.rb

@@ -83,7 +83,7 @@ module Mongo
       # @since 2.5.0
       def payload
         BSON::Document.new(
-          command_name: command.keys.first,
+          command_name: command.keys.first.to_s,
           database_name: global_args[DATABASE_IDENTIFIER],
           command: command,
           request_id: request_id,

data/lib/mongo/protocol/query.rb

@@ -269,11 +269,11 @@ module Mongo
         # @example Get the command name.
         #   upconverter.command_name
         #
-        # @return [ String, Symbol ] The command name.
+        # @return [ String ] The command name.
         #
         # @since 2.1.0
         def command_name
-          (filter[:$query] || !command?) ? FIND : filter.keys.first
+          ((filter[:$query] || !command?) ? FIND : filter.keys.first).to_s
         end
 
         private

data/lib/mongo/retryable.rb

@@ -69,14 +69,19 @@ module Mongo
     #
     # @note This only retries read operations on socket errors.
     #
+    # @param [ Hash ] options Options.
     # @param [ Proc ] block The block to execute.
     #
+    # @option options [ String ] :retry_message Message to log when retrying.
+    #
     # @return [ Result ] The result of the operation.
     #
     # @since 2.2.6
-    def read_with_one_retry
+    def read_with_one_retry(options = nil)
       yield
-    rescue Error::SocketError, Error::SocketTimeoutError
+    rescue Error::SocketError, Error::SocketTimeoutError => e
+      retry_message = options && options[:retry_message]
+      log_retry(e, message: retry_message)
       yield
     end
 
@@ -102,6 +107,7 @@ 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 | Session ] session Optional session to use with the operation.
     # @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.
@@ -122,6 +128,9 @@ module Mongo
         return legacy_write_with_retry(nil, session, &block)
       end
 
+      # If we are here, session is not nil. A session being nil would have
+      # failed retry_write_allowed? check.
+
       server = cluster.next_primary
 
       unless ending_transaction || server.retry_writes?
@@ -130,7 +139,7 @@ module Mongo
 
       begin
         txn_num = session.in_transaction? ? session.txn_num : session.next_txn_num
-        yield(server, txn_num)
+        yield(server, txn_num, false)
       rescue Error::SocketError, Error::SocketTimeoutError => e
         raise e if session.in_transaction? && !ending_transaction
         retry_write(e, txn_num, &block)
@@ -162,7 +171,7 @@ module Mongo
       server = cluster.next_primary
       raise original_error unless (server.retry_writes? && txn_num)
       log_retry(original_error)
-      yield(server, txn_num)
+      yield(server, txn_num, true)
     rescue Error::SocketError, Error::SocketTimeoutError => e
       cluster.scan!(false)
       raise e
@@ -196,8 +205,13 @@ module Mongo
     end
 
     # Log a warning so that any application slow down is immediately obvious.
-    def log_retry(e)
-      Logger.logger.warn "Retry due to: #{e.class.name} #{e.message}"
+    def log_retry(e, options = nil)
+      message = if options && options[:message]
+        options[:message]
+      else
+        "Retry"
+      end
+      Logger.logger.warn "#{message} due to: #{e.class.name} #{e.message}"
     end
   end
 end

data/lib/mongo/server.rb

@@ -253,6 +253,12 @@ module Mongo
         'GHOST'
       when other?
         'OTHER'
+      when unknown?
+        'UNKNOWN'
+      else
+        # Since the summary method is often used for debugging, do not raise
+        # an exception in case none of the expected types matched
+        ''
       end
       if replica_set_name
         status += " replica_set=#{replica_set_name}"

data/lib/mongo/server/connection.rb

@@ -1,11 +1,11 @@
 # 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.
 # You may obtain a copy of the License at
-
-#  http://www.apache.org/licenses/LICENSE-2.0
-
+#
+#   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.

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

@@ -1,11 +1,11 @@
 # 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.
 # You may obtain a copy of the License at
-
-#  http://www.apache.org/licenses/LICENSE-2.0
-
+#
+#   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.
@@ -128,7 +128,7 @@ module Mongo
         # @since 2.2.0
         def ismaster
           ensure_connected do |socket|
-            read_with_one_retry do
+            read_with_one_retry(retry_message: retry_message) do
               socket.write(ISMASTER_BYTES)
               Protocol::Message.deserialize(socket).documents[0]
             end
@@ -212,6 +212,10 @@ module Mongo
             reply
           end
         end
+
+        def retry_message
+          "Retrying ismaster on #{address}"
+        end
       end
     end
   end