mongo 2.14.0 → 2.16.0

data/lib/mongo/protocol/message.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");
@@ -140,7 +143,13 @@ module Mongo
         self
       end
 
-      def maybe_decrypt(client)
+      # Possibly decrypt this message with libmongocrypt.
+      #
+      # @param [ Mongo::Operation::Context ] context The operation context.
+      #
+      # @return [ Mongo::Protocol::Msg ] The decrypted message, or the original
+      #   message if decryption was not possible or necessary.
+      def maybe_decrypt(context)
         # TODO determine if we should be decrypting data coming from pre-4.2
         # servers, potentially using legacy wire protocols. If so we need
         # to implement decryption for those wire protocols as our current
@@ -148,11 +157,23 @@ module Mongo
         self
       end
 
-      def maybe_encrypt(server, client)
+      # Possibly encrypt this message with libmongocrypt.
+      #
+      # @param [ Mongo::Server::Connection ] connection The connection on which
+      #   the operation is performed.
+      # @param [ Mongo::Operation::Context ] context The operation context.
+      #
+      # @return [ Mongo::Protocol::Msg ] The encrypted message, or the original
+      #   message if encryption was not possible or necessary.
+      def maybe_encrypt(connection, context)
         # Do nothing if the Message subclass has not implemented this method
         self
       end
 
+      def maybe_add_server_api(server_api)
+        raise Error::ServerApiNotSupported, "Server API parameters cannot be sent to pre-3.6 MongoDB servers. Please remove the :server_api parameter from Client options or use MongoDB 3.6 or newer"
+      end
+
       private def merge_sections
         cmd = if @sections.length > 1
           cmd = @sections.detect { |section| section[:type] == 0 }[:payload]

data/lib/mongo/protocol/msg.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2017-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -40,11 +43,11 @@ module Mongo
       # Creates a new OP_MSG protocol message
       #
       # @example Create a OP_MSG wire protocol message
-      #   Msg.new([:more_to_come], {}, { ismaster: 1 },
+      #   Msg.new([:more_to_come], {}, { hello: 1 },
       #           { type: 1, payload: { identifier: 'documents', sequence: [..] } })
       #
-      # @param [ Array<Symbol> ] flags The flag bits. Current supported values
-      #   are :more_to_come and :checksum_present.
+      # @param [ Array<Symbol> ] flags The flag bits. Currently supported
+      #   values are :more_to_come and :checksum_present.
       # @param [ Hash ] options The options.
       # @param [ BSON::Document, Hash ] main_document The document that will
       #   become the payload type 0 section. Can contain global args as they
@@ -196,18 +199,19 @@ module Mongo
       # auto-encryption options, the client has not been instructed to bypass
       # auto-encryption, and mongocryptd determines that this message is
       # eligible for encryption. A message is eligible for encryption if it
-      # represents one of the command types whitelisted by libmongocrypt and it
+      # represents one of the command types allow-listed by libmongocrypt and it
       # contains data that is required to be encrypted by a local or remote json schema.
       #
-      # @param [ Mongo::Client | nil ] client The client used to make the original
-      #   command. This client may have auto-encryption options specified.
+      # @param [ Mongo::Server::Connection ] connection The connection on which
+      #   the operation is performed.
+      # @param [ Mongo::Operation::Context ] context The operation context.
       #
       # @return [ Mongo::Protocol::Msg ] The encrypted message, or the original
       #   message if encryption was not possible or necessary.
-      def maybe_encrypt(connection, client)
+      def maybe_encrypt(connection, context)
         # TODO verify compression happens later, i.e. when this method runs
         # the message is not compressed.
