resque_stuck_queue_revised 0.5.1

data/test/test_lagtime.rb

@@ -0,0 +1,34 @@
+require 'minitest'
+require "minitest/autorun"
+require 'pry'
+
+$:.unshift(".")
+require 'resque_stuck_queue'
+require File.join(File.expand_path(File.dirname(__FILE__)), "resque", "set_redis_key")
+require File.join(File.expand_path(File.dirname(__FILE__)), "test_helper")
+
+class TestLagTime < Minitest::Test
+
+  include TestHelper
+
+  def setup
+    Resque::StuckQueue.config[:redis] = Redis.new
+    Resque::StuckQueue.redis.flushall
+    Resque::StuckQueue.config[:abort_on_exception] = true
+    Resque::StuckQueue.config[:watcher_interval] = 1
+  end
+
+  def test_triggers_handler_with_lagtime
+    Resque::StuckQueue.config[:trigger_timeout] = 2 # won't allow waiting too much and will complain (eg trigger) sooner than later
+    Resque::StuckQueue.config[:heartbeat_interval] = 1
+    @lagtime = 0
+    Resque::StuckQueue.config[:triggered_handler] = proc { |queue_name, lagtime| @lagtime = lagtime }
+    start_and_stop_loops_after(5)
+
+    # check handler did get called
+    assert @lagtime > 0, "lagtime shoudl be set"
+    assert @lagtime < 5, "lagtime shoudl be set"
+  end
+
+
+end

data/test/test_named_queues.rb

@@ -0,0 +1,96 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "test_helper")
+
+class TestNamedQueues < Minitest::Test
+
+  include TestHelper
+
+  def setup
+    Resque::StuckQueue.config[:trigger_timeout] = 1
+    Resque::StuckQueue.config[:heartbeat_interval] = 1
+    Resque::StuckQueue.config[:abort_on_exception] = true
+    Resque::StuckQueue.config[:redis] = Redis.new
+    Resque::StuckQueue.config[:watcher_interval] = 1
+    Resque::StuckQueue.redis.flushall
+  end
+
+  def teardown
+    hax_kill_resque
+    Resque::StuckQueue.force_stop!
+    Process.waitpid(@resque_pid) if @resque_pid
+  end
+
+  def test_no_custom_queues_defaults_to_app
+    puts "#{__method__}"
+    Resque::StuckQueue.config[:queues] = nil
+    start_and_stop_loops_after(2)
+    assert Resque::StuckQueue.heartbeat_keys.include?("app:resque-stuck-queue"), 'has global keys'
+  end
+
+  def test_has_custom_queues
+    puts "#{__method__}"
+    Resque::StuckQueue.config[:queues] = [:foo,:bar]
+    assert Resque::StuckQueue.heartbeat_keys.include?("foo:resque-stuck-queue"), 'has global keys'
+  end
+
+  def test_resque_enqueues_a_job_with_resqueue_running_but_on_that_queue_does_trigger
+    puts "#{__method__}"
+    Resque::StuckQueue.config[:trigger_timeout] = 2 # won't allow waiting too much and will complain (eg trigger) sooner than later
+    Resque::StuckQueue.config[:heartbeat_interval] = 1
+    Resque::StuckQueue.config[:queues] = [:custom_queue_name]
+    @triggered = false
+    Resque::StuckQueue.config[:triggered_handler] = proc { |queue_name| @triggered = queue_name }
+    Resque::StuckQueue.start_in_background
+
+    # job gets enqueued successfully
+    @resque_pid = run_resque("no-such-jobs-for-this-queue")
+    sleep 2 # allow timeout to trigger
+
+    # check handler did get called
+    assert_equal @triggered, :custom_queue_name
+  end
+
+  def test_resque_enqueues_a_job_correct_queue_does_not_trigger
+    puts "#{__method__}"
+    Resque::StuckQueue.config[:trigger_timeout] = 2 # won't allow waiting too much and will complain (eg trigger) sooner than later
+    Resque::StuckQueue.config[:heartbeat_interval] = 1
+    Resque::StuckQueue.config[:queues] = [:custom_queue_name, :diff_one]
+    assert Resque::StuckQueue.heartbeat_keys.include?("custom_queue_name:resque-stuck-queue"), 'has global keys'
+    @triggered = false
+    Resque::StuckQueue.config[:triggered_handler] = proc { @triggered = true }
+    @resque_pid = run_resque("custom_queue_name")
+    Resque::StuckQueue.start_in_background
+    sleep 2 # allow timeout to trigger
+
+    # check handler did not get called
+    assert_equal @triggered, false
+  end
+
+  def test_triggers_once_and_then_recovers
+    # FIXME test refactoring wrong place for this test.
+    puts "#{__method__}"
+
+    Resque::StuckQueue.config[:trigger_timeout] = 2
+    Resque::StuckQueue.config[:heartbeat_interval] = 1
+    Resque::StuckQueue.config[:queues] = [:app]
+
+    @triggered = 0
+    @recovered = 0
+    Resque::StuckQueue.config[:triggered_handler] = proc { @triggered += 1 }
+    Resque::StuckQueue.config[:recovered_handler] = proc { @recovered += 1 }
+
+    Thread.new {
+      # mock a job going through after we trigger :recovered so we'll w/o doing a run_resque
+      Thread.current.abort_on_exception = true
+      sleep 3
+      Resque::StuckQueue.redis.set(Resque::StuckQueue.heartbeat_key_for(:app), Time.now.to_i)
+    }
+    start_and_stop_loops_after(4)
+
+    # check handler did get called ONCE
+    assert_equal @recovered, 1
+    assert_equal @triggered, 1
+  end
+
+end
+
+

