resque_stuck_queue 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YWNkZWJjMzVlMTZlNmI4ZDNiZjk5MTk2ZjFiOTVhZTIxYjA4ZDY1Ng==
+    Y2RiMWFkM2ZmMGJmOWI1YzcwYzg5MWUyNjU3MTEzNWQwYmZiOWQ1YQ==
   data.tar.gz: !binary |-
-    NDlmNDlmZGI3OThiMDk2NjJiZGZhZDlmY2YxNzZhOGY0ZmU1YzMxNQ==
+    NjQ2ODNlOTNmMDMzZWU1MDU2NWE1NTc4YmQ1NzAwOGFlYzNlOTU5Nw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ODgyNjJhMjNiYjNhNWRjNjBhYzhiNGUxODNmZDhiNWJiNDViODQ1ZTBlNTdk
-    MzU2ZjU3M2MyMWY0OGE5ZWIzYTBlMGI4OTEzZGFkY2RlNjkyNWU2MmI0NjYy
-    NDQ3M2IyY2E3YTAwYzUyODExZDNkY2E2ZmI3ZDVjYzAwYWVlN2Q=
+    Mzc4ZTI4NjM2ZjlhY2ExNDM3NDhmMjU1NTA0ODE2Y2I3MzkwYzMxNDE3NTNk
+    YThjNjQ2ZDhkZjY5Nzk2YzAwMWZhZjgxOWNjMThiYzFhNGJlZWVjZjMzY2Rj
+    ZTZjZThlOGQyMzMwMzFlZmE1NTFmNDE4NzY4NmQ3ZTU1MDAwNDI=
   data.tar.gz: !binary |-
-    NzM4ZjQyMDQzOTI2MDQyNTExMzQyNzEwNTAxM2M0NmRiYzM2YWJmMmQyYmFk
-    MTMxZWM1YmY3Nzc2ODM0N2M3MTM3NjI2ZmYxNDFjNDc5ZmUyNmVmZmIxMGQ5
-    MjkyNWNhOWZkNTNmNWVmM2ExNjg5ZGNkOGRmOTk0ZGU5NGQwYjA=
+    YzIzYWMxYWVkZGRiYjdhY2Y3ZDNlYzQ1NzcyYzQ2ZTcxZjM1NTE5NDgyMDU1
+    OTFkMmZjNWM5NjJiZmNkM2MyNDIyMWY5Y2Q4NTk4MDZkMTViMDY2ZDlhNDgz
+    NjQ0NGJiNzEwNDIyN2Y4NTJjZTYwODI0ZTRiYjgwYWM5OGI1MGU=

data/README.md

@@ -16,8 +16,6 @@ It will trigger a pre-defined proc (see below) if the last time the hearbeat job
 
 ## Usage
 
-Add this to wherever you're setting up resque (config/initializers or wherever).
-
 Configure it first:
 
 <pre>
@@ -41,6 +39,10 @@ Resque::StuckQueue.config[:global_key] = "name-the-refresh-key-as-you-please"
 
 # optional, if you want the resque-stuck-queue threads to explicitly raise, default is false
 Resque::StuckQueue.config[:abort_on_exception] = true
+
+# optional, pass a logger. Default a ruby logger will be instantiated. Needs to respond to that interface.
+Resque::StuckQueue.config[:logger] = Logger.new($stdout)
+
 </pre>
 
 Then start it:
@@ -57,6 +59,16 @@ Resque::StuckQueue.stop                 # this will block until the threads end
 Resque::StuckQueue.force_stop!          # force kill those threads and let's move on
 </pre>
 
+## Deployment/Integration
+
+* Include this in the app in a config initializer of some sort.
+
+Note though, the resque-stuck threads will live alongside the app server process so you will need to explicitely handle `start` _and_ `stop`. If you're deployed in a forking-server environment and the whatever process has this does not get restarted the threads will keep on going indefinitely.
+
+* Run this as a daemon somewhere alongside the app/in your setup.
+
+<!-- TODO example -->
+
 ## Tests
 
 Run the tests:

data/THOUGHTS

