mongo 2.17.4 → 2.21.0

data/lib/mongo/index/view.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -15,6 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/cursor/nontailable'
+
 module Mongo
   module Index
 
@@ -25,6 +27,8 @@ module Mongo
       extend Forwardable
       include Enumerable
       include Retryable
+      include Mongo::CursorHost
+      include Cursor::NonTailable
 
       # @return [ Collection ] collection The indexes collection.
       attr_reader :collection
@@ -33,6 +37,12 @@ module Mongo
       #   when sending the listIndexes command.
       attr_reader :batch_size
 
+      # @return [ Integer | nil | The timeout_ms value that was passed as an
+      #   option to the view.
+      #
+      # @api private
+      attr_reader :operation_timeout_ms
+
       def_delegators :@collection, :cluster, :database, :read_preference, :write_concern, :client
       def_delegators :cluster, :next_primary
 
@@ -69,7 +79,9 @@ module Mongo
         :unique => :unique,
         :version => :v,
         :weights => :weights,
-        :collation => :collation
+        :collation => :collation,
+        :comment => :comment,
+        :wildcard_projection => :wildcardProjection,
       }.freeze
 
       # Drop an index by its name.
@@ -78,13 +90,17 @@ module Mongo
       #   view.drop_one('name_1')
       #
       # @param [ String ] name The name of the index.
+      # @param [ Hash ] options Options for this operation.
+      #
+      # @option options [ Object ] :comment A user-provided
+      #   comment to attach to this command.
       #
       # @return [ Result ] The response.
       #
       # @since 2.0.0
-      def drop_one(name)
+      def drop_one(name, options = {})
         raise Error::MultiIndexDrop.new if name == Index::ALL
-        drop_by_name(name)
+        drop_by_name(name, options)
       end
 
       # Drop all indexes on the collection.
@@ -92,11 +108,16 @@ module Mongo
       # @example Drop all indexes on the collection.
       #   view.drop_all
       #
+      # @param [ Hash ] options Options for this operation.
+      #
+      # @option options [ Object ] :comment A user-provided
+      #   comment to attach to this command.
+      #
       # @return [ Result ] The response.
       #
       # @since 2.0.0
-      def drop_all
-        drop_by_name(Index::ALL)
+      def drop_all(options = {})
+        drop_by_name(Index::ALL, options)
       end
 
       # Creates an index on the collection.
@@ -134,6 +155,8 @@ module Mongo
       #   - "majority" indicating that a majority of data bearing nodes must vote
       #   - "votingMembers" which means that all voting data bearing nodes must vote
       # @option options [ Session ] :session The session to use for the operation.
+      # @option options [ Object ] :comment A user-provided
+      #   comment to attach to this command.
       #
       # @note Note that the options listed may be subset of those available.
       # See the MongoDB documentation for a full list of supported options by server version.
@@ -148,7 +171,7 @@ module Mongo
         if session = @options[:session]
           create_options[:session] = session
         end
-        %i(commit_quorum session).each do |key|
+        %i(commit_quorum session comment timeout_ms max_time_ms).each do |key|
           if value = options.delete(key)
             create_options[key] = value
           end
@@ -185,6 +208,7 @@ module Mongo
       #     - "majority" indicating that a majority of data bearing nodes must vote
       #     - "votingMembers" which means that all voting data bearing nodes must vote
       #   - session: The session to use.
+      #   - comment: A user-provided comment to attach to this command.
       #
       # @return [ Result ] The result of the command.
       #
@@ -196,7 +220,7 @@ module Mongo
           options = models.pop
         end
 
-        client.send(:with_session, @options.merge(options)) do |session|
+        client.with_session(@options.merge(options)) do |session|
           server = next_primary(nil, session)
 
           indexes = normalize_models(models, server)
@@ -213,9 +237,14 @@ module Mongo
             session: session,
             commit_quorum: options[:commit_quorum],
             write_concern: write_concern,
+            comment: options[:comment],
           }
