sidekiq-priority 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 SocialPandas
+
+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,44 @@
+Sidekiq Priority
+================
+Prioritize Sidekiq jobs within queues
+
+Overview
+--------
+
+Sidekiq Priority lets you prioritize the jobs within any Sidekiq queue.
+
+For example, say you've added 5 jobs:
+
+```ruby
+5.times.do
+  MyWorker.perform_async(42)
+end
+```
+
+Using Sidekiq Priority, you can add new jobs that have a higher priority by calling perform_with_priority instead of perform_async:
+
+```ruby
+MyWorker.perform_with_priority(:high, 42)
+```
+
+This job won't interrupt any running jobs, but it'll start before any other jobs in the queue do.
+
+You can also add jobs that should only run with lower priority than the default priority:
+
+```ruby
+MyWorker.perform_with_priority(:low, 42)
+```
+
+### Custom Priorities
+
+By default, two priorities are available: `:high` (above the default prioritization of perform_async) and `:low` (below the default prioritization), but you can add others (these values should be symbols, and `nil` represents the default prioritization):
+
+```ruby
+# config/initializers/sidekiq_priority.rb
+Sidekiq::Priorities.priorities = [:very_high, :high, nil, :low]
+```
+
+License
+-------
+
+Sidekiq Priority is released under the MIT License. Please see the MIT-LICENSE file for details.

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/priority/server/fetch.rb

@@ -0,0 +1,29 @@
+require 'sidekiq/fetch'
+
+module Sidekiq
+  module Priority
+    module Server
+      class Fetch < Sidekiq::BasicFetch
+        def initialize(options)
+          queues = prioritized_queues(options[:queues])
+          @strictly_ordered_queues = !!options[:strict]
+          @queues = queues.map { |q| "queue:#{q}" }
+          @unique_queues = @queues.uniq
+        end
+
+        protected
+
+        def prioritized_queues(base_queues)
+          queues = []
+          priorities = Sidekiq::Priority.priorities
+          priorities.each do |priority|
+            base_queues.each do |queue|
+              queues << Sidekiq::Priority.queue_with_priority(queue, priority)
+            end
+          end
+          queues
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/priority/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Priority
+    VERSION = '0.0.1'
+  end
+end

data/lib/sidekiq/priority.rb

@@ -0,0 +1,30 @@
+require 'sidekiq'
+require 'celluloid'
+
+directory = File.dirname(File.absolute_path(__FILE__))
+Dir.glob("#{directory}/priority/**/*.rb") { |file| require file }
+Dir.glob("#{directory}/superworker/**/*.rb") { |file| require file } if defined?(Sidekiq::Superworker)
+require "#{directory}/worker_ext.rb"
+
+module Sidekiq
+  module Priority
+    PRIORITIES = [:high, nil, :low]
+
+    def self.priorities
+      @priorities ||= PRIORITIES.dup
+    end
+
+    def self.priorities=(priorities)
+      @priorities = priorities
+    end
+
+    def self.queue_with_priority(queue, priority)
+      priority.nil? ? queue : "#{queue}_#{priority}"
+    end
+  end
+end
+
+Sidekiq.configure_server do |config|
+  Dir.glob("#{directory}/priority/server/*.rb") { |file| require file }
+  Sidekiq.options[:fetch] = Sidekiq::Priority::Server::Fetch
+end

data/lib/sidekiq/superworker/subjob_processor.rb

@@ -0,0 +1,22 @@
+module Sidekiq
+  module Superworker
+    class SubjobProcessor
+      class << self
+        alias_method :original_sidekiq_item, :sidekiq_item
+
+        def sidekiq_item(subjob, klass, jid)
+          item = original_sidekiq_item(subjob, klass, jid)
+
+          # Modify the queue to be the prioritized queue, if necessary
+          priority = subjob.meta ? subjob.meta[:priority] : nil
+          if priority
+            queue = klass.get_sidekiq_options['queue']
+            queue = Sidekiq::Priority.queue_with_priority(queue, priority)
+            item['queue'] = queue
+          end
+          item
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/superworker/worker_class.rb

@@ -0,0 +1,15 @@
+module Sidekiq
+  module Superworker
+    class WorkerClass
+      class << self
+        def perform_with_priority(priority, *arg_values)
+          options = initialize_superjob(arg_values)
+          options[:meta] ||= {}
+          options[:meta].merge!({ priority: priority })
+          subjobs = create_subjobs(arg_values, options)
+          SuperjobProcessor.create(@superjob_id, @class_name, arg_values, subjobs, options)
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/worker_ext.rb

@@ -0,0 +1,11 @@
+module Sidekiq
+  module Worker
+    module ClassMethods
+      def perform_with_priority(priority, *args)
+        queue = self.get_sidekiq_options['queue']
+        queue = Sidekiq::Priority.queue_with_priority(queue, priority)
+        client_push('class' => self, 'args' => args, 'queue' => queue)
+      end
+    end
+  end
+end

data/lib/sidekiq-priority.rb

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

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-priority
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tom Benner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-10 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.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: Prioritize Sidekiq jobs within queues
+email:
+- tombenner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sidekiq/priority/server/fetch.rb
+- lib/sidekiq/priority/version.rb
+- lib/sidekiq/priority.rb
+- lib/sidekiq/superworker/subjob_processor.rb
+- lib/sidekiq/superworker/worker_class.rb
+- lib/sidekiq/worker_ext.rb
+- lib/sidekiq-priority.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/socialpandas/sidekiq-priority
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Prioritize Sidekiq jobs within queues
+test_files: []