Fix RUBY-1980 Ensure cursor IDs are always encoded as 64-bit integers in BSON for getMore (#1559)

Author: p-mongo

lib/mongo/collection/view/readable.rb

@@ -602,15 +602,15 @@ def parallel_scan(cursor_count, options = {})
           cmd.execute(server).cursor_ids.map do |cursor_id|
             result = if server.features.find_command_enabled?
               Operation::GetMore.new({
-                :selector => {:getMore => cursor_id,
+                :selector => {:getMore => BSON::Int64.new(cursor_id),
                              :collection => collection.name},
                 :db_name => database.name,
                 :session => session,
               }).execute(server)
              else
               Operation::GetMore.new({
                 :to_return => 0,
-                :cursor_id => cursor_id,
+                :cursor_id => BSON::Int64.new(cursor_id),
                 :db_name => database.name,
                 :coll_name => collection.name
               }).execute(server)

lib/mongo/cursor/builder/get_more_command.rb

@@ -57,7 +57,10 @@ def specification
         private
 
         def get_more_command
-          command = { :getMore => cursor.id, :collection => collection_name }
+          command = {
+            :getMore => BSON::Int64.new(cursor.id),
+            :collection => collection_name,
+          }
           command[:batchSize] = batch_size.abs if batch_size && batch_size != 0
           # If the max_await_time_ms option is set, then we set maxTimeMS on
           # the get more command.

lib/mongo/cursor/builder/op_get_more.rb

@@ -50,9 +50,9 @@ def initialize(cursor)
         def specification
           {
             :to_return => to_return,
-            :cursor_id => cursor.id,
+            :cursor_id => BSON::Int64.new(cursor.id),
             :db_name   => database.name,
-            :coll_name => collection_name
+            :coll_name => collection_name,
           }
         end
       end

lib/mongo/protocol/get_more.rb

@@ -110,6 +110,7 @@ class Upconverter
         # The get more constant.
         #
         # @since 2.2.0
+        # @deprecated
         GET_MORE = 'getMore'.freeze
 
         # @return [ String ] collection The name of the collection.
@@ -148,7 +149,7 @@ def initialize(collection, cursor_id, number_to_return)
         # @since 2.1.0
         def command
           document = BSON::Document.new
-          document.store(GET_MORE, cursor_id)
+          document.store('getMore', BSON::Int64.new(cursor_id))
           document.store(Message::BATCH_SIZE, number_to_return)
           document.store(Message::COLLECTION, collection)
           document

lib/mongo/protocol/serializers.rb

@@ -102,13 +102,16 @@ def self.serialize(buffer, value, validating_keys = BSON::Config.validating_keys
       # Serializes and de-serializes one 32-bit integer.
       module Int32
 
-        # Serializes a fixnum to a 4-byte 32-bit integer
+        # Serializes a number to a 32-bit integer
         #
         # @param buffer [ String ] Buffer to receive the serialized Int32.
-        # @param value [ Fixnum ] 32-bit integer to be serialized.
+        # @param value [ Integer | BSON::Int32 ] 32-bit integer to be serialized.
         #
         # @return [String] Buffer with serialized value.
         def self.serialize(buffer, value, validating_keys = BSON::Config.validating_keys?)
+          if value.is_a?(BSON::Int32)
+            value = value.value
+          end
           buffer.put_int32(value)
         end
 
@@ -127,13 +130,16 @@ def self.deserialize(buffer)
       # Serializes and de-serializes one 64-bit integer.
       module Int64
 
-        # Serializes a fixnum to an 8-byte 64-bit integer
+        # Serializes a number to a 64-bit integer
         #
         # @param buffer [ String ] Buffer to receive the serialized Int64.
-        # @param value [ Fixnum ] 64-bit integer to be serialized.
+        # @param value [ Integer | BSON::Int64 ] 64-bit integer to be serialized.
         #
         # @return [ String ] Buffer with serialized value.
         def self.serialize(buffer, value, validating_keys = BSON::Config.validating_keys?)
+          if value.is_a?(BSON::Int64)
+            value = value.value
+          end
           buffer.put_int64(value)
         end
 

mongo.gemspec

@@ -32,5 +32,5 @@ Gem::Specification.new do |s|
   s.require_paths     = ['lib']
   s.bindir            = 'bin'
 
-  s.add_dependency 'bson', '>=4.4.2', '<5.0.0'
+  s.add_dependency 'bson', '>=4.6.0', '<5.0.0'
 end

spec/integration/get_more_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe 'getMore operation' do
+  # https://jira.mongodb.org/browse/RUBY-1987
+  min_server_fcv '3.2'
+
+  let(:collection) do
+    subscribed_client['get_more_spec']
+  end
+
+  let(:scope) do
+    collection.find.batch_size(1).each
+  end
+
+  before do
+    collection.delete_many
+    collection.insert_one(a: 1)
+    #collection.insert_one(a: 2)
+    EventSubscriber.clear_events!
+  end
+
+  let(:get_more_command) do
+    event = EventSubscriber.single_command_started_event('getMore')
+    event.command['getMore']
+  end
+
+  it 'sends cursor id as int64' do
+    scope.to_a
+
+    expect(get_more_command).to be_a(BSON::Int64)
+  end
+end

spec/mongo/bulk_write_spec.rb

@@ -1924,11 +1924,11 @@
             end
 
             let(:first_txn_number) do
-              started_events[-2].command['txnNumber'].instance_variable_get(:@integer)
+              started_events[-2].command['txnNumber'].value
             end
 
             let(:second_txn_number) do
-              started_events[-1].command['txnNumber'].instance_variable_get(:@integer)
+              started_events[-1].command['txnNumber'].value
             end
 
             it 'inserts the documents' do

spec/mongo/cursor/builder/get_more_command_spec.rb

@@ -5,7 +5,9 @@
   describe '#specification' do
 
     let(:reply) do
-      Mongo::Protocol::Reply.allocate
+      Mongo::Protocol::Reply.allocate.tap do |reply|
+        allow(reply).to receive(:cursor_id).and_return(8000)
+      end
     end
 
     let(:result) do
@@ -54,7 +56,7 @@
       end
 
       it 'includes getMore with cursor id' do
-        expect(selector[:getMore]).to eq(cursor.id)
+        expect(selector[:getMore]).to eq(BSON::Int64.new(8000))
       end
 
       it 'includes the collection name' do

spec/mongo/cursor/builder/op_get_more_spec.rb

@@ -5,7 +5,9 @@
   describe '#specification' do
 
     let(:reply) do
-      Mongo::Protocol::Reply.allocate
+      Mongo::Protocol::Reply.allocate.tap do |reply|
+        allow(reply).to receive(:cursor_id).and_return(8000)
+      end
     end
 
     let(:result) do
@@ -38,7 +40,7 @@
     end
 
     it 'includes the cursor id' do
-      expect(specification[:cursor_id]).to eq(cursor.id)
+      expect(specification[:cursor_id]).to eq(BSON::Int64.new(8000))
     end
 
     it 'includes the database name' do