resque-multi-job-forks 0.2.0 → 0.3.0

data/lib/resque-multi-job-forks.rb

@@ -2,6 +2,74 @@ require 'resque'
 require 'resque/worker'
 
 module Resque
+  class Worker
+    attr_accessor :seconds_per_fork
+    attr_accessor :jobs_per_fork
+    attr_reader   :jobs_processed
+
+    unless method_defined?(:shutdown_without_multi_job_forks)
+      def perform_with_multi_job_forks(job = nil)
+        perform_without_multi_job_forks(job)
+        hijack_fork unless fork_hijacked?
+        @jobs_processed += 1
+      end
+      alias_method :perform_without_multi_job_forks, :perform
+      alias_method :perform, :perform_with_multi_job_forks
+
+      def shutdown_with_multi_job_forks
+        release_fork if fork_hijacked? && fork_job_limit_reached?
+        shutdown_without_multi_job_forks
+      end
+      alias_method :shutdown_without_multi_job_forks, :shutdown?
+      alias_method :shutdown?, :shutdown_with_multi_job_forks
+    end
+
+    def fork_hijacked?
+      @release_fork_limit
+    end
+
+    def hijack_fork
+      log 'hijack fork.'
+      @suppressed_fork_hooks = [Resque.after_fork, Resque.before_fork]
+      Resque.after_fork = Resque.before_fork = nil
+      @release_fork_limit = fork_job_limit
+      @jobs_processed = 0
+      @cant_fork = true
+    end
+
+    def release_fork
+      log "jobs processed by child: #{jobs_processed}"
+      run_hook :before_child_exit, self
+      Resque.after_fork, Resque.before_fork = *@suppressed_fork_hooks
+      @release_fork_limit = @jobs_processed = @cant_fork = nil
+      log 'hijack over, counter terrorists win.'
+    end
+
+    def fork_job_limit
+      jobs_per_fork.nil? ? Time.now.to_i + seconds_per_fork : jobs_per_fork
+    end
+
+    def fork_job_limit_reached?
+      fork_job_limit_remaining <= 0 ? true : false
+    end
+
+    def fork_job_limit_remaining
+      jobs_per_fork.nil? ? @release_fork_limit - Time.now.to_i : jobs_per_fork - @jobs_processed
+    end
+
+    def seconds_per_fork
+      @seconds_per_fork ||= minutes_per_fork * 60
+    end
+
+    def minutes_per_fork
+      ENV['MINUTES_PER_FORK'].nil? ? 1 : ENV['MINUTES_PER_FORK'].to_i
+    end
+
+    def jobs_per_fork
+      @jobs_per_fork ||= ENV['JOBS_PER_FORK'].nil? ? nil : ENV['JOBS_PER_FORK'].to_i
+    end
+  end
+
   # the `before_child_exit` hook will run in the child process
   # right before the child process terminates
   #
@@ -16,45 +84,4 @@ module Resque
     @before_child_exit = before_child_exit
   end
 
-  class Worker
-    attr_accessor :jobs_per_fork
-    attr_reader   :jobs_processed
-
-    unless method_defined?(:done_working_without_multi_job_forks)
-      def process_with_multi_job_forks(job = nil)
-        @jobs_processed ||= 0
-        @kill_fork_at ||= Time.now.to_i + (ENV['MINUTES_PER_FORK'].to_i * 60)
-        process_without_multi_job_forks(job)
-      end
-      alias_method :process_without_multi_job_forks, :process
-      alias_method :process, :process_with_multi_job_forks
-
-      def done_working_with_multi_job_forks
-        done_working_without_multi_job_forks
-
-        @jobs_processed += 1
-
-        if @jobs_processed == 1
-          old_after_fork = Resque.after_fork
-          Resque.after_fork = nil
-
-          while Time.now.to_i < @kill_fork_at
-            if job = reserve
-              process(job)
-            else
-              sleep(1)
-            end
-          end
-
-          Resque.after_fork = old_after_fork
-
-          run_hook :before_child_exit, self
-          @jobs_processed = nil
-          @kill_fork_at = nil
-        end
-      end
-      alias_method :done_working_without_multi_job_forks, :done_working
-      alias_method :done_working, :done_working_with_multi_job_forks
-    end
-  end
-end
+end

