mongo 2.14.0.rc1 → 2.15.1

data/lib/mongo/grid/stream/read.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -133,16 +136,28 @@ module Mongo
             !@open
           end
 
-          # Get the read preference used when streaming.
-          #
-          # @example Get the read preference.
-          #   stream.read_preference
+          # Get the read preference.
           #
-          # @return [ Mongo::ServerSelector ] The read preference.
+          # @note This method always returns a BSON::Document instance, even
+          #   though the constructor specifies the type of :read as a Hash, not
+          #   as a BSON::Document.
           #
-          # @since 2.1.0
+          # @return [ BSON::Document ] The read preference.
+          #   The document may have the following fields:
+          #   - *:mode* -- read preference specified as a symbol; valid values are
+          #     *:primary*, *:primary_preferred*, *:secondary*, *:secondary_preferred*
+          #     and *:nearest*.
+          #   - *:tag_sets* -- an array of hashes.
+          #   - *:local_threshold*.
           def read_preference
-            @read_preference ||= options[:read] || fs.read_preference
+            @read_preference ||= begin
+              pref = options[:read] || fs.read_preference
+              if BSON::Document === pref
+                pref
+              else
+                BSON::Document.new(pref)
+              end
+            end
           end
 
           # Get the files collection file information document for the file

data/lib/mongo/grid/stream/write.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/grid/stream.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/grid.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/id.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2016-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

data/lib/mongo/index/view.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -127,6 +130,7 @@ module Mongo
       #   data-bearing members of a replica set, including the primary, must
       #   complete the index builds successfully before the primary marks
       #   the indexes as ready.
+      # @option options [ Session ] :session The session to use for the operation.
       #
       # @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.
@@ -137,7 +141,15 @@ module Mongo
       def create_one(keys, options = {})
         options = options.dup
 
-        create_options = { commit_quorum: options.delete(:commit_quorum) }
+        create_options = {}
+        if session = @options[:session]
+          create_options[:session] = session
+        end
+        %i(commit_quorum session).each do |key|
+          if value = options.delete(key)
+            create_options[key] = value
+          end
+        end
         create_many({ key: keys }.merge(options), create_options)
       end
 
@@ -166,19 +178,20 @@ module Mongo
       #   - commit_quorum: Specify how many data-bearing members of a replica set,
       #     including the primary, must complete the index builds successfully
       #     before the primary marks the indexes as ready.
+      #   - session: The session to use.
       #
       # @return [ Result ] The result of the command.
       #
       # @since 2.0.0
       def create_many(*models)
-        client.send(:with_session, @options) do |session|
-          server = next_primary(nil, session)
+        models = models.flatten
+        options = {}
+        if models && !models.last.key?(:key)
+          options = models.pop
+        end
 
-          models = models.flatten
-          options = {}
-          if models && !models.last.key?(:key)
-            options = models.pop
-          end
+        client.send(:with_session, @options.merge(options)) do |session|
+          server = next_primary(nil, session)
 
           # While server versions 3.4 and newer generally perform option
           # validation, there was a bug on server versions 4.2.0 - 4.2.5 where
@@ -208,7 +221,7 @@ module Mongo
 
           spec[:write_concern] = write_concern if description.features.collation_enabled?
 
-          Operation::CreateIndex.new(spec).execute(server, client: client)
+          Operation::CreateIndex.new(spec).execute(server, context: Operation::Context.new(client: client, session: session))
         end
       end
 
@@ -286,7 +299,7 @@ module Mongo
                  }
           server = next_primary(nil, session)
           spec[:write_concern] = write_concern if server.with_connection { |connection| connection.features }.collation_enabled?
-          Operation::DropIndex.new(spec).execute(server, client: client)
+          Operation::DropIndex.new(spec).execute(server, context: Operation::Context.new(client: client, session: session))
         end
       end
 
@@ -322,7 +335,7 @@ module Mongo
       end
 
       def send_initial_query(server, session)
-        initial_query_op(session).execute(server, client: client)
+        initial_query_op(session).execute(server, context: Operation::Context.new(client: client, session: session))
       end
 
       def with_generated_names(models, server)

data/lib/mongo/index.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/lint.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongo
 
   # @api private

data/lib/mongo/loggable.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/logger.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/monitoring/cmap_log_subscriber.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