-        if client && client.encrypter && client.encrypter.encrypt?
+        if context.encrypt?
           if connection.description.max_wire_version < 8
             raise Error::CryptError.new(
               "Cannot perform encryption against a MongoDB server older than " +
@@ -219,7 +223,7 @@ module Mongo
 
           db_name = @main_document[DATABASE_IDENTIFIER]
           cmd = merge_sections
-          enc_cmd = client.encrypter.encrypt(db_name, cmd)
+          enc_cmd = context.encrypter.encrypt(db_name, cmd)
           if cmd.key?('$db') && !enc_cmd.key?('$db')
             enc_cmd['$db'] = cmd['$db']
           end
@@ -234,18 +238,17 @@ module Mongo
       # decrypted if the specified client exists, that client has been given
       # auto-encryption options, and this message is eligible for decryption.
       # A message is eligible for decryption if it represents one of the command
-      # types whitelisted by libmongocrypt and it contains data that is required
+      # types allow-listed by libmongocrypt and it contains data that is required
       # to be encrypted by a local or remote json schema.
       #
-      # @param [ Mongo::Client | nil ] client The client used to make the original
-      #   command. This client may have auto-encryption options specified.
+      # @param [ Mongo::Operation::Context ] context The operation context.
       #
-      # @return [ Mongo::Protocol::Msg ] The decryption message, or the original
+      # @return [ Mongo::Protocol::Msg ] The decrypted message, or the original
       #   message if decryption was not possible or necessary.
-      def maybe_decrypt(client)
-        if client && client.encrypter
+      def maybe_decrypt(context)
+        if context.decrypt?
           cmd = merge_sections
-          enc_cmd = client.encrypter.decrypt(cmd)
+          enc_cmd = context.encrypter.decrypt(cmd)
           Msg.new(@flags, @options, enc_cmd)
         else
           self
@@ -275,6 +278,26 @@ module Mongo
         num_inserts > 1  || num_updates > 1 || num_deletes > 1
       end
 
+      def maybe_add_server_api(server_api)
+        conflicts = {}
+        %i(apiVersion apiStrict apiDeprecationErrors).each do |key|
+          if @main_document.key?(key)
+            conflicts[key] = @main_document[key]
+          end
+          if @main_document.key?(key.to_s)
+            conflicts[key] = @main_document[key.to_s]
+          end
+        end
+        unless conflicts.empty?
+          raise Error::ServerApiConflict, "The Client is configured with :server_api option but the operation provided the following conflicting parameters: #{conflicts.inspect}"
+        end
+
+        main_document = @main_document.merge(
+          Utils.transform_server_api(server_api)
+        )
+        Msg.new(@flags, @options, main_document, *@sequences)
+      end
+
       private
 
       # Validate that the documents in this message are all smaller than the

data/lib/mongo/protocol/query.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");
@@ -40,34 +43,42 @@ module Mongo
       #   Query.new('xgen', 'users', {:name => 'Tyler'}, :skip => 5,
       #                                                  :limit => 10)
       #
-      # @example Find all users with slave ok bit set
-      #   Query.new('xgen', 'users', {:name => 'Tyler'}, :flags => [:slave_ok])
+      # @example Find all users with secondaryOk bit set
+      #   Query.new('xgen', 'users', {:name => 'Tyler'}, :flags => [:secondary_ok])
       #
       # @example Find all user ids.
       #   Query.new('xgen', 'users', {}, :fields => {:id => 1})
       #
-      # @param database [String, Symbol] The database to query.
-      # @param collection [String, Symbol] The collection to query.
-      # @param selector [Hash] The query selector.
-      # @param options [Hash] The additional query options.
-      #
-      # @option options :project [Hash] The projection.
-      # @option options :skip [Integer] The number of documents to skip.
-      # @option options :limit [Integer] The number of documents to return.
-      # @option options :flags [Array] The flags for the query message.
+      # @param [ String, Symbol ] database The database to query.
+      # @param [ String, Symbol ] collection The collection to query.
+      # @param [ Hash ] selector The query selector.
+      # @param [ Hash ] options The additional query options.
       #
-      #   Supported flags: +:tailable_cursor+, +:slave_ok+, +:oplog_replay+,
-      #   +:no_cursor_timeout+, +:await_data+, +:exhaust+, +:partial+
+      # @option options [ Array<Symbol> ] :flags The flag bits.
+      #   Currently supported values are :await_data, :exhaust,
+      #   :no_cursor_timeout, :oplog_replay, :partial, :secondary_ok,
+      #   :tailable_cursor.
+      # @option options [ Integer ] :limit The number of documents to return.
+      # @option options [ Hash ] :project The projection.
+      # @option options [ Integer ] :skip The number of documents to skip.
       def initialize(database, collection, selector, options = {})
         @database = database
         @namespace = "#{database}.#{collection}"
+        if selector.nil?
+          raise ArgumentError, 'Selector cannot be nil'
+        end
         @selector = selector
         @options = options
         @project = options[:project]
         @limit = determine_limit
         @skip = options[:skip]  || 0
         @flags = options[:flags] || []
-        @upconverter = Upconverter.new(collection, selector, options, flags)
+        @upconverter = Upconverter.new(
+          collection,
+          BSON::Document.new(selector),
+          BSON::Document.new(options),
+          flags,
+        )
         super
       end
 
@@ -168,10 +179,11 @@ module Mongo
       end
 
       # Available flags for a Query message.
+      # @api private
       FLAGS = [
         :reserved,
         :tailable_cursor,
-        :slave_ok,
+        :secondary_ok,
         :oplog_replay,
         :no_cursor_timeout,
         :await_data,
@@ -220,7 +232,7 @@ module Mongo
         }.freeze
 
         SPECIAL_FIELD_MAPPINGS = {
-          :$readPreference => 'readPreference',
+          :$readPreference => '$readPreference',
           :$orderby => 'sort',
           :$hint => 'hint',
           :$comment => 'comment',
@@ -245,16 +257,6 @@ module Mongo
           :partial => 'allowPartialResults'
         }.freeze
 
-        # Find command constant.
-        #
-        # @since 2.1.0
-        FIND = 'find'.freeze
-
-        # Filter attribute constant.
-        #
-        # @since 2.1.0
-        FILTER = 'filter'.freeze
-
         # @return [ String ] collection The name of the collection.
         attr_reader :collection
 
@@ -279,6 +281,15 @@ module Mongo
         #
         # @since 2.1.0
         def initialize(collection, filter, options, flags)
+          # Although the docstring claims both hashes and BSON::Documents
+          # are acceptable, this class expects the filter and options to
+          # contain symbol keys which isn't what the operation layer produces.
+          unless BSON::Document === filter
+            raise ArgumentError, 'Filter must provide indifferent access'
+          end
+          unless BSON::Document === options
+            raise ArgumentError, 'Options must provide indifferent access'
+          end
           @collection = collection
           @filter = filter
           @options = options
@@ -307,7 +318,7 @@ module Mongo
         #
         # @since 2.1.0
         def command_name
-          ((filter[:$query] || !command?) ? FIND : filter.keys.first).to_s
+          ((filter[:$query] || !command?) ? :find : filter.keys.first).to_s
         end
 
         private
@@ -329,15 +340,25 @@ module Mongo
         end
 
         def find_command
-          document = BSON::Document.new
-          document.store(FIND, collection)
-          document.store(FILTER, query_filter)
+          document = BSON::Document.new(
+            find: collection,
+            filter: query_filter,
+          )
           OPTION_MAPPINGS.each do |legacy, option|
             document.store(option, options[legacy]) unless options[legacy].nil?
           end
-          Mongo::Lint.validate_camel_case_read_preference(filter['readPreference'])
+          if Lint.enabled?
+            filter.each do |k, v|
+              unless String === k
+                raise Error::LintError, "All keys in filter must be strings: #{filter.inspect}"
+              end
+            end
+          end
+          Lint.validate_camel_case_read_preference(filter['readPreference'])
           SPECIAL_FIELD_MAPPINGS.each do |special, normal|
-            document.store(normal, filter[special]) unless filter[special].nil?
+            unless (v = filter[special]).nil?
+              document.store(normal, v)
+            end
           end
           FLAG_MAPPINGS.each do |legacy, flag|
             document.store(flag, true) if flags.include?(legacy)

data/lib/mongo/protocol/registry.rb

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

data/lib/mongo/protocol/reply.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/protocol/serializers.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/protocol/update.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/protocol.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Wire Protocol Base
 require 'mongo/protocol/serializers'
 require 'mongo/protocol/registry'

data/lib/mongo/query_cache.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2020 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -238,5 +241,35 @@ module Mongo
         end
       end
     end
+
+    # Rack middleware that activates the query cache for each request.
+    class Middleware
+
+      # Instantiate the middleware.
+      #
+      # @example Create the new middleware.
+      #   Middleware.new(app)
+      #
+      # @param [ Object ] app The rack application stack.
+      def initialize(app)
+        @app = app
+      end
+
+      # Enable query cache and execute the request.
+      #
+      # @example Execute the request.
+      #   middleware.call(env)
+      #
+      # @param [ Object ] env The environment.
+      #
+      # @return [ Object ] The result of the call.
+      def call(env)
+        QueryCache.cache do
+          @app.call(env)
+        end
+      ensure
+        QueryCache.clear
+      end
+    end
   end
 end

data/lib/mongo/retryable.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");
@@ -477,7 +480,7 @@ module Mongo
       else
         "Retry"
       end
-      Logger.logger.warn "#{message} due to: #{e.class.name} #{e.message}"
+      Logger.logger.warn "#{message} due to: #{e.class.name}: #{e.message}"
     end
 
     # Retry writes on MMAPv1 should raise an actionable error; append actionable

data/lib/mongo/semaphore.rb

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

data/lib/mongo/server/app_metadata.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");
@@ -14,7 +17,7 @@
 
 module Mongo
   class Server
-    # Application metadata that is sent to the server in an ismaster command,
+    # Application metadata that is sent to the server during a handshake,
     #   when a new connection is established.
     #
     # @api private
@@ -43,6 +46,11 @@ module Mongo
       # @api private
       AUTH_OPTION_KEYS = [:user, :auth_source, :auth_mech].freeze
 
+      # Possible connection purposes.
+      #
+      # @api private
+      PURPOSES = %i(application monitor push_monitor).freeze
+
       # Instantiate the new AppMetadata object.
       #
       # @api private
@@ -60,10 +68,16 @@ module Mongo
       # @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'.
+      #   driver only supports 'zstd', 'snappy' and 'zlib'.
       # @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 [ Symbol ] :purpose The purpose of this connection.
+      # @option options [ Hash ] :server_api The requested server API version.
+      #   This hash can have the following items:
+      #   - *:version* -- string
+      #   - *:strict* -- boolean
+      #   - *:deprecation_errors* -- boolean
       # @option options [ String ] :user The user name.
       # @option options [ Array<Hash> ] :wrapping_libraries Information about
       #   libraries such as ODMs that are wrapping the driver. Specify the
@@ -71,11 +85,17 @@ module Mongo
       #   :platform.
       #
       # @since 2.4.0
-      def initialize(options)
+      def initialize(options = {})
         @app_name = options[:app_name].to_s if options[:app_name]
         @platform = options[:platform]
+        if @purpose = options[:purpose]
+          unless PURPOSES.include?(@purpose)
+            raise ArgumentError, "Invalid purpose: #{@purpose}"
+          end
+        end
         @compressors = options[:compressors] || []
         @wrapping_libraries = options[:wrapping_libraries]
+        @server_api = options[:server_api]
 
         if options[:user] && !options[:auth_mech]
           auth_db = options[:auth_source] || 'admin'
@@ -83,25 +103,37 @@ module Mongo
         end
       end
 
+      # @return [ Symbol ] The purpose of the connection for which this
+      #   app metadata is created.
+      #
+      # @api private
+      attr_reader :purpose
+
+      # @return [ Hash | nil ] The requested server API version.
+      #
+      #   Thes hash can have the following items:
+      #   - *:version* -- string
+      #   - *:strict* -- boolean
+      #   - *:deprecation_errors* -- boolean
+      #
+      # @api private
+      attr_reader :server_api
+
       # @return [ Array<Hash> | nil ] Information about libraries wrapping
       #   the driver.
       attr_reader :wrapping_libraries
 
-      # Get the bytes of the ismaster message including this metadata.
+      # Get the metadata as BSON::Document to be sent to
+      # as part of the handshake. The document should
+      # be appended to a suitable handshake command.
       #
-      # @api private
+      # This method ensures that the metadata are valid.
       #
-      # @example Get the ismaster message bytes.
-      #   metadata.ismaster_bytes
+      # @return [BSON::Document] Valid document for connection's handshake.
       #
-      # @return [ String ] The raw bytes.
+      # @raise [ Error::InvalidApplicationName ] When the metadata are invalid.
       #
-      # @since 2.4.0
-      # @deprecated
-      def ismaster_bytes
-        @ismaster_bytes ||= validate! && serialize.to_s
-      end
-
+      # @api private
       def validated_document
         validate!
         document
@@ -109,6 +141,10 @@ module Mongo
 
       private
 
+      # Check whether it is possible to build a valid app metadata document
+      # with params provided on intialization.
+      #
+      # @raise [ Error::InvalidApplicationName ] When the metadata are invalid.
       def validate!
         if @app_name && @app_name.bytesize > MAX_APP_NAME_SIZE
           raise Error::InvalidApplicationName.new(@app_name, MAX_APP_NAME_SIZE)
@@ -116,6 +152,10 @@ module Mongo
         true
       end
 
+      # Get BSON::Document to be used as value for `client` key in
+      # handshake document.
+      #
+      # @return [BSON::Document] Document describing client for handshake.
       def full_client_document
         BSON::Document.new.tap do |doc|
           doc[:application] = { name: @app_name } if @app_name
@@ -125,27 +165,39 @@ module Mongo
         end
       end
 
-      def serialize
-        Protocol::Query.new(Database::ADMIN, Database::COMMAND, document, :limit => -1).serialize
-      end
 
+      # Get the metadata as BSON::Document to be sent to
+      # as part of the handshake. The document should
+      # be appended to a suitable handshake command.
+      #
+      # @return [BSON::Document] Document for connection's handshake.
       def document
-        client_document = full_client_document
-        while client_document.to_bson.to_s.size > MAX_DOCUMENT_SIZE do
-          if client_document[:os][:name] || client_document[:os][:architecture]
-            client_document[:os].delete(:name)
-            client_document[:os].delete(:architecture)
-          elsif client_document[:platform]
-            client_document.delete(:platform)
-          else
-            client_document = nil
+        @document ||= begin
+          client_document = full_client_document
+          while client_document.to_bson.to_s.size > MAX_DOCUMENT_SIZE do
+            if client_document[:os][:name] || client_document[:os][:architecture]
+              client_document[:os].delete(:name)
+              client_document[:os].delete(:architecture)
+            elsif client_document[:platform]
+              client_document.delete(:platform)
+            else
+              client_document = nil
+            end
           end
+          document = BSON::Document.new(
+            {
+              compression: @compressors,
+              client: client_document,
+            }
+          )
+          document[:saslSupportedMechs] = @request_auth_mech if @request_auth_mech
+          if @server_api
+            document.update(
+              Utils.transform_server_api(@server_api)
+            )
+          end
+          document
         end
-        document = Server::Monitor::Connection::ISMASTER
-        document = document.merge(compression: @compressors)
-        document[:client] = client_document
-        document[:saslSupportedMechs] = @request_auth_mech if @request_auth_mech
-        document
       end
 
       def driver_doc
@@ -192,12 +244,16 @@ module Mongo
           ruby_versions = ["Ruby #{RUBY_VERSION}"]
           platforms = [RUBY_PLATFORM]
         end
-        platform = [
+        platforms = [
           @platform,
           *ruby_versions,
           *platforms,
           RbConfig::CONFIG['build'],
-        ].compact.join(', ')
+        ]
+        if @purpose
+          platforms << @purpose.to_s[0].upcase
+        end
+        platform = platforms.compact.join(', ')
         platforms = [platform]
         if wrapping_libraries
           wrapping_libraries.each do |library|