data/test/helper.rb

@@ -1,8 +1,60 @@
-require 'rubygems'
-require 'test/unit'
-
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+
 $TESTING = true
 
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+Bundler.require
+require 'test/unit'
 require 'resque-multi-job-forks'
+
+# setup redis & resque.
+redis = Redis.new(:db => 1)
+Resque.redis = redis
+
+# adds simple STDOUT logging to test workers.
+# set `VERBOSE=true` when running the tests to view resques log output.
+module Resque
+  class Worker
+    def log(msg)
+      puts "*** #{msg}" unless ENV['VERBOSE'].nil?
+    end
+    alias_method :log!, :log
+  end
+end
+
+# stores a record of the job processing sequence.
+# you may wish to reset this in the test `setup` method.
+$SEQUENCE = []
+
+# test job, tracks sequence.
+class SequenceJob
+  @queue = :jobs
+  def self.perform(i)
+    $SEQUENCE << "work_#{i}".to_sym
+    sleep(2)
+  end
+end
+
+class QuickSequenceJob
+  @queue = :jobs
+  def self.perform(i)
+    $SEQUENCE << "work_#{i}".to_sym
+  end
+end
+
+
+# test hooks, tracks sequence.
+Resque.after_fork do
+  $SEQUENCE << :after_fork
+end
+
+Resque.before_fork do
+  $SEQUENCE << :before_fork
+end
+
+Resque.before_child_exit do |worker|
+  $SEQUENCE << "before_child_exit_#{worker.jobs_processed}".to_sym
+end

data/test/test_resque-multi-job-forks.rb

@@ -1,40 +1,58 @@
-require 'helper'
-
-class SomeJob
-  def self.perform(i)
-    $SEQUENCE << "work_#{i}".to_sym
-    puts 'working...'
-    sleep(25)
-  end
-end
-
-Resque.after_fork do
-  $SEQUENCE << :after_fork
-end
-
-Resque.before_child_exit do |worker|
-  $SEQUENCE << "before_child_exit_#{worker.jobs_processed}".to_sym
-end
+require File.dirname(__FILE__) + '/helper'
 
 class TestResqueMultiJobForks < Test::Unit::TestCase
   def setup
     $SEQUENCE = []
+    Resque.redis.flushdb
+    @worker = Resque::Worker.new(:jobs)
   end
-  
-  def test_sequence_of_events
-    Resque.redis.flush_all
-    
-    ENV['MINUTES_PER_FORK'] = '1'
 
-    worker = Resque::Worker.new(:jobs)
-
-    Resque::Job.create(:jobs, SomeJob, 1)
-    Resque::Job.create(:jobs, SomeJob, 2)
-    Resque::Job.create(:jobs, SomeJob, 3)
-    Resque::Job.create(:jobs, SomeJob, 4)
-
-    worker.work(0)
+  def test_timeout_limit_sequence_of_events
+    # only allow enough time for 3 jobs to process.
+    @worker.seconds_per_fork = 3
+  
+    Resque.enqueue(SequenceJob, 1)
+    Resque.enqueue(SequenceJob, 2)
+    Resque.enqueue(SequenceJob, 3)
+    Resque.enqueue(SequenceJob, 4)
+  
+    # make sure we don't take longer then 15 seconds.
+    begin
+      Timeout::timeout(15) { @worker.work(1) }
+    rescue Timeout::Error
+    end
+  
+    # test the sequence is correct.
+    assert_equal([:before_fork, :after_fork, :work_1, :work_2, :work_3,
+                  :before_child_exit_3, :before_fork, :after_fork, :work_4,
+                  :before_child_exit_1], $SEQUENCE, 'correct sequence')
+  end
 
