mongo 2.18.0 → 2.18.2

data/lib/mongo/query_cache.rb

@@ -114,24 +114,24 @@ module Mongo
       #
       # @param [ Mongo::CachingCursor ] cursor The CachingCursor instance to store.
       #
-      # @option opts [ String | nil ] namespace The namespace of the query,
+      # @option opts [ String | nil ] :namespace The namespace of the query,
       #   in the format "database_name.collection_name".
-      # @option opts [ Array, Hash ] selector The selector passed to the query.
+      # @option opts [ Array, Hash ] :selector The selector passed to the query.
       #   For most queries, this will be a Hash, but for aggregations, this
       #   will be an Array representing the aggregation pipeline. May not be nil.
-      # @option opts [ Integer | nil ] skip The skip value of the query.
-      # @option opts [ Hash | nil ] sort The order of the query results
+      # @option opts [ Integer | nil ] :skip The skip value of the query.
+      # @option opts [ Hash | nil ] :sort The order of the query results
       #   (e.g. { name: -1 }).
-      # @option opts [ Integer | nil ] limit The limit value of the query.
-      # @option opts [ Hash | nil ] projection The projection of the query
+      # @option opts [ Integer | nil ] :limit The limit value of the query.
+      # @option opts [ Hash | nil ] :projection The projection of the query
       #   results (e.g. { name: 1 }).
-      # @option opts [ Hash | nil ] collation The collation of the query
+      # @option opts [ Hash | nil ] :collation The collation of the query
       #   (e.g. { "locale" => "fr_CA" }).
-      # @option opts [ Hash | nil ] read_concern The read concern of the query
+      # @option opts [ Hash | nil ] :read_concern The read concern of the query
       #   (e.g. { level: :majority }).
-      # @option opts [ Hash | nil ] read_preference The read preference of
+      # @option opts [ Hash | nil ] :read_preference The read preference of
       #   the query (e.g. { mode: :secondary }).
-      # @option opts [ Boolean | nil ] multi_collection Whether the query
+      # @option opts [ Boolean | nil ] :multi_collection Whether the query
       #   results could potentially come from multiple collections. When true,
       #   these results will be stored under the nil namespace key and cleared
       #   on every write command.
@@ -152,24 +152,24 @@ module Mongo
       # For the given query options, retrieve a cached cursor that can be used
       # to obtain the correct query results, if one exists in the cache.
       #
-      # @option opts [ String | nil ] namespace The namespace of the query,
+      # @option opts [ String | nil ] :namespace The namespace of the query,
       #   in the format "database_name.collection_name".
-      # @option opts [ Array, Hash ] selector The selector passed to the query.
+      # @option opts [ Array, Hash ] :selector The selector passed to the query.
       #   For most queries, this will be a Hash, but for aggregations, this
       #   will be an Array representing the aggregation pipeline. May not be nil.
-      # @option opts [ Integer | nil ] skip The skip value of the query.
-      # @option opts [ Hash | nil ] sort The order of the query results
+      # @option opts [ Integer | nil ] :skip The skip value of the query.
+      # @option opts [ Hash | nil ] :sort The order of the query results
       #   (e.g. { name: -1 }).
-      # @option opts [ Integer | nil ] limit The limit value of the query.
-      # @option opts [ Hash | nil ] projection The projection of the query
+      # @option opts [ Integer | nil ] :limit The limit value of the query.
+      # @option opts [ Hash | nil ] :projection The projection of the query
       #   results (e.g. { name: 1 }).
-      # @option opts [ Hash | nil ] collation The collation of the query
+      # @option opts [ Hash | nil ] :collation The collation of the query
       #   (e.g. { "locale" => "fr_CA" }).
-      # @option opts [ Hash | nil ] read_concern The read concern of the query
+      # @option opts [ Hash | nil ] :read_concern The read concern of the query
       #   (e.g. { level: :majority }).
-      # @option opts [ Hash | nil ] read_preference The read preference of
+      # @option opts [ Hash | nil ] :read_preference The read preference of
       #   the query (e.g. { mode: :secondary }).
