sidekiq 2.1.1 → 2.2.0

data/Changes.md

@@ -1,3 +1,17 @@
+2.2.0
+-----------
+
+- Add extension to delay any arbitrary class method to Sidekiq.
+  Previously this was limited to ActiveRecord classes.
+
+```ruby
+SomeClass.delay.class_method(1, 'mike', Date.today)
+```
+
+- Sidekiq::Client now generates and returns a random, 128-bit Job ID 'jid' which
+  can be used to track the processing of a Job, e.g. for calling back to a webhook
+  when a job is finished.
+
 2.1.1
 -----------
 

data/Gemfile

@@ -5,7 +5,7 @@ gem 'celluloid'
 gem 'slim'
 gem 'sprockets'
 gem 'sass'
-gem 'rails', '3.2.6'
+gem 'rails', '3.2.8'
 gem 'sqlite3'
 
 group :test do

data/README.md

@@ -1,6 +1,9 @@
-Sidekiq [![Build Status](https://secure.travis-ci.org/mperham/sidekiq.png)](http://travis-ci.org/mperham/sidekiq)
+Sidekiq
 ==============
 
+[![Build Status](https://secure.travis-ci.org/mperham/sidekiq.png)](http://travis-ci.org/mperham/sidekiq)
+[![Dependency Status](https://gemnasium.com/mperham/sidekiq.png)](https://gemnasium.com/mperham/sidekiq)
+
 Simple, efficient message processing for Ruby.
 
 Sidekiq uses threads to handle many messages at the same time in the
@@ -60,7 +63,8 @@ Problems?
 
 **Please do not directly email any Sidekiq committers with questions or problems.**  A community is best served when discussions are held in public.
 
-If you have a problem, please review the [FAQ](/mperham/sidekiq/wiki/FAQ) and [Troubleshooting](/mperham/sidekiq/wiki/Problems-and-Troubleshooting) wiki pages.  Searching the issues for your problem is also a good idea.  If that doesn't help, feel free to email the Sidekiq mailing list or open a new issue.
+If you have a problem, please review the [FAQ](/mperham/sidekiq/wiki/FAQ) and [Troubleshooting](/mperham/sidekiq/wiki/Problems-and-Troubleshooting) wiki pages. Searching the issues for your problem is also a good idea.  If that doesn't help, feel free to email the Sidekiq mailing list or open a new issue.
+The mailing list is the preferred place to ask questions on usage. If you are encountering what you think is a bug, please open an issue.
 
 
 License

data/lib/sidekiq.rb

@@ -5,6 +5,7 @@ require 'sidekiq/worker'
 require 'sidekiq/redis_connection'
 require 'sidekiq/util'
 
+require 'sidekiq/extensions/class_methods'
 require 'sidekiq/extensions/action_mailer'
 require 'sidekiq/extensions/active_record'
 require 'sidekiq/rails' if defined?(::Rails::Engine)

data/lib/sidekiq/cli.rb

@@ -58,7 +58,7 @@ module Sidekiq
       options.merge!(config.merge(cli))
 
       Sidekiq.logger.level = Logger::DEBUG if options[:verbose]
-      Celluloid.logger = nil
+      Celluloid.logger = nil unless options[:verbose]
 
       validate!
       write_pid
@@ -141,7 +141,7 @@ module Sidekiq
 
       @parser = OptionParser.new do |o|
         o.on "-q", "--queue QUEUE[,WEIGHT]...", "Queues to process with optional weights" do |arg|
-          queues_and_weights = arg.scan(/(\w+),?(\d*)/)
+          queues_and_weights = arg.scan(/([\w-]+),?(\d*)/)
           queues_and_weights.each {|queue_and_weight| parse_queues(opts, *queue_and_weight)}
           opts[:strict] = queues_and_weights.collect(&:last).none? {|weight| weight != ''}
         end

data/lib/sidekiq/client.rb

@@ -28,6 +28,8 @@ module Sidekiq
     # All options must be strings, not symbols.  NB: because we are serializing to JSON, all
     # symbols in 'args' will be converted to strings.
     #
+    # Returns nil if not pushed to Redis or a unique Job ID if pushed.
+    #
     # Example:
     #   Sidekiq::Client.push('queue' => 'my_queue', 'class' => MyWorker, 'args' => ['foo', 1, :bat => 'bar'])
     #
@@ -42,6 +44,7 @@ module Sidekiq
       item = worker_class.get_sidekiq_options.merge(item)
       item['retry'] = !!item['retry']
       queue = item['queue']
+      item['jid'] = SecureRandom.base64
 
       pushed = false
       Sidekiq.client_middleware.invoke(worker_class, item, queue) do
@@ -57,7 +60,7 @@ module Sidekiq
           end
         end
       end
-      !! pushed
+      pushed ? item['jid'] : nil
     end
 
     # Redis compatibility helper.  Example usage:

data/lib/sidekiq/exception_handler.rb

@@ -24,7 +24,7 @@ module Sidekiq
     end
 
     def send_to_exception_notifier(msg, ex)
-      ::ExceptionNotifier::Notifier.background_exception_notification(ex, :data => { :message => msg })
+      ::ExceptionNotifier::Notifier.background_exception_notification(ex, :data => { :message => msg }).deliver
     end
   end
 end

data/lib/sidekiq/extensions/active_record.rb

@@ -3,11 +3,14 @@ require 'sidekiq/extensions/generic_proxy'
 module Sidekiq
   module Extensions
     ##
-    # Adds a 'delay' method to ActiveRecord to offload arbitrary method
+    # Adds a 'delay' method to ActiveRecords to offload instance method
     # execution to Sidekiq.  Examples:
     #
-    # User.delay.delete_inactive
     # User.recent_signups.each { |user| user.delay.mark_as_awesome }
+    #
+    # Please note, this is not recommended as this will serialize the entire
+    # object to Redis.  Your Sidekiq jobs should pass IDs, not entire instances.
+    # This is here for backwards compatibility with Delayed::Job only.
     class DelayedModel
       include Sidekiq::Worker
 

data/lib/sidekiq/extensions/class_methods.rb

@@ -0,0 +1,33 @@
+require 'sidekiq/extensions/generic_proxy'
+
+module Sidekiq
+  module Extensions
+    ##
+    # Adds a 'delay' method to all Classes to offload class method
+    # execution to Sidekiq.  Examples:
+    #
+    # User.delay.delete_inactive
+    # Wikipedia.delay.download_changes_for(Date.today)
+    #
+    class DelayedClass
+      include Sidekiq::Worker
+
+      def perform(yml)
+        (target, method_name, args) = YAML.load(yml)
+        target.send(method_name, *args)
+      end
+    end
+
+    module Klass
+      def delay
+        Proxy.new(DelayedClass, self)
+      end
+      def delay_for(interval)
+        Proxy.new(DelayedClass, self, Time.now.to_f + interval.to_f)
+      end
+    end
+
+  end
+end
+
+Class.send(:include, Sidekiq::Extensions::Klass)

data/lib/sidekiq/processor.rb

@@ -15,8 +15,6 @@ module Sidekiq
     include Util
     include Celluloid
 
-    exclusive :process
-
     def self.default_middleware
       Middleware::Chain.new do |m|
         m.add Middleware::Server::Logging
@@ -31,19 +29,26 @@ module Sidekiq
     end
 
     def process(msgstr, queue)
-      msg = Sidekiq.load_json(msgstr)
-      klass  = constantize(msg['class'])
-      worker = klass.new
+      # Defer worker execution to Celluloid's thread pool since all actor
+      # invocations are run within a Fiber, which dramatically limits
+      # our stack size.
+      defer do
+        begin
+          msg = Sidekiq.load_json(msgstr)
+          klass  = constantize(msg['class'])
+          worker = klass.new
 
-      stats(worker, msg, queue) do
-        Sidekiq.server_middleware.invoke(worker, msg, queue) do
-          worker.perform(*cloned(msg['args']))
+          stats(worker, msg, queue) do
+            Sidekiq.server_middleware.invoke(worker, msg, queue) do
+              worker.perform(*cloned(msg['args']))
+            end
+          end
+        rescue => ex
+          handle_exception(ex, msg || { :message => msgstr })
+          raise
         end
       end
       @boss.processor_done!(current_actor)
-    rescue => ex
-      handle_exception(ex, msg || { :message => msgstr })
-      raise
     end
 
     # See http://github.com/tarcieri/celluloid/issues/22

data/lib/sidekiq/rails.rb

@@ -2,7 +2,6 @@ module Sidekiq
   def self.hook_rails!
     return unless Sidekiq.options[:enable_rails_extensions]
     if defined?(ActiveRecord)
-      ActiveRecord::Base.extend(Sidekiq::Extensions::ActiveRecord)
       ActiveRecord::Base.send(:include, Sidekiq::Extensions::ActiveRecord)
     end
 

data/lib/sidekiq/scheduled.rb

@@ -43,7 +43,7 @@ module Sidekiq
                 end
               end
             end
-          rescue SystemCallError => ex
+          rescue SystemCallError, Redis::TimeoutError, Redis::ConnectionError => ex
             # ECONNREFUSED, etc.  Most likely a problem with
             # redis networking.  Punt and try again at the next interval
             logger.warn ex.message

data/lib/sidekiq/version.rb

@@ -1,3 +1,3 @@
 module Sidekiq
-  VERSION = "2.1.1"
+  VERSION = "2.2.0"
 end

data/test/test_cli.rb

@@ -65,6 +65,11 @@ class TestCli < MiniTest::Unit::TestCase
       assert_equal %w(bar foo foo foo), Sidekiq.options[:queues]
     end
 
+    it 'handles queues with multi-word names' do
+      @cli.parse(['sidekiq', '-q', 'queue_one,queue-two', '-r', './test/fake_env.rb'])
+      assert_equal %w(queue_one queue-two), Sidekiq.options[:queues]
+    end
+
     it 'sets verbose' do
       old = Sidekiq.logger.level
       @cli.parse(['sidekiq', '-v', '-r', './test/fake_env.rb'])

data/test/test_client.rb

@@ -36,6 +36,7 @@ class TestClient < MiniTest::Unit::TestCase
       @redis.expect :rpush, 1, ['queue:foo', String]
       pushed = Sidekiq::Client.push('queue' => 'foo', 'class' => MyWorker, 'args' => [1, 2])
       assert pushed
+      assert_equal 24, pushed.size
       @redis.verify
     end
 

data/test/test_exception_handler.rb

@@ -66,9 +66,12 @@ class TestExceptionHandler < MiniTest::Unit::TestCase
     end
 
     it "notifies ExceptionNotifier" do
-      ::ExceptionNotifier::Notifier.expect(:background_exception_notification,nil,[TEST_EXCEPTION, :data => { :message => { :b => 2 } }])
+      mail = MiniTest::Mock.new
+      mail.expect(:deliver,nil)
+      ::ExceptionNotifier::Notifier.expect(:background_exception_notification,mail,[TEST_EXCEPTION, :data => { :message => { :b => 2 } }])
       Component.new.invoke_exception(:b => 2)
       ::ExceptionNotifier::Notifier.verify
+      mail.verify
     end
   end
 

data/test/test_extensions.rb

@@ -54,6 +54,15 @@ class TestExtensions < MiniTest::Unit::TestCase
       UserMailer.delay_for(5.days).greetings(1, 2)
       assert_equal 1, Sidekiq.redis {|c| c.zcard('schedule') }
     end
+
+    class SomeClass
+      def self.doit(arg)
+      end
+    end
+
+    it 'allows delay of any ole class method' do
+      SomeClass.delay.doit(Date.today)
+    end
   end
 
   describe 'sidekiq rails extensions configuration' do

data/test/test_scheduling.rb

@@ -19,13 +19,13 @@ class TestScheduling < MiniTest::Unit::TestCase
 
     it 'schedules a job via interval' do
       @redis.expect :zadd, true, ['schedule', String, String]
-      assert_equal true, ScheduledWorker.perform_in(600, 'mike')
+      assert ScheduledWorker.perform_in(600, 'mike')
       @redis.verify
     end
 
     it 'schedules a job via timestamp' do
       @redis.expect :zadd, true, ['schedule', String, String]
-      assert_equal true, ScheduledWorker.perform_in(5.days.from_now, 'mike')
+      assert ScheduledWorker.perform_in(5.days.from_now, 'mike')
       @redis.verify
     end
   end

data/test/test_testing.rb

@@ -76,10 +76,15 @@ class TestTesting < MiniTest::Unit::TestCase
       assert_equal 1, Sidekiq::Extensions::DelayedMailer.jobs.size
     end
 
+    class Something
+      def self.foo(x)
+      end
+    end
+
     it 'stubs the delay call on models' do
-      assert_equal 0, Sidekiq::Extensions::DelayedModel.jobs.size
-      FooModel.delay.bar('hello!')
-      assert_equal 1, Sidekiq::Extensions::DelayedModel.jobs.size
+      assert_equal 0, Sidekiq::Extensions::DelayedClass.jobs.size
+      Something.delay.foo(Date.today)
+      assert_equal 1, Sidekiq::Extensions::DelayedClass.jobs.size
     end
 
     it 'stubs the enqueue call' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-07 00:00:00.000000000 Z
+date: 2012-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -229,6 +229,7 @@ files:
 - lib/sidekiq/exception_handler.rb
 - lib/sidekiq/extensions/action_mailer.rb
 - lib/sidekiq/extensions/active_record.rb
+- lib/sidekiq/extensions/class_methods.rb
 - lib/sidekiq/extensions/generic_proxy.rb
 - lib/sidekiq/fetch.rb
 - lib/sidekiq/logging.rb