mongo 2.2.7 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82e2963414b68a630d0784e70921c1d44775934e
-  data.tar.gz: db5398568a322af951e6b7ce3dfe7a22ddb8eb42
+  metadata.gz: 5da2e7df100dcc00d786b3839cce847de888bb3d
+  data.tar.gz: 858a508aa78ac85c6fc5a7506bdd660cdc384a9f
 SHA512:
-  metadata.gz: 108c89ec2a1e2849fc76a9d71b50307fd3fa6eca10389572a675d5065a700c0a48308e594f48cde6bb901f748387e0dae845ebd281afc6d96970024563cfb7a5
-  data.tar.gz: 47be1ace716e50c8020cc53599a9fd82e7c9f88ace2dfdd5d157a086f65002ae51d524a424e483795c9db6e7465a4ab04b79089315f140844f44d86f74a610e7
+  metadata.gz: 7a017939e8bfdc94ea78635128b71c5b837f725243777cf32f3d46b380cffc9b7c3e40b9558257af917b2eabf58e145dc8af7d36443b3342e55e08e16ff845b3
+  data.tar.gz: e22e1fbfe7908b55d0289f027483d56891f57757c5f29ff23bfaae1dd7140dfe3856b9e936d27402910fb7874d37576878c6d48e4de74765bac37c28251f9342

data/LICENSE

@@ -175,7 +175,7 @@
 
    END OF TERMS AND CONDITIONS
 
-   Copyright (C) 2009-2015 MongoDB, Inc.
+   Copyright (C) 2009-2016 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/README.md

@@ -63,7 +63,7 @@ Full release notes and release history are available [here](https://github.com/m
 License
 -----
 
- Copyright (C) 2009-2015 MongoDB, Inc.
+ Copyright (C) 2009-2016 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/Rakefile

@@ -36,7 +36,7 @@ task :docs => 'docs:yard'
 namespace :docs do
   desc "Generate yard documention"
   task :yard do
-    out = File.join('docs', Mongo::VERSION)
+    out = File.join('yard-docs', Mongo::VERSION)
     FileUtils.rm_rf(out)
     system "yardoc -o #{out} --title mongo-#{Mongo::VERSION}"
   end

data/lib/mongo.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2015 MongoDB, Inc.
+# Copyright (C) 2014-2016 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/address.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2015 MongoDB, Inc.
+# Copyright (C) 2014-2016 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/address/ipv4.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2015 MongoDB, Inc.
+# Copyright (C) 2014-2016 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/address/ipv6.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2015 MongoDB, Inc.
+# Copyright (C) 2014-2016 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/address/unix.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2015 MongoDB, Inc.
+# Copyright (C) 2014-2016 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/auth.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2015 MongoDB, Inc.
+# Copyright (C) 2014-2016 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/auth/cr.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2015 MongoDB Inc.
+# Copyright (C) 2014-2016 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/auth/ldap.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2015 MongoDB Inc.
+# Copyright (C) 2014-2016 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/auth/roles.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2015 MongoDB, Inc.
+# Copyright (C) 2014-2016 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/auth/user.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2015 MongoDB Inc.
+# Copyright (C) 2014-2016 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/auth/user/view.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2015 MongoDB, Inc.
+# Copyright (C) 2014-2016 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -44,7 +44,7 @@ module Mongo
           Operation::Write::CreateUser.new(
             user: user,
             db_name: database.name
-          ).execute(next_primary.context)
+          ).execute(next_primary)
         end
 
         # Initialize the new user view.
@@ -73,7 +73,7 @@ module Mongo
           Operation::Write::RemoveUser.new(
             user_name: name,
             db_name: database.name
-          ).execute(next_primary.context)
+          ).execute(next_primary)
         end
 
         # Update a user in the database.
@@ -92,7 +92,7 @@ module Mongo
           Operation::Write::UpdateUser.new(
             user: user,
             db_name: database.name
-          ).execute(next_primary.context)
+          ).execute(next_primary)
         end
 
         # Get info for a particular user in the database.
@@ -115,7 +115,7 @@ module Mongo
           Operation::Commands::UserQuery.new(
             user_name: name,
             db_name: database.name
-          ).execute(next_primary.context)
+          ).execute(next_primary)
         end
 
         def generate(user, options)

