sidekiq-lock 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+
+notifications:
+  email: false

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1
+
+- Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sidekiq-lock.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Rafal Wojsznis
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# Sidekiq::Lock
+
+[![Code Climate](https://codeclimate.com/github/emq/sidekiq-lock.png)](https://codeclimate.com/github/emq/sidekiq-lock)
+[![Build Status](https://travis-ci.org/emq/sidekiq-lock.png?branch=master)](https://travis-ci.org/emq/sidekiq-lock)
+
+Redis-based simple locking mechanism for [sidekiq][2]. Uses [SET command][1] introduced in Redis 2.6.16.
+
+It can be handy if you push a lot of jobs into the queue(s), but you don't want to execute specific jobs at the same time - it provides a `lock` method that you can use in whatever way you want.
+
+## Installation
+
+This gem requires at least:
+- redis 2.6.12
+- redis-rb 3.0.5 (support for extended SET method)
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'sidekiq-lock'
+```
+
+And then execute:
+
+``` bash
+$ bundle
+```
+
+## Usage
+
+Sidekiq-lock is a middleware/module combination, let me go through my thought process here :).
+
+In your worker class include `Sidekiq::Lock::Worker` module and provide `lock` attribute inside `sidekiq_options`, for example:
+
+``` ruby
+class Worker
+  include Sidekiq::Worker
+  include Sidekiq::Lock::Worker
+
+  # static lock that expires after one second
+  sidekiq_options lock: { timeout: 1000, name: 'lock-worker' }
+
+  def perform
+    # ...
+  end
+end
+```
+
+What will happen is:
+
+- middleware will setup a `Sidekiq::Lock::RedisLock` object under `Thread.current[Sidekiq::Lock::THREAD_KEY]` (well, I had no better idea for this) - assuming you provided `lock` options, otherwise it will do nothing, just execute your worker's code
+
+- `Sidekiq::Lock::Worker` module provides a `lock` method that just simply points to that thread variable, just as a convenience
+
+So now in your worker class you can call (whenever you need):
+
+- `lock.acquire!` - will try to acquire the lock, if returns false on failure (that means some other process / thread took the lock first)
+- `lock.acquired?` - set to `true` when lock is successfully acquired
+- `lock.release!` - deletes the lock (if not already expired / taken by another process)
+
+### Lock options
+
+sidekiq_options lock will accept static values or `Proc` that will be called on argument(s) passed to `perform` method.
+
+- timeout - specified expire time, in milliseconds
+- name - name of the redis key that will be used as lock name
+
+Dynamic lock example:
+
+``` ruby
+class Worker
+  include Sidekiq::Worker
+  include Sidekiq::Lock::Worker
+  sidekiq_options lock: {
+    timeout: proc { |user_id, timeout| timeout * 2 },
+    name:    proc { |user_id, timeout| "lock:peruser:#{user_id}" }
+  }
+
+  def perform(user_id, timeout)
+    # ...
+    # do some work
+    # only at this point I want to acquire the lock
+    if lock.acquire!
+      # I can do the work
+    else
+      # reschedule, raise an error or do whatever you want
+    end
+  end
+end
+```
+
+Just be sure to provide valid redis key as a lock name.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[1]: http://redis.io/commands/set
+[2]: https://github.com/mperham/sidekiq

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/lib/sidekiq-lock.rb

@@ -0,0 +1 @@
+require 'sidekiq/lock'

data/lib/sidekiq/lock.rb

@@ -0,0 +1,16 @@
+require "sidekiq/lock/version"
+require "sidekiq/lock/worker"
+require "sidekiq/lock/middleware"
+require "sidekiq/lock/redis_lock"
+
+module Sidekiq
+  module Lock
+    THREAD_KEY = :sidekiq_lock
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Lock::Middleware
+  end
+end

data/lib/sidekiq/lock/middleware.rb

@@ -0,0 +1,24 @@
+module Sidekiq
+  module Lock
+    class Middleware
+
+      def call(worker, msg, queue)
+        options = lock_options(worker)
+        setup_lock(options, msg['args']) unless options.nil?
+
+        yield
+      end
+
+      private
+
+        def setup_lock(options, payload)
+          Thread.current[Sidekiq::Lock::THREAD_KEY] = RedisLock.new(options, payload)
+        end
+
+        def lock_options(worker)
+          worker.class.get_sidekiq_options['lock']
+        end
+
+    end
+  end
+end

data/lib/sidekiq/lock/redis_lock.rb

@@ -0,0 +1,72 @@
+module Sidekiq
+  module Lock
+    class RedisLock
+      attr_reader :options, :payload
+
+      # checks for configuration
+      def initialize(options, payload)
+        @options  = options.symbolize_keys
+        @payload  = payload
+        @acquired = false
+
+        timeout
+        name
+      end
+
+      def acquired?
+        @acquired
+      end
+
+      # acquire lock using modified SET command introduced in Redis 2.6.12
+      # this also requires redis-rb >= 3.0.5
+      def acquire!
+        @acquired ||= Sidekiq.redis do |r|
+          r.set(name, value, { nx: true, px: timeout })
+        end
+      end
+
+      def release!
+        Sidekiq.redis do |r|
+          begin
+            r.evalsha redis_lock_script_sha, keys: [name], argv: [value]
+            rescue Redis::CommandError
+              r.eval redis_lock_script, keys: [name], argv: [value]
+          end
+        end
+      end
+
+      def name
+        raise ArgumentError, "Provide a lock name inside sidekiq_options" if options[:name].nil?
+
+        @name ||= (options[:name].respond_to?(:call) ? options[:name].call(*payload) : options[:name])
+      end
+
+      def timeout
+        raise ArgumentError, "Provide lock timeout inside sidekiq_options" if options[:timeout].nil?
+
+        @timeout ||= (options[:timeout].respond_to?(:call) ? options[:timeout].call(*payload) : options[:timeout]).to_i
+      end
+
+      private
+
+        def redis_lock_script_sha
+          @lock_script_sha ||= Digest::SHA1.hexdigest redis_lock_script
+        end
+
+        def redis_lock_script
+          <<-LUA
+          if redis.call("get", KEYS[1]) == ARGV[1]
+          then
+            return redis.call("del",KEYS[1])
+          else
+            return 0
+          end
+          LUA
+        end
+
+        def value
+          @value ||= SecureRandom.hex(25)
+        end
+    end
+  end
+end

data/lib/sidekiq/lock/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Lock
+    VERSION = "0.0.1"
+  end
+end

data/lib/sidekiq/lock/worker.rb

@@ -0,0 +1,11 @@
+module Sidekiq
+  module Lock
+    module Worker
+
+      def lock
+        Thread.current[Sidekiq::Lock::THREAD_KEY]
+      end
+
+    end
+  end
+end

data/sidekiq-lock.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/lock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-lock"
+  spec.version       = Sidekiq::Lock::VERSION
+  spec.authors       = ["Rafal Wojsznis"]
+  spec.email         = ["rafal.wojsznis@gmail.com"]
+  spec.description   = spec.summary = "Simple redis-based lock mechanism for your sidekiq workers"
+  spec.homepage      = "https://github.com/emq/sidekiq-lock"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sidekiq", ">= 2.14.0"
+  spec.add_dependency "redis",   ">= 3.0.5"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+end

data/test/lib/middleware_test.rb

@@ -0,0 +1,67 @@
+require "test_helper"
+
+class LockWorker
+  include Sidekiq::Worker
+  include Sidekiq::Lock::Worker
+  sidekiq_options lock: { timeout: 1, name: 'lock-worker' }
+end
+
+class DynamicLockWorker
+  include Sidekiq::Worker
+  include Sidekiq::Lock::Worker
+  sidekiq_options lock: {
+    timeout: proc { |user_id, timeout| timeout*2 },
+    name:    proc { |user_id, timeout| "lock:#{user_id}" }
+  }
+end
+
+class RegularWorker
+  include Sidekiq::Worker
+  include Sidekiq::Lock::Worker
+end
+
+
+module Sidekiq
+  module Lock
+    describe Middleware do
+
+      def thread_variable
+        Thread.current[Sidekiq::Lock::THREAD_KEY]
+      end
+
+      before do
+        Sidekiq.redis = REDIS
+        Sidekiq.redis { |c| c.flushdb }
+        Thread.current[Sidekiq::Lock::THREAD_KEY] = nil
+      end
+
+      let(:handler){ Sidekiq::Lock::Middleware.new }
+
+      it 'sets lock variable with provided static lock options' do
+        handler.call(LockWorker.new, {'class' => LockWorker, 'args' => []}, 'default') do
+          true
+        end
+
+        assert_kind_of RedisLock, thread_variable
+      end
+
+      it 'sets lock variable with provided dynamic options' do
+        handler.call(DynamicLockWorker.new, {'class' => DynamicLockWorker, 'args' => [1234, 1000]}, 'default') do
+          true
+        end
+
+        assert_equal "lock:1234", thread_variable.name
+        assert_equal 2000,   thread_variable.timeout
+      end
+
+      it 'sets nothing for workers without lock options' do
+        handler.call(RegularWorker.new, {'class' => RegularWorker, 'args' => []}, 'default') do
+          true
+        end
+
+        assert_nil thread_variable
+      end
+
+    end
+  end
+end

data/test/lib/redis_lock_test.rb

@@ -0,0 +1,84 @@
+require "test_helper"
+
+module Sidekiq
+  module Lock
+    describe RedisLock do
+      before do
+        Sidekiq.redis = REDIS
+        Sidekiq.redis { |c| c.flushdb }
+      end
+
+      let(:args) { [{'timeout' => 100, 'name' => 'test-lock'}, []] }
+
+      it "raises an error on missing timeout&name values" do
+        assert_raises ArgumentError do
+          RedisLock.new({},[])
+        end
+      end
+
+      it "raises an error on missing timeout value" do
+        assert_raises ArgumentError do
+          RedisLock.new({ 'name' => 'this-is-lock' }, [])
+        end
+      end
+
+      it "raises an error on missing name value" do
+        assert_raises ArgumentError do
+          RedisLock.new({ 'timeout' => 500 }, [])
+        end
+      end
+
+      it "does not raise an error when timeout and name is provided" do
+        assert RedisLock.new({ 'timeout' => 500, 'name' => 'lock-name' }, [])
+      end
+
+      it "can accept block as arguments" do
+        lock = RedisLock.new({
+            'timeout' => proc { |options| options['timeout'] * 2 },
+            'name'    => proc { |options| "#{options['test']}-sidekiq" }
+          }, ['timeout' => 500, 'test' => 'hello'])
+
+        assert_equal 1000, lock.timeout
+        assert_equal 'hello-sidekiq', lock.name
+      end
+
+      it "can acquire a lock" do
+        lock = RedisLock.new(*args)
+        assert lock.acquire!
+      end
+
+      it "cannot aquire lock if it's already taken by other process/thread" do
+        faster_lock = RedisLock.new(*args)
+        assert faster_lock.acquire!
+
+        slower_lock = RedisLock.new(*args)
+        refute slower_lock.acquire!
+      end
+
+      it "releases taken lock" do
+        lock = RedisLock.new(*args)
+        lock.acquire!
+        assert redis("get", "test-lock")
+
+        lock.release!
+        assert_nil redis("get", "test-lock")
+      end
+
+      it "releases lock taken by another process without deleting lock key" do
+        lock = RedisLock.new(*args)
+        lock.acquire!
+        lock_value = redis("get", "test-lock")
+        assert lock_value
+        sleep 0.11 # timeout lock
+
+        new_lock = RedisLock.new(*args)
+        new_lock.acquire!
+        new_lock_value = redis("get", "test-lock")
+
+        lock.release!
+
+        assert_equal new_lock_value, redis("get", "test-lock")
+      end
+    end
+  end
+end

data/test/lib/worker_test.rb

@@ -0,0 +1,14 @@
+require "test_helper"
+
+module Sidekiq
+  module Lock
+    describe Worker do
+
+      it 'sets lock method that points to thread variable' do
+        Thread.current[Sidekiq::Lock::THREAD_KEY] = "test"
+        assert_equal "test", LockWorker.new.lock
+      end
+
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+require "minitest/autorun"
+require "minitest/pride"
+
+require "sidekiq"
+require "sidekiq-lock"
+
+Sidekiq.logger.level = Logger::ERROR
+
+REDIS = Sidekiq::RedisConnection.create(url: "redis://localhost/15", namespace: "sidekiq_lock_test")
+
+def redis(command, *args)
+  Sidekiq.redis do |c|
+    c.send(command, *args)
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-lock
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rafal Wojsznis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple redis-based lock mechanism for your sidekiq workers
+email:
+- rafal.wojsznis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq-lock.rb
+- lib/sidekiq/lock.rb
+- lib/sidekiq/lock/middleware.rb
+- lib/sidekiq/lock/redis_lock.rb
+- lib/sidekiq/lock/version.rb
+- lib/sidekiq/lock/worker.rb
+- sidekiq-lock.gemspec
+- test/lib/middleware_test.rb
+- test/lib/redis_lock_test.rb
+- test/lib/worker_test.rb
+- test/test_helper.rb
+homepage: https://github.com/emq/sidekiq-lock
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 153540864602808106
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 153540864602808106
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Simple redis-based lock mechanism for your sidekiq workers
+test_files:
+- test/lib/middleware_test.rb
+- test/lib/redis_lock_test.rb
+- test/lib/worker_test.rb
+- test/test_helper.rb