lantins-resque-multi-job-forks 0.3.0

data/LICENSE

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,30 @@
+= 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

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift 'lib'
+
+require 'fileutils'
+require 'rake/testtask'
+require 'yard/rake/yardoc_task'
+
+task :default => :test
+
+# Test task.
+Rake::TestTask.new(:test) do |task|
+  task.test_files = FileList['test/test_*.rb']
+  task.verbose = true
+end
+
+# docs task.
+YARD::Rake::YardocTask.new :yardoc do |t|
+    t.files   = ['lib/**/*.rb']
+    t.options = ['--output-dir', "doc/",
+                 '--files', 'LICENSE',
+                 '--readme', 'README.rdoc',
+                 '--title', 'lantins-resque-multi-job-forks documentation']
+end

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

@@ -0,0 +1,87 @@
+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
+  #
+  # Call with a block to set the hook.
+  # Call with no arguments to return the hook.
+  def self.before_child_exit(&block)
+    block ? (@before_child_exit = block) : @before_child_exit
+  end
+
+  # Set the before_child_exit proc.
+  def self.before_child_exit=(before_child_exit)
+    @before_child_exit = before_child_exit
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,57 @@
+dir = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift dir + '/../lib'
+
+$TESTING = true
+
+require 'rubygems'
+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

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + '/helper'
+
+class TestResqueMultiJobForks < Test::Unit::TestCase
+  def setup
+    $SEQUENCE = []
+    Resque.redis.flushdb
+    @worker = Resque::Worker.new(:jobs)
+  end
+
+  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
+
+  # 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

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: lantins-resque-multi-job-forks
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Mick Staugaard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-15 00:00:00 +01: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: 39
+        segments: 
+        - 1
+        - 9
+        - 10
+        version: 1.9.10
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :development
+  version_requirements: *id003
+description: "  When your resque jobs are frequent and fast, the overhead of forking and\n  running your after_fork might get too big.\n\n  You may limit by either job limit or time limit per fork.\n"
+email: mick@staugaard.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- Rakefile
+- README.rdoc
+- test/helper.rb
+- test/test_resque-multi-job-forks.rb
+- lib/resque-multi-job-forks.rb
+has_rdoc: false
+homepage: http://github.com/lantins/lantins-resque-multi-job-forks
+licenses: []
+
+post_install_message: 
+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.7
+signing_key: 
+specification_version: 3
+summary: A Resque plugin; allows workers to process multiple jobs per fork.
+test_files: []
+