resqutils 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63c56aed110c280ee955278e9d007f242482e15e
-  data.tar.gz: 07eac3dc61ff36df991829d3002d805da88bd3d3
+  metadata.gz: 2663293b0ffb13621afe5b4d29b2a98a0505452a
+  data.tar.gz: 0cdd0723fab6b23d274c5f40e62181d1e1d9fc8a
 SHA512:
-  metadata.gz: 91fc61241a2cd1c0b623f9473fab38ecfcc19f1d7b83c92a1c5c91f72e62c8378ce614950e530f7b535987dec8f3029f62cef0c1e573d139f6d3e8dc885481c2
-  data.tar.gz: 2f5f870492b27271bd29ebc34e4b9d6f24c0117dcf443a479175ca545a514cb881352168e12095a807ce54670f8af685a6388bca85cdf18bb07c6d86fa7b90d7
+  metadata.gz: 4db81ced533e45a6892a8940f9b11f6c4b0b4933fbec2117bec8b302230f9ce79a670d775dc8982d634223cb740347f412a6520b8f5f70a68de662ed1c208dbc
+  data.tar.gz: c502717b9ff99592aca62f89df365c27c7689e1b2e81eac5fd976d1a66a6c164d110584e3e013b8f49224d7483b6290cc2d9782102bc08effe23b26c2a8ee549

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.2.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    resqutils (1.0.0)
+    resqutils (1.1.0)
       resque
 
 GEM

data/README.md

@@ -33,17 +33,21 @@ failed handling (which is hopefully to restart your jobs).
 You need a means of identifying these workers, and then killing them.
 
 ```ruby
-Resqutils::StaleWorkers.new.each do |worker|
-  # this worker is still considered running but has started over an hour ago
-  Resque.enqueue(WorkerKillerJob,worker.id)
-end
+Resqutils::StaleWorkersKiller.kill_stale_workers
 ```
 
-`Resqutils::StaleWorkers`'s default of an hour can be overridden either in the constructor or by setting the
-`RESQUTILS_SECONDS_TO_BE_CONSIDERED_STALE` environment variable.
+This will queue a `WorkerKillerJob` for each stale worker.  This uses `Resqutils::StaleWorkers` under the covers to identify
+which are stale.  You can pass it in to `StaleWorkersKiller`'s constructor, or configure it using the environment.  By
+default, a worker running for more than an hour is considered stale.
+
+Setting the `RESQUTILS_SECONDS_TO_BE_CONSIDERED_STALE` environment variable, you can override that.
+
+The queue that `WorkerKillerJob` will queue to is `worker_killer_job` by default, but can be changed by setting the `RESQUTILS_WORKER_KILLER_JOB_QUEUE` environment variable.
+
+`Resqutils::StaleWorkersKiller` is also itself a resque job, so you can use this class directly in your resque-scheduler
+implementation to kill stale jobs on a schedule.
 
-The queue that `WorkerKillerJob` will queue to is `worker_killer_job` by default, but can either be set during the `enqueue`
-call or by setting the `RESQUTILS_WORKER_KILLER_JOB_QUEUE` environment variable.
+You can, of course, use these building blocks on your own for other purposes.
 
 ## Spec Helpers
 

data/lib/resqutils.rb

@@ -4,4 +4,5 @@ end
 require 'resqutils/do_not_auto_retry'
 require 'resqutils/worker_killer_job'
 require 'resqutils/stale_workers'
+require 'resqutils/stale_workers_killer'
 require 'resqutils/version'

data/lib/resqutils/stale_workers_killer.rb

@@ -0,0 +1,18 @@
+module Resqutils
+  # Vends stale workers that have been running "too long"
+  class StaleWorkersKiller
+
+    def self.perform
+      self.new.kill_stale_workers
+    end
+
+    def initialize(stale_workers: nil)
+      @stale_workers = stale_workers || Resqutils::StaleWorkers.new
+    end
+    def kill_stale_workers
+      @stale_workers.each do |worker|
+        Resque.enqueue(Resqutils::WorkerKillerJob,worker.id)
+      end
+    end
+  end
+end

data/lib/resqutils/version.rb

@@ -1,3 +1,3 @@
 module Resqutils
-  VERSION='1.0.0'
+  VERSION='1.1.0'
 end

data/lib/resqutils/worker_killer_job.rb

@@ -10,7 +10,7 @@ module Resqutils
                  end
     end
     def self.perform(worker_id)
-      Resque.workers.detect { |_| _.id == worker_id }.unregister_worker
+      Resque.workers.select { |_| _.id == worker_id }.each(&:unregister_worker)
     end
   end
 end

