mongo 2.5.3 → 2.6.0

data/lib/mongo/session/server_session.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017 MongoDB, Inc.
+# Copyright (C) 2017-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -38,6 +38,11 @@ module Mongo
       # @since 2.5.0
       attr_reader :last_use
 
+      # The current transactions number.
+      #
+      # @since 2.5.0
+      attr_reader :txn_num
+
       # Initialize a ServerSession.
       #
       # @example
@@ -47,7 +52,7 @@ module Mongo
       def initialize
         set_last_use!
         session_id
-        @txn_num = -1
+        @txn_num = 0
       end
 
       # Update the last_use attribute of the server session to now.

data/lib/mongo/session/session_pool.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017 MongoDB, Inc.
+# Copyright (C) 2017-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/socket.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/socket/ssl.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/socket/tcp.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/socket/unix.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/uri.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -175,7 +175,7 @@ module Mongo
     # @since 2.1.0
     INVALID_PORT = "Invalid port. Port must be an integer greater than 0 and less than 65536".freeze
 
-    # Map of URI read preference modes to ruby driver read preference modes
+    # Map of URI read preference modes to Ruby driver read preference modes
     #
     # @since 2.0.0
     READ_MODE_MAP = {
@@ -186,15 +186,17 @@ module Mongo
       'nearest'            => :nearest
     }.freeze
 
-    # Map of URI authentication mechanisms to ruby driver mechanisms
+    # Map of URI authentication mechanisms to Ruby driver mechanisms
     #
     # @since 2.0.0
     AUTH_MECH_MAP = {
       'PLAIN'        => :plain,
+      # MONGODB-CR is deprecated and will be removed in driver version 3.0
       'MONGODB-CR'   => :mongodb_cr,
       'GSSAPI'       => :gssapi,
       'MONGODB-X509' => :mongodb_x509,
-      'SCRAM-SHA-1'  => :scram
+      'SCRAM-SHA-1'  => :scram,
+      'SCRAM-SHA-256' => :scram256
     }.freeze
 
     # Options that are allowed to appear more than once in the uri.

data/lib/mongo/uri/srv_protocol.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2017 MongoDB, Inc.
+# Copyright (C) 2017-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

data/lib/mongo/version.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -17,5 +17,5 @@ module Mongo
   # The current version of the driver.
   #
   # @since 2.0.0
-  VERSION = '2.5.3'.freeze
+  VERSION = '2.6.0'.freeze
 end

data/lib/mongo/write_concern.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/write_concern/acknowledged.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

data/lib/mongo/write_concern/normalizable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

data/lib/mongo/write_concern/unacknowledged.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2017 MongoDB, Inc.
+# Copyright (C) 2014-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

data/mongo.gemspec

@@ -4,7 +4,10 @@ require 'mongo/version'
 
 Gem::Specification.new do |s|
   s.name              = 'mongo'
-  s.version           = Mongo::VERSION
+  # The dup call makes `bundle install` work on ruby 1.9.3.
+  # Without it rubygems tries to modify version which fails because
+  # Mongo::VERSION is frozen.
+  s.version           = Mongo::VERSION.dup
   s.platform          = Gem::Platform::RUBY
 
   s.authors           = ['Tyler Brock', 'Emily Stolfo', 'Durran Jordan']

data/spec/atlas/atlas_connectivity_spec.rb

@@ -0,0 +1,54 @@
+require 'lite_spec_helper'
+
+describe 'Atlas connectivity' do
+  shared_examples 'connects to Atlas' do
+    let(:uri) { ENV[var] }
+    let(:client) { Mongo::Client.new(uri) }
+
+    before do
+      if uri.nil?
+        skip "#{var} not set in environment"
+      end
+    end
+
+    it 'runs ismaster successfully' do
+      result = client.database.command(:ismaster => 1)
+      expect(result.documents.first['ismaster']).to be true
+    end
+
+    it 'runs findOne successfully' do
+      result = client.use(:test)['test'].find.to_a
+      expect(result).to be_a(Array)
+    end
+  end
+
+  context 'Atlas replica set' do
+    let(:var) { 'ATLAS_REPLICA_SET_URI' }
+
+    it_behaves_like 'connects to Atlas'
+  end
+
+  context 'Atlas sharded cluster' do
+    let(:var) { 'ATLAS_SHARDED_URI' }
+
+    it_behaves_like 'connects to Atlas'
+  end
+
+  context 'Atlas free tier replica set' do
+    let(:var) { 'ATLAS_FREE_TIER_URI' }
+
+    it_behaves_like 'connects to Atlas'
+  end
+
+  context 'Atlas TLS 1.1 only replica set' do
+    let(:var) { 'ATLAS_TLS11_URI' }
+
+    it_behaves_like 'connects to Atlas'
+  end
+
+  context 'Atlas TLS 1.2 only replica set' do
+    let(:var) { 'ATLAS_TLS12_URI' }
+
+    it_behaves_like 'connects to Atlas'
+  end
+end