-
-          Operation::CreateIndex.new(spec).execute(server, context: Operation::Context.new(client: client, session: session))
+          context = Operation::Context.new(
+            client: client,
+            session: session,
+            operation_timeouts: operation_timeouts(options)
+          )
+          Operation::CreateIndex.new(spec).execute(server, context: context)
         end
       end
 
@@ -248,9 +277,15 @@ module Mongo
       #
       # @since 2.0.0
       def each(&block)
-        session = client.send(:get_session, @options)
-        cursor = read_with_retry_cursor(session, ServerSelector.primary, self) do |server|
-          send_initial_query(server, session)
+        session = client.get_session(@options)
+        context = Operation::Context.new(
+          client: client,
+          session: session,
+          operation_timeouts: operation_timeouts(@options)
+        )
+
+        cursor = read_with_retry_cursor(session, ServerSelector.primary, self, context: context) do |server|
+          send_initial_query(server, session, context)
         end
         if block_given?
           cursor.each do |doc|
@@ -268,22 +303,53 @@ module Mongo
       #
       # @param [ Collection ] collection The collection.
       # @param [ Hash ] options Options for getting a list of indexes.
-      #   Only relevant for when the listIndexes command is used with server
-      #   versions >=2.8.
       #
       # @option options [ Integer ] :batch_size The batch size for results
       #   returned from the listIndexes command.
+      # @option options [ :cursor_lifetime | :iteration ] :timeout_mode How to interpret
+      #   :timeout_ms (whether it applies to the lifetime of the cursor, or per
+      #   iteration).
+      # @option options [ Integer ] :timeout_ms The operation timeout in milliseconds.
+      #    Must be a non-negative integer. An explicit value of 0 means infinite.
+      #    The default value is unset which means the value is inherited from
+      #    the collection or the database or the client.
       #
       # @since 2.0.0
       def initialize(collection, options = {})
         @collection = collection
+        @operation_timeout_ms = options.delete(:timeout_ms)
+
+        validate_timeout_mode!(options)
+
         @batch_size = options[:batch_size]
         @options = options
       end
 
+      # The timeout_ms value to use for this operation; either specified as an
+      # option to the view, or inherited from the collection.
+      #
+      # @return [ Integer | nil ] the timeout_ms for this operation
+      def timeout_ms
+        operation_timeout_ms || collection.timeout_ms
+      end
+
+      # @return [ Hash ] timeout_ms value set on the operation level (if any),
+      #   and/or timeout_ms that is set on collection/database/client level (if any).
+      #
+      # @api private
+      def operation_timeouts(opts = {})
+        {}.tap do |result|
+          if opts[:timeout_ms] || operation_timeout_ms
+            result[:operation_timeout_ms] = opts.delete(:timeout_ms) || operation_timeout_ms
+          else
+            result[:inherited_timeout_ms] = collection.timeout_ms
+          end
+        end
+      end
+
       private
 
-      def drop_by_name(name)
+      def drop_by_name(name, opts = {})
         client.send(:with_session, @options) do |session|
           spec = {
             db_name: database.name,
@@ -292,8 +358,14 @@ module Mongo
             session: session,
             write_concern: write_concern,
           }
+          spec[:comment] = opts[:comment] unless opts[:comment].nil?
           server = next_primary(nil, session)
-          Operation::DropIndex.new(spec).execute(server, context: Operation::Context.new(client: client, session: session))
+          context = Operation::Context.new(
+            client: client,
+            session: session,
+            operation_timeouts: operation_timeouts(opts)
+          )
+          Operation::DropIndex.new(spec).execute(server, context: context)
         end
       end
 
@@ -331,8 +403,13 @@ module Mongo
         end
       end
 
-      def send_initial_query(server, session)
-        initial_query_op(session).execute(server, context: Operation::Context.new(client: client, session: session))
+      def send_initial_query(server, session, context)
+        if server.load_balancer?
+          connection = server.pool.check_out(context: context)
+          initial_query_op(session).execute_with_connection(connection, context: context)
+        else
+          initial_query_op(session).execute(server, context: context)
+        end
       end
     end
   end

data/lib/mongo/index.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/lint.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongo
 

data/lib/mongo/loggable.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
@@ -96,7 +96,7 @@ module Mongo
     #
     # @since 2.1.0
     def logger