data/lib/mongo/auth/x509.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2015 MongoDB Inc.
+# Copyright (C) 2014-2016 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/bson.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2016 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/bulk_write.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2015 MongoDB, Inc.
+# Copyright (C) 2014-2016 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -169,7 +169,7 @@ module Mongo
     def delete(documents, server, operation_id)
       Operation::Write::Bulk::Delete.new(
         base_spec(operation_id).merge(:deletes => documents)
-      ).execute(server.context)
+      ).execute(server)
     end
 
     alias :delete_one :delete
@@ -178,13 +178,13 @@ module Mongo
     def insert_one(documents, server, operation_id)
       Operation::Write::Bulk::Insert.new(
         base_spec(operation_id).merge(:documents => documents)
-      ).execute(server.context)
+      ).execute(server)
     end
 
     def update(documents, server, operation_id)
       Operation::Write::Bulk::Update.new(
         base_spec(operation_id).merge(:updates => documents)
-      ).execute(server.context)
+      ).execute(server)
     end
 
     alias :replace_one :update

data/lib/mongo/bulk_write/combineable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2016 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/bulk_write/ordered_combiner.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2016 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/bulk_write/result.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2016 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/bulk_write/result_combiner.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2016 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/bulk_write/transformable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2016 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/bulk_write/unordered_combiner.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2016 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/bulk_write/validatable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2016 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/client.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2015 MongoDB, Inc.
+# Copyright (C) 2014-2016 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -226,7 +226,7 @@ module Mongo
     #
     # @since 2.0.0
     def read_preference
-      @read_preference ||= ServerSelector.get(Options::Redacted.new(options[:read] || {}).merge(options))
+      @read_preference ||= ServerSelector.get(options[:read] || ServerSelector::PRIMARY)
     end
 
     # Use the database with the provided name. This will switch the current

data/lib/mongo/cluster.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2015 MongoDB, Inc.
+# Copyright (C) 2014-2016 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,6 +13,7 @@
 # limitations under the License.
 
 require 'mongo/cluster/topology'
+require 'mongo/cluster/cursor_reaper'
 
 module Mongo
 
@@ -42,6 +43,7 @@ module Mongo
     attr_reader :topology
 
     def_delegators :topology, :replica_set?, :replica_set_name, :sharded?, :single?, :unknown?
+    def_delegators :@cursor_reaper, :register_cursor, :schedule_kill_cursor, :unregister_cursor
 
     # Determine if this cluster of servers is equal to another object. Checks the
     # servers currently in the cluster, not what was configured.
@@ -113,6 +115,10 @@ module Mongo
       subscribe_to(Event::PRIMARY_ELECTED, Event::PrimaryElected.new(self))
 
       seeds.each{ |seed| add(seed) }
+
+      @cursor_reaper = CursorReaper.new
+      @cursor_reaper.run!
+
       ObjectSpace.define_finalizer(self, self.class.finalize(pools))
     end
 
@@ -130,6 +136,8 @@ module Mongo
     # @since 2.2.0
     def self.finalize(pools)
       proc do
+        begin; @cursor_reaper.kill_cursors; rescue; end
+        @cursor_reaper.stop!
         pools.values.each do |pool|
           pool.disconnect!
         end
@@ -159,7 +167,8 @@ module Mongo
     #
     # @since 2.0.0
     def next_primary(ping = true)
-      ServerSelector.get(ServerSelector::PRIMARY.merge(options)).select_server(self, ping)
+      @primary_selector ||= ServerSelector.get(ServerSelector::PRIMARY)
+      @primary_selector.select_server(self, ping)
     end
 
     # Elect a primary server from the description that has just changed to a
@@ -287,6 +296,8 @@ module Mongo
     #
     # @since 2.1.0
     def disconnect!
+      begin; @cursor_reaper.kill_cursors; rescue; end
+      @cursor_reaper.stop!
       @servers.each { |server| server.disconnect! } and true
     end
 
@@ -300,7 +311,8 @@ module Mongo
     # @since 2.1.0
     def reconnect!
       scan!
-      servers.each { |server| server.reconnect! } and true
+      servers.each { |server| server.reconnect! }
+      @cursor_reaper.restart! and true
     end
 
     # Add hosts in a description to the cluster.

data/lib/mongo/cluster/cursor_reaper.rb