-      # @option opts [ Boolean | nil ] multi_collection Whether the query
+      # @option opts [ Boolean | nil ] :multi_collection Whether the query
       #   results could potentially come from multiple collections. When true,
       #   these results will be stored under the nil namespace key and cleared
       #   on every write command.

data/lib/mongo/session.rb

@@ -522,7 +522,7 @@ module Mongo
     #
     # @option options [ Integer ] :max_commit_time_ms The maximum amount of
     #   time to allow a single commitTransaction command to run, in milliseconds.
-    # @option options [ Hash ] read_concern The read concern options hash,
+    # @option options [ Hash ] :read_concern The read concern options hash,
     #   with the following optional keys:
     #   - *:level* -- the read preference level as a symbol; valid values
     #      are *:local*, *:majority*, and *:snapshot*

data/lib/mongo/version.rb

@@ -20,5 +20,5 @@ module Mongo
   # The current version of the driver.
   #
   # @since 2.0.0
-  VERSION = '2.18.0'.freeze
+  VERSION = '2.18.2'.freeze
 end

data/spec/README.md

@@ -408,7 +408,8 @@ The client-side encryption tests require the mongocryptd binary to be in the
 system path.
 
 Download enterprise versions of MongoDB here: https://www.mongodb.com/download-center/enterprise
-Read more about installing mongocryptd here: https://mongodb.com/docs/manual/reference/security-client-side-encryption-appendix/#mongocryptd
+Download the Automatic Encryption Shared Library https://www.mongodb.com/docs/manual/core/queryable-encryption/reference/shared-library/#std-label-qe-reference-shared-library-download
+Install and Configure mongocryptd: https://www.mongodb.com/docs/manual/core/queryable-encryption/reference/mongocryptd/
 
 Install libmongocrypt on your machine:
 
@@ -426,6 +427,9 @@ Option 1: Download a pre-built binary
 Option 2: Build from source
 - To build libmongocrypt from source, follow the instructions in the README on the libmongocrypt GitHub repo: https://github.com/mongodb/libmongocrypt
 
+Option 3: Use libmongocrypt-helper gem (Linux only)
+- Run command `FLE=helper bundle install`
+
 Create AWS KMS keys
 Many of the Client-Side Encryption tests require that you have an encryption
 master key hosted on AWS's Key Management Service. Set up a master key by following

data/spec/integration/bulk_write_spec.rb

@@ -18,6 +18,22 @@ describe 'Bulk writes' do
         authorized_collection.bulk_write(operations)
       end.not_to raise_error
     end
+
+    context 'in transaction' do
+      require_transaction_support
+      min_server_version "4.4"
+
+      it 'succeeds' do
+        authorized_collection.create
+        expect do
+          authorized_collection.client.start_session do |session|
+            session.with_transaction do
+              authorized_collection.bulk_write(operations, { session: session })
+            end
+          end
+        end.not_to raise_error
+      end
+    end
   end
 
   context 'when bulk write needs to be split' do

data/spec/integration/command_spec.rb

@@ -12,7 +12,7 @@ describe 'Command' do
 
     let(:payload) do
       server.with_connection do |connection|
-        command.send(:final_operation, connection).send(:message, connection).payload.dup.tap do |payload|
+        command.send(:final_operation).send(:message, connection).payload.dup.tap do |payload|
           if payload['request_id'].is_a?(Integer)
             payload['request_id'] = 42
           end
@@ -150,28 +150,6 @@ describe 'Command' do
           expect(payload).to eq(expected_payload)
         end
       end
-
-      # Servers using legacy wire protocol message do not have $db in payload.
-      # $db is added to the payload later when the command monitoring event is
-      # published.
-      context 'pre-OP_MSG servers' do
-        max_server_version '3.4'
-
-        let(:expected_payload) do
-          {
-            'command' => {
-              'find' => 'collection_name',
-            },
-            'command_name' => 'find',
-            'database_name' => 'foo',
-            'request_id' => 42,
-          }
-        end
-
-        it 'returns expected payload' do
-          expect(payload).to eq(expected_payload)
-        end
-      end
     end
 
   end

data/spec/integration/ocsp_verifier_spec.rb