-      ((options && options[:logger]) || Logger.logger)
+      ((respond_to?(:options) && options && options[:logger]) || Logger.logger)
     end
 
     private
@@ -106,7 +106,7 @@ module Mongo
     end
 
     def _mongo_log_prefix
-      (options && options[:log_prefix]) || PREFIX
+      (respond_to?(:options) && options && options[:log_prefix]) || PREFIX
     end
   end
 end

data/lib/mongo/logger.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2014-2020 MongoDB Inc.
 #

data/lib/mongo/monitoring/cmap_log_subscriber.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

data/lib/mongo/monitoring/command_log_subscriber.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #

data/lib/mongo/monitoring/event/cmap/base.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

data/lib/mongo/monitoring/event/cmap/connection_check_out_failed.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

data/lib/mongo/monitoring/event/cmap/connection_check_out_started.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

data/lib/mongo/monitoring/event/cmap/connection_checked_in.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

data/lib/mongo/monitoring/event/cmap/connection_checked_out.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

data/lib/mongo/monitoring/event/cmap/connection_closed.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

data/lib/mongo/monitoring/event/cmap/connection_created.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

data/lib/mongo/monitoring/event/cmap/connection_ready.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

data/lib/mongo/monitoring/event/cmap/pool_cleared.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -34,15 +34,22 @@ module Mongo
           # @return [ nil | Object ] The service id, if any.
           attr_reader :service_id
 
+          # @return [ Hash ] options The options
+          attr_reader :options
+
           # Create the event.
           #
           # @param [ Address ] address
           # @param [ Object ] service_id The service id, if any.
+          # @param [ true | false | nil ] interrupt_in_use_connections The
+          #   interrupt_in_use_connections flag, if given.
           #
           # @api private
-          def initialize(address, service_id: nil)
+          def initialize(address, service_id: nil, interrupt_in_use_connections: nil)
             @address = address
             @service_id = service_id
+            @options = {}
+            @options[:interrupt_in_use_connections] = interrupt_in_use_connections
           end
 
           # Returns a concise yet useful summary of the event.

data/lib/mongo/monitoring/event/cmap/pool_closed.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

data/lib/mongo/monitoring/event/cmap/pool_created.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #

data/lib/mongo/monitoring/event/cmap/pool_ready.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+# Copyright (C) 2019-present 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 Monitoring
+    module Event
+      module Cmap
+
+        # Event published when a connection pool is marked ready.
+        class PoolReady < Base
+
+          # @return [ Mongo::Address ] address The address of the server the pool's connections will
+          #   connect to.
+          attr_reader :address
+
+          # @return [ Hash ] options Options specified for pool creation.
+          attr_reader :options
+
+          # @return [ Mongo::Server::ConnectionPool ] pool The pool that was just
+          # created.
+          #
+          # @api experimental
+          attr_reader :pool
+
+          # Create the event.
+          #
+          # @example Create the event.
+          #   PoolCreated.new(address, options, pool)
+          #
+          # @since 2.9.0
+          # @api private
+          def initialize(address, options, pool)
+            @address = address
+            @options = options.dup.freeze
+            @pool = pool
+          end
+
+          # Returns a concise yet useful summary of the event.
+          #
+          # @return [ String ] String summary of the event.
+          #
+          # @note This method is experimental and subject to change.
+          #
+          # @api experimental
+          def summary
+            "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " +
+                "address=#{address} options=#{options} pool=0x#{pool.object_id}>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/monitoring/event/cmap.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
@@ -26,3 +26,4 @@ require 'mongo/monitoring/event/cmap/connection_ready'
 require 'mongo/monitoring/event/cmap/pool_cleared'
 require 'mongo/monitoring/event/cmap/pool_closed'
 require 'mongo/monitoring/event/cmap/pool_created'
+require 'mongo/monitoring/event/cmap/pool_ready'

data/lib/mongo/monitoring/event/command_failed.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -53,6 +53,9 @@ module Mongo
         # @return [ Integer ] request_id The request id.
         attr_reader :request_id
 
