resque-batchworker 0.1.0

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ian Warshak
+
+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,35 @@
+= resque-batchworker
+
+Works with Resque 1.8.5
+
+Resque::Plugins::Batchworker is an alternative to the standard Worker class. 
+
+This class works by forking X children, which all work until there are no more jobs
+to run, and then all of the children quit. Note that the traditional Worker
+will fork for every single job. This class will not do that. Keep that in mind.
+
+This was written for a situation where hundreds of thousands of jobs get queued
+throughout the day but ONLY wanted them to be processed during off-peak hours
+(i.e. middle of the night)
+
+To use Batchworker, run this: 
+  require 'resque/plugins/batchworker'
+  Resque::Plugins::Batchworker.initiate_work NUMBER_OF_PROCESSES, QUEUE_NAME
+  
+
+Thanks to Facilities Technology Group for allowing this code to be released
+publicly.
+
+== 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 Ian Warshak. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "resque-batchworker"
+    gem.summary = %Q{Resque plugin for batch processing of jobs}
+    gem.description = %Q{Forks X children, processes all jobs in the queue and all processes quit when there are no more jobs to complete}
+    gem.email = "iwarshak@stripey.net"
+    gem.homepage = "http://github.com/iwarshak/resque-batchworker"
+    gem.authors = ["Ian Warshak"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  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-batchworker #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/resque-batchworker.rb

@@ -0,0 +1,3 @@
+require 'resque'
+require 'resque/plugins/batchworker'
+require 'resque/plugins/safe_fork'

data/lib/resque/plugins/batchworker.rb

@@ -0,0 +1,93 @@
+module Resque
+  module Plugins
+    class Batchworker < Resque::Worker
+      include Resque::Helpers
+      extend Resque::Helpers
+
+      def work(worker_number, &block)
+        # This runs in a child process
+        $0 = "resque: Starting"
+        run_hook :after_fork
+        prune_dead_workers
+        register_worker
+      
+        @logger = Logger.new("batchworker.log")
+        @logger.debug("about to start a forked worker with count #{worker_number}")
+        @logger.debug("inside safe_fork #{Process.pid}")
+        job_counter = 0
+        begin
+          @logger.debug("about to register worker #{Process.pid}")
+          @logger.debug("#{Process.pid } registered worker! about to look for a job")
+          while job = reserve
+            @logger.info("#{Process.pid } found job #{job}")
+            working_on(job)
+            procline "#{self} Processing #{job.queue} since #{Time.now.to_i} number:#{worker_number}"
+            perform(job, &block)
+            job_counter += 1
+          end
+        ensure
+          @logger.info "#{self} processed #{job_counter} jobs"
+          @logger.info "#{Process.pid } unregistering worker #{self}"
+          unregister_worker
+        end
+      end
+  
+  
+      def self.initiate_work(count, queue, &block)
+        count ||= 1
+        self.new(queue.to_sym).startup # Want this to be called before forking
+      
+        safe_fork(count.to_i) do |worker_number|
+          worker = self.new(queue.to_sym)
+          worker.work(worker_number)
+        end
+      end
+
+      def perform(job = nil)
+        return unless job ||= reserve
+      
+        begin
+          # We don't want this called here because we only want it called once. 
+          # run_hook :after_fork, job 
+          @logger.error("#{Process.pid} performing #{job}")
+          job.perform
+        rescue Object => e
+          log "#{job.inspect} failed: #{e.inspect}"
+          job.fail(e)
+          failed!
+        else
+          log "done: #{job.inspect}"
+        ensure
+          yield job if block_given?
+          done_working
+        end
+      end
+
+      undef fork if method_defined?(:fork)
+
+      def startup
+        enable_gc_optimizations
+        # register_signal_handlers # This won't work, so remove it.
+        run_hook :before_first_fork
+        run_hook :before_fork
+
+        # Fix buffering so we can `rake resque:work > resque.log` and
+        # get output from the child in there.
+        $stdout.sync = true
+      end
+
+      def prune_dead_workers
+        all_workers = self.class.all # the only change here. 
+        known_workers = worker_pids unless all_workers.empty?
+        all_workers.each do |worker|
+          host, pid, queues = worker.id.split(':')
+          next unless host == hostname
+          next if known_workers.include?(pid)
+          log! "Pruning dead worker: #{worker}"
+          worker.unregister_worker
+        end
+      end
+
+    end
+  end
+end

data/lib/resque/plugins/safe_fork.rb

@@ -0,0 +1,20 @@
+require 'resque'
+require 'active_support' 
+
+module Kernel
+  def safe_fork(count = 1)
+    if Object.const_defined?('ActiveRecord') && ActiveRecord.const_defined?('Base')
+      ActiveRecord::Base.lock_optimistically = false
+      ActiveRecord::Base.connection_pool.disconnect!
+    end  
+    
+    count.times do |i|
+      fork do
+        Resque.redis.connect_to_server if Object.const_defined?('Resque')
+        yield(i) if block_given?
+        exit!
+      end
+    end
+    Process.waitall
+  end
+end

data/resque-batchworker.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{resque-batchworker}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ian Warshak"]
+  s.date = %q{2010-06-04}
+  s.description = %q{Forks X children, processes all jobs in the queue and all processes quit when there are no more jobs to complete}
+  s.email = %q{iwarshak@stripey.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/resque-batchworker.rb",
+     "lib/resque/plugins/batchworker.rb",
+     "lib/resque/plugins/safe_fork.rb",
+     "resque-batchworker.gemspec",
+     "test/helper.rb",
+     "test/test_resque-batchworker.rb"
+  ]
+  s.homepage = %q{http://github.com/iwarshak/resque-batchworker}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Resque plugin for batch processing of jobs}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_resque-batchworker.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'redis'
+require 'active_support'
+require 'resque'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'resque-batchworker'
+
+class Test::Unit::TestCase
+end
+
+class BatchJob
+  @queue = :test
+  
+  def self.perform(args)
+    r = Redis.new
+    r.rpush :batch_job_test, Process.pid
+  end
+end

data/test/test_resque-batchworker.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+class TestResqueBatchworker < Test::Unit::TestCase
+  should "be a valid plugin" do
+    assert_nothing_raised do
+      Resque::Plugin.lint(Resque::Plugins::Batchworker)
+    end
+  end
+  should "process 2 jobs with 2 workers" do
+    4.times {|i| Resque.enqueue(BatchJob, i)}
+    Resque::Plugins::Batchworker.initiate_work 2, :test
+    redis = Redis.new
+    pids = []
+    while pid = redis.rpop(:batch_job_test)
+      pids << pid
+    end
+    assert_equal pids.size, 4
+    assert_equal pids.uniq.size, 2
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: resque-batchworker
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ian Warshak
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-04 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Forks X children, processes all jobs in the queue and all processes quit when there are no more jobs to complete
+email: iwarshak@stripey.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/resque-batchworker.rb
+- lib/resque/plugins/batchworker.rb
+- lib/resque/plugins/safe_fork.rb
+- resque-batchworker.gemspec
+- test/helper.rb
+- test/test_resque-batchworker.rb
+has_rdoc: true
+homepage: http://github.com/iwarshak/resque-batchworker
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Resque plugin for batch processing of jobs
+test_files: 
+- test/helper.rb
+- test/test_resque-batchworker.rb