sidekiq-limit_fetch 0.2

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg/

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 brainopia
+
+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,27 @@
+## Description
+
+Sidekig strategy to restrict number of workers
+which are able to run specified queues simultaneously.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sidekiq-limit_fetch'
+
+## Usage
+
+Specify limits which you want to place on queues inside sidekiq.yml:
+
+```yaml
+:limits:
+  queue_name1: 5
+  queue_name2: 10
+```
+
+In this example, tasks for the first restricted queue will be run by at most 5
+workers at the same time and the second queue will have no more than 10
+workers simultaneously.
+
+Sponsored by [Evil Martians].
+[Evil Martians]: http://evilmartians.com/

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sidekiq/limit_fetch/queue.rb

@@ -0,0 +1,14 @@
+class Sidekiq::LimitFetch
+  class Queue
+    extend Forwardable
+
+    attr_reader :name, :full_name
+    def_delegators :@lock, :acquire, :release
+
+    def initialize(name, limit)
+      @name = name
+      @full_name = "queue:#{name}"
+      @lock = Semaphore.for limit
+    end
+  end
+end

data/lib/sidekiq/limit_fetch/semaphore.rb

@@ -0,0 +1,28 @@
+class Sidekiq::LimitFetch::Semaphore
+  Stub = Struct.new(:acquire, :release)
+
+  def self.for(limit)
+    limit ? new(limit) : stub
+  end
+
+  def self.stub
+    @stub ||= Stub.new(true, true)
+  end
+
+  def initialize(limit)
+    @lock  = Mutex.new
+    @limit = limit
+  end
+
+  def acquire
+    @lock.synchronize do
+      @limit -= 1 if @limit > 0
+    end
+  end
+
+  def release
+    @lock.synchronize do
+      @limit += 1
+    end
+  end
+end

data/lib/sidekiq/limit_fetch/unit_of_work.rb

@@ -0,0 +1,16 @@
+Sidekiq::LimitFetch::UnitOfWork = Struct.new :queue_wrapper, :message do
+  extend Forwardable
+
+  def_delegator :queue_wrapper, :full_name, :queue
+  def_delegator :queue_wrapper, :name, :queue_name
+  def_delegator :queue_wrapper, :release
+
+  def acknowledge
+    release
+  end
+
+  def requeue
+    release
+    Sidekiq.redis {|it| it.rpush queue, message }
+  end
+end

data/lib/sidekiq/limit_fetch.rb

@@ -0,0 +1,59 @@
+require 'sidekiq'
+require 'sidekiq/fetch'
+
+class Sidekiq::LimitFetch
+  require_relative 'limit_fetch/semaphore'
+  require_relative 'limit_fetch/queue'
+  require_relative 'limit_fetch/unit_of_work'
+
+  Sidekiq.options[:fetch] = self
+
+  def initialize(options)
+    prepare_queues options
+    options[:strict] ? define_strict_queues : define_weighted_queues
+  end
+
+  def available_queues
+    fetch_queues.select(&:acquire)
+  end
+
+  def retrieve_work
+    queues = available_queues
+    queue_name, message = Sidekiq.redis do |it|
+      it.brpop *queues.map(&:full_name), Sidekiq::Fetcher::TIMEOUT
+    end
+
+    if message
+      queue = queues.find {|it| it.full_name == queue_name }
+      queues.delete queue
+
+      UnitOfWork.new queue, message
+    end
+  ensure
+    queues.each(&:release) if queues
+  end
+
+  private
+
+  def prepare_queues(options)
+    cache = {}
+    limits = options[:limits] || {}
+
+    @queues = options[:queues].map do |name|
+      cache[name] ||= Queue.new name, limits[name]
+    end
+  end
+
+  def define_strict_queues
+    @queues.uniq!
+    def fetch_queues
+      @queues
+    end
+  end
+
+  def define_weighted_queues
+    def fetch_queues
+      @queues.shuffle.uniq
+    end
+  end
+end

data/sidekiq-limit_fetch.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |gem|
+  gem.name          = 'sidekiq-limit_fetch'
+  gem.version       = '0.2'
+  gem.authors       = 'brainopia'
+  gem.email         = 'brainopia@evilmartians.com'
+  gem.summary       = 'Sidekig strategy to support queue limits'
+  gem.homepage      = 'https://github.com/brainopia/sidekiq-limit_fetch'
+  gem.description   = <<-DESCRIPTION
+    Sidekig strategy to restrict number of workers
+    which are able to run specified queues simultaneously.
+  DESCRIPTION
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep %r{^spec/}
+  gem.require_paths = %w(lib)
+
+  gem.add_dependency 'sidekiq', '>= 2.6.3'
+  gem.add_development_dependency 'rspec'
+end

data/spec/integration_spec.rb

@@ -0,0 +1,67 @@
+require 'sidekiq/limit_fetch'
+
+describe Sidekiq::LimitFetch do
+  before :each do
+    Sidekiq.redis do |it|
+      it.del 'queue:example'
+      it.rpush 'queue:example', 'task'
+      it.expire 'queue:example', 30
+    end
+  end
+
+  def queues(fetcher)
+    fetcher.available_queues.map(&:full_name)
+  end
+
+  def new_fetcher(options={})
+    described_class.new options.merge queues: %w(example example example2 example2)
+  end
+
+  it 'should retrieve weighted queues' do
+    fetcher = new_fetcher
+    queues(fetcher).should =~ %w(queue:example queue:example2)
+  end
+
+  it 'should retrieve strictly ordered queues' do
+    fetcher = new_fetcher strict: true
+    queues(fetcher).should == %w(queue:example queue:example2)
+  end
+
+  it 'should retrieve limited queues' do
+    fetcher = new_fetcher strict: true, limits: { 'example' => 2 }
+    queues = -> { fetcher.available_queues }
+
+    queues1 = queues.call
+    queues2 = queues.call
+    queues1.should have(2).items
+    queues2.should have(2).items
+    queues.call.should have(1).items
+
+    queues1.each(&:release)
+    queues.call.should have(2).items
+    queues.call.should have(1).items
+
+    queues2.each(&:release)
+    queues.call.should have(2).items
+    queues.call.should have(1).items
+  end
+
+  it 'should acquire lock on queue for excecution' do
+    fetcher = new_fetcher limits: { 'example' => 1, 'example2' => 1 }
+    work = fetcher.retrieve_work
+    work.message.should == 'task'
+    work.queue.should == 'queue:example'
+    work.queue_name.should == 'example'
+
+    queues = fetcher.available_queues
+    queues.should have(1).item
+    queues.each(&:release)
+
+    work.requeue
+    work = fetcher.retrieve_work
+    work.message.should == 'task'
+    work.acknowledge
+
+    fetcher.available_queues.should have(2).items
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-limit_fetch
+version: !ruby/object:Gem::Version
+  version: '0.2'
+  prerelease: 
+platform: ruby
+authors:
+- brainopia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+    none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+    none: false
+- !ruby/object:Gem::Dependency
+  name: rspec
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: ! "    Sidekig strategy to restrict number of workers\n    which are
+  able to run specified queues simultaneously.\n"
+email: brainopia@evilmartians.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq/limit_fetch.rb
+- lib/sidekiq/limit_fetch/queue.rb
+- lib/sidekiq/limit_fetch/semaphore.rb
+- lib/sidekiq/limit_fetch/unit_of_work.rb
+- sidekiq-limit_fetch.gemspec
+- spec/integration_spec.rb
+homepage: https://github.com/brainopia/sidekiq-limit_fetch
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Sidekig strategy to support queue limits
+test_files:
+- spec/integration_spec.rb