sidekiq-status 0.3.0 → 0.3.1

data/README.md

@@ -91,6 +91,14 @@ Sidekiq::Status::total   job_id #=> 100
 Sidekiq::Status::message job_id #=> "Almost done"
 Sidekiq::Status::pct_complete job_id #=> 5
 ```
+### Unscheduling
+
+```ruby
+scheduled_job_id = MyJob.perform_in 3600
+Sidekiq::Status.cancel scheduled_job_id #=> true
+#doesn't cancel running jobs, this is more like unscheduling, therefore an alias:
+Sidekiq::Status.unschedule scheduled_job_id #=> true
+```
 
 ### Features coming
 * Stopping jobs by id
@@ -100,6 +108,7 @@ Sidekiq::Status::pct_complete job_id #=> 5
 Andrew Korzhuev  
 Jon Moses  
 Wayne Hoover
+Dylan Robinson
 
 ## License
 MIT License , see LICENSE for more details.

data/lib/sidekiq-status.rb

@@ -29,6 +29,12 @@ module Sidekiq::Status
       status.to_sym  unless status.nil?
     end
 
+    def cancel(job_id, job_unix_time = nil)
+      delete_and_unschedule(job_id, job_unix_time)
+    end
+
+    alias_method :unschedule, :cancel
+
     STATUS.each do |name|
       class_eval(<<-END, __FILE__, __LINE__)
         def #{name}?(job_id)

data/lib/sidekiq-status/storage.rb

@@ -1,5 +1,6 @@
 module Sidekiq::Status::Storage
   RESERVED_FIELDS=%w(status stop update_time).freeze
+  BATCH_LIMIT = 500
 
   protected
 
@@ -27,6 +28,26 @@ module Sidekiq::Status::Storage
     store_for_id id, {status: status}, expiration
   end
 
+  # Unschedules the job and deletes the Status
+  # @param [String] id job id
+  # @param [Num] job_unix_time, unix timestamp for the scheduled job
+  def delete_and_unschedule(job_id, job_unix_time = nil)
+    Sidekiq.redis do |conn|
+      scan_options = {offset: 0, conn: conn, start: (job_unix_time || '-inf'), end: (job_unix_time || '+inf')}
+
+      while not (jobs = schedule_batch(scan_options)).empty?
+        match = scan_scheduled_jobs_for_jid jobs, job_id
+        unless match.nil?
+          conn.zrem "schedule", match
+          conn.del job_id
+          return true # Done
+        end
+        scan_options[:offset] += BATCH_LIMIT
+      end
+    end
+    false
+  end
+
   # Gets a single valued from job status hash
   # @param [String] id job id
   # @param [String] Symbol field fetched field name
@@ -45,4 +66,28 @@ module Sidekiq::Status::Storage
       conn.hgetall id
     end
   end
+
+  private
+
+  # Gets the batch of scheduled jobs based on input options
+  # Uses Redis zrangebyscore for log(n) search, if unix-time is provided
+  # @param [Hash] options, options hash containing (REQUIRED) keys:
+  #  -  conn: Redis connection
+  #  -  start: start score (i.e. -inf or a unix timestamp)
+  #  -  end: end score (i.e. +inf or a unix timestamp)
+  #  -  offset: current progress through (all) jobs (e.g.: 100 if you want jobs from 100 to BATCH_LIMIT)
+  def schedule_batch(options)
+    options[:conn].zrangebyscore "schedule", options[:start], options[:end], {limit: [options[:offset], BATCH_LIMIT]}
+  end
+
+  # Searches the jobs Array for the job_id
+  # @param [Array] scheduled_jobs, results of Redis schedule key
+  # @param [String] id job id
+  def scan_scheduled_jobs_for_jid(scheduled_jobs, job_id)
+    # A Little skecthy, I know, but the structure of these internal JSON
+    # is predefined in such a way where this will not catch unintentional elements,
+    # and this is notably faster than performing JSON.parse() for every listing:
+    scheduled_jobs.each { |job_listing| (return job_listing) if job_listing.include?("\"jid\":\"#{job_id}") }
+    nil
+  end
 end

data/lib/sidekiq-status/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Status
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
   end
 end

data/spec/lib/sidekiq-status_spec.rb

@@ -5,6 +5,9 @@ describe Sidekiq::Status do
   let!(:redis) { Sidekiq.redis { |conn| conn } }
   let!(:job_id) { SecureRandom.hex(12) }
   let!(:job_id_1) { SecureRandom.hex(12) }
+  let!(:unused_id) { SecureRandom.hex(12) }
+  let!(:plain_sidekiq_job_id) { SecureRandom.hex(12) }
+  let!(:retried_job_id) { SecureRandom.hex(12) }
 
   # Clean Redis before each test
   # Seems like flushall has no effect on recently published messages,
@@ -77,30 +80,69 @@ describe Sidekiq::Status do
     end
   end
 
+  describe ".cancel" do
+    it "cancels a job by id" do
+      SecureRandom.should_receive(:hex).twice.and_return(job_id, job_id_1)
+      start_server do
+        job = LongJob.perform_in(3600)
+        job.should == job_id
+        second_job = LongJob.perform_in(3600)
+        second_job.should == job_id_1
+
+        initial_schedule = redis.zrange "schedule", 0, -1, {withscores: true}
+        initial_schedule.size.should be 2
+        initial_schedule.select {|scheduled_job| JSON.parse(scheduled_job[0])["jid"] == job_id }.size.should be 1
+
+        Sidekiq::Status.unschedule(job_id).should be_true
+        Sidekiq::Status.cancel(unused_id).should be_false # Unused, therefore unfound => false
+
+        remaining_schedule = redis.zrange "schedule", 0, -1, {withscores: true}
+        remaining_schedule.size.should == (initial_schedule.size - 1)
+        remaining_schedule.select {|scheduled_job| JSON.parse(scheduled_job[0])["jid"] == job_id }.size.should be 0
+      end
+    end
+
+    it "does not cancel a job with correct id but wrong time" do
+      SecureRandom.should_receive(:hex).once.and_return(job_id)
+      start_server do
+        scheduled_time = Time.now.to_i + 3600
+        returned_job_id = LongJob.perform_at(scheduled_time)
+        returned_job_id.should == job_id
+
+        initial_schedule = redis.zrange "schedule", 0, -1, {withscores: true}
+        initial_schedule.size.should == 1
+        Sidekiq::Status.cancel(returned_job_id, (scheduled_time + 1)).should be_false # wrong time, therefore unfound => false
+        (redis.zrange "schedule", 0, -1, {withscores: true}).size.should be 1
+        Sidekiq::Status.cancel(returned_job_id, (scheduled_time)).should be_true # same id, same time, deletes
+        (redis.zrange "schedule", 0, -1, {withscores: true}).size.should be_zero
+      end
+    end
+  end
+
   context "keeps normal Sidekiq functionality" do
     it "does jobs with and without included worker module" do
-      SecureRandom.should_receive(:hex).exactly(4).times.and_return(job_id, job_id, job_id_1, job_id_1)
+      SecureRandom.should_receive(:hex).exactly(4).times.and_return(plain_sidekiq_job_id, plain_sidekiq_job_id, job_id_1, job_id_1)
       start_server do
         capture_status_updates(12) {
-          StubJob.perform_async.should == job_id
+          StubJob.perform_async.should == plain_sidekiq_job_id
           NoStatusConfirmationJob.perform_async(1)
           StubJob.perform_async.should == job_id_1
           NoStatusConfirmationJob.perform_async(2)
-        }.should =~ [job_id, job_id_1] * 6
+        }.should =~ [plain_sidekiq_job_id, job_id_1] * 6
       end
       redis.mget('NoStatusConfirmationJob_1', 'NoStatusConfirmationJob_2').should == %w(done)*2
-      Sidekiq::Status.status(job_id).should == :complete
+      Sidekiq::Status.status(plain_sidekiq_job_id).should == :complete
       Sidekiq::Status.status(job_id_1).should == :complete
     end
 
     it "retries failed jobs" do
-      SecureRandom.should_receive(:hex).once.and_return(job_id)
+      SecureRandom.should_receive(:hex).once.and_return(retried_job_id)
       start_server do
         capture_status_updates(5) {
-          RetriedJob.perform_async().should == job_id
-        }.should == [job_id] * 5
+          RetriedJob.perform_async().should == retried_job_id
+        }.should == [retried_job_id] * 5
       end
-      Sidekiq::Status.status(job_id).should == :complete
+      Sidekiq::Status.status(retried_job_id).should == :complete
     end
   end
 

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require "rspec"
 
+require 'celluloid'
 require 'sidekiq'
 require 'sidekiq/processor'
 require 'sidekiq/manager'

data/spec/support/test_jobs.rb

@@ -58,6 +58,7 @@ class RetriedJob < StubJob
   def perform()
     Sidekiq.redis do |conn|
       key = "RetriedJob_#{jid}"
+      sleep 1
       unless conn.exists key
         conn.set key, 'tried'
         raise StandardError

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-status
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -118,4 +118,3 @@ test_files:
 - spec/lib/sidekiq-status_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_jobs.rb
-has_rdoc: