sidetiq 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79f2b65ef53704beb2a8b0176b5a72a840b5df07
-  data.tar.gz: 99004a1cb008a81248c80217603b041f6c44fcb8
+  metadata.gz: 1df64df09fdf5d7e87b13410a3a8b39c325fd70a
+  data.tar.gz: 43e79f2eb7c71065ba27f54cf8e36924c8575250
 SHA512:
-  metadata.gz: 8e15758167ae4177fa2dcf367fb40b5a1070b4815f78105d0437df53a9f478b81a7ac6e9c3b01d6420fd08be1f230bb3464a808a72d6c42469e4c64ca9b1db3a
-  data.tar.gz: 534269b3b8e92d1fd4ff9f3f15e82145fc180f9f976a697fa8a2ad4ba9220cae2e7a26b480eba5dea001dfdd43f1efd06d3c52aa9a50f3c804e47c8ae844a176
+  metadata.gz: 3b11cd2d90c41504bd9914ca3058cc242c9d4819d4d8550348e2326d85aaacbcf9293f02f5ac01b058be6b222f94eedbca5bafeba76c3cc231e168c1d63a964c
+  data.tar.gz: c5b583be6d96c52e8494bc790c406f5d06cd84e0e0b643e0ca14ef9eae1dc36b5e858cfde858a2e8891d3c11bb18d2982f4018370beba0451cccd54f1171930d

data/.travis.yml

@@ -1,6 +1,39 @@
 language: ruby
+branches:
+  only:
+    - master
+services:
+  - redis-server
 rvm:
   - 1.9.3
   - 2.0.0
   - jruby-19mode
   - rbx-19mode
+  - ruby-head
+  - jruby-head
+jdk:
+  - openjdk6
+  - openjdk7
+  - oraclejdk7
+matrix:
+  exclude:
+    - rvm: 2.0.0
+      jdk: openjdk7
+    - rvm: 2.0.0
+      jdk: openjdk6
+    - rvm: 1.9.3
+      jdk: openjdk7
+    - rvm: 1.9.3
+      jdk: openjdk6
+    - rvm: rbx-19mode
+      jdk: openjdk7
+    - rvm: rbx-19mode
+      jdk: openjdk6
+    - rvm: ruby-head
+      jdk: openjdk7
+    - rvm: ruby-head
+      jdk: openjdk6
+  allow_failures:
+    - rvm: rbx-19mode
+    - rvm: ruby-head
+    - rvm: jruby-head

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+0.3.6
+-----
+
+- Better protection against stale locks and race-conditions.
+
+  Locking is now done using WATCH/MULTI/EXEC/UNWATCH and additionally
+  includes a host and process specific identifier to prevent accidental
+  unlocks from other Sidekiq processes.
+
+- Fix Sidetiq::Schedulable documentation.
+
 0.3.5
 -----
 

data/lib/sidetiq.rb

@@ -2,6 +2,7 @@
 require 'monitor'
 require 'ostruct'
 require 'singleton'
+require 'socket'
 
 # gems
 require 'ice_cube'
@@ -10,6 +11,7 @@ require 'sidekiq'
 # internal
 require 'sidetiq/config'
 require 'sidetiq/clock'
+require 'sidetiq/lock'
 require 'sidetiq/middleware'
 require 'sidetiq/schedule'
 require 'sidetiq/schedulable'

data/lib/sidetiq/clock.rb

@@ -52,7 +52,7 @@ module Sidetiq
       tick = gettime
       mon_synchronize do
         schedules.each do |worker, sched|
-          synchronize_clockworks(worker) do |redis|
+          Lock.new(worker).synchronize do |redis|
             if sched.backfill? && (last = worker.last_scheduled_occurrence) > 0
               last = Sidetiq.config.utc ? Time.at(last).utc : Time.at(last)
               sched.occurrences_between(last + 1, tick).each do |past_t|
@@ -150,24 +150,6 @@ module Sidetiq
       end
     end
 
-    def synchronize_clockworks(klass)
-      lock = "sidetiq:#{klass.name}:lock"
-
-      Sidekiq.redis do |redis|
-        if redis.setnx(lock, 1)
-          Sidetiq.logger.debug "Sidetiq::Clock lock #{lock}"
-
-          begin
-            redis.pexpire(lock, Sidetiq.config.lock_expire)
-            yield redis
-          ensure
-            redis.del(lock)
-            Sidetiq.logger.debug "Sidetiq::Clock unlock #{lock}"
-          end
-        end
-      end
-    end
-
     def clock
       loop do
         sleep_time = time { yield }

