mongo 2.13.0 → 2.15.0.alpha

data/lib/mongo/lint.rb

@@ -4,12 +4,13 @@ module Mongo
   module Lint
 
     # Raises LintError if +obj+ is not of type +cls+.
-    module_function def assert_type(obj, cls)
+    def assert_type(obj, cls)
       return unless enabled?
       unless obj.is_a?(cls)
         raise Error::LintError, "Expected #{obj} to be a #{cls}"
       end
     end
+    module_function :assert_type
 
     def validate_underscore_read_preference(read_pref)
       return unless enabled?

data/lib/mongo/logger.rb

@@ -21,7 +21,7 @@ module Mongo
 
     class << self
 
-      # Get the wrapped logger. If none was set will return a default debug
+      # Get the wrapped logger. If none was set will return a default info
       # level logger.
       #
       # @example Get the wrapped logger.
@@ -75,8 +75,8 @@ module Mongo
       private
 
       def default_logger
-        logger = ::Logger.new($stdout)
-        logger.level = ::Logger::DEBUG
+        logger = ::Logger.new(STDOUT)
+        logger.level = ::Logger::INFO
         logger
       end
     end

data/lib/mongo/monitoring.rb

@@ -307,9 +307,9 @@ module Mongo
     # @api private
     def publish_heartbeat(server, awaited: false)
       if monitoring?
-        event = Event::ServerHeartbeatStarted.new(
+        started_event = Event::ServerHeartbeatStarted.new(
           server.address, awaited: awaited)
-        started(SERVER_HEARTBEAT, event)
+        started(SERVER_HEARTBEAT, started_event)
       end
 
       # The duration we publish in heartbeat succeeded/failed events is
@@ -328,14 +328,23 @@ module Mongo
       rescue => exc
         if monitoring?
           event = Event::ServerHeartbeatFailed.new(
-            server.address, Time.now-start_time, exc, awaited: awaited)
+            server.address,
+            Time.now-start_time,
+            exc,
+            awaited: awaited,
+            started_event: started_event,
+          )
           failed(SERVER_HEARTBEAT, event)
         end
         raise
       else
         if monitoring?
           event = Event::ServerHeartbeatSucceeded.new(
-            server.address, Time.now-start_time, awaited: awaited)
+            server.address,
+            Time.now-start_time,
+            awaited: awaited,
+            started_event: started_event,
+          )
           succeeded(SERVER_HEARTBEAT, event)
         end
         result

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

@@ -21,6 +21,29 @@ module Mongo
       # @since 2.7.0
       class ServerHeartbeatFailed < Mongo::Event::Base
 
+        # Create the event.
+        #
+        # @example Create the event.
+        #   ServerHeartbeatSucceeded.new(address, duration)
+        #
+        # @param [ Address ] address The server address.
+        # @param [ Float ] round_trip_time Duration of ismaster call in seconds.
+        # @param [ true | false ] awaited Whether the heartbeat was awaited.
+        # @param [ Monitoring::Event::ServerHeartbeatStarted ] started_event
+        #   The corresponding started event.
+        #
+        # @since 2.7.0
+        # @api private
+        def initialize(address, round_trip_time, error, awaited: false,
+          started_event:
+        )
+          @address = address
+          @round_trip_time = round_trip_time
+          @error = error
+          @awaited = !!awaited
+          @started_event = started_event
+        end
+
         # @return [ Address ] address The server address.
         attr_reader :address
 
@@ -41,23 +64,11 @@ module Mongo
           @awaited
         end
 
-        # Create the event.
-        #
-        # @example Create the event.
-        #   ServerHeartbeatSucceeded.new(address, duration)
-        #
-        # @param [ Address ] address The server address.
-        # @param [ Float ] round_trip_time Duration of ismaster call in seconds.
-        # @param [ true | false ] awaited Whether the heartbeat was awaited.
+        # @return [ Monitoring::Event::ServerHeartbeatStarted ]
+        #   The corresponding started event.
         #
-        # @since 2.7.0
-        # @api private
-        def initialize(address, round_trip_time, error, awaited: false)
-          @address = address
-          @round_trip_time = round_trip_time
-          @error = error
-          @awaited = !!awaited
-        end
+        # @api experimental
+        attr_reader :started_event
 
         # Returns a concise yet useful summary of the event.
         #

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

@@ -21,20 +21,6 @@ module Mongo
       # @since 2.7.0
       class ServerHeartbeatSucceeded < Mongo::Event::Base
 
