mongo 1.6.0 → 1.6.1

data/README.md

@@ -37,7 +37,7 @@ for much more:
 
 ### Ruby Versions
 
-The driver works and is consistently tested on Ruby 1.8.6, 1.8.7, and 1.9.2, and JRuby 1.5.1.
+The driver works and is consistently tested on Ruby 1.8.7 and 1.9.3 as well as JRuby 1.6.6.
 
 Note that if you're on 1.8.7, be sure that you're using a patchlevel >= 249. There
 are some IO bugs in earlier versions.
@@ -198,7 +198,7 @@ Here is a sample primary key factory, taken from the tests:
 
     class TestPKFactory
       def create_pk(row)
-        row['_id'] ||= Mongo::ObjectID.new
+        row['_id'] ||= BSON::ObjectId.new
         row
       end
     end
@@ -212,7 +212,7 @@ ActiveRecord-like framework for non-Rails apps) and the AR Mongo adapter code
       def create_pk(row)
         return row if row[:_id]
         row.delete(:_id)      # in case it exists but the value is nil
-        row['_id'] ||= Mongo::ObjectID.new
+        row['_id'] ||= BSON::ObjectId.new
         row
       end
     end
@@ -283,12 +283,9 @@ To run any individual rake tasks with the C extension enabled, just pass C_EXT=t
 
     $ rake test:unit C_EXT=true
 
-If you want to test replica set, you can run the following tests
-individually:
+If you want to test replica set, you can run the following task:
 
-    $ rake test:replica_set_count
-    $ rake test:replica_set_insert
-    $ rake test:replica_set_query
+    $ rake test:rs
 
 ### Shoulda and Mocha
 

data/Rakefile

@@ -3,15 +3,20 @@ if RUBY_VERSION < '1.9.0'
   require 'rubygems'
   require 'rubygems/specification'
 end
+
 require 'fileutils'
 require 'rake/testtask'
-require 'rbconfig'
 require 'rake'
+
+begin
+  require 'git'
+  rescue LoadError
+end
+
 begin
   require 'ci/reporter/rake/test_unit'
   rescue LoadError
 end
-include Config
 
 ENV['TEST_MODE'] = 'TRUE'
 
@@ -210,10 +215,12 @@ namespace :gem do
 
   desc "Build all gems"
   task :build_all do
+    `rm *.gem`
     `gem build mongo.gemspec`
     `gem build bson.gemspec`
     `gem build bson.java.gemspec`
     `gem build bson_ext.gemspec`
+    puts `ls *.gem`
   end
 
 end
@@ -228,6 +235,81 @@ namespace :ci do
   end
 end
 