data/lib/sidetiq/lock.rb

@@ -0,0 +1,63 @@
+module Sidetiq
+  class Lock # :nodoc: all
+    attr_reader :key, :timeout
+
+    OWNER = "#{Socket.gethostname}:#{Process.pid}"
+
+    def initialize(key, timeout = Sidetiq.config.lock_expire)
+      @key  = key.kind_of?(Class) ? "sidetiq:#{key.name}:lock" : "sidetiq:#{key}:lock"
+      @timeout   = timeout
+    end
+
+    def synchronize
+      Sidekiq.redis do |redis|
+        if lock(redis)
+          Sidetiq.logger.debug "Sidetiq::Clock lock #{key}"
+
+          begin
+            yield redis
+          ensure
+            unlock(redis)
+            Sidetiq.logger.debug "Sidetiq::Clock unlock #{key}"
+          end
+        end
+      end
+    end
+
+    private
+
+    def lock(redis)
+      acquired = false
+
+      watch(redis, key) do
+        if !redis.exists(key)
+          acquired = !!redis.multi do |multi|
+            multi.psetex(key, timeout, OWNER)
+          end
+        end
+      end
+
+      acquired
+    end
+
+    def unlock(redis)
+      watch(redis, key) do
+        if redis.get(key) == OWNER
+          redis.multi do |multi|
+            multi.del(key)
+          end
+        end
+      end
+    end
+
+    def watch(redis, *args)
+      redis.watch(*args)
+
+      begin
+        yield
+      ensure
+        redis.unwatch
+      end
+    end
+  end
+end

data/lib/sidetiq/schedulable.rb

@@ -8,7 +8,7 @@ module Sidetiq
   #     include Sidetiq::Schedulable
   #
   #     # Daily at midnight
-  #     tiq { daily }
+  #     recurrence { daily }
   #   end
   module Schedulable
     module ClassMethods

data/lib/sidetiq/schedule.rb

@@ -47,7 +47,7 @@ module Sidetiq
     #     include Sidekiq::Worker
     #     include Sidetiq::Schedulable
     #
-    #     tiq { daily }
+    #     recurrence { daily }
     #
     #     def perform
     #     end

data/lib/sidetiq/version.rb

@@ -8,7 +8,7 @@ module Sidetiq
     MINOR = 3
 
     # Public: Sidetiq patch level.
-    PATCH = 5
+    PATCH = 6
 
     # Public: String representation of the current Sidetiq version.
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')

data/test/test_lock.rb

@@ -0,0 +1,30 @@
+require_relative 'helper'
+
+class TestLock < Sidetiq::TestCase
+  def test_locking
+    lock_name = SecureRandom.hex(8)
+    key = SecureRandom.hex(8)
+
+    Sidekiq.redis do |redis|
+      redis.set(key, 0)
+
+      5.times.map do
+        Thread.start do
+          locked(lock_name) do |r|
+            sleep 0.1
+            r.incr(key)
+          end
+        end
+      end.each(&:join)
+
+      assert_equal "1", redis.get(key)
+    end
+  end
+
+  def locked(lock_name)
+    Sidetiq::Lock.new(lock_name).synchronize do |redis|
+      yield redis
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidetiq
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Tobias Svensson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-29 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -56,6 +56,7 @@ files:
 - lib/sidetiq.rb
 - lib/sidetiq/clock.rb
 - lib/sidetiq/config.rb
+- lib/sidetiq/lock.rb
 - lib/sidetiq/middleware.rb
 - lib/sidetiq/schedulable.rb
 - lib/sidetiq/schedule.rb
@@ -73,6 +74,7 @@ files:
 - test/helper.rb
 - test/test_clock.rb
 - test/test_config.rb
+- test/test_lock.rb
 - test/test_middleware.rb
 - test/test_schedule.rb
 - test/test_sidetiq.rb
@@ -113,6 +115,7 @@ test_files:
 - test/helper.rb
 - test/test_clock.rb
 - test/test_config.rb
+- test/test_lock.rb
 - test/test_middleware.rb
 - test/test_schedule.rb
 - test/test_sidetiq.rb