-        # @return [ Address ] address The server address.
-        attr_reader :address
-
-        # @return [ Float ] round_trip_time Duration of ismaster call in seconds.
-        attr_reader :round_trip_time
-
-        # Alias of round_trip_time.
-        alias :duration :round_trip_time
-
-        # @return [ true | false ] Whether the heartbeat was awaited.
-        def awaited?
-          @awaited
-        end
-
         # Create the event.
         #
         # @example Create the event.
@@ -43,15 +29,40 @@ module Mongo
         # @param [ Address ] address The server address.
         # @param [ Float ] round_trip_time Duration of ismaster call in seconds.
         # @param [ true | false ] awaited Whether the heartbeat was awaited.
+        # @param [ Monitoring::Event::ServerHeartbeatStarted ] started_event
+        #   The corresponding started event.
         #
         # @since 2.7.0
         # @api private
-        def initialize(address, round_trip_time, awaited: false)
+        def initialize(address, round_trip_time, awaited: false,
+          started_event:
+        )
           @address = address
           @round_trip_time = round_trip_time
           @awaited = !!awaited
+          @started_event = started_event
         end
 
+        # @return [ Address ] address The server address.
+        attr_reader :address
+
+        # @return [ Float ] round_trip_time Duration of ismaster call in seconds.
+        attr_reader :round_trip_time
+
+        # Alias of round_trip_time.
+        alias :duration :round_trip_time
+
+        # @return [ true | false ] Whether the heartbeat was awaited.
+        def awaited?
+          @awaited
+        end
+
+        # @return [ Monitoring::Event::ServerHeartbeatStarted ]
+        #   The corresponding started event.
+        #
+        # @api experimental
+        attr_reader :started_event
+
         # Returns a concise yet useful summary of the event.
         #
         # @return [ String ] String summary of the event.

data/lib/mongo/operation.rb

@@ -1,3 +1,4 @@
+require 'mongo/operation/context'
 require 'mongo/operation/result'
 
 require 'mongo/operation/shared/response_handling'
@@ -5,6 +6,7 @@ require 'mongo/operation/shared/executable'
 require 'mongo/operation/shared/executable_no_validate'
 require 'mongo/operation/shared/executable_transaction_label'
 require 'mongo/operation/shared/polymorphic_lookup'
+require 'mongo/operation/shared/polymorphic_operation'
 require 'mongo/operation/shared/polymorphic_result'
 require 'mongo/operation/shared/read_preference_supported'
 require 'mongo/operation/shared/bypass_document_validation'
@@ -18,8 +20,6 @@ require 'mongo/operation/shared/specifiable'
 require 'mongo/operation/shared/object_id_generator'
 require 'mongo/operation/shared/op_msg_or_command'
 require 'mongo/operation/shared/op_msg_or_find_command'
-require 'mongo/operation/shared/op_msg_or_list_indexes_command'
-require 'mongo/operation/shared/collections_info_or_list_collections'
 
 require 'mongo/operation/op_msg_base'
 require 'mongo/operation/command'
@@ -50,6 +50,8 @@ require 'mongo/operation/create_index'
 require 'mongo/operation/drop_index'
 
 module Mongo
+
+  # @api private
   module Operation
 
     # The q field constant.

data/lib/mongo/operation/aggregate/result.rb

@@ -14,25 +14,24 @@
 
 module Mongo
   module Operation
-
-    # Aggregate result wrapper.
-    #
-    # @since 2.0.0
     class Aggregate
 
       # Defines custom behavior of results in an aggregation context.
       #
       # @since 2.0.0
+      # @api semiprivate
       class Result < Operation::Result
 
         # The field name for the aggregation explain information.
         #
         # @since 2.0.5
+        # @api private
         EXPLAIN = 'stages'.freeze
 
         # The legacy field name for the aggregation explain information.
         #
         # @since 2.0.5
+        # @api private
         EXPLAIN_LEGACY = 'serverPipeline'.freeze
 
         # Get the cursor id for the result.
@@ -48,6 +47,7 @@ module Mongo
         # @return [ Integer ] The cursor id.
         #
         # @since 2.0.0
+        # @api private
         def cursor_id
           cursor_document ? cursor_document[CURSOR_ID] : 0
         end
@@ -62,8 +62,8 @@ module Mongo
         end
 
         # Get the documents for the aggregation result. This is either the
-        # first document's 'result' field, or if a cursor option was selected, 
-        # it is the 'firstBatch' field in the 'cursor' field of the first 
+        # first document's 'result' field, or if a cursor option was selected,
+        # it is the 'firstBatch' field in the 'cursor' field of the first
         # document returned. Otherwise, it is an explain document.
         #
         # @example Get the documents.
