rails_is_forked 0.0.1

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+  gem "activerecord", ">= 3.0.3"
+  gem "pg"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kurt Stephens
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,103 @@
+= rails_is_forked
+
+Rails does not clear ConnectionPool and reestablish connections in Process.fork children:
+
+  puts "Parent: #{$$}: #{ActiveRecord::Base.connection.object_id}"
+  fork { puts "Child: #{$$}: #{ActiveRecord::Base.connection.object_id}" }
+  puts "Parent after fork: #{$$}: #{ActiveRecord::Base.connection.object_id}"
+  Thread.new { puts "Thread: #{ActiveRecord::Base.connection.object_id}" }
+
+Sample Output:
+
+  Parent: 27282: 153210860
+  Child: 29777: 153210860
+  Parent after fork: 27282: 153210860
+  Thread: 153076390
+
+Note that Threads get their own connections, but subprocesses do not.
+
+A ConnectionPool exists for each ActiveRecord::Base subclass that has been sent #establish_connection.
+
+  puts "Parent #{$$}: #{ActiveRecord::Base.connection_pool.object_id}"
+  fork { puts "Child: #{$$}: #{ActiveRecord::Base.connection_pool.object_id}" }
+  Thread.new { puts "Thread: #{ActiveRecord::Base.connection_pool.object_id}" }
+
+Sample Output:
+
+  Parent 30003: 102371950
+  Child: 30053: 102371950
+  Thread: 102371950
+
+Note that ConnectionPools are only unique per process.
+
+Using rails_is_forked:
+
+  require 'rails_is_forked/rails'
+  puts "Parent #{$$}: #{ActiveRecord::Base.connection.object_id}"
+  fork { puts "Child: #{$$}: #{ActiveRecord::Base.connection.object_id}" }
+  puts "Parent after fork: #{$$}: #{ActiveRecord::Base.connection.object_id}"
+  Thread.new { puts "Thread: #{ActiveRecord::Base.connection.object_id}" }
+
+Sample Output:
+
+  Parent 31583: 90260550
+  Child: 31627: 152197900
+  Parent after fork: 31583: 90260550
+  Thread: 151738880
+
+== Strategy
+
+The naive solution is #disconnect! all database connections at the beginning of each 
+forked child process.  However the child will likely send "termination commands" to a database handle that is still active in the parent.
+
+The database handle's FD is shared between the parent process and its children; its resources are not likely to be reclaimed in the database server until all processes close() their FDs.  
+
+Another "portable" solution is to #disconnect! all the connections in the parent process *before* forking the children.  This doesn't require digging deep into each and every database adapter.   However this is likely to cause problems if the parent is in an active transaction when the child is forked.
+
+At the risk of leaking memory and FDs in long running child processes, a safe solution is to "forget", not #disconnect!, all connections at the beginning of the forked child processes.  The GC should eventually reap the ActiverRecord connection and the underlying handle, but may leave the FD still open, until the child process dies, because ActiveRecord connections and database handles do not have finalizers.
+
+If a database handle has a finalizer and it sends "termination commands", forgetting connections in the child could still affect parent processes.
+
+The correct solution is: close the FDs in the database handles and forget the connections in the child. 
+
+However, most database connection adapters and APIs do not provide mechanisms for:
+
+1) closing the low-level file descriptor (FD),
+2) resetting the database client library handle (ex: gem pg) without sending a "termination command" along the FD, as this is usually done in the database client code (see libpq sources for "X"),
+3) automatically reconnecting the database handle after the FD has been closed.
+
+Database client handles should:
+
+1) have a notion of the "owning process id" of the handle.
+2) send "termination commands" only if the current process is the owning process.
+3) should have a "close" method, that simply closes its FD, but does not send "termination commands".
+4) should call "close" or "disconnect" on finalization, depending on if the handle is owned by the current process or not.
+
+ActiveRecord connection objects should disconnect database handles on finalization.
+
+For long-running child processes, it's probably best for the parent process to forcefully #disconnect! (and remove from their ConnectionPools) all its connections, before forking children and outside a transaction, to insure there are no connections leaked in the children.  This can be done by calling ActiveRecord::Base.connection_handler.clear_all_connections! before Process.fork.
+
+== Functionality
+
+* RailsIsForked::Rails
+** Calls ActiveRecord::ConnectionAdapters::ConnectionPool#disconnect! for all instances in forked children.  See ActiveRecord::Base.connection_handler.connection_pools.
+
+== See Also
+
+* http://github.com/kstephens/ruby_is_forked
+
+== Contributing to rails_is_forked
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Kurt Stephens. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rails_is_forked"
+  gem.homepage = "http://github.com/kstephens/rails_is_forked"
+  gem.license = "MIT"
+  gem.summary = %Q{Deal with resources (DB connections, etc) in forked Rails processes.}
+  gem.description = %Q{See http://github.com/kstephens/rails_is_forked}
+  gem.email = "ks.github@kurtstephens.com"
+  gem.authors = ["Kurt Stephens"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = [ '-f', 'd' ]
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rails_is_forked #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/rails_is_forked.rb

@@ -0,0 +1,5 @@
+require 'ruby_is_forked/fork_callback'
+module RailsIsForked
+  ForkCallback = ::RubyIsForked::ForkCallback # alias
+end
+require 'rails_is_forked/rails'

data/lib/rails_is_forked/rails.rb

@@ -0,0 +1,57 @@
+require 'ruby_is_forked/fork_callback'
+
+require 'active_record/connection_adapters/abstract/connection_pool'
+
+module RailsIsForked
+  module ConnectionPoolDisconnectOnFork
+    @@once = false
+
+    def self.included target
+      super
+
+      return if @@once
+      @@once = true
+
+if true
+      # Register callback to call forget connections in child processes.
+      proc = RubyIsForked::ForkCallback.add_callback_in_child! do | child_pid |
+        ActiveRecord::Base.connection_handler.connection_pools.each_value do | pool |
+          # Naive solution:
+          # pool.disconnect!
+          #
+          # This causes the following error in the parent:
+          # PGError: server closed the connection unexpectedly
+          # This probably means the server terminated abnormally
+          # before or while processing the request.
+
+          # Simplest solution:
+          pool.forget_all_connections!
+        end
+      end
+else
+      # Naive solution:
+      # Register callback to disconnect connections before forking child processes.
+      #
+      # This cause the parent to fail if fork occurs with a transaction:
+      # Failure/Error: ActiveRecord::Base.transaction do
+      # not connected
+      #
+      proc = RubyIsForked::ForkCallback.add_callback_before_child! do | child_pid |
+        ActiveRecord::Base.connection_handler.clear_all_connections!
+      end
+end
+      # $stderr.puts "Registered callback #{proc}"
+    end
+
+    # Forgets all reserved connections and live connections,
+    # without calling #disconnect! on each of them.
+    # See also #disconnect!
+    def forget_all_connections!
+      @reserved_connections = {}
+      @connections = []
+    end
+
+   ::ActiveRecord::ConnectionAdapters::ConnectionPool.send(:include, self)
+  end
+end
+

data/spec/rails_is_forked/rails_spec.rb

@@ -0,0 +1,72 @@
+unless ENV['RAILS_DATABASE_YML']
+  $stderr.puts "#{__FILE__}: enable test with: export RAILS_DATABASE_YML=.../database.yml"
+else
+  require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+  require 'rubygems'
+  gem 'activerecord'
+  require 'active_record'
+  require 'rails_is_forked/rails'
+  
+  describe "RailsIsForked::Rails" do
+    
+    before(:all) do
+      spec = ENV["RAILS_DATABASE_YML"]
+      spec = YAML.load_file(spec)
+      spec = spec[ENV['RAILS_ENV'] || 'development']
+      case spec['adapter']
+      when 'postgresql'
+        gem 'pg'; require 'pg'
+      end
+      ActiveRecord::Base.establish_connection(spec)
+    end
+    
+    it "should make forked children acquire new db connections." do
+      parent_connection = ActiveRecord::Base.connection
+      parent_connection_obj = parent_connection.instance_variable_get('@connection')
+      read_pipe, write_pipe = IO.pipe
+      Process.fork do 
+        read_pipe.close
+        child_connection = ActiveRecord::Base.connection
+        child_connection_obj = child_connection.instance_variable_get('@connection')
+        write_pipe.write(Marshal.dump([child_connection.object_id, child_connection_obj.object_id]))
+        write_pipe.close
+      end
+      write_pipe.close
+      child_connection_object_id, child_connection_obj_object_id = Marshal.load(read_pipe.read)
+      read_pipe.close
+      child_connection_object_id.should_not == parent_connection.object_id
+      child_connection_obj_object_id.should_not == parent_connection_obj.object_id
+      
+      if true # not disconnect! before fork
+        ActiveRecord::Base.connection.object_id.should == parent_connection.object_id
+        ActiveRecord::Base.connection.instance_variable_get('@connection').object_id.should == parent_connection_obj.object_id
+      end
+    end
+    
+    it "should handle forks within a transaction." do
+      ActiveRecord::Base.transaction do
+        parent_connection = ActiveRecord::Base.connection
+        parent_connection_obj = parent_connection.instance_variable_get('@connection')
+        read_pipe, write_pipe = IO.pipe
+        Process.fork do 
+          read_pipe.close
+          child_connection = ActiveRecord::Base.connection
+          child_connection_obj = child_connection.instance_variable_get('@connection')
+          write_pipe.write(Marshal.dump([child_connection.object_id, child_connection_obj.object_id]))
+          write_pipe.close
+        end
+        write_pipe.close
+        child_connection_object_id, child_connection_obj_object_id = Marshal.load(read_pipe.read)
+        read_pipe.close
+        child_connection_object_id.should_not == parent_connection.object_id
+        child_connection_obj_object_id.should_not == parent_connection_obj.object_id
+        
+        ActiveRecord::Base.connection.object_id.should == parent_connection.object_id
+        ActiveRecord::Base.connection.instance_variable_get('@connection').object_id.should == parent_connection_obj.object_id
+      end
+    end
+
+  end # describe
+
+end # unless
+

data/spec/rails_is_forked_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "RailsIsForked" do
+  it "Has no tests" do
+    1.should == 1
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+# require 'rails_is_forked'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: rails_is_forked
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kurt Stephens
+- Robert Fletcher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-01 00:00:00.000000000 Z
+dependencies: []
+description: Handles issues with forked Rails processes - DB connections, etc.
+email: lobatifricha@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rails_is_forked/rails.rb
+- lib/rails_is_forked.rb
+- spec/rails_is_forked_spec.rb
+- spec/rails_is_forked/rails_spec.rb
+- spec/spec_helper.rb
+- README.rdoc
+- Gemfile
+- LICENSE.txt
+- Rakefile
+homepage: https://github.com/mockdeep/rails_is_forked
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Handles issues with forked Rails processes - DB connections, etc.
+test_files: []