-    assert_equal([:after_fork, :work_1, :work_2, :work_3, :before_child_exit_3, :after_fork, :work_4, :before_child_exit_1], $SEQUENCE)
+  # test we can also limit fork job process by a job limit.
+  def test_job_limit_sequence_of_events
+    # only allow enough time for 3 jobs to process.
+    ENV['JOBS_PER_FORK'] = '20'
+
+    # queue 40 jobs.
+    (1..40).each { |i| Resque.enqueue(QuickSequenceJob, i) }
+
+    begin
+      Timeout::timeout(3) { @worker.work(1) }
+    rescue Timeout::Error
+    end
+
+    assert_equal :before_fork, $SEQUENCE[0], 'first before_fork call.'
+    assert_equal :after_fork, $SEQUENCE[1], 'first after_fork call.'
+    assert_equal :work_20, $SEQUENCE[21], '20th chunk of work.'
+    assert_equal :before_child_exit_20, $SEQUENCE[22], 'first before_child_exit call.'
+    assert_equal :before_fork, $SEQUENCE[23], 'final before_fork call.'
+    assert_equal :after_fork, $SEQUENCE[24], 'final after_fork call.'
+    assert_equal :work_40, $SEQUENCE[44], '40th chunk of work.'
+    assert_equal :before_child_exit_20, $SEQUENCE[45], 'final before_child_exit call.'
+  end
+  
+  def teardown
+    # make sure we don't clobber any other tests.
+    ENV['JOBS_PER_FORK'] = nil
   end
 end

metadata

@@ -1,53 +1,93 @@
 --- !ruby/object:Gem::Specification 
 name: resque-multi-job-forks
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Mick Staugaard
+- Luke Antins
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-04-22 00:00:00 -07:00
+date: 2010-12-17 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: resque
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 63
         segments: 
         - 1
-        - 8
+        - 10
         - 0
-        version: 1.8.0
+        version: 1.10.0
   type: :runtime
   version_requirements: *id001
-description: |-
-  When your resque jobs are frequent and fast,
-        the overhead of forking and running your after_fork might get too big.
-email: mick@staugaard.com
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: When your resque jobs are frequent and fast, the overhead of forking and running your after_fork might get too big.
+email: 
+- mick@zendesk.com
+- luke@lividpenguin.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
-- .document
-- .gitignore
-- LICENSE
-- README.rdoc
-- Rakefile
 - lib/resque-multi-job-forks.rb
 - test/helper.rb
 - test/test_resque-multi-job-forks.rb
@@ -56,28 +96,32 @@ homepage: http://github.com/staugaard/resque-multi-job-forks
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Have your resque workers process more that one job

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.gitignore

@@ -1,22 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-*.gemspec
-
-## PROJECT::SPECIFIC

data/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2009 Mick Staugaard
-
-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

@@ -1,30 +0,0 @@
-= resque-multi-job-forks
-
-If you have very frequent and fast resque jobs, the overhead of forking and running your after_fork hook, might get too big. Using this resque plugin, you can have your workers perform more than one job, before terminating.
-
-You simply specify the number of minutes you want each fork to run using the MINUTES_PER_FORK environment variable:
-
-  QUEUE=* MINUTES_PER_FORK=5 rake resque:work
-
-This will have each fork process jobs for 5 minutes, before terminating.
-
-This plugin also defines a new hook, that gets called right before the fork terminates:
-
-  Resque.before_child_exit do |worker|
-    worker.log("#{worker.jobs_processed} were processed in this fork")
-  end
-  
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Mick Staugaard. See LICENSE for details.

data/Rakefile

@@ -1,54 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "resque-multi-job-forks"
-    gem.version = "0.2.0"
-    gem.summary = %Q{Have your resque workers process more that one job}
-    gem.description = %Q{When your resque jobs are frequent and fast,
-      the overhead of forking and running your after_fork might get too big.}
-    gem.email = "mick@staugaard.com"
-    gem.homepage = "http://github.com/staugaard/resque-multi-job-forks"
-    gem.authors = ["Mick Staugaard"]
-    gem.add_dependency "resque", "< 1.8.0"
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :test => :check_dependencies
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "resque-multi-job-forks #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end