@@ -335,6 +335,8 @@ describe Mongo::Socket::OcspVerifier do
     # have a path in the OCSP URI (which the test also asserts).
     # Note that these certificates expire in 3 months and need to be replaced
     # with a more permanent solution.
+    # Use the spec/support/certificates/retrieve-atlas-cert script to retrieve
+    # current certificates from Atlas.
     let(:cert_path) { File.join(File.dirname(__FILE__), '../support/certificates/atlas-ocsp.crt') }
     let(:ca_cert_path) { File.join(File.dirname(__FILE__), '../support/certificates/atlas-ocsp-ca.crt') }
     let(:cert_store) do

data/spec/mongo/client_construction_spec.rb

@@ -1773,28 +1773,28 @@ describe Mongo::Client do
             expect do
               client = new_local_client_nmio(['127.0.0.1:27017'],
                 :read => {:mode => :bogus})
-            end.to raise_error(Mongo::Error::InvalidReadOption, 'Invalid read option: {"mode"=>:bogus}: mode bogus is not one of recognized modes')
+            end.to raise_error(Mongo::Error::InvalidReadOption, 'Invalid read preference value: {"mode"=>:bogus}: mode bogus is not one of recognized modes')
           end
 
           it 'rejects bogus read preference as string' do
             expect do
               client = new_local_client_nmio(['127.0.0.1:27017'],
                 :read => {:mode => 'bogus'})
-            end.to raise_error(Mongo::Error::InvalidReadOption, 'Invalid read option: {"mode"=>"bogus"}: mode bogus is not one of recognized modes')
+            end.to raise_error(Mongo::Error::InvalidReadOption, 'Invalid read preference value: {"mode"=>"bogus"}: mode bogus is not one of recognized modes')
           end
 
           it 'rejects read option specified as a string' do
             expect do
               client = new_local_client_nmio(['127.0.0.1:27017'],
                 :read => 'primary')
-            end.to raise_error(Mongo::Error::InvalidReadOption, 'Invalid read option: primary: must be a hash')
+            end.to raise_error(Mongo::Error::InvalidReadOption, 'Invalid read preference value: "primary": the read preference must be specified as a hash: { mode: "primary" }')
           end
 
           it 'rejects read option specified as a symbol' do
             expect do
               client = new_local_client_nmio(['127.0.0.1:27017'],
                 :read => :primary)
-            end.to raise_error(Mongo::Error::InvalidReadOption, 'Invalid read option: primary: must be a hash')
+            end.to raise_error(Mongo::Error::InvalidReadOption, "Invalid read preference value: :primary: the read preference must be specified as a hash: { mode: :primary }")
           end
         end
       end

data/spec/mongo/collection_crud_spec.rb

@@ -362,6 +362,42 @@ describe Mongo::Collection do
       expect(result.inserted_ids.size).to eq(2)
     end
 
+    context 'when an enumerable is used instead of an array' do
+
+      context 'when the enumerable is not empty' do
+
+        let(:source_data) do
+          [{ name: 'test1' }, { name: 'test2' }]
+        end
+
+        let(:result) do
+          authorized_collection.insert_many(source_data.lazy)
+        end
+
+        it 'should accepts them without raising an error' do
+          expect { result }.to_not raise_error
+          expect(result.inserted_count).to eq(source_data.size)
+        end
+      end
+
+      context 'when the enumerable is empty' do
+
+        let(:source_data) do
+          []
+        end
+
+        let(:result) do
+          authorized_collection.insert_many(source_data.lazy)
+        end
+
+        it 'should raise ArgumentError' do
+          expect do
+            result
+          end.to raise_error(ArgumentError, /Bulk write requests cannot be empty/)
+        end
+      end
+    end
+
     context 'when a session is provided' do
 
       let(:session) do
@@ -4412,4 +4448,24 @@ describe Mongo::Collection do
       expect(result).to be_nil
     end
   end