+        # @return [ Integer ] server_connection_id The server connection id.
+        attr_reader :server_connection_id
+
         # @return [ nil | Object ] The service id, if any.
         attr_reader :service_id
 
@@ -81,7 +84,7 @@ module Mongo
         # @api private
         def initialize(command_name, database_name, address,
           request_id, operation_id, message, failure, duration,
-          started_event:, service_id: nil
+          started_event:, server_connection_id: nil, service_id: nil
         )
           @command_name = command_name.to_s
           @database_name = database_name
@@ -93,6 +96,7 @@ module Mongo
           @started_event = started_event
           @failure = redacted(command_name, failure)
           @duration = duration
+          @server_connection_id = server_connection_id
         end
 
         # Returns a concise yet useful summary of the event.
@@ -126,7 +130,8 @@ module Mongo
         # @since 2.1.0
         # @api private
         def self.generate(address, operation_id, payload, message,
-          failure, duration, started_event:, service_id: nil
+          failure, duration, started_event:, server_connection_id: nil,
+          service_id: nil
         )
           new(
             payload[:command_name],
@@ -138,6 +143,7 @@ module Mongo
             failure,
             duration,
             started_event: started_event,
+            server_connection_id: server_connection_id,
             service_id: service_id,
           )
         end

data/lib/mongo/monitoring/event/command_started.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -60,7 +60,7 @@ module Mongo
         # @api private
         attr_reader :connection_id
 
-        # @api private
+        # @return [ Integer ] server_connection_id The server connection id.
         attr_reader :server_connection_id
 
         # @return [ true | false ] Whether the event contains sensitive data.

data/lib/mongo/monitoring/event/command_succeeded.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -46,6 +46,9 @@ module Mongo
         # @return [ Integer ] request_id The request id.
         attr_reader :request_id
 
+        # @return [ Integer ] server_connection_id The server connection id.
+        attr_reader :server_connection_id
+
         # @return [ nil | Object ] The service id, if any.
         attr_reader :service_id
 
@@ -73,7 +76,8 @@ module Mongo
         # @since 2.1.0
         # @api private
         def initialize(command_name, database_name, address, request_id,
-          operation_id, reply, duration, started_event:, service_id: nil
+          operation_id, reply, duration, started_event:,
+          server_connection_id: nil, service_id: nil
         )
           @command_name = command_name.to_s
           @database_name = database_name
@@ -84,6 +88,7 @@ module Mongo
           @started_event = started_event
           @reply = redacted(command_name, reply)
           @duration = duration
+          @server_connection_id = server_connection_id
         end
 
         # Returns a concise yet useful summary of the event.
@@ -116,7 +121,8 @@ module Mongo
         # @since 2.1.0
         # @api private
         def self.generate(address, operation_id, command_payload,
-          reply_payload, duration, started_event:, service_id: nil
+          reply_payload, duration, started_event:, server_connection_id: nil,
+          service_id: nil
         )
           new(
             command_payload[:command_name],
@@ -127,6 +133,7 @@ module Mongo
             generate_reply(command_payload, reply_payload),
             duration,
             started_event: started_event,
+            server_connection_id: server_connection_id,
             service_id: service_id,
           )
         end

data/lib/mongo/monitoring/event/secure.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
@@ -58,7 +58,7 @@ module Mongo
             # According to Command Monitoring spec,for hello/legacy hello commands
             # when speculativeAuthenticate is present, their commands AND replies
             # MUST be redacted from the events.
-            # See https://github.com/mongodb/specifications/blob/master/source/command-monitoring/command-monitoring.rst#security
+            # See https://github.com/mongodb/specifications/blob/master/source/command-logging-and-monitoring/command-logging-and-monitoring.rst#security
             true
           else
             false

data/lib/mongo/monitoring/event/server_closed.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2016-2020 MongoDB Inc.
 #

data/lib/mongo/monitoring/event/server_description_changed.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2016-2020 MongoDB Inc.
 #

data/lib/mongo/monitoring/event/server_heartbeat_failed.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #

data/lib/mongo/monitoring/event/server_heartbeat_started.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 # Copyright (C) 2018-2020 MongoDB Inc.
 #