data/test/test_resque_stuck_queue.rb

@@ -0,0 +1,58 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "test_helper")
+
+class TestResqueStuckQueue < Minitest::Test
+
+  include TestHelper
+
+  def teardown
+    puts "#{__method__}"
+    Resque::StuckQueue.unstub(:read_from_redis)
+  end
+
+  def setup
+    puts "#{__method__}"
+    # clean previous test runs
+    Resque::StuckQueue.config[:redis] = Redis.new
+    Resque::StuckQueue.config[:watcher_interval] = 1
+    Resque::StuckQueue.redis.flushall
+    Resque::StuckQueue.config[:heartbeat_interval]   = 1 # seconds
+    Resque::StuckQueue.config[:abort_on_exception] = true
+  end
+
+  def test_configure_heartbeat_key
+    puts "#{__method__}"
+    assert_nil Resque::StuckQueue.redis.get("it-is-configurable"), "global key should not be set"
+    Resque::StuckQueue.config[:heartbeat_key] = "it-is-configurable"
+    start_and_stop_loops_after(3)
+    refute_nil Resque::StuckQueue.redis.get("app:it-is-configurable"), "global key should be set"
+  end
+
+  def test_it_does_not_trigger_handler_if_under_max_time
+    puts "#{__method__}"
+    Resque::StuckQueue.config[:trigger_timeout] = 5
+    Resque::StuckQueue.stubs(:read_from_redis).returns(Time.now.to_i)
+
+    @triggered = false
+    Resque::StuckQueue.config[:triggered_handler] = proc { @triggered = true }
+    start_and_stop_loops_after(3)
+    assert_equal false, @triggered # "handler should not be called"
+  end
+
+  def test_stops_if_handler_raises
+    puts "#{__method__}"
+    Resque::StuckQueue.config[:trigger_timeout] = 1 # wait a short time, will trigger
+    Resque::StuckQueue.config[:abort_on_exception] = true # bubble up the raise
+    last_time_too_old = Time.now.to_i - Resque::StuckQueue::TRIGGER_TIMEOUT
+    Resque::StuckQueue.config[:triggered_handler] = proc { raise "handler had bad sad!" }
+    begin
+      start_and_stop_loops_after(4)
+      sleep 4
+      assert false, "should raise"
+    rescue => e
+      puts e.inspect
+      assert true, "should raise handler bad sad #{e.inspect}"
+    end
+  end
+
+end
+

data/test/test_set_custom_refresh_job.rb