+
+  context "when creating collection with view_on and pipeline" do
+    before do
+      authorized_client["my_view"].drop
+      authorized_collection.insert_one({ bar: "here!" })
+      authorized_client["my_view",
+        view_on: authorized_collection.name,
+        pipeline: [ { :'$project' => { "baz": "$bar" } } ]
+      ].create
+    end
+
+    it "the view has a document" do
+      expect(authorized_client["my_view"].find.to_a.length).to eq(1)
+    end
+
+    it "applies the pipeline" do
+      expect(authorized_client["my_view"].find.first).to have_key("baz")
+      expect(authorized_client["my_view"].find.first["baz"]).to eq("here!")
+    end
+  end
 end

data/spec/mongo/collection_spec.rb

@@ -647,7 +647,11 @@ describe Mongo::Collection do
     context 'when the collection is capped' do
 
       let(:collection) do
-        described_class.new(database, :specs, :capped => true, :size => 1024)
+        described_class.new(database, :specs, :capped => true, :size => 4096, :max => 512)
+      end
+
+      let(:collstats) do
+        database.read_command(:collstats => :specs).documents.first
       end
 
       before do
@@ -658,6 +662,12 @@ describe Mongo::Collection do
       it 'returns true' do
         expect(collection).to be_capped
       end
+
+      it "applies the options" do
+        expect(collstats["capped"]).to be true
+        expect(collstats["max"]).to eq(512)
+        expect(collstats["maxSize"]).to eq(4096)
+      end
     end
 
     context 'when the collection is not capped' do

data/spec/mongo/crypt/auto_encrypter_spec.rb

@@ -16,12 +16,16 @@ describe Mongo::Crypt::AutoEncrypter do
     described_class.new(
       auto_encryption_options.merge(
         client: authorized_client.use(:auto_encryption),
-        # Spawn mongocryptd on non-default port for sharded cluster tests
-        extra_options: extra_options
+        extra_options: auto_encrypter_extra_options
       )
     )
   end
 
+  let(:auto_encrypter_extra_options) do
+    # Spawn mongocryptd on non-default port for sharded cluster tests
+    extra_options
+  end
+
   let(:client) { authorized_client }
 
   let(:db_name) { 'auto_encryption' }
@@ -155,7 +159,7 @@ describe Mongo::Crypt::AutoEncrypter do
     end
   end
 
-  context 'with schema map in auto encryption commands' do
+  shared_examples 'with schema map in auto encryption commands' do
     include_context 'without jsonSchema validator'
 
     let(:auto_encryption_options) do
@@ -193,7 +197,7 @@ describe Mongo::Crypt::AutoEncrypter do
     end
   end
 
-  context 'with schema map file in auto encryption commands' do
+  shared_examples 'with schema map file in auto encryption commands' do
     include_context 'without jsonSchema validator'
 
     let(:schema_map_file) do
@@ -246,7 +250,7 @@ describe Mongo::Crypt::AutoEncrypter do
     end
   end
 
-  context 'with schema map collection validator' do
+  shared_examples 'with schema map collection validator' do
     include_context 'with jsonSchema validator'
 
     let(:auto_encryption_options) do
@@ -302,7 +306,7 @@ describe Mongo::Crypt::AutoEncrypter do
     end
   end
 
-  context 'with no validator or client option' do
+  shared_examples 'with no validator or client option' do
     include_context 'without jsonSchema validator'
 
     let(:auto_encryption_options) do
@@ -403,4 +407,35 @@ describe Mongo::Crypt::AutoEncrypter do
       end
     end
   end
+
+  context 'when using crypt shared library' do
+    min_server_version '6.0.0'
+
+    let(:auto_encrypter_extra_options) do
+      {
+        crypt_shared_lib_path: SpecConfig.instance.crypt_shared_lib_path
+      }
+    end
+
+    let(:auto_encryption_options) do
+      {
+        kms_providers: kms_providers,
+        kms_tls_options: kms_tls_options,
+        key_vault_namespace: key_vault_namespace,
+        schema_map: { "#{db_name}.#{collection_name}": schema_map },
+      }
+    end
+
+    it_behaves_like 'with schema map in auto encryption commands'
+    it_behaves_like 'with schema map file in auto encryption commands'
+    it_behaves_like 'with schema map collection validator'
+    it_behaves_like 'with no validator or client option'
+  end
+
+  context 'when using mongocryptd' do
+    it_behaves_like 'with schema map in auto encryption commands'
+    it_behaves_like 'with schema map file in auto encryption commands'
+    it_behaves_like 'with schema map collection validator'
+    it_behaves_like 'with no validator or client option'
+  end
 end

