resque_stuck_queue 0.0.5 → 0.0.6

checksums.yaml

@@ -1,15 +1,7 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MGU4NWIyMWEyMjMyMWQwYTVjYjUxYTI5YjlmZWUwMmM0ZWYxMzhlZg==
-  data.tar.gz: !binary |-
-    NzBlMGViOGVmNzMzZTU1ZjczMzNiZDU4MjU3YTViNWNmY2YwNzU3Mw==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    Mzg5ZTUyOWVhMjQzYTkwNmQ3YmQ2NDc0MDAzZGU4NWZhNTkxYWE3ODM0N2Jk
-    NzBlYTdlOTliMTNkOGIyYzc2ZDU2MmU4ZmJlYzllNGVhZjExNzk4MWY0Mzlj
-    MGRjM2FlNmNlY2RkZWE4NGRiNTJmN2IxOTY5M2EyZDhkZjFlMWQ=
-  data.tar.gz: !binary |-
-    Yjc3ZWJmN2Y3OGM3NDk0ODMzMGJjNzcxMWIzMGRkY2Q2NWQxNTdiNGU3OTQ1
-    NDU3NmRmNDMxMmRhYzk1ZmU1OTViYTJhZmY5ZjkwNGMxYTEwZjY5N2QzZmI1
-    ZThmYWMyYWE5OTgzNGRjNGJiMGZiMDczOWQ4ZmRiNmZkMDdmNWM=
+--- 
+SHA1: 
+  data.tar.gz: f3bb5b9529929905d39cbe224c3be24be7a140a3
+  metadata.gz: 22cdb53ee5c30b9ba2fac0e44a029e9163980cc6
+SHA512: 
+  data.tar.gz: c9ab5e52097a9f8d98620d9e9c4c337d60bee4594a3a9b827607139a5fd913e78b0e56b13355977d9430b81c09265c3d9c544f5d53e82652911c8bd44e4cd8ed
+  metadata.gz: 84d36d31275f1be8ba45fadf880226bdbe582612e18ce54009e422e2b274b4a873077f735141e7bcd5f55bf9e263ec7b9c7cd05cc538f913df23698c69bcd65e

data/README.md

@@ -77,7 +77,7 @@ Contrived example:
 
 # put this in lib/tasks/resque_stuck_queue.rb
 
-require 'resque_stuck_queue'
+require 'resque_stuck_queue' # or require 'resque/stuck_queue'
 
 namespace :resque do
   desc "Start a Resque-stuck daemon"
@@ -99,6 +99,26 @@ $ bundle exec rake --trace resque:stuck_queue
 
 </pre>
 
+## Sidekiq/Other redis-based job queues
+
+If you have trouble with other queues you can use this lib by setting your own custom refresh job (aka, the job that refreshes the global_key). The one thing you need to take care of is ensure whatever and however you enque your own custom job, it sets the global_key to Time.now. Then do:
+
+<pre>
+
+class CustomJob
+  include Sidekiq::Worker
+  def perform
+    # ensure you're setting the key in the redis the job queue is using
+    $redis.set(Resque::StuckQueue.global_key, Time.now.to_i)
+  end
+end
+
+Resque::StuckQueue.config[:refresh_job] = proc {
+  # or however else you enque your custom job, Sidekiq::Client.enqueue(CustomJob), whatever, etc.
+  CustomJob.perform_async
+}
+</pre>
+
 ## Tests
 
 Run the tests:

data/THOUGHTS

@@ -10,3 +10,4 @@ add daemon example to readme
 add a 'resque_stuck_queue/tasks' bit? See tres eg
 require 'resque/stuck_queue' instead?
 ensure the logging gets flushed into log file correctly? (integration with god?)
+add a trap{} to force_stop. ok for overwriting process's trap handlers? use config for that?

data/lib/resque_stuck_queue.rb

@@ -95,6 +95,11 @@ module Resque
         @stopped
       end
 
+      def global_key
+        # public, for use in custom heartbeat job
+        config[:global_key] || GLOBAL_KEY
+      end
+
       private
 
       def enqueue_repeating_refresh_job
