Merge branch 'master' of github.com:defunkt/resque

Author: defunkt

HOOKS.md

@@ -60,7 +60,9 @@ like this:
 
 Once this hook is made available to your job (either by way of
 inheritence or `extend`), it will be run before the job's `perform`
-method is called.
+method is called. Hooks of each type are executed in alphabetical order,
+so `before_perform_a` will always be executed before `before_perform_b`.
+An unnamed hook (`before_perform`) will be executed first.
 
 The available hooks are:
 

lib/resque/job.rb

@@ -109,10 +109,10 @@ def perform
       job_args = args || []
       job_was_performed = false
 
-      before_hooks  = job.methods.grep(/^before_perform/)
-      around_hooks  = job.methods.grep(/^around_perform/)
-      after_hooks   = job.methods.grep(/^after_perform/)
-      failure_hooks = job.methods.grep(/^on_failure/)
+      before_hooks  = job.methods.grep(/^before_perform/).sort
+      around_hooks  = job.methods.grep(/^around_perform/).sort
+      after_hooks   = job.methods.grep(/^after_perform/).sort
+      failure_hooks = job.methods.grep(/^on_failure/).sort
 
       begin
         # Execute before_perform hook. Abort the job gracefully if
@@ -132,7 +132,7 @@ def perform
         else
           # We want to nest all around_perform plugins, with the last one
           # finally calling perform
-          stack = around_hooks.inject(nil) do |last_hook, hook|
+          stack = around_hooks.reverse.inject(nil) do |last_hook, hook|
             if last_hook
               lambda do
                 job.send(hook, *job_args) { last_hook.call }

test/job_plugins_test.rb

@@ -0,0 +1,209 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+context "Multiple plugins with multiple hooks" do
+  include PerformJob
+
+  module Plugin1
+    def before_perform_record_history1(history)
+      history << :before1
+    end
+    def after_perform_record_history1(history)
+      history << :after1
+    end
+  end
+
+  module Plugin2
+    def before_perform_record_history2(history)
+      history << :before2
+    end
+    def after_perform_record_history2(history)
+      history << :after2
+    end
+  end
+
+  class ManyBeforesJob
+    extend Plugin1
+    extend Plugin2
+    def self.perform(history)
+      history << :perform
+    end
+  end
+
+  test "hooks of each type are executed in alphabetical order" do
+    result = perform_job(ManyBeforesJob, history=[])
+    assert_equal true, result, "perform returned true"
+    assert_equal [:before1, :before2, :perform, :after1, :after2], history
+  end
+end
+
+context "Resque::Plugin ordering before_perform" do
+  include PerformJob
+
+  module BeforePerformPlugin
+    def before_perform1(history)
+      history << :before_perform1
+    end
+  end
+
+  class BeforePerformJob
+    extend BeforePerformPlugin
+    def self.perform(history)
+      history << :perform
+    end
+    def self.before_perform(history)
+      history << :before_perform
+    end
+  end
+
+  test "before_perform hooks are executed in order" do
+    result = perform_job(BeforePerformJob, history=[])
+    assert_equal true, result, "perform returned true"
+    assert_equal [:before_perform, :before_perform1, :perform], history
+  end
+end
+
+context "Resque::Plugin ordering after_perform" do
+  include PerformJob
+
+  module AfterPerformPlugin
+    def after_perform_record_history(history)
+      history << :after_perform1
+    end
+  end
+
+  class AfterPerformJob
+    extend AfterPerformPlugin
+    def self.perform(history)
+      history << :perform
+    end
+    def self.after_perform(history)
+      history << :after_perform
+    end
+  end
+
+  test "after_perform hooks are executed in order" do
+    result = perform_job(AfterPerformJob, history=[])
+    assert_equal true, result, "perform returned true"
+    assert_equal [:perform, :after_perform, :after_perform1], history
+  end
+end
+
+context "Resque::Plugin ordering around_perform" do
+  include PerformJob
+
+  module AroundPerformPlugin1
+    def around_perform1(history)
+      history << :around_perform_plugin1
+      yield
+    end
+  end
+
+  class AroundPerformJustPerformsJob
+    extend AroundPerformPlugin1
+    def self.perform(history)
+      history << :perform
+    end
+  end
+
+  test "around_perform hooks are executed before the job" do
+    result = perform_job(AroundPerformJustPerformsJob, history=[])
+    assert_equal true, result, "perform returned true"
+    assert_equal [:around_perform_plugin1, :perform], history
+  end
+
+  class AroundPerformJob
+    extend AroundPerformPlugin1
+    def self.perform(history)
+      history << :perform
+    end
+    def self.around_perform(history)
+      history << :around_perform
+      yield
+    end
+  end
+
+  test "around_perform hooks are executed in order" do
+    result = perform_job(AroundPerformJob, history=[])
+    assert_equal true, result, "perform returned true"
+    assert_equal [:around_perform, :around_perform_plugin1, :perform], history
+  end
+
+  module AroundPerformPlugin2
+    def around_perform2(history)
+      history << :around_perform_plugin2
+      yield
+    end
+  end
+
+  class AroundPerformJob2
+    extend AroundPerformPlugin1
+    extend AroundPerformPlugin2
+    def self.perform(history)
+      history << :perform
+    end
+    def self.around_perform(history)
+      history << :around_perform
+      yield
+    end
+  end
+
+  test "many around_perform are executed in order" do
+    result = perform_job(AroundPerformJob2, history=[])
+    assert_equal true, result, "perform returned true"
+    assert_equal [:around_perform, :around_perform_plugin1, :around_perform_plugin2, :perform], history
+  end
+
+  module AroundPerformDoesNotYield
+    def around_perform0(history)
+      history << :around_perform0
+    end
+  end
+
+  class AroundPerformJob3
+    extend AroundPerformPlugin1
+    extend AroundPerformPlugin2
+    extend AroundPerformDoesNotYield
+    def self.perform(history)
+      history << :perform
+    end
+    def self.around_perform(history)
+      history << :around_perform
+      yield
+    end
+  end
+
+  test "the job is aborted if an around_perform hook does not yield" do
+    result = perform_job(AroundPerformJob3, history=[])
+    assert_equal false, result, "perform returned false"
+    assert_equal [:around_perform, :around_perform0], history
+  end
+end
+
+context "Resque::Plugin ordering on_failure" do
+  include PerformJob
+
+  module OnFailurePlugin
+    def on_failure1(exception, history)
+      history << "#{exception.message} plugin"
+    end
+  end
+
+  class FailureJob
+    extend OnFailurePlugin
+    def self.perform(history)
+      history << :perform
+      raise StandardError, "oh no"
+    end
+    def self.on_failure(exception, history)
+      history << exception.message
+    end
+  end
+
+  test "on_failure hooks are executed in order" do
+    history = []
+    assert_raises StandardError do
+      perform_job(FailureJob, history)
+    end
+    assert_equal [:perform, "oh no", "oh no plugin"], history
+  end
+end

test/worker_test.rb

@@ -17,7 +17,7 @@
     @worker.work(0)
     assert_equal 1, Resque::Failure.count
   end
-  
+
   test "failed jobs report excpetion and message" do
     Resque::Job.create(:jobs, BadJobWithSyntaxError)
     @worker.work(0)