data/spec/mongo/crypt/binding/version_spec.rb

@@ -41,5 +41,13 @@ describe 'Mongo::Crypt::Binding' do
         end.not_to raise_error(LoadError, /libmongocrypt version .* or above is required, but version .* was found./)
       end
     end
+
+    context 'when in a non-parsable format' do
+      it 'does not raise ArgumentError' do
+        expect do
+          Mongo::Crypt::Binding.validate_version("1.5.3-dev+20220730git8f8675fa11")
+        end.not_to raise_error(ArgumentError, /Malformed version number string/)
+      end
+    end
   end
 end

data/spec/mongo/crypt/handle_spec.rb

@@ -18,6 +18,10 @@ describe Mongo::Crypt::Handle do
         kms_tls_options,
         schema_map: schema_map,
         schema_map_path: schema_map_path,
+        bypass_query_analysis: bypass_query_analysis,
+        crypt_shared_lib_path: crypt_shared_lib_path,
+        crypt_shared_lib_required: crypt_shared_lib_required,
+        explicit_encryption_only: explicit_encryption_only,
       )
     end
 
@@ -29,6 +33,22 @@ describe Mongo::Crypt::Handle do
       nil
     end
 
+    let(:bypass_query_analysis) do
+      nil
+    end
+
+    let(:crypt_shared_lib_path) do
+      nil
+    end
+
+    let(:crypt_shared_lib_required) do
+      nil
+    end
+
+    let(:explicit_encryption_only) do
+      nil
+    end
+
     shared_examples 'a functioning Mongo::Crypt::Handle' do
       context 'with valid schema map' do
         it 'does not raise an exception' do
@@ -73,6 +93,88 @@ describe Mongo::Crypt::Handle do
           expect { handle }.not_to raise_error
         end
       end
+
+      context 'with crypt_shared_lib_path' do
+        min_server_version '6.0.0'
+
+        context 'with correct path' do
+          let(:crypt_shared_lib_path) do
+            SpecConfig.instance.crypt_shared_lib_path
+          end
+
+          it 'loads the crypt shared lib' do
+            expect(handle.crypt_shared_lib_version).not_to eq(0)
+          end
+        end
+
+        context 'with incorrect path' do
+          let(:crypt_shared_lib_path) do
+            '/some/bad/path/mongo_crypt_v1.so'
+          end
+
+          it 'raises an exception' do
+            expect { handle }.to raise_error(Mongo::Error::CryptError)
+          end
+        end
+      end
+
+      context 'with crypt_shared_lib_required' do
+        min_server_version '6.0.0'
+
+        context 'set to true' do
+          let(:crypt_shared_lib_required) do
+            true
+          end
+
+          context 'when shared lib is available' do
+            let(:crypt_shared_lib_path) do
+              SpecConfig.instance.crypt_shared_lib_path
+            end
+
+            it 'does not raise an exception' do
+              expect { handle }.not_to raise_error
+            end
+          end
+
+          context 'when shared lib is not available' do
+            let(:crypt_shared_lib_path) do
+              '/some/bad/path/mongo_crypt_v1.so'
+            end
+
+            it 'raises an exception' do
+              expect { handle }.to raise_error(Mongo::Error::CryptError)
+            end
+          end
+        end
+      end
+
+      context 'if bypass_query_analysis is true' do
+        min_server_version '6.0.0'
+
+        let(:bypass_query_analysis) do
+          true
+        end
+
+        it 'does not load the crypt shared lib' do
+          expect_any_instance_of(Binding).not_to receive(:setopt_append_crypt_shared_lib_search_path)
+
+          expect(handle.crypt_shared_lib_version).to eq(0)
+        end
+      end
+
+      context 'if explicit_encryption_only is true' do
+        min_server_version '6.0.0'
+
+        let(:explicit_encryption_only) do
+          true
+        end
+
+        it 'does not load the crypt shared lib' do
+          expect_any_instance_of(Binding).not_to receive(:setopt_append_crypt_shared_lib_search_path)
+
+          expect(handle.crypt_shared_lib_version).to eq(0)
+        end
+      end
     end
 
     context 'local' do

