mongoid 7.1.4 → 7.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16518b942d2280aa5a81476d27709c2242f98ad559a2cea776c23369f9951d58
-  data.tar.gz: 243b7a7b9e0991f5feb7c3e8ae514e650915052c93b78c31fcbe8d8308e7743a
+  metadata.gz: '06912d432d08b07e80bad71d5073cf2d5a4924f097cdefed959107c6cad245ef'
+  data.tar.gz: d6880896621095c3d3017207d9966f99c17f7aea9a1d7366746e287e4c2cea04
 SHA512:
-  metadata.gz: '07539688736c17c7d33b8dfea04e7c5d9d8295b176358be200fd5cc0793c40902e54704697c75a6bf08930f418891b032ae0f0f0dbb090635590c277ca2aabce'
-  data.tar.gz: ed2a4140a29a5dfd12328a34363af63280661048c15c7b34b32905bdec493822e7377cb206407a7ba99298b27ef158785ba5ec92b5ef93641a95de923c539022
+  metadata.gz: 9b9a2bcc459c5ae8f2d7dd5585e7c0c39869f6a860067ae4ab36c5df64efb524ef688d5ab087e1a52a9d6ea3101df66213ad607c62df7499e5706bcce3f0974c
+  data.tar.gz: cafe608ad57c0b91593bd570024c74aa6ed203f14e6ebe61b026601ef7c64ab8bc28d944a42e73aa6c1b1aea1510f83e9a64f869bee15ce549db2ade75e56295

data/lib/mongoid/query_cache.rb

@@ -163,14 +163,13 @@ module Mongoid
       private
 
       def process(result)
-        @remaining -= result.returned_count if limited?
-        @cursor_id = result.cursor_id
-        @coll_name ||= result.namespace.sub("#{database.name}.", '') if result.namespace
-        documents = result.documents
+        documents = super
+
         if @cursor_id.zero? && !@after_first_batch
           @cached_documents ||= []
           @cached_documents.concat(documents)
         end
+
         @after_first_batch = true
         documents
       end
@@ -224,34 +223,39 @@ module Mongoid
       #
       # @since 5.0.0
       def each
-        if system_collection? || !QueryCache.enabled?
+        if system_collection? || !QueryCache.enabled? || (respond_to?(:write?, true) && write?)
           super
         else
-          unless cursor = cached_cursor
-            read_with_retry do
-              server = server_selector.select_server(cluster)
-              result = send_initial_query(server)
-              if result.cursor_id == 0 || result.cursor_id.nil?
-                cursor = CachedCursor.new(view, result, server)
-                QueryCache.cache_table[cache_key] = cursor
-              else
-                cursor = Mongo::Cursor.new(view, result, server)
+          @cursor = nil
+          unless @cursor = cached_cursor
+
+            if driver_supports_cursor_sessions?
+              session = client.send(:get_session, @options)
+              read_with_retry(session, server_selector) do |server|
+                result = send_initial_query(server, session)
+                @cursor = get_cursor(result, server, session)
+              end
+            else
+              read_with_retry do
+                server = server_selector.select_server(cluster)
+                result = send_initial_query(server)
+                @cursor = get_cursor(result, server)
               end
             end
           end
 
           if block_given?
             if limit && limit != -1
-              cursor.to_a[0...limit].each do |doc|
+              @cursor.to_a[0...limit].each do |doc|
                 yield doc
               end
             else
-              cursor.each do |doc|
+              @cursor.each do |doc|
                 yield doc
               end
             end
           else
-            cursor
+            @cursor.to_enum
           end
         end
       end
@@ -266,6 +270,26 @@ module Mongoid
         cursor || QueryCache.cache_table[cache_key]
       end
 
+      def get_cursor(result, server, session = nil)
+        if result.cursor_id == 0 || result.cursor_id.nil?
+          cursor = if session
+            CachedCursor.new(view, result, server, session: session)
+          else
+            CachedCursor.new(view, result, server)
+          end
+
+          QueryCache.cache_table[cache_key] = cursor
+        else
+          cursor = if session
+            Mongo::Cursor.new(view, result, server, session: session)
+          else
+            Mongo::Cursor.new(view, result, server)
+          end
+        end
+
+        cursor
+      end
+
       def cache_key
         [ collection.namespace, selector, limit, skip, sort, projection, collation ]
       end