data/spec/stale_workers_killer_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'support/worker_helper'
+
+describe Resqutils::StaleWorkersKiller do
+  include WorkerHelper
+  let(:stale_workers) {
+    [
+      worker,
+      worker,
+      worker,
+    ]
+  }
+  before do
+    allow(Resque).to receive(:enqueue)
+  end
+  describe "kill_stale_workers" do
+    before do
+
+      described_class.new(stale_workers: stale_workers).kill_stale_workers
+    end
+    it "queues a job for all stale workers" do
+      stale_workers.each do |worker|
+        expect(Resque).to have_received(:enqueue).with(Resqutils::WorkerKillerJob,worker.id)
+      end
+    end
+  end
+  describe "::perform" do
+    before do
+      allow(Resqutils::StaleWorkers).to receive(:new).and_return(stale_workers)
+      described_class.perform
+    end
+    it "queues a job for all stale workers" do
+      stale_workers.each do |worker|
+        expect(Resque).to have_received(:enqueue).with(Resqutils::WorkerKillerJob,worker.id)
+      end
+    end
+  end
+end

data/spec/stale_workers_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
+require 'support/worker_helper'
 
 describe Resqutils::StaleWorkers do
+  include WorkerHelper
   describe "each" do
     let(:workers) {
       [
@@ -139,10 +141,4 @@ describe Resqutils::StaleWorkers do
       end
     end
   end
-
-  def worker(run_at = Time.now)
-    double("resque worker", id: SecureRandom.uuid, job: { "queue" => "whatever",
-                                                          "run_at" => run_at.to_s,
-                                                          "payload" => { "class" => "Foo", "args" => [] } })
-  end
 end

data/spec/support/worker_helper.rb

@@ -0,0 +1,7 @@
+module WorkerHelper
+  def worker(run_at = Time.now)
+    double("resque worker", id: SecureRandom.uuid, job: { "queue" => "whatever",
+                                                          "run_at" => run_at.to_s,
+                                                          "payload" => { "class" => "Foo", "args" => [] } })
+  end
+end

data/spec/worker_killer_job_spec.rb

@@ -23,37 +23,48 @@ describe Resqutils::WorkerKillerJob do
     end
   end
   describe "::perform" do
-    let(:workers) {
-      [
-        double(id: worker_id),
-        double(id: worker_id),
-        double(id: worker_id),
-        double(id: worker_id),
-        double(id: worker_id),
-        double(id: worker_id),
-      ]
-    }
-
-    let(:worker_to_kill) { workers[2] }
+    context "worker to kill exists" do
+      let(:workers) {
+        [
+          double(id: worker_id),
+          double(id: worker_id),
+          double(id: worker_id),
+          double(id: worker_id),
+          double(id: worker_id),
+          double(id: worker_id),
+        ]
+      }
 
-    before do
-      allow(Resque).to receive(:workers).and_return(workers)
-      workers.each do |worker|
-        allow(worker).to receive(:unregister_worker)
+      let(:worker_to_kill) { workers[2] }
+
+      before do
+        allow(Resque).to receive(:workers).and_return(workers)
+        workers.each do |worker|
+          allow(worker).to receive(:unregister_worker)
+        end
+        described_class.perform(worker_to_kill.id)
       end
-      described_class.perform(worker_to_kill.id)
-    end
 
-    it "unregisters the worker we want to kill" do
-      expect(worker_to_kill).to have_received(:unregister_worker)
-    end
+      it "unregisters the worker we want to kill" do
+        expect(worker_to_kill).to have_received(:unregister_worker)
+      end
 
-    it "doesn't touch the other workers" do
-      workers.reject { |_| _ == worker_to_kill }.each do |worker|
-        expect(worker).not_to have_received(:unregister_worker)
+      it "doesn't touch the other workers" do
+        workers.reject { |_| _ == worker_to_kill }.each do |worker|
+          expect(worker).not_to have_received(:unregister_worker)
+        end
+      end
+    end
+    context "worker to doesn't exist" do
+      before do
+        allow(Resque).to receive(:workers).and_return([])
+      end
+      it "doesn't blow up" do
+        expect {
+          described_class.perform(worker_id)
+        }.not_to raise_error
       end
     end
-
   end
 
   def worker_id

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resqutils
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Stitch Fix Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-04 00:00:00.000000000 Z
+date: 2015-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque
@@ -62,6 +62,7 @@ files:
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -73,12 +74,15 @@ files:
 - lib/resqutils/spec/resque_helpers.rb
 - lib/resqutils/spec/resque_matchers.rb
 - lib/resqutils/stale_workers.rb
+- lib/resqutils/stale_workers_killer.rb
 - lib/resqutils/version.rb
 - lib/resqutils/worker_killer_job.rb
 - lib/resqutils/worker_task.rb
 - resqutils.gemspec
 - spec/spec_helper.rb
+- spec/stale_workers_killer_spec.rb
 - spec/stale_workers_spec.rb
+- spec/support/worker_helper.rb
 - spec/worker_killer_job_spec.rb
 homepage: http://tech.stitchfix.com
 licenses: []
@@ -105,5 +109,7 @@ specification_version: 4
 summary: Utilities for using Resque in a Rails app
 test_files:
 - spec/spec_helper.rb
+- spec/stale_workers_killer_spec.rb
 - spec/stale_workers_spec.rb
+- spec/support/worker_helper.rb
 - spec/worker_killer_job_spec.rb