data/spec/mongo/crypt/kms_spec.rb

@@ -33,7 +33,6 @@ describe Mongo::Crypt::KMS do
         %i(
           ssl_verify_certificate
           ssl_verify_hostname
-          ssl_verify_ocsp_endpoint
         ).each do |insecure_opt|
           expect {
             Mongo::Crypt::KMS::Validations.validate_tls_options(
@@ -46,14 +45,18 @@ describe Mongo::Crypt::KMS do
       end
 
       it 'allows valid options' do
-        options = {
-          aws: {
-            ssl: true,
-            ssl_cert_string: 'Content is not validated',
-
-          }
-        }
+        expect do
+          Mongo::Crypt::KMS::Validations.validate_tls_options(
+            {
+              aws: {
+                ssl: true,
+                ssl_cert_string: 'Content is not validated',
+                ssl_verify_ocsp_endpoint: false
+              }
+            }
+          )
+        end.not_to raise_error
       end
     end
   end
-end
+end

data/spec/mongo/cursor_spec.rb

@@ -734,4 +734,54 @@ describe Mongo::Cursor do
       end
     end
   end
+
+  describe '#batch_size' do
+    let(:subscriber) { Mrss::EventSubscriber.new }
+
+    let(:subscribed_client) do
+      authorized_client.tap do |client|
+        client.subscribe(Mongo::Monitoring::COMMAND, subscriber)
+      end
+    end
+
+    let(:collection) do
+      subscribed_client[TEST_COLL]
+    end
+
+    let(:view) do
+      collection.find({}, limit: limit)
+    end
+
+    before do
+      collection.drop
+      collection.insert_many([].fill({ "bar": "baz" }, 0, 102))
+    end
+
+    context 'when limit is 0 and batch_size is not set' do
+      let(:limit) do
+        0
+      end
+
+      it 'does not set batch_size' do
+        view.to_a
+        get_more_commands = subscriber.started_events.select { |e| e.command_name == 'getMore' }
+        expect(get_more_commands.length).to eq(1)
+        expect(get_more_commands.first.command.keys).not_to include('batchSize')
+      end
+    end
+
+    context 'when limit is not zero and batch_size is not set' do
+      let(:limit) do
+        1000
+      end
+
+      it 'sets batch_size' do
+        view.to_a
+        get_more_commands = subscriber.started_events.select { |e| e.command_name == 'getMore' }
+
+        expect(get_more_commands.length).to eq(1)
+        expect(get_more_commands.first.command.keys).to include('batchSize')
+      end
+    end
+  end
 end

data/spec/shared/lib/mrss/event_subscriber.rb

@@ -84,22 +84,32 @@ module Mrss
 
     # Locates command stated events for the specified command name,
     # asserts that there is exactly one such event, and returns it.
-    def single_command_started_event(command_name, include_auth: false)
+    def single_command_started_event(command_name, include_auth: false, database_name: nil)
       events = if include_auth
                  started_events
                else
                  non_auth_command_started_events
                end
-      events.select! do |event|
-        event.command[command_name]
+      get_one_event(events, command_name, 'started', database_name: database_name)
+    end
+
+    # Locates command succeeded events for the specified command name,
+    # asserts that there is exactly one such event, and returns it.
+    def single_command_succeeded_event(command_name, database_name: nil)
+      get_one_event(succeeded_events, command_name, 'succeeded', database_name: database_name)
+    end
+
+    def get_one_event(events, command_name, kind, database_name: nil)
+      events = events.select do |event|
+        event.command_name == command_name and
+        database_name.nil? || database_name == event.database_name
       end
       if events.length != 1
-        raise "Expected a single #{command_name} event but we have #{events.length}"
+        raise "Expected a single '#{command_name}' #{kind} event#{database_name ? " for '#{database_name}'" : ''} but we have #{events.length}"
       end
       events.first
     end
 
-
     # Get the first succeeded event published for the name, and then delete it.
     #
     # @param [ String ] name The event name.