@@ -72,10 +72,11 @@ module Mongo
         # @return [ Array<BSON::Document> ] The documents.
         #
         # @since 2.0.0
+        # @api public
         def documents
-          docs = reply.documents[0][RESULT] 
+          docs = reply.documents[0][RESULT]
           docs ||= cursor_document[FIRST_BATCH] if cursor_document
-          docs ||= explain_document 
+          docs ||= explain_document
           docs
         end
 

data/lib/mongo/operation/collections_info.rb

@@ -25,7 +25,24 @@ module Mongo
     # @since 2.0.0
     class CollectionsInfo
       include Specifiable
-      include CollectionsInfoOrListCollections
+      include PolymorphicOperation
+      include PolymorphicLookup
+
+      private
+
+      def final_operation(connection)
+         op_class = if connection.features.list_collections_enabled?
+          if connection.features.op_msg_enabled?
+            ListCollections::OpMsg
+          else
+            ListCollections::Command
+          end
+        else
+          CollectionsInfo::Command
+        end
+
+        op_class.new(spec)
+      end
     end
   end
 end

data/lib/mongo/operation/collections_info/command.rb

@@ -27,6 +27,11 @@ module Mongo
 
         private
 
+        def get_result(connection, context, options = {})
+          # This is a Mongo::Operation::CollectionsInfo::Result
+          Result.new(*dispatch_message(connection, context), db_name)
+        end
+
         def selector(connection)
           {}
         end

data/lib/mongo/operation/collections_info/result.rb

@@ -20,8 +20,24 @@ module Mongo
       # collection.
       #
       # @since 2.1.0
+      # @api semiprivate
       class Result < Operation::Result
 
+        # Initialize a new result.
+        #
+        # @param [ Array<Protocol::Message> | nil ] replies The wire protocol replies, if any.
+        # @param [ Server::Description ] connection_description
+        #   Server description of the server that performed the operation that
+        #   this result is for.
+        # @param [ String ] database_name The name of the database that the
+        #   query was sent to.
+        #
+        # @api private
+        def initialize(replies, connection_description, database_name)
+          super(replies, connection_description)
+          @database_name = database_name
+        end
+
         # Get the namespace for the cursor.
         #
         # @example Get the namespace.
@@ -30,8 +46,9 @@ module Mongo
         # @return [ String ] The namespace.
         #
         # @since 2.1.0
+        # @api private
         def namespace
-          Database::NAMESPACES
+          "#{@database_name}.#{Database::NAMESPACES}"
         end
       end
     end

data/lib/mongo/operation/context.rb

@@ -0,0 +1,99 @@
+# Copyright (C) 2021 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
+  module Operation
+
+    # Context for operations.
+    #
+    # Holds various objects needed to make decisions about operation execution
+    # in a single container, and provides facade methods for the contained
+    # objects.
+    #
+    # @api private
+    class Context
+      def initialize(client: nil, session: nil, options: nil)
+        if options
+          if client
+            raise ArgumentError, 'Client and options cannot both be specified'
+          end
+
+          if session
+            raise ArgumentError, 'Session and options cannot both be specified'
+          end
+        end
+
+        @client = client
+        @session = session
+        @options = options
+      end
+
+      attr_reader :client
+      attr_reader :session
+      attr_reader :options
+
+      def in_transaction?
+        session&.in_transaction? || false
+      end
+
+      def starting_transaction?
+        session&.starting_transaction? || false
+      end
+
+      def committing_transaction?
+        in_transaction? && session.committing_transaction?
+      end
+
+      def aborting_transaction?
+        in_transaction? && session.aborting_transaction?
+      end
+
+      def modern_retry_writes?
+        client && client.options[:retry_writes]
+      end
+
+      def legacy_retry_writes?
+        client && !client.options[:retry_writes] && client.max_write_retries > 0
+      end
+
+      def any_retry_writes?
+        modern_retry_writes? || legacy_retry_writes?
+      end
+
+      def server_api
+        if client
+          client.options[:server_api]
+        elsif options
+          options[:server_api]
+        end
+      end
+
+      def encrypt?
+        client&.encrypter&.encrypt? || false
+      end
+
+      def decrypt?
+        !!client&.encrypter
+      end
+
+      def encrypter
+        if client&.encrypter
+          client.encrypter
+        else
+          raise Error::InternalDriverError, 'Encrypter should only be accessed when encryption is to be performed'
+        end
+      end
+    end
+  end
+end