mongoid_connection_pool 1.0.2 → 1.0.3

data/README.md

@@ -1,12 +1,13 @@
 # MongoidConnectionPool
 
-If you have ever use Mongoid in a threaded environment such as Sidekiq
-with Rubinius or JRuby, you will quickly find out that it is not safe to use Mongoid.
+If you ever use Mongoid in a threaded environment such as Sidekiq with Rubinius
+or JRuby you will quickly find out that Mongoid does not handle DB connections
+well.
 
 Mongoid by default gives every thread it's own database connection and doesn't
 clean up after itself, so these connections remain open.
 MongoDB will quickly become overloaded and you will no longer be able to connect.
-Often times MongoDB will also likely crash.
+Often times MongoDB itself will also crash.
 
 This gem monkey patches Mongoid (>= 3.1 < 4.0) to add connection pooling.
 We take over how Mongoid handles it's connections, so there is nothing you need
@@ -18,7 +19,7 @@ implementation of connection pooling.
 This is all well and good but it is still as of yet to be released, and won't
 be supported on Mongoid versions < 4.0 (also unreleased).
 
-This monkey patche passes all of Mongoid's specs.
+This monkey patch passes all of Mongoid's specs.
 
 ## Installation
 
@@ -38,6 +39,31 @@ Or install it yourself as:
 
 Just require mongoid_connection_pool AFTER Mongoid.  That's it.  Easy-peasy.
 
+Configure it for your environment with the following options:<br />
+session_pool_size: The max number of DB connections you want to have in the pool<br />
+session_checkout_timeout: Time for a thread to wait for a connection (in seconds) before timing out<br />
+session_reap_frequency: Time, in seconds, for the session to reap unused but checked out sessions
+```ruby
+Mongoid.configure do |config|
+    config.session_pool_size = 5
+    config.session_checkout_timeout = 3
+    config.session_reap_frequency = 3
+end
+```
+
+You can also take advantage of Mongoid.with_session method.
+This is similar to ActiveRecords 'with_connection'
+
+```ruby
+Mongoid.with_session do
+  # stuff
+end
+```
+With this you are explicitly checking out a connection and checking it back in
+once complete.
+
+You also no longer need to use Kiqstand, the Sidekiq Middleware for Mongoid.
+
 ## Contributing
 
 1. Fork it

data/lib/mongoid_connection_pool/mongoid/sessions/session_pool.rb

@@ -129,6 +129,7 @@ module Mongoid
 
       def clear(thread=nil)
         if thread
+          disconnect(thread)
           @reserved_sessions.delete(thread) if session_for(thread)
           @sessions.pop
         else
@@ -139,6 +140,19 @@ module Mongoid
         @reserved_sessions
       end
 
+      def disconnect(thread=Thread.current)
+        synchronize do
+          @session_pool.try(:each) do |name, pool|
+            if thread
+              pool.session_for(thread).try(:disconnect)
+            else
+              pool.sessions.try(:each) { |session| session.disconnect }
+            end
+          end
+        end
+        true
+      end
+
       def checkin_from_thread(thread)
         checkin @reserved_sessions[thread]
         true

data/lib/mongoid_connection_pool/mongoid/sessions.rb

@@ -22,11 +22,17 @@ module Mongoid
         @session_pool[name]
       end
 
-      def disconnect
+      def disconnect(thread=Thread.current)
         synchronize do
-          session_pool.each {|s| s.disconnect}
-          @session_pool = nil
+          @session_pool.try(:each) do |name, pool|
+            if thread
+              pool.session_for(thread).try(:disconnect)
+            else
+              pool.sessions.try(:each) { |session| session.disconnect }
+            end
+          end
         end
+        true
       end
 
       def with_name(name)

data/lib/mongoid_connection_pool/version.rb

@@ -1,3 +1,3 @@
 module MongoidConnectionPool
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/spec/sessions_spec.rb

@@ -0,0 +1,8 @@
+describe Mongoid::Sessions do
+  describe '.disconnect' do
+    it "does not lock up when no sessions are created" do
+      Mongoid::Sessions.instance_variable_set('@session_pool', nil)
+      expect(Mongoid::Sessions.disconnect).to_not raise_error
+    end
+  end
+end

metadata

@@ -1,71 +1,76 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_connection_pool
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
+  prerelease: 
 platform: ruby
 authors:
 - Brian Goff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-12 00:00:00.000000000 Z
+date: 2013-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  type: :development
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  type: :development
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
+        version: '0'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  type: :development
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
+        version: '0'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mongoid
-  prerelease: false
-  type: :runtime
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.1.0
+  type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -90,33 +95,34 @@ files:
 - lib/mongoid_connection_pool/version.rb
 - mongoid_connection_pool.gemspec
 - spec/session_pool_spec.rb
+- spec/sessions_spec.rb
 - spec/spec_helper.rb
 homepage: http://www.github.com/cpuguy83/mongoid_connection_pool
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: !binary |-
-        MA==
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: !binary |-
-        MA==
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 1.8.24
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Provides connection pooling for Mongoid
 test_files:
 - spec/session_pool_spec.rb
+- spec/sessions_spec.rb
 - spec/spec_helper.rb

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YzQ5Y2MxMTY1YmMyODFjNTI0YzQ5MDQ4NjhkM2VmNDRiYTExYjY2ZA==
-  data.tar.gz: !binary |-
-    MTMzZTMwYzZjNTlkYTcyMGZjYWJhMTI3ZmNkZDUyNGEwYTMwMzAwNA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    MzRhMmIwYmY5NmI2YzQ0YzExNzAwMTE4NjA5MjRlMTQ2OTAxMDRhOTU1MzMy
-    ZDA2ZmYzMTc4OGY2NGRmNmVjYWM2MWNmYWUzYWU0YjU5YmI2ZjA5OWM4ZWMw
-    Y2RmNDNjMGExNTAwYTlkZWFhMDBlNzY0MzkzMTI1MmZlNzEzZjk=
-  data.tar.gz: !binary |-
-    YjI1NTkyODUwODQyODgxZTJiMTFjMzViNWIwM2M5OWZjMWQ5YWZmYWExM2Yx
-    MGQzZjEwYjJlMGJjMjM0NjE5ZGYwNTc3YzA5MjEwOWUzZjEyYmIzMWJkZGJm
-    ZGYzNmRiMWQ5ZDhlNDMzN2UxOThhYzJiNmU5ODcyMzYwZTVjMDU=