data/lib/mongo/monitoring/command_log_subscriber.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
@@ -20,6 +23,7 @@ module Mongo
       #
       # @since 2.1.0
       class CommandFailed < Mongo::Event::Base
+        include Secure
 
         # @return [ Server::Address ] address The server address.
         attr_reader :address
@@ -49,6 +53,15 @@ module Mongo
         # @return [ Integer ] request_id The request id.
         attr_reader :request_id
 
+        # @return [ nil | Object ] The service id, if any.
+        attr_reader :service_id
+
+        # @return [ Monitoring::Event::CommandStarted ] started_event The corresponding
+        #   started event.
+        #
+        # @api private
+        attr_reader :started_event
+
         # Create the new event.
         #
         # @example Create the event.
@@ -61,18 +74,25 @@ module Mongo
         # @param [ String ] message The error message.
         # @param [ BSON::Document ] failure The error document, if any.
         # @param [ Float ] duration The duration the command took in seconds.
+        # @param [ Monitoring::Event::CommandStarted ] started_event The corresponding
+        #   started event.
+        # @param [ Object ] service_id The service id, if any.
         #
-        # @since 2.1.0
         # @api private
-        def initialize(command_name, database_name, address, request_id, operation_id, message, failure, duration)
+        def initialize(command_name, database_name, address,
+          request_id, operation_id, message, failure, duration,
+          started_event:, service_id: nil
+        )
           @command_name = command_name.to_s
           @database_name = database_name
           @address = address
           @request_id = request_id
           @operation_id = operation_id
           @message = message
-          @failure = failure
+          @started_event = started_event
+          @failure = redacted(command_name, failure)
           @duration = duration
+          @service_id = service_id
         end
 
         # Returns a concise yet useful summary of the event.
@@ -97,12 +117,17 @@ module Mongo
         # @param [ String ] message The error message.
         # @param [ BSON::Document ] failure The error document, if any.
         # @param [ Float ] duration The duration of the command in seconds.
+        # @param [ Monitoring::Event::CommandStarted ] started_event The corresponding
+        #   started event.
+        # @param [ Object ] service_id The service id, if any.
         #
         # @return [ CommandFailed ] The event.
         #
         # @since 2.1.0
         # @api private
-        def self.generate(address, operation_id, payload, message, failure, duration)
+        def self.generate(address, operation_id, payload, message,
+          failure, duration, started_event:, service_id: nil
+        )
           new(
             payload[:command_name],
             payload[:database_name],
@@ -111,7 +136,9 @@ module Mongo
             operation_id,
             message,
             failure,
-            duration
+            duration,
+            started_event: started_event,
+            service_id: service_id,
           )
         end
       end

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
@@ -40,6 +43,9 @@ module Mongo
         # @return [ Integer ] request_id The request id.
         attr_reader :request_id
 
+        # @return [ nil | Object ] The service id, if any.
+        attr_reader :service_id
+
         # object_id of the socket object used for this command.
         #
         # @api private
@@ -57,6 +63,11 @@ module Mongo
         # @api private
         attr_reader :server_connection_id
 
+        # @return [ true | false ] Whether the event contains sensitive data.
+        #
+        # @api private
+        attr_reader :sensitive
+
         # Create the new event.
         #
         # @example Create the event.
@@ -72,13 +83,19 @@ module Mongo
         # @api private
         def initialize(command_name, database_name, address, request_id,
           operation_id, command, socket_object_id: nil, connection_id: nil,
-          connection_generation: nil, server_connection_id: nil
+          connection_generation: nil, server_connection_id: nil,
+          service_id: nil
         )
           @command_name = command_name.to_s
           @database_name = database_name
           @address = address
           @request_id = request_id
           @operation_id = operation_id
+          @service_id = service_id
+          @sensitive = sensitive?(
+            command_name: @command_name,
+            document: command
+          )
           @command = redacted(command_name, command)
           @socket_object_id = socket_object_id
           @connection_id = connection_id
@@ -130,7 +147,7 @@ module Mongo
         # @api private
         def self.generate(address, operation_id, payload,
           socket_object_id: nil, connection_id: nil, connection_generation: nil,
-          server_connection_id: nil
+          server_connection_id: nil, service_id: nil
         )
           new(
             payload[:command_name],
@@ -148,6 +165,7 @@ module Mongo
             connection_id: connection_id,
             connection_generation: connection_generation,
             server_connection_id: server_connection_id,
+            service_id: service_id,
           )
         end