data/spec/integration/bulk_insert_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe 'Bulk insert' do
+  include PrimarySocket
+
+  FAIL_POINT_BASE_COMMAND = { 'configureFailPoint' => "failCommand" }
+
+  let(:collection_name) { 'bulk_insert_spec' }
+  let(:collection) { authorized_client[collection_name] }
+
+  describe 'inserted_ids' do
+    before do
+      collection.delete_many
+    end
+
+    context 'success' do
+      it 'returns one insert_id as array' do
+        result = collection.insert_many([
+          {:_id => 9},
+        ])
+        expect(result.inserted_ids).to eql([9])
+      end
+    end
+
+    context 'error on first insert' do
+      it 'is an empty array' do
+        collection.insert_one(:_id => 9)
+        begin
+          result = collection.insert_many([
+            {:_id => 9},
+          ])
+          fail 'Should have raised'
+        rescue Mongo::Error::BulkWriteError => e
+          expect(e.result['inserted_ids']).to eql([])
+        end
+      end
+    end
+
+    context 'error on third insert' do
+      it 'is an array of the first two ids' do
+        collection.insert_one(:_id => 9)
+        begin
+          result = collection.insert_many([
+            {:_id => 7},
+            {:_id => 8},
+            {:_id => 9},
+          ])
+          fail 'Should have raised'
+        rescue Mongo::Error::BulkWriteError => e
+          expect(e.result['inserted_ids']).to eql([7, 8])
+        end
+      end
+    end
+
+    context 'entire operation fails' do
+      min_server_version '4.0'
+      require_topology :single, :replica_set
+
+      it 'is an empty array' do
+        collection.client.use(:admin).command(FAIL_POINT_BASE_COMMAND.merge(
+          :mode => {:times => 1},
+          :data => {:failCommands => ['insert'], errorCode: 100}))
+        begin
+          result = collection.insert_many([
+            {:_id => 7},
+            {:_id => 8},
+            {:_id => 9},
+          ])
+          fail 'Should have raised'
+        rescue Mongo::Error => e
+          result = e.send(:instance_variable_get, '@result')
+          expect(result).to be_a(Mongo::Operation::Insert::BulkResult)
+          expect(result.inserted_ids).to eql([])
+        end
+      end
+    end
+  end
+end

data/spec/integration/change_stream_spec.rb

