mongo 2.14.0.rc1 → 2.15.1

data/lib/mongo/operation/users_info/op_msg.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/operation/users_info/result.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/operation/users_info.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/operation.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'mongo/operation/context'
 require 'mongo/operation/result'
 
 require 'mongo/operation/shared/response_handling'
@@ -5,6 +9,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 +23,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'

data/lib/mongo/options/mapper.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/options/redacted.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/options.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/protocol/bit_vector.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/compressed.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");
@@ -18,12 +21,25 @@ module Mongo
     # MongoDB Wire protocol Compressed message.
     #
     # This is a bi-directional message that compresses another opcode.
+    # See https://github.com/mongodb/specifications/blob/master/source/compression/OP_COMPRESSED.rst
     #
     # @api semipublic
     #
     # @since 2.5.0
     class Compressed < Message
 
+      # The noop compressor identifier.
+      NOOP = 'noop'.freeze
+
+      # The byte signaling that the message has not been compressed (test mode).
+      NOOP_BYTE = 0.chr.force_encoding(BSON::BINARY).freeze
+
+      # The snappy compressor identifier.
+      SNAPPY = 'snappy'.freeze
+
+      # The byte signaling that the message has been compressed with snappy.
+      SNAPPY_BYTE = 1.chr.force_encoding(BSON::BINARY).freeze
+
       # The byte signaling that the message has been compressed with Zlib.
       #
       # @since 2.5.0
@@ -34,10 +50,20 @@ module Mongo
       # @since 2.5.0
       ZLIB = 'zlib'.freeze
 
+      # The zstd compressor identifier.
+      ZSTD = 'zstd'.freeze
+
+      # The byte signaling that the message has been compressed with zstd.
+      ZSTD_BYTE = 3.chr.force_encoding(BSON::BINARY).freeze
+
       # The compressor identifier to byte map.
       #
       # @since 2.5.0
-      COMPRESSOR_ID_MAP = { ZLIB => ZLIB_BYTE }.freeze
+      COMPRESSOR_ID_MAP = {
+        SNAPPY => SNAPPY_BYTE,
+        ZSTD => ZSTD_BYTE,
+        ZLIB => ZLIB_BYTE
+      }.freeze
 
       # Creates a new OP_COMPRESSED message.
       #
@@ -68,9 +94,7 @@ module Mongo
       # @api private
       def maybe_inflate
         message = Registry.get(@original_op_code).allocate
-        uncompressed_message = Zlib::Inflate.inflate(@compressed_message)
-
-        buf = BSON::ByteBuffer.new(uncompressed_message)
+        buf = decompress(@compressed_message)
 
         message.send(:fields).each do |field|
           if field[:multi]
@@ -125,10 +149,35 @@ module Mongo
         buf = BSON::ByteBuffer.new
         @original_message.send(:serialize_fields, buf, max_bson_size)
         @uncompressed_size = buf.length
-        @compressed_message = Zlib::Deflate.deflate(buf.to_s, @zlib_compression_level).force_encoding(BSON::BINARY)
+        @compressed_message = compress(buf)
         super
       end
 
+      def compress(buffer)
+        if @compressor_id == NOOP_BYTE
+          buffer.to_s.force_encoding(BSON::BINARY)
+        elsif @compressor_id == ZLIB_BYTE
+          Zlib::Deflate.deflate(buffer.to_s, @zlib_compression_level).force_encoding(BSON::BINARY)
+        elsif @compressor_id == SNAPPY_BYTE
+          Snappy.deflate(buffer.to_s).force_encoding(BSON::BINARY)
+        elsif @compressor_id == ZSTD_BYTE
+          # DRIVERS-600 will allow this to be configurable in the future
+          Zstd.compress(buffer.to_s).force_encoding(BSON::BINARY)
+        end
+      end
+
+      def decompress(compressed_message)
+        if @compressor_id == NOOP_BYTE
+          BSON::ByteBuffer.new(compressed_message)
+        elsif @compressor_id == ZLIB_BYTE
+          BSON::ByteBuffer.new(Zlib::Inflate.inflate(compressed_message))
+        elsif @compressor_id == SNAPPY_BYTE
+          BSON::ByteBuffer.new(Snappy.inflate(compressed_message))
+        elsif @compressor_id == ZSTD_BYTE
+          BSON::ByteBuffer.new(Zstd.decompress(compressed_message))
+        end
+      end
+
       Registry.register(OP_CODE, self)
     end
   end

data/lib/mongo/protocol/delete.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/get_more.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/insert.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/kill_cursors.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/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,24 +43,24 @@ 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}"
@@ -168,10 +171,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,

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");