+# Deployment
+VERSION_FILES = %w(lib/bson/version.rb lib/mongo/version.rb ext/cbson/version.h)
+GEMSPECS = %w(bson.gemspec bson.java.gemspec bson_ext.gemspec mongo.gemspec)
+
+def gem_list(version)
+  files = []
+  files << "bson-#{version}.gem"
+  files << "bson-#{version}-java.gem"
+  files << "bson_ext-#{version}.gem"
+  files << "mongo-#{version}.gem"
+  return files
+end
+
+def check_gem_list_existence(version)
+  gem_list(version).each do |filename|
+    if !File.exists?(filename)
+      raise "#{filename} does not exist!"
+    end
+  end
+end
+
+def check_version(version)
+  if !(version =~ /\d\.\d\.\d/)
+    raise "Must specify a valid version (e.g., x.y.z)"
+  end
+end
+
+def current_version
+  f = File.open("lib/mongo/version.rb")
+  str = f.read
+  str =~ /VERSION\s+=\s+([.\d"]+)$/
+  return $1
+end
+
+def change_version(new_version)
+  version = current_version
+  VERSION_FILES.each do |filename|
+    f = File.open(filename)
+    str = f.read
+    f.close
+    str.gsub!(version, "\"#{new_version}\"")
+    File.open(filename, 'w') do |f|
+      f.write(str)
+    end
+  end
+end
+
+namespace :deploy do
+  task :version, [:version] do |t, args|
+    check_version(args[:version])
+    puts args[:version]
+    change_version(args[:version])
+  end
+
+  task :git_prepare, [:version] do |t, args|
+    g = Git.open(Dir.getwd())
+    version = args[:version]
+    check_version(version)
+    g.add(VERSION_FILES)
+    g.commit "RELEASE #{version}"
+    g.add_tag("#{version}")
+  end
+
+  task :git_push do
+    g = Git.open(Dir.getwd())
+    g.push
+  end
+
+  task :gems, [:version] do |t, args|
+    check_version(args[:version])
+    check_gem_list_existence(args[:version])
+    gem_list
+  end
+end
+
 task :default => :list
 
 task :list do

data/docs/HISTORY.md

@@ -1,5 +1,13 @@
 # MongoDB Ruby Driver History
 
+### 1.6.1
+2012-03-07
+
+* Added thread affinity to Mongo::Pool
+* Added deploy tasks
+* Added Travis CI support (Cyril Mougel)
+* Logging warning message is only displayed for level :debug
+
 ### 1.6.0
 2012-02-22
 

data/docs/REPLICA_SETS.md

@@ -38,8 +38,16 @@ The driver will essentially cycle through all known seed addresses until a node
 You can now specify a refresh mode and refresh interval for a replica set connection. This will help to ensure that
 changes to a replica set's configuration are quickly reflected on the driver side. In particular, if you change
 the state of any secondary node, the automated refresh will ensure that this state is recorded on the client side.
+
+There are two secenarios in which refresh is helpful and does not raise exceptions:
+
+# You add a new secondary node to an existing replica set
+# You remove an unused secondary from an existing replica set
+
+If using MongoDB earlier than 2.0 any changes to replica set state will raise exceptions therefore refresh mode will not be useful.
+
 If you add a secondary that responds to pings much faster than the existing nodes, then the new secondary will
-be used for reads.
+be used for reads if :read_preference is :secondary or :secondary_only
 
 Refresh mode is disabled by default.
 

data/lib/mongo.rb

@@ -61,6 +61,7 @@ require 'mongo/util/pool'
 require 'mongo/util/pool_manager'
 require 'mongo/util/server_version'
 require 'mongo/util/ssl_socket'
+require 'mongo/util/tcp_socket'
 require 'mongo/util/uri_parser'
 
 require 'mongo/collection'

data/lib/mongo/connection.rb

@@ -33,6 +33,8 @@ module Mongo
     Thread.abort_on_exception = true
 
     DEFAULT_PORT = 27017
+    GENERIC_OPTS = [:ssl, :auths, :pool_size, :pool_timeout, :timeout, :op_timeout, :connect_timeout, :safe, :logger, :connect]
+    CONNECTION_OPTS = [:slave_ok]
 
     mongo_thread_local_accessor :connections
 
@@ -97,10 +99,18 @@ module Mongo
 
       # Host and port of current master.
       @host = @port = nil
+      
+      # Default maximum BSON object size
+      @max_bson_size = Mongo::DEFAULT_MAX_BSON_SIZE
+      
+      # Lock for request ids.
+      @id_lock = Mutex.new
+      
+      # Connection pool for primay node
+      @primary      = nil
+      @primary_pool = nil
 
-      # slave_ok can be true only if one node is specified
-      @slave_ok = opts[:slave_ok]
-
+      check_opts(opts)
       setup(opts)
     end
 
@@ -498,32 +508,41 @@ module Mongo
 
     # Check a socket back into its pool.
     def checkin(socket)
-      if @primary_pool
-        @primary_pool.checkin(socket)
+      if @primary_pool && socket
+        socket.pool.checkin(socket)
       end
     end
 
     protected
 
-    # Generic initialization code.
-    def setup(opts)
-      # Default maximum BSON object size
-      @max_bson_size = Mongo::DEFAULT_MAX_BSON_SIZE
+    def valid_opts
+      GENERIC_OPTS + CONNECTION_OPTS
+    end
+
+    def check_opts(opts)
+      bad_opts = opts.keys.reject { |opt| valid_opts.include?(opt) }
+
+      unless bad_opts.empty?
+        bad_opts.each {|opt| warn "#{opt} is not a valid option for #{self.class}"}
+      end
+    end
 
+    # Parse option hash
+    def setup(opts)
+      # slave_ok can be true only if one node is specified
+      @slave_ok = opts[:slave_ok]
+      
       # Determine whether to use SSL.
       @ssl = opts.fetch(:ssl, false)
       if @ssl
         @socket_class = Mongo::SSLSocket
       else
-        @socket_class = ::TCPSocket
+        @socket_class = Mongo::TCPSocket
       end
 
       # Authentication objects
       @auths = opts.fetch(:auths, [])
 
-      # Lock for request ids.
-      @id_lock = Mutex.new
-
       # Pool size and timeout.
       @pool_size = opts[:pool_size] || 1
       if opts[:timeout]
@@ -540,10 +559,6 @@ module Mongo
 
       # Global safe option. This is false by default.
       @safe = opts[:safe] || false
-      
-      # Connection pool for primay node
-      @primary      = nil
-      @primary_pool = nil
 
       @logger = opts.fetch(:logger, nil)
 

data/lib/mongo/cursor.rb

@@ -470,7 +470,7 @@ module Mongo
           Mongo::Constants::OP_QUERY, message, nil, sock, @command,
           nil, @options & OP_QUERY_EXHAUST != 0)
         rescue ConnectionFailure, OperationFailure, OperationTimeout => ex
-          force_checkin_socket(sock)
+          force_checkin_socket(sock) unless @socket
           raise ex
         end
         checkin_socket(sock) unless @socket

data/lib/mongo/gridfs/grid.rb

@@ -68,7 +68,7 @@ module Mongo
     # @return [BSON::ObjectId] the file's id.
     def put(data, opts={})
       opts     = opts.dup
-      filename = opts[:filename]
+      filename = opts.delete(:filename)
       opts.merge!(default_grid_io_opts)
       file = GridIO.new(@files, @chunks, filename, 'w', opts)
       file.write(data)

data/lib/mongo/repl_set_connection.rb

@@ -21,6 +21,9 @@ module Mongo
   # Instantiates and manages connections to a MongoDB replica set.
   class ReplSetConnection < Connection
 
+    REPL_SET_OPTS = [:read, :refresh_mode, :refresh_interval, :require_primary,
+      :read_secondary, :rs_name, :name]
+
     attr_reader :replica_set_name, :seeds, :refresh_interval, :refresh_mode,
       :refresh_version
 
@@ -33,7 +36,7 @@ module Mongo
     #
     # @param [Array] seeds "host:port" strings
     #
-    # @option opts [String] :rs_name (nil) The name of the replica set to connect to. You
+    # @option opts [String] :name (nil) The name of the replica set to connect to. You
     #   can use this option to verify that you're connecting to the right replica set.
     # @option opts [Boolean, Hash] :safe (false) Set the default safe-mode options
     #   propogated to DB objects instantiated off of this Connection. This
@@ -83,11 +86,11 @@ module Mongo
       else
         opts = {}
       end
-      
+
       unless args.length > 0
         raise MongoArgumentError, "A ReplSetConnection requires at least one seed node."
       end
-      
+
       # This is temporary until support for the old format is dropped
       @seeds = []
       if args.first.last.is_a?(Integer)
@@ -106,51 +109,33 @@ module Mongo
       @seeds.freeze
 
       # Refresh
-      @refresh_mode = opts.fetch(:refresh_mode, false)
-      @refresh_interval = opts[:refresh_interval] || 90
       @last_refresh = Time.now
       @refresh_version = 0
 
       # No connection manager by default.
       @manager = nil
-      @pool_mutex = Mutex.new
+      @old_managers = []
 
-      if @refresh_mode == :async
-        warn ":async refresh mode has been deprecated. Refresh
-        mode will be disabled."
-      elsif ![:sync, false].include?(@refresh_mode)
-        raise MongoArgumentError,
-          "Refresh mode must be either :sync or false."
-      end
-
-      # Are we allowing reads from secondaries?
-      if opts[:read_secondary]
-        warn ":read_secondary options has now been deprecated and will " +
-          "be removed in driver v2.0. Use the :read option instead."
-        @read_secondary = opts.fetch(:read_secondary, false)
-        @read = :secondary
-      else
-        @read = opts.fetch(:read, :primary)
-        Mongo::Support.validate_read_preference(@read)
-      end
+      # Lock for request ids.
+      @id_lock = Mutex.new
 
+      @pool_mutex = Mutex.new
       @connected = false
 
-      # Replica set name
-      if opts[:rs_name]
-        warn ":rs_name option has been deprecated and will be removed in v2.0. " +
-          "Please use :name instead."
-        @replica_set_name = opts[:rs_name]
-      else
-        @replica_set_name = opts[:name]
-      end
+      @safe_mutex_lock = Mutex.new
+      @safe_mutexes = Hash.new {|hash, key| hash[key] = Mutex.new}
 
-      # Require a primary node to connect?
-      @require_primary = opts.fetch(:require_primary, true)
+      @connect_mutex = Mutex.new
+      @refresh_mutex = Mutex.new
 
+      check_opts(opts)
       setup(opts)
     end
 
+    def valid_opts
+      GENERIC_OPTS + REPL_SET_OPTS
+    end
+
     def inspect
       "<Mongo::ReplSetConnection:0x#{self.object_id.to_s(16)} @seeds=#{@seeds.inspect} " +
         "@connected=#{@connected}>"
@@ -159,22 +144,26 @@ module Mongo
     # Initiate a connection to the replica set.
     def connect
       log(:info, "Connecting...")
-      return if @connected
-
-      discovered_seeds = @manager ? @manager.seeds : []
-      @manager = PoolManager.new(self, discovered_seeds)
-
-      @manager.connect
-      @refresh_version += 1
-
-      if @require_primary && self.primary.nil? #TODO: in v2.0, we'll let this be optional and do a lazy connect.
-        close
-        raise ConnectionFailure, "Failed to connect to primary node."
-      elsif self.read_pool.nil?
-        close
-        raise ConnectionFailure, "Failed to connect to any node."
-      else
-        @connected = true
+      @connect_mutex.synchronize do
+        return if @connected
+
+        discovered_seeds = @manager ? @manager.seeds : []
+        @manager = PoolManager.new(self, discovered_seeds)
+        
+        Thread.current[:manager] = @manager
+
+        @manager.connect
+        @refresh_version += 1
+
+        if @require_primary && @manager.primary.nil? #TODO: in v2.0, we'll let this be optional and do a lazy connect.
+          close
+          raise ConnectionFailure, "Failed to connect to primary node."
+        elsif @manager.read_pool.nil?
+          close
+          raise ConnectionFailure, "Failed to connect to any node."
+        else
+          @connected = true
+        end
       end
     end
 
@@ -211,19 +200,21 @@ module Mongo
     def hard_refresh!
       log(:info, "Initiating hard refresh...")
       discovered_seeds = @manager ? @manager.seeds : []
-      background_manager = PoolManager.new(self, discovered_seeds | @seeds)
-      background_manager.connect
+      new_manager = PoolManager.new(self, discovered_seeds | @seeds)
+      new_manager.connect
+
+      Thread.current[:manager] = new_manager
 
       # TODO: make sure that connect has succeeded
-      old_manager = @manager
-      @manager = background_manager
-      old_manager.close(:soft => true)
+      @old_managers << @manager
+      @manager = new_manager
+
       @refresh_version += 1
       return true
     end
 
     def connected?
-      @connected && (self.primary_pool || self.read_pool)
+      @connected && (@manager.primary_pool || @manager.read_pool)
     end
 
     # @deprecated
@@ -236,14 +227,14 @@ module Mongo
     #
     # @return [String]
     def host
-      self.primary_pool.host
+      @manager.primary_pool.host
     end
 
     # The replica set primary's port.
     #
     # @return [Integer]
     def port
-      self.primary_pool.port
+      @manager.primary_pool.port
     end
 
     def nodes
@@ -257,7 +248,7 @@ module Mongo
     #
     # @return [Boolean]
     def read_primary?
-      self.read_pool == self.primary_pool
+      @manager.read_pool == @manager.primary_pool
     end
     alias :primary? :read_primary?
 
@@ -296,105 +287,84 @@ module Mongo
     end
 
     def authenticate_pools
-      self.primary_pool.authenticate_existing
-      self.secondary_pools.each do |pool|
+      primary_pool.authenticate_existing
+      secondary_pools.each do |pool|
         pool.authenticate_existing
       end
     end
 
     def logout_pools(db)
-      self.primary_pool.logout_existing(db)
-      self.secondary_pools.each do |pool|
+      primary_pool.logout_existing(db)
+      secondary_pools.each do |pool|
         pool.logout_existing(db)
       end
     end
 
-    # Checkout a socket for reading (i.e., a secondary node).
-    # Note that @read_pool might point to the primary pool
-    # if no read pool has been defined.
-    def checkout_reader
+    # Generic socket checkout
+    # Takes a block that returns a socket from pool
+    def checkout(&block)
       if connected?
         sync_refresh
       else
         connect
       end
+      
       begin
-        socket = get_socket_from_pool(self.read_pool)
-        if !socket
-          connect
-          socket = get_socket_from_pool(self.primary_pool)
-        end
+        socket = block.call
       rescue => ex
         checkin(socket) if socket
         raise ex
       end
-
+      
       if socket
         socket
       else
-        raise ConnectionFailure.new("Could not connect to a node for reading.")
+        @connected = false
+        raise ConnectionFailure.new("Could not checkout a socket.")
       end
     end
     
-    def checkout_secondary
-      if connected?
-        sync_refresh
-      else
-        connect
-      end
-      begin
-        socket = get_socket_from_pool(self.secondary_pool)
-      rescue => ex
-        checkin(socket) if socket
-        raise ex
+    # Checkout a socket for reading (i.e., a secondary node).
+    # Note that @read_pool might point to the primary pool
+    # if no read pool has been defined.
+    def checkout_reader
+      checkout do
+        socket = get_socket_from_pool(:read)
+        if !socket
+          connect
+          socket = get_socket_from_pool(:primary)
+        end
+        socket
       end
+    end
 
-      if socket
-        socket
-      else
-        raise ConnectionFailure.new("Could not connect to a secondary for reading.")
+    # Checkout a socket from a secondary
+    # For :read_preference => :secondary_only
+    def checkout_secondary
+      checkout do
+        get_socket_from_pool(:secondary)
       end
     end
 
     # Checkout a socket for writing (i.e., a primary node).
     def checkout_writer
-      if connected?
-        sync_refresh
-      else
-        connect
-      end
-      begin
-        socket = get_socket_from_pool(self.primary_pool)
-
-        if !socket
-          connect
-          socket = get_socket_from_pool(self.primary_pool)
-        end
-      rescue => ex
-        checkin(socket)
-        raise ex
-      end
-
-      if socket
-        socket
-      else
-        raise ConnectionFailure.new("Could not connect to primary node.")
+      checkout do
+        get_socket_from_pool(:primary)
       end
     end
 
     # Checkin a socket used for reading.
     def checkin_reader(socket)
-      if !((self.read_pool && self.read_pool.checkin(socket)) ||
-        (self.primary_pool && self.primary_pool.checkin(socket)))
-        close_socket(socket)
+      if socket
+        socket.pool.checkin(socket)
       end
       sync_refresh
     end
 
     # Checkin a socket used for writing.
     def checkin_writer(socket)
-      if !self.primary_pool || !self.primary_pool.checkin(socket)
-        close_socket(socket)
+      if socket
+        socket.pool.checkin(socket)
       end
       sync_refresh
     end
@@ -407,58 +377,74 @@ module Mongo
       end
     end
 
-    def get_socket_from_pool(pool)
+    def get_socket_from_pool(pool_type)
+      if Thread.current[:manager] != @manager
+        Thread.current[:manager] = @manager
+      end
+      
+      pool = case pool_type
+        when :primary
+          primary_pool
+        when :secondary
+          secondary_pool
+        when :read
+          read_pool
+      end
+
       begin
         if pool
-          socket = pool.checkout
-          socket
+          pool.checkout
         end
       rescue ConnectionFailure => ex
         log(:info, "Failed to checkout from #{pool} with #{ex.class}; #{ex.message}")
         return nil
       end
     end
+    
+    def local_manager
+      Thread.current[:manager]
+    end
 
     def arbiters
-      @manager.arbiters.nil? ? [] : @manager.arbiters
+      local_manager.arbiters.nil? ? [] : local_manager.arbiters
     end
 
     def primary
-      @manager ? @manager.primary : nil
+      local_manager ? local_manager.primary : nil
     end
 
     # Note: might want to freeze these after connecting.
     def secondaries
-      @manager ? @manager.secondaries : []
+      local_manager ? local_manager.secondaries : []
     end
 
     def hosts
-      @manager ? @manager.hosts : []
+      local_manager ? local_manager.hosts : []
     end
 
     def primary_pool
-      @manager ? @manager.primary_pool : nil
+      local_manager ? local_manager.primary_pool : nil
     end
 
     def read_pool
-      @manager ? @manager.read_pool : nil
+      local_manager ? local_manager.read_pool : nil
     end
-    
+
     def secondary_pool
-      @manager ? @manager.secondary_pool : nil
+      local_manager ? local_manager.secondary_pool : nil
     end
 
     def secondary_pools
-      @manager ? @manager.secondary_pools : []
+      local_manager ? local_manager.secondary_pools : []
     end
 
     def tag_map
-      @manager ? @manager.tag_map : {}
+      local_manager ? local_manager.tag_map : {}
     end
 
     def max_bson_size
-      if @manager && @manager.max_bson_size
-        @manager.max_bson_size
+      if local_manager && local_manager.max_bson_size
+        local_manager.max_bson_size
       else
         Mongo::DEFAULT_MAX_BSON_SIZE
       end
@@ -466,13 +452,45 @@ module Mongo
 
     private
 
-    # Generic initialization code.
+    # Parse option hash
     def setup(opts)
-      @safe_mutex_lock = Mutex.new
-      @safe_mutexes = Hash.new {|hash, key| hash[key] = Mutex.new}
-      
+      # Require a primary node to connect?
+      @require_primary = opts.fetch(:require_primary, true)
+
+      # Refresh
+      @refresh_mode = opts.fetch(:refresh_mode, false)
+      @refresh_interval = opts[:refresh_interval] || 90
+
+      if @refresh_mode == :async
+        warn ":async refresh mode has been deprecated. Refresh
+        mode will be disabled."
+      elsif ![:sync, false].include?(@refresh_mode)
+        raise MongoArgumentError,
+          "Refresh mode must be either :sync or false."
+      end
+
+      # Are we allowing reads from secondaries?
+      if opts[:read_secondary]
+        warn ":read_secondary options has now been deprecated and will " +
+          "be removed in driver v2.0. Use the :read option instead."
+        @read_secondary = opts.fetch(:read_secondary, false)
+        @read = :secondary
+      else
+        @read = opts.fetch(:read, :primary)
+        Mongo::Support.validate_read_preference(@read)
+      end
+
+      # Replica set name
+      if opts[:rs_name]
+        warn ":rs_name option has been deprecated and will be removed in v2.0. " +
+          "Please use :name instead."
+        @replica_set_name = opts[:rs_name]
+      else
+        @replica_set_name = opts[:name]
+      end
+
       opts[:connect_timeout] = opts[:connect_timeout] || 30
-      
+
       super opts
     end
 
@@ -493,12 +511,32 @@ module Mongo
       raise NodeWithTagsNotFound,
         "Could not find a connection tagged with #{tags}."
     end
+    
+    def prune_managers
+      @old_managers.each do |manager|
+        if manager != @manager
+          if manager.closed?
+            @old_managers.delete(manager)
+          else
+            manager.close(:soft => true)
+          end
+        end
+      end
+    end
 
     def sync_refresh
       if @refresh_mode == :sync &&
         ((Time.now - @last_refresh) > @refresh_interval)
         @last_refresh = Time.now
-        refresh
+        
+        if @refresh_mutex.try_lock
+          begin
+            refresh
+            prune_managers
+          ensure
+            @refresh_mutex.unlock
+          end
+        end
       end
     end
   end