@@ -28,4 +28,5 @@ verify @config options, raise if no handler, etc.
 - ensure it only runs from the server box and not the resque box??
   (the deploy restarts the server but not resque workers)
 
-
+add a 'resque_stuck_queue/tasks' bit? See tres eg
+require 'resque/stuck_queue' instead?

data/lib/resque_stuck_queue.rb

@@ -7,13 +7,15 @@ Redis::Classy.db = Resque.redis
 # TODO move this require into a configurable?
 require 'resque'
 
+require 'logger'
+
 module Resque
   module StuckQueue
 
     GLOBAL_KEY        = "resque-stuck-queue"
     HEARTBEAT         = 60 * 60 # check/refresh every hour
     TRIGGER_TIMEOUT   = 5 * 60 * 60 # warn/trigger 5 hours
-    HANDLER           = proc { $stderr.puts("Shit gone bad with them queues.") }
+    HANDLER           = proc { $stdout.puts("Shit gone bad with them queues.") }
 
     class << self
 
@@ -38,6 +40,10 @@ module Resque
         @config ||= {}
       end
 
+      def logger
+        @logger ||= (config[:logger] || Logger.new($stdout))
+      end
+
       def start_in_background
         Thread.new do
           self.start
@@ -65,34 +71,44 @@ module Resque
         # fo-eva.
         @threads.map(&:join)
 
+        logger.info("threads stopped")
         @stopped = true
       end
 
-      # for tests
       def stop
-        @config = config.dup #unfreeze
-        @running = false
-
+        reset!
         # wait for clean thread shutdown
         while @stopped == false
           sleep 1
         end
+        logger.info("Stopped")
       end
 
       def force_stop!
         @threads.map(&:kill)
+        reset!
+        logger.info("Force stopped")
+      end
+
+      def reset!
+        # clean state so we can stop and start in the same process.
+        @config = config.dup #unfreeze
+        @logger = nil
+        @running = false
       end
 
       private
 
       def enqueue_repeating_refresh_job
         @threads << Thread.new do
+          logger.info("Starting heartbeat thread")
           while @running
             wait_for_it
             # we want to go through resque jobs, because that's what we're trying to test here:
             # ensure that jobs get executed and the time is updated!
             #
             # TODO REDIS 2.0 compat
+            logger.info("Sending refresh job")
             Resque.enqueue(RefreshLatestTimestamp, global_key)
           end
         end
@@ -100,12 +116,14 @@ module Resque
 
       def setup_checker_thread
         @threads << Thread.new do
+          logger.info("Starting checker thread")
           while @running
             wait_for_it
             mutex = Redis::Mutex.new('resque_stuck_queue_lock', block: 0)
             if mutex.lock
               begin
                 if Time.now.to_i - last_time_worked > max_wait_time
+                  logger.info("Triggering handler at #{Time.now} (pid: #{Process.pid})")
                   trigger_handler
                 end
               ensure

data/lib/resque_stuck_queue/version.rb

@@ -1,5 +1,5 @@
 module Resque
   module StuckQueue
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/test/test_logger.rb

@@ -0,0 +1,30 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "test_helper")
+
+class TestResqueStuckQueue < 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_has_logger
+    puts "#{__method__}"
+    begin
+      Resque::StuckQueue.config[:logger] = Logger.new($stdout)
+      start_and_stop_loops_after(2)
+      assert true, "should not have raised"
+    rescue
+      assert false, "should have succeeded with good logger"
+    end
+  end
+
+end
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque_stuck_queue
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Shai Rosenfeld
@@ -74,6 +74,7 @@ files:
 - test/test_collision.rb
 - test/test_helper.rb
 - test/test_integration.rb
+- test/test_logger.rb
 - test/test_resque_stuck_queue.rb
 homepage: https://github.com/shaiguitar/resque_stuck_queue/
 licenses:
@@ -105,5 +106,6 @@ test_files:
 - test/test_collision.rb
 - test/test_helper.rb
 - test/test_integration.rb
+- test/test_logger.rb
 - test/test_resque_stuck_queue.rb
 has_rdoc: