sidetiq 0.1.5 → 0.2.0

data/.travis.yml

@@ -1,6 +1,14 @@
 language: ruby
+before_script:
+  - bundle exec rake compile
 rvm:
+  - 1.9.2
   - 1.9.3
   - 2.0.0
-before_script:
-  - bundle exec rake compile
+  - ruby-head
+  - jruby-19mode
+  - rbx-19mode
+matrix:
+  allow_failures:
+    - rvm: 1.9.2
+    - rvm: jruby-19mode

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+0.2.0
+-----
+
+- Add class methods to get last and next scheduled occurrence.
+- Pass last and next (current) occurrence to #perform, if desired.
+  This checks the method arity of #perform.
+- Bump Sidekiq dependency to 2.8.0
+- Fix incorrectly assigned Thread priority.
+- Adjust clock sleep depending of execution time of the last tick.
+- Don't log thread object ids.
+- Issue a warning from the middleware if the clock thread died previously.
+
 0.1.5
 -----
 

data/lib/sidetiq/clock.rb

@@ -92,7 +92,7 @@ module Sidetiq
       Sidekiq.logger.info "Sidetiq::Clock start"
       @thread = Thread.start { clock { tick } }
       @thread.abort_on_exception = true
-      @thread.priority = Sidetiq.config.resolution
+      @thread.priority = Sidetiq.config.priority
       @thread
     end
 
@@ -131,15 +131,20 @@ module Sidetiq
 
     def enqueue(worker, time)
       key = "sidetiq:#{worker.name}"
+      time_f = time.to_f
 
       synchronize_clockworks("#{key}:lock") do |redis|
-        status = redis.get(key)
+        next_run = (redis.get("#{key}:next") || -1).to_f
 
-        if status.nil? || status.to_f < time.to_f
-          time_f = time.to_f
-          Sidekiq.logger.info "Sidetiq::Clock enqueue #{worker.name} (at: #{time_f})"
-          redis.set(key, time_f)
-          worker.perform_at(time)
+        if next_run < time_f
+          Sidekiq.logger.info "Sidetiq::Clock enqueue #{worker.name} (at: #{time_f}) (last: #{next_run})"
+
+          redis.mset("#{key}:last", next_run, "#{key}:next", time_f)
+
+          arity = [worker.instance_method(:perform).arity - 1, -1].max
+          args = [next_run, time_f][0..arity]
+
+          worker.perform_at(time, *args)
         end
       end
     end
@@ -147,24 +152,32 @@ module Sidetiq
     def synchronize_clockworks(lock)
       Sidekiq.redis do |redis|
         if redis.setnx(lock, 1)
-          Sidekiq.logger.debug "Sidetiq::Clock lock #{lock} #{Thread.current.inspect}"
+          Sidekiq.logger.debug "Sidetiq::Clock lock #{lock}"
 
           redis.pexpire(lock, Sidetiq.config.lock_expire)
           yield redis
           redis.del(lock)
 
-          Sidekiq.logger.debug "Sidetiq::Clock unlock #{lock} #{Thread.current.inspect}"
+          Sidekiq.logger.debug "Sidetiq::Clock unlock #{lock}"
         end
       end
     end
 
     def clock
       loop do
-        yield
-        Thread.pass
-        sleep Sidetiq.config.resolution
+        sleep_time = time { yield }
+
+        if sleep_time > 0
+          Thread.pass
+          sleep sleep_time
+        end
       end
     end
+
+    def time
+      start = gettime
+      yield
+      Sidetiq.config.resolution - (gettime.to_f - start.to_f)
+    end
   end
 end
-

data/lib/sidetiq/middleware.rb

@@ -6,7 +6,10 @@ module Sidetiq
 
     def call(*args)
       # Restart the clock if the thread died.
-      @clock.start! if !@clock.ticking?
+      if !@clock.ticking?
+        Sidekiq.logger.warn "Sidetiq::Clock thread died. Restarting..."
+        @clock.start!
+      end
       yield
     end
   end

data/lib/sidetiq/schedulable.rb

@@ -12,12 +12,28 @@ module Sidetiq
   #     end
   module Schedulable
     module ClassMethods
+      def last_scheduled_occurrence
+        get_timestamp "last"
+      end
+
+      def next_scheduled_occurrence
+        get_timestamp "next"
+      end
+
       def tiq(&block) # :nodoc:
         clock = Sidetiq::Clock.instance
         clock.synchronize do
           clock.schedule_for(self).instance_eval(&block)
         end
       end
+
+    private
+
+      def get_timestamp(key)
+        Sidekiq.redis do |redis|
+          (redis.get("sidetiq:#{name}:#{key}") || -1).to_f
+        end
+      end
     end
 
     def self.included(klass) # :nodoc:
@@ -25,4 +41,3 @@ module Sidetiq
     end
   end
 end
-

data/lib/sidetiq/version.rb

@@ -5,10 +5,10 @@ module Sidetiq
     MAJOR = 0
 
     # Public: Sidetiq minor version number.
-    MINOR = 1
+    MINOR = 2
 
     # Public: Sidetiq patch level.
-    PATCH = 5
+    PATCH = 0
 
     # Public: String representation of the current Sidetiq version.
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')

data/sidetiq.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.version       = Sidetiq::VERSION::STRING
   gem.authors       = ["Tobias Svensson"]
   gem.email         = ["tob@tobiassvensson.co.uk"]
-  gem.description   = "High-resolution job scheduler for Sidekiq"
+  gem.description   = "Recurring jobs for Sidekiq"
   gem.summary       = gem.description
   gem.homepage      = "http://github.com/tobiassvn/sidetiq"
   gem.license       = "MIT"
@@ -19,6 +19,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.extensions    = ['ext/sidetiq_ext/extconf.rb']
 
-  gem.add_dependency 'sidekiq',  '~> 2.7.0'
-  gem.add_dependency 'ice_cube', '~> 0.9.3'
+  gem.add_dependency 'sidekiq',  '~> 2.8.0'
+  gem.add_dependency 'ice_cube', '~> 0.10.0'
 end

data/test/helper.rb

@@ -1,5 +1,7 @@
-require 'simplecov'
-SimpleCov.start { add_filter "/test/" }
+if ENV["COVERAGE"]
+  require 'simplecov'
+  SimpleCov.start { add_filter "/test/" }
+end
 
 require 'minitest/autorun'
 require 'mocha/setup'

data/test/test_clock.rb

@@ -1,7 +1,9 @@
 require_relative 'helper'
 
 class TestClock < Sidetiq::TestCase
-  class FakeWorker;
+  class FakeWorker
+    def perform
+    end
   end
 
   def test_delegates_to_instance
@@ -61,5 +63,72 @@ class TestClock < Sidetiq::TestCase
     clock.tick
     clock.tick
   end
-end
 
+  class LastTickWorker
+    def perform last_tick
+    end
+  end
+
+  def test_enqueues_jobs_with_default_last_tick_arg_on_first_run
+    schedule = Sidetiq::Schedule.new(Sidetiq::Clock::START_TIME)
+    schedule.hourly
+
+    time = Time.local(2011, 1, 1, 1, 30)
+
+    clock.stubs(:gettime).returns(time, time + 3600)
+    clock.stubs(:schedules).returns(LastTickWorker => schedule)
+
+    expected_first_tick = time + 1800
+    expected_second_tick = expected_first_tick + 3600
+
+    LastTickWorker.expects(:perform_at).with(expected_first_tick, -1).once
+    LastTickWorker.expects(:perform_at).with(expected_second_tick, expected_first_tick.to_f).once
+
+    clock.tick
+    clock.tick
+  end
+
+  class LastAndScheduledTicksWorker
+    def perform last_tick, scheduled_tick
+    end
+  end
+
+  def test_enqueues_jobs_with_last_run_timestamp_and_next_run_timestamp
+    schedule = Sidetiq::Schedule.new(Sidetiq::Clock::START_TIME)
+    schedule.hourly
+
+    time = Time.local(2011, 1, 1, 1, 30)
+
+    clock.stubs(:gettime).returns(time, time + 3600)
+    clock.stubs(:schedules).returns(LastAndScheduledTicksWorker => schedule)
+
+    expected_first_tick = time + 1800
+    expected_second_tick = expected_first_tick + 3600
+
+    LastAndScheduledTicksWorker.expects(:perform_at).with(expected_first_tick, -1, expected_first_tick.to_f).once
+    clock.tick
+
+    LastAndScheduledTicksWorker.expects(:perform_at).with(expected_second_tick, expected_first_tick.to_f, expected_second_tick.to_f).once
+    clock.tick
+  end
+
+  class SplatArgsWorker
+    def perform arg1, *args
+    end
+  end
+
+  def test_enqueues_jobs_correctly_for_splat_args_perform_methods
+    schedule = Sidetiq::Schedule.new(Sidetiq::Clock::START_TIME)
+    schedule.hourly
+
+    time = Time.local(2011, 1, 1, 1, 30)
+
+    clock.stubs(:gettime).returns(time, time + 3600)
+    clock.stubs(:schedules).returns(SplatArgsWorker => schedule)
+
+    expected_first_tick = time + 1800
+
+    SplatArgsWorker.expects(:perform_at).with(expected_first_tick, -1, expected_first_tick.to_f).once
+    clock.tick
+  end
+end

data/test/test_worker.rb

@@ -0,0 +1,25 @@
+require_relative 'helper'
+
+class TestWorker < Sidetiq::TestCase
+  class FakeWorker
+    include Sidetiq::Schedulable
+  end
+
+  def test_timestamps_for_new_worker
+    assert FakeWorker.last_scheduled_occurrence == -1
+    assert FakeWorker.next_scheduled_occurrence == -1
+  end
+
+  def test_timestamps_for_existing_worker
+    last_run = (Time.now - 100).to_f
+    next_run = (Time.now + 100).to_f
+
+    Sidekiq.redis do |redis|
+      redis.set "sidetiq:TestWorker::FakeWorker:last", last_run
+      redis.set "sidetiq:TestWorker::FakeWorker:next", next_run
+    end
+
+    assert FakeWorker.last_scheduled_occurrence == last_run
+    assert FakeWorker.next_scheduled_occurrence == next_run
+  end
+end

metadata

@@ -2,21 +2,21 @@
 name: sidetiq
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Tobias Svensson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.8.0
     none: false
   name: sidekiq
   type: :runtime
@@ -25,14 +25,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.8.0
     none: false
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.3
+        version: 0.10.0
     none: false
   name: ice_cube
   type: :runtime
@@ -41,9 +41,9 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.3
+        version: 0.10.0
     none: false
-description: High-resolution job scheduler for Sidekiq
+description: Recurring jobs for Sidekiq
 email:
 - tob@tobiassvensson.co.uk
 executables: []
@@ -81,6 +81,7 @@ files:
 - test/test_schedule.rb
 - test/test_version.rb
 - test/test_web.rb
+- test/test_worker.rb
 homepage: http://github.com/tobiassvn/sidetiq
 licenses:
 - MIT
@@ -105,7 +106,7 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: High-resolution job scheduler for Sidekiq
+summary: Recurring jobs for Sidekiq
 test_files:
 - test/helper.rb
 - test/test_clock.rb
@@ -115,4 +116,5 @@ test_files:
 - test/test_schedule.rb
 - test/test_version.rb
 - test/test_web.rb
+- test/test_worker.rb
 has_rdoc: