mongoid 6.4.7 → 6.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b178391288873186489028a588fe8d35be83a44d9bf351846a727af169096cd
-  data.tar.gz: ce725bbd596c7ac7df2817826788be6162a55a6ebeacf5553eebc810feb43ee3
+  metadata.gz: b8c453904dce4061c6cd88c36e21f3514fb778b37976ffd12e985aaf80fc2b98
+  data.tar.gz: d10421a146387851daa6a9c27184b48da1cc50d96a946bce0851aa69fd56c9a5
 SHA512:
-  metadata.gz: ea99aca6fe69fbe884477398019e761bf7f1274bb75b382b451767cdc6cfa4f6a1ea1ed874a65835d758ebc97c08823734721c6908296a926b1ae37e35c67fda
-  data.tar.gz: d9e7087501c49435c51873f901bb2e24a036dd1b2268fcb733f03f3aea6a523339e13997198d8e46ea2a128abf665ded41a1765382004d40523b317f3691e7d6
+  metadata.gz: 6c0e672470d68faab3afc70e65524baa771801b46bbbb51b831a5cc709baf6df4ed7f0d81aed2dd5d0c3e3cf6730166da9bc8345b33577298f4438ec6c11fca3
+  data.tar.gz: 2008465437ba6eafe50235b22204df40b560b8e3bd27d064e97912c3249f5443af2ad1016c9a545d9d487abc6c1b38835624090a6d9165d06f9c4e676b561a23

data/lib/mongoid/query_cache.rb

@@ -159,11 +159,14 @@ 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
-        (@cached_documents ||= []).concat(documents)
+        documents = super
+
+        if @cursor_id.zero? && !@after_first_batch
+          @cached_documents ||= []
+          @cached_documents.concat(documents)
+        end
+
+        @after_first_batch = true
         documents
       end
     end
@@ -218,34 +221,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
@@ -260,6 +268,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
@@ -267,6 +295,12 @@ module Mongoid
       def system_collection?
         collection.namespace =~ /^system./
       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 behaviour to the query cache for collections.

data/lib/mongoid/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Mongoid
-  VERSION = "6.4.7"
+  VERSION = "6.4.8"
 end

data/spec/mongoid/query_cache_spec.rb

@@ -7,6 +7,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

data/spec/spec_helper.rb

@@ -38,6 +38,7 @@ require 'support/macros'
 require 'support/spec_config'
 require 'support/cluster_config'
 require 'support/constraints'
+require 'support/session_registry'
 
 # Give MongoDB time to start up on the travis ci environment.
 if (ENV['CI'] == 'travis' || ENV['CI'] == 'evergreen')

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: 6.4.7
+  version: 6.4.8
 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
@@ -861,6 +861,7 @@ files:
 - spec/support/constraints.rb
 - spec/support/expectations.rb
 - spec/support/macros.rb
+- spec/support/session_registry.rb
 - spec/support/spec_config.rb
 homepage: http://mongoid.org
 licenses:
@@ -1356,6 +1357,7 @@ test_files:
 - spec/config/mongoid.yml
 - spec/integration/document_spec.rb
 - spec/mongoid_spec.rb
+- spec/support/session_registry.rb
 - spec/support/constraints.rb
 - spec/support/macros.rb
 - spec/support/expectations.rb