@@ -107,12 +112,20 @@ module Resque
             #
             # TODO REDIS 2.0 compat
             logger.info("Sending refresh job")
-            Resque.enqueue(RefreshLatestTimestamp, global_key)
+            enqueue_job
             wait_for_it
           end
         end
       end
 
+      def enqueue_job
+        if config[:refresh_job]
+          config[:refresh_job].call
+        else
+          Resque.enqueue(RefreshLatestTimestamp, global_key)
+        end
+      end
+
       def setup_checker_thread
         @threads << Thread.new do
           Thread.current.abort_on_exception = config[:abort_on_exception]
@@ -165,10 +178,6 @@ module Resque
         sleep config[:heartbeat] || HEARTBEAT
       end
 
-      def global_key
-        config[:global_key] || GLOBAL_KEY
-      end
-
       def max_wait_time
         config[:trigger_timeout] || TRIGGER_TIMEOUT
       end

data/lib/resque_stuck_queue/version.rb

@@ -1,5 +1,5 @@
 module Resque
   module StuckQueue
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/test/test_set_your_own_refresh_job.rb

@@ -0,0 +1,56 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "test_helper")
+
+class TestYourOwnRefreshJob < Minitest::Test
+
+  include TestHelper
+
+  def setup
+    Resque::StuckQueue.config[:trigger_timeout] = 1
+    Resque::StuckQueue.config[:heartbeat] = 1
+    Resque::StuckQueue.config[:abort_on_exception] = true
+  end
+
+  def teardown
+    Resque::StuckQueue.reset!
+  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[:refresh_job] = proc { nil } # does not refresh global key
+    @triggered = false
+    Resque::StuckQueue.config[: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[:refresh_job] = proc { raise 'bad proc doc' } # does not refresh global key
+      @triggered = false
+      Resque::StuckQueue.config[: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
+
+
+  def test_has_settable_custom_hearbeat_job
+    puts "#{__method__}"
+    begin
+      Resque::StuckQueue.config[:refresh_job] = proc { Resque.enqueue(RefreshLatestTimestamp, Resque::StuckQueue.global_key) }
+      @triggered = false
+      Resque::StuckQueue.config[:handler] = proc { @triggered = true }
+      start_and_stop_loops_after(3)
+      assert true, "should not have raised"
+      assert @triggered, "should have triggered"
+    rescue => e
+      assert false, "should have succeeded with good refresh_job.\n #{e.inspect}"
+    end
+  end
+
+
+end

metadata

@@ -1,64 +1,55 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: resque_stuck_queue
-version: !ruby/object:Gem::Version
-  version: 0.0.5
+version: !ruby/object:Gem::Version 
+  version: 0.0.6
 platform: ruby
-authors:
+authors: 
 - Shai Rosenfeld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-08 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2014-01-13 00:00:00 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
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id003 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !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:
+  requirement: &id002 !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'
+      - !ruby/object:Gem::Version 
+        version: "1.5"
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id003
+  type: :development
+  version_requirements: *id004
 description: where the wild things are. err, when resque gets stuck
-email:
+email: 
 - srosenfeld@engineyard.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - Gemfile.lock
@@ -77,31 +68,31 @@ files:
 - test/test_integration.rb
 - test/test_logger.rb
 - test/test_resque_stuck_queue.rb
+- test/test_set_your_own_refresh_job.rb
 homepage: https://github.com/shaiguitar/resque_stuck_queue/
-licenses:
+licenses: 
 - MIT
 metadata: {}
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+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'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id003
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id003
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: fire a handler when your queues are wonky
-test_files:
+test_files: 
 - test/resque/refresh_latest_timestamp.rb
 - test/resque/set_redis_key.rb
 - test/test_collision.rb
@@ -109,4 +100,4 @@ test_files:
 - test/test_integration.rb
 - test/test_logger.rb
 - test/test_resque_stuck_queue.rb
-has_rdoc: 
+- test/test_set_your_own_refresh_job.rb