@@ -273,6 +297,12 @@ module Mongoid
       def system_collection?
         collection.namespace =~ /\Asystem./
       end
+
+      def driver_supports_cursor_sessions?
+        # Driver versions 2.9 and newer support passing in a session to the
+        # cursor object.
+        (Mongo::VERSION.split('.').map(&:to_i) <=> [2, 9, 0]) > 0
+      end
     end
 
     # Adds behavior to the query cache for collections.

data/lib/mongoid/version.rb

@@ -2,5 +2,5 @@
 # encoding: utf-8
 
 module Mongoid
-  VERSION = "7.1.4"
+  VERSION = "7.1.5"
 end

data/spec/lite_spec_helper.rb

@@ -16,6 +16,7 @@ require 'pp'
 
 require 'support/spec_config'
 require 'support/lite_constraints'
+require "support/session_registry"
 
 unless SpecConfig.instance.ci?
   begin

data/spec/mongoid/query_cache_spec.rb

@@ -10,6 +10,20 @@ describe Mongoid::QueryCache do
     Mongoid::QueryCache.cache { spec.run }
   end
 
+  before(:all) do
+    # It is likely that there are other session leaks in the driver
+    # and/or Mongoid that are unrelated to the query cache. Clear the
+    # SessionRegistry at the start of these tests in order to detect leaks that
+    # occur only within the scope of these tests.
+    #
+    # Other session leaks will be detected and addressed as part of RUBY-2391.
+    SessionRegistry.instance.clear_registry
+  end
+
+  after do
+    SessionRegistry.instance.verify_sessions_ended!
+  end
+
   context 'when iterating over objects sharing the same base' do
 
     let(:server) do
@@ -543,7 +557,7 @@ describe Mongoid::QueryCache do
       Mongoid::QueryCache.enabled = true
       10.times { Band.create! }
 
-      Band.batch_size(4).all.any?
+      Band.batch_size(4).all.to_a
     end
 
     it 'does not cache the result' do

data/spec/support/session_registry.rb

@@ -0,0 +1,50 @@
+require 'singleton'
+
+module Mongo
+  class Client
+    alias :get_session_without_tracking :get_session
+
+    def get_session(options = {})
+      get_session_without_tracking(options).tap do |session|
+        SessionRegistry.instance.register(session)
+      end
+    end
+  end
+
+  class Session
+    alias :end_session_without_tracking :end_session
+
+    def end_session
+      SessionRegistry.instance.unregister(self)
+      end_session_without_tracking
+    end
+  end
+end
+
+
+class SessionRegistry
+  include Singleton
+
+  def initialize
+    @registry = {}
+  end
+
+  def register(session)
+    @registry[session.session_id] = session if session
+  end
+
+  def unregister(session)
+    @registry.delete(session.session_id)
+  end
+
+  def verify_sessions_ended!
+    unless @registry.empty?
+      sessions = @registry.map { |_, session| session }
+      raise "Session registry contains live sessions: #{sessions.join(', ')}"
+    end
+  end
+
+  def clear_registry
+    @registry = {}
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid
 version: !ruby/object:Gem::Version
-  version: 7.1.4
+  version: 7.1.5
 platform: ruby
 authors:
 - Durran Jordan
@@ -29,7 +29,7 @@ cert_chain:
   gpvfPNWMwyBDlHaNS3GfO6cRRxBOvEG05GUCsvtTY4Bpe8yjE64wg1ymb47LMOnv
   Qb1lGORmf/opg45mluKUYl7pQNZHD0d3
   -----END CERTIFICATE-----
-date: 2020-10-13 00:00:00.000000000 Z
+date: 2020-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -929,6 +929,7 @@ files:
 - spec/support/helpers.rb
 - spec/support/lite_constraints.rb
 - spec/support/macros.rb
+- spec/support/session_registry.rb
 - spec/support/shared/time.rb
 - spec/support/spec_config.rb
 homepage: https://mongoid.org
@@ -1489,6 +1490,7 @@ test_files:
 - spec/lite_spec_helper.rb
 - spec/README.md
 - spec/support/helpers.rb
+- spec/support/session_registry.rb
 - spec/support/child_process_helper.rb
 - spec/support/constraints.rb
 - spec/support/lite_constraints.rb