@@ -0,0 +1,41 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "test_helper")
+
+class TestYourOwnRefreshJob < Minitest::Test
+
+  include TestHelper
+
+  def setup
+    Resque::StuckQueue.reset!
+    Resque::StuckQueue.config[:trigger_timeout] = 1
+    Resque::StuckQueue.config[:heartbeat_interval] = 1
+    Resque::StuckQueue.config[:watcher_interval] = 1
+    Resque::StuckQueue.config[:abort_on_exception] = true
+    Resque::StuckQueue.config[:heartbeat_job] = nil
+    Resque::StuckQueue.config[:redis] = Redis.new
+    Resque::StuckQueue.redis.flushall
+  end
+
+  def test_will_trigger_with_unrefreshing_custom_heartbeat_job 
+    # it will trigger because the key will be unrefreshed, hence 'old' and will always trigger.
+    puts "#{__method__}"
+    Resque::StuckQueue.config[:heartbeat_job] = proc { nil } # does not refresh global key
+    @triggered = false
+    Resque::StuckQueue.config[:triggered_handler] = proc { @triggered = true }
+    start_and_stop_loops_after(3)
+    assert @triggered, "will trigger because global key will be old"
+  end
+
+  def test_will_fail_with_bad_custom_heartbeat_job
+    puts "#{__method__}"
+    begin
+      Resque::StuckQueue.config[:heartbeat_job] = proc { raise 'bad proc doc' } # does not refresh global key
+      @triggered = false
+      Resque::StuckQueue.config[:triggered_handler] = proc { @triggered = true }
+      start_and_stop_loops_after(3)
+      assert false, "should not succeed with bad refresh_job"
+    rescue
+      assert true, "will fail with bad refresh_job"
+    end
+  end
+
+end

data/test/test_ver_2.rb

@@ -0,0 +1,45 @@
+# run with
+# $ RESQUE_2=1 bi; RESQUE_2=1 be ruby -I. -Ilib/ test/test_resque_2.rb
+if !ENV['RESQUE_2'].nil?
+
+  require File.join(File.expand_path(File.dirname(__FILE__)), "test_helper")
+
+  class TestResque2 < Minitest::Test
+
+    include TestHelper
+
+    def setup
+      assert (Resque::VERSION.match /^2\./), "must run in 2.0"
+    Resque.redis = Redis.new
+    Resque::StuckQueue.config[:redis] = Redis.new
+      Redis.new.flushall
+    end
+
+   def test_works_with_2_point_oh_do_not_trigger_because_key_is_updated
+
+     Resque::StuckQueue.config[:redis] = Redis.new
+
+     Resque::StuckQueue.config[:watcher_interval] = 1
+     Resque::StuckQueue.config[:heartbeat_interval] = 1
+     Resque::StuckQueue.config[:abort_on_exception] = true
+     Resque::StuckQueue.config[:trigger_timeout] = 5
+     Resque::StuckQueue.config[:logger] = Logger.new($stdout)
+     Resque::StuckQueue.config[:triggered_handler] = proc { Redis.new.incr("test-incr-key") }
+     Resque::StuckQueue.config[:redis] = Redis.new
+     Resque::StuckQueue.config[:queues] = [:app]
+
+     #binding.pry
+     Resque::StuckQueue.start_in_background
+
+     @r2_pid = fork { Resque::StuckQueue.config[:redis] = Redis.new ; Resque::Worker.new("*", :graceful_term => true).work ; Process.waitall }
+     sleep 10
+
+     # triggers once
+     assert_equal Redis.new.get("test-incr-key").to_i, 1
+     hax_kill_resque
+     Resque::StuckQueue.force_stop!
+   end
+
+  end
+
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: resque_stuck_queue_revised
+version: !ruby/object:Gem::Version
+  version: 0.5.1
+platform: ruby
+authors:
+- Dave Kerr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis-mutex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: where the wild things are. err, when resque gets stuck
+email:
+- davek09@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- THOUGHTS
+- lib/resque/stuck_queue.rb
+- lib/resque_stuck_queue.rb
+- lib/resque_stuck_queue/config.rb
+- lib/resque_stuck_queue/heartbeat_job.rb
+- lib/resque_stuck_queue/version.rb
+- resque_stuck_queue.gemspec
+- test/resque/set_redis_key.rb
+- test/test_collision.rb
+- test/test_config.rb
+- test/test_helper.rb
+- test/test_integration.rb
+- test/test_lagtime.rb
+- test/test_named_queues.rb
+- test/test_resque_stuck_queue.rb
+- test/test_set_custom_refresh_job.rb
+- test/test_ver_2.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: fire a handler when your queues are wonky
+test_files:
+- test/resque/set_redis_key.rb
+- test/test_collision.rb
+- test/test_config.rb
+- test/test_helper.rb
+- test/test_integration.rb
+- test/test_lagtime.rb
+- test/test_named_queues.rb
+- test/test_resque_stuck_queue.rb
+- test/test_set_custom_refresh_job.rb
+- test/test_ver_2.rb