@@ -0,0 +1,174 @@
+# Copyright (C) 2014-2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'set'
+
+module Mongo
+  class Cluster
+
+    # A manager that sends kill cursors operations at regular intervals to close
+    # cursors that have been garbage collected without being exhausted.
+    #
+    # @since 2.3.0
+    class CursorReaper
+      extend Forwardable
+      include Retryable
+
+      # The default time interval for the cursor reaper to send pending kill cursors operations.
+      #
+      # @since 2.3.0
+      FREQUENCY = 1.freeze
+
+      # Create a cursor reaper.
+      #
+      # @example Create a CursorReaper.
+      #   Mongo::Cluster::CursorReaper.new(cluster)
+      #
+      # @api private
+      #
+      # @since 2.3.0
+      def initialize
+        @to_kill = {}
+        @active_cursors = Set.new
+        @mutex = Mutex.new
+      end
+
+      # Start the cursor reaper's thread.
+      #
+      # @example Start the cursor reaper's thread.
+      #   reaper.run!
+      #
+      # @api private
+      #
+      # @since 2.3.0
+      def run!
+        @thread && @thread.alive? ? @thread : start!
+      end
+      alias :restart! :run!
+
+      # Schedule a kill cursors operation to be eventually executed.
+      #
+      # @example Schedule a kill cursors operation.
+      #   cursor_reaper.schedule_kill_cursor(id, op_spec, server)
+      #
+      # @param [ Integer ] id The id of the cursor to kill.
+      # @param [ Hash ] op_spec The spec for the kill cursors op.
+      # @param [ Mongo::Server ] server The server to send the kill cursors operation to.
+      #
+      # @api private
+      #
+      # @since 2.3.0
+      def schedule_kill_cursor(id, op_spec, server)
+        @mutex.synchronize do
+          if @active_cursors.include?(id)
+            @to_kill[server] ||= Set.new
+            @to_kill[server] << op_spec
+          end
+        end
+      end
+
+      # Register a cursor id as active.
+      #
+      # @example Register a cursor as active.
+      #   cursor_reaper.register_cursor(id)
+      #
+      # @param [ Integer ] id The id of the cursor to register as active.
+      #
+      # @api private
+      #
+      # @since 2.3.0
+      def register_cursor(id)
+        if id && id > 0
+          @mutex.synchronize do
+            @active_cursors << id
+          end
+        end
+      end
+
+      # Unregister a cursor id, indicating that it's no longer active.
+      #
+      # @example Unregister a cursor.
+      #   cursor_reaper.unregister_cursor(id)
+      #
+      # @param [ Integer ] id The id of the cursor to unregister.
+      #
+      # @api private
+      #
+      # @since 2.3.0
+      def unregister_cursor(id)
+        @mutex.synchronize do
+          @active_cursors.delete(id)
+        end
+      end
+
+      # Stop the cursor reaper's thread.
+      #
+      # @example Stop the cursor reaper's thread.
+      #   reaper.stop!
+      #
+      # @api private
+      #
+      # @since 2.3.0
+      def stop!
+        @thread.kill && @thread.stop?
+      end
+
+      # Execute all pending kill cursors operations.
+      #
+      # @example Execute pending kill cursors operations.
+      #   cursor_reaper.kill_cursors
+      #
+      # @api private
+      #
+      # @since 2.3.0
+      def kill_cursors
+        to_kill_copy = {}
+        active_cursors_copy = []
+
+        @mutex.synchronize do
+          to_kill_copy = @to_kill.dup
+          active_cursors_copy = @active_cursors.dup
+          @to_kill = {}
+        end
+
+        to_kill_copy.each do |server, op_specs|
+          op_specs.each do |op_spec|
+            if server.features.find_command_enabled?
+              Cursor::Builder::KillCursorsCommand.update_cursors(op_spec, active_cursors_copy.to_a)
+              if Cursor::Builder::KillCursorsCommand.get_cursors_list(op_spec).size > 0
+                Operation::Commands::Command.new(op_spec).execute(server)
+              end
+            else
+              Cursor::Builder::OpKillCursors.update_cursors(op_spec, active_cursors_copy.to_a)
+              if Cursor::Builder::OpKillCursors.get_cursors_list(op_spec).size > 0
+                Operation::KillCursors.new(op_spec).execute(server)
+              end
+            end
+          end
+        end
+      end
+
+      private
+
+      def start!
+        @thread = Thread.new(FREQUENCY) do |i|
+          loop do
+            sleep(i)
+            kill_cursors
+          end
+        end
+      end
+    end
+  end
+end