@@ -0,0 +1,365 @@
+require 'spec_helper'
+
+describe 'Change stream integration' do
+  only_mri
+  max_example_run_time 7
+
+  FAIL_POINT_BASE_COMMAND = { 'configureFailPoint' => "failCommand" }
+
+  # There is value in not clearing fail points between tests because
+  # their triggering will distinguish fail points not being set vs
+  # them not being triggered
+  def clear_fail_point(collection)
+    collection.client.use(:admin).command(FAIL_POINT_BASE_COMMAND.merge(mode: "off"))
+  end
+
+  class << self
+    def clear_fail_point_before
+      before do
+        clear_fail_point(authorized_collection)
+      end
+    end
+  end
+
+  before do
+    unless test_change_streams?
+      skip 'Not testing change streams'
+    end
+  end
+
+  describe 'watch+next' do
+    let(:change_stream) { authorized_collection.watch }
+
+    shared_context 'returns a change document' do
+      it 'returns a change document' do
+        change_stream
+
+        authorized_collection.insert_one(:a => 1)
+        sleep 0.5
+
+        change = change_stream.to_enum.next
+        expect(change).to be_a(BSON::Document)
+        expect(change['operationType']).to eql('insert')
+        doc = change['fullDocument']
+        expect(doc['_id']).to be_a(BSON::ObjectId)
+        doc.delete('_id')
+        expect(doc).to eql('a' => 1)
+      end
+    end
+
+    context 'no errors' do
+      it 'next returns changes' do
+        change_stream
+
+        authorized_collection.insert_one(:a => 1)
+
+        change = change_stream.to_enum.next
+        expect(change).to be_a(BSON::Document)
+        expect(change['operationType']).to eql('insert')
+        doc = change['fullDocument']
+        expect(doc['_id']).to be_a(BSON::ObjectId)
+        doc.delete('_id')
+        expect(doc).to eql('a' => 1)
+      end
+    end
+
+    context 'error on initial aggregation' do
+      min_server_version '4.0'
+      clear_fail_point_before
+
+      before do
+        authorized_collection.client.use(:admin).command(FAIL_POINT_BASE_COMMAND.merge(
+          :mode => {:times => 1},
+          :data => {:failCommands => ['aggregate'], errorCode: 100}))
+      end
+
+      it 'watch raises error' do
+        expect do
+          authorized_collection.watch
+        end.to raise_error(Mongo::Error::OperationFailure, "Failing command due to 'failCommand' failpoint (100)")
+      end
+    end
+
+    context 'one error on getMore' do
+      min_server_version '4.0'
+      clear_fail_point_before
+
+      context 'error on first getMore' do
+        before do
+          authorized_collection.client.use(:admin).command(FAIL_POINT_BASE_COMMAND.merge(
+            :mode => {:times => 1},
+            :data => {:failCommands => ['getMore'], errorCode: 100}))
+        end
+
+        it_behaves_like 'returns a change document'
+      end
+
+      context 'error on a getMore other than first' do
+        before do
+          # Need to retrieve a change stream document successfully prior to
+          # failing to have the resume token, otherwise the change stream
+          # ignores documents inserted after the first aggregation
+          # and the test gets stuck
+          change_stream
+          authorized_collection.insert_one(:a => 1)
+          change_stream.to_enum.next
+          authorized_collection.insert_one(:a => 1)
+
+          authorized_collection.client.use(:admin).command(FAIL_POINT_BASE_COMMAND.merge(
+            :mode => {:times => 1},
+            :data => {:failCommands => ['getMore'], errorCode: 100}))
+        end
+
+        it_behaves_like 'returns a change document'
+      end
+    end
+
+    context 'two errors on getMore' do
+      min_server_version '4.0'
+      clear_fail_point_before
+
+      context 'error of first getMores' do
+        before do
+          authorized_collection.client.use(:admin).command(FAIL_POINT_BASE_COMMAND.merge(
+            :mode => {:times => 2},
+            :data => {:failCommands => ['getMore'], errorCode: 100}))
+        end
+
+        # this retries twice because aggregation resets retry count,
+        # and ultimately succeeds and returns data
+        it_behaves_like 'returns a change document'
+      end
+
+      context 'error on a getMore other than first' do
+        before do
+          # Need to retrieve a change stream document successfully prior to
+          # failing to have the resume token, otherwise the change stream
+          # ignores documents inserted after the first aggregation
+          # and the test gets stuck
+          change_stream
+          authorized_collection.insert_one(:a => 1)
+          change_stream.to_enum.next
+          authorized_collection.insert_one(:a => 1)
+
+          authorized_collection.client.use(:admin).command(FAIL_POINT_BASE_COMMAND.merge(
+            :mode => {:times => 2},
+            :data => {:failCommands => ['getMore'], errorCode: 100}))
+        end
+
+        # this retries twice because aggregation resets retry count,
+        # and ultimately succeeds and returns data
+        it_behaves_like 'returns a change document'
+      end
+    end
+
+    context 'two errors on getMore followed by an error on aggregation' do
+      min_server_version '4.0'
+      clear_fail_point_before
+
+      it 'next raises error' do
+        change_stream
+
+        authorized_collection.insert_one(:a => 1)
+        sleep 0.5
+
+        enum = change_stream.to_enum
+
+        authorized_collection.client.use(:admin).command(FAIL_POINT_BASE_COMMAND.merge(
+          :mode => {:times => 2},
+          :data => {:failCommands => ['getMore', 'aggregate'], errorCode: 101}))
+
+        sleep 0.5
+
+        expect do
+          enum.next
+        end.to raise_error(Mongo::Error::OperationFailure, "Failing command due to 'failCommand' failpoint (101)")
+      end
+    end
+  end
+
+  describe 'try_next' do
+    let(:change_stream) { authorized_collection.watch }
+
+    shared_context 'returns a change document' do
+      it 'returns a change document' do
+        change_stream
+
+        sleep 0.5
+        authorized_collection.insert_one(:a => 1)
+        sleep 0.5
+
+        change = change_stream.to_enum.try_next
+        expect(change).to be_a(BSON::Document)
+        expect(change['operationType']).to eql('insert')
+        doc = change['fullDocument']
+        expect(doc['_id']).to be_a(BSON::ObjectId)
+        doc.delete('_id')
+        expect(doc).to eql('a' => 1)
+      end
+    end
+
+    context 'there are changes' do
+      it_behaves_like 'returns a change document'
+    end
+
+    context 'there are no changes' do
+      it 'returns nil' do
+        change_stream
+
+        change = change_stream.to_enum.try_next
+        expect(change).to be nil
+      end
+    end
+
+    context 'one error on getMore' do
+      min_server_version '4.0'
+      clear_fail_point_before
+
+      context 'error on first getMore' do
+        before do
+          authorized_collection.client.use(:admin).command(FAIL_POINT_BASE_COMMAND.merge(
+            :mode => {:times => 1},
+            :data => {:failCommands => ['getMore'], errorCode: 100}))
+        end
+
+        it_behaves_like 'returns a change document'
+      end
+
+      context 'error on a getMore other than first' do
+        before do
+          change_stream
+          authorized_collection.insert_one(:a => 1)
+          change_stream.to_enum.next
+          authorized_collection.insert_one(:a => 1)
+
+          authorized_collection.client.use(:admin).command(FAIL_POINT_BASE_COMMAND.merge(
+            :mode => {:times => 1},
+            :data => {:failCommands => ['getMore'], errorCode: 100}))
+        end
+
+        it_behaves_like 'returns a change document'
+      end
+    end
+
+    context 'two errors on getMore' do
+      min_server_version '4.0'
+      clear_fail_point_before
+
+      before do
+        authorized_collection.client.use(:admin).command(FAIL_POINT_BASE_COMMAND.merge(
+          :mode => {:times => 2},
+          :data => {:failCommands => ['getMore'], errorCode: 100}))
+      end
+
+      # this retries twice because aggregation resets retry count,
+      # and ultimately succeeds and returns data
+      it_behaves_like 'returns a change document'
+    end
+
+    context 'two errors on getMore followed by an error on aggregation' do
+      min_server_version '4.0'
+      clear_fail_point_before
+
+      context 'error on first getMore' do
+        it 'next raises error' do
+          change_stream
+
+          sleep 0.5
+          authorized_collection.insert_one(:a => 1)
+          sleep 0.5
+
+          enum = change_stream.to_enum
+
+          authorized_collection.client.use(:admin).command(FAIL_POINT_BASE_COMMAND.merge(
+            :mode => {:times => 3},
+            :data => {:failCommands => ['getMore', 'aggregate'], errorCode: 101}))
+
+          sleep 0.5
+
+          expect do
+            enum.try_next
+          end.to raise_error(Mongo::Error::OperationFailure, "Failing command due to 'failCommand' failpoint (101)")
+        end
+      end
+
+      context 'error on a getMore other than first' do
+        it 'next raises error' do
+          change_stream
+
+          authorized_collection.insert_one(:a => 1)
+          change_stream.to_enum.next
+          authorized_collection.insert_one(:a => 1)
+          sleep 0.5
+
+          enum = change_stream.to_enum
+
+          authorized_collection.client.use(:admin).command(FAIL_POINT_BASE_COMMAND.merge(
+            :mode => {:times => 3},
+            :data => {:failCommands => ['getMore', 'aggregate'], errorCode: 101}))
+
+          sleep 0.5
+
+          expect do
+            enum.try_next
+          end.to raise_error(Mongo::Error::OperationFailure, "Failing command due to 'failCommand' failpoint (101)")
+        end
+      end
+    end
+  end
+
+  describe ':start_at_operation_time option' do
+    min_server_version '4.0'
+
+    before do
+      authorized_collection.delete_many
+    end
+
+    it 'respects start time prior to beginning of aggregation' do
+      time = Time.now - 1
+      authorized_collection.insert_one(:a => 1)
+      sleep 0.5
+
+      cs = authorized_collection.watch([], start_at_operation_time: time)
+
+      document = cs.to_enum.next
+      expect(document).to be_a(BSON::Document)
+    end
+
+    it 'respects start time after beginning of aggregation' do
+      time = Time.now + 10
+      cs = authorized_collection.watch([], start_at_operation_time: time)
+      sleep 0.5
+
+      authorized_collection.insert_one(:a => 1)
+
+      sleep 0.5
+
+      document = cs.to_enum.try_next
+      expect(document).to be_nil
+    end
+
+    it 'accepts a Time' do
+      time = Time.now
+      cs = authorized_collection.watch([], start_at_operation_time: time)
+    end
+
+    it 'accepts a BSON::Timestamp' do
+      time = BSON::Timestamp.new(Time.now.to_i, 1)
+      cs = authorized_collection.watch([], start_at_operation_time: time)
+    end
+
+    it 'rejects a Date' do
+      time = Date.today
+      expect do
+        authorized_collection.watch([], start_at_operation_time: time)
+      end.to raise_error(ArgumentError, 'Time must be a Time or a BSON::Timestamp instance')
+    end
+
+    it 'rejects an integer' do
+      time = 1
+      expect do
+        authorized_collection.watch([], start_at_operation_time: time)
+      end.to raise_error(ArgumentError, 'Time must be a Time or a BSON::Timestamp instance')
+    end
+  end
+end