sidekiq 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6924f9ac5a08e3bfb8b20204262b281082a590c9
-  data.tar.gz: db0c1c65e0f8ca499771c8f68174cc889a977e79
+  metadata.gz: 93d056a574eb27c83e3308da80180846a5378d69
+  data.tar.gz: 1885563fea28763432f157d911e1860ffa845919
 SHA512:
-  metadata.gz: 541f6b4546da89be32045f56d4e5dd41aa9d97d03860ee4fdde696cfb88d9b6ca68d4fb5f83377696d4ee1a9fe572d129afe8c5ddfebb61809302ed0cd54f88c
-  data.tar.gz: d396cad4b53238a174c722a92e485fb8657664d1965ea826c264c2aab1e5e25991023edce4556e3ceff05250bccf02892190b9fa69a1bc1c40944a71cb20d445
+  metadata.gz: 4151032b8a44f021855169594fd69c36e7e6217fd051723e90019c4144a928b2c4715c6dc5167cbbdeecc1cea86fdcc9392524ae4597d2eab2bc1f32d929d880
+  data.tar.gz: ed392bf5ea410c79ca0b08f05c72f454df90d852c777b66e17b1cee54e54ea7a534322738b0258958ac67e4a626c0078ef71b7007f367286938bb5a8dff2fa79

data/Changes.md

@@ -1,7 +1,19 @@
-3.0.0
+3.0.1
 -----------
 
-**Not yet released**
+- Revert pidfile behavior from 2.17.5: Sidekiq will no longer remove its own pidfile
+  as this is a race condition when restarting. [#1470, #1677]
+- Show warning on the Queues page if a queue is paused [#1672]
+- Only activate the ActiveRecord middleware if ActiveRecord::Base is defined on boot. [#1666]
+- Add ability to disable jobs going to the DJQ with the `dead` option.
+```ruby
+sidekiq_options :dead => false, :retry => 5
+```
+- Minor fixes
+
+
+3.0.0
+-----------
 
 Please see [3.0-Upgrade.md](3.0-Upgrade.md) for more comprehensive upgrade notes.
 

data/Pro-Changes.md

@@ -3,7 +3,21 @@ Sidekiq Pro Changelog
 
 Please see [http://sidekiq.org/pro](http://sidekiq.org/pro) for more details and how to buy.
 
-HEAD
+1.7.0
+-----------
+
+- Add ability to pause reliable queues via API.
+```ruby
+q = Sidekiq::Queue.new("critical")
+q.pause!
+q.paused? # => true
+q.unpause!
+```
+
+Sidekiq polls Redis every 10 seconds for paused queues so pausing will take
+a few seconds to take effect.
+
+1.6.0
 -----------
 
 - Compatible with Sidekiq 3.
@@ -17,7 +31,6 @@ HEAD
 1.5.0
 -----------
 
-- Compatible with upcoming Sidekiq 3.0 release
 - Fix issue on Heroku where reliable fetch could orphan jobs [#1573]
 
 

data/README.md

@@ -78,6 +78,13 @@ If you have a problem, please review the [FAQ](https://github.com/mperham/sideki
 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.
 
 
+Thanks
+-----------------
+
+Sidekiq stays fast by using the [JProfiler java profiler](http://www.ej-technologies.com/products/jprofiler/overview.html) to find and fix
+performance problems on JRuby.  Unfortunately MRI does not have good profile tooling.
+
+
 License
 -----------------
 

data/lib/sidekiq.rb

@@ -117,6 +117,9 @@ module Sidekiq
     Sidekiq::Logging.logger = log
   end
 
+  # The default poll interval is 15 seconds.  This should generally be set to
+  # (Sidekiq process count * 5).  So if you have a dozen Sidekiq processes, set
+  # poll_interval to 60.
   def self.poll_interval=(interval)
     self.options[:poll_interval] = interval
   end

data/lib/sidekiq/api.rb

@@ -132,6 +132,11 @@ module Sidekiq
       Sidekiq.redis { |con| con.llen(@rname) }
     end
 
+    # Sidekiq Pro overrides this
+    def paused?
+      false
+    end
+
     def latency
       entry = Sidekiq.redis do |conn|
         conn.lrange(@rname, -1, -1)

data/lib/sidekiq/cli.rb

@@ -4,6 +4,7 @@ require 'yaml'
 require 'singleton'
 require 'optparse'
 require 'erb'
+require 'fileutils'
 
 require 'sidekiq'
 require 'sidekiq/util'
@@ -319,12 +320,10 @@ module Sidekiq
 
     def write_pid
       if path = options[:pidfile]
-        File.open(path, 'w') do |f|
+        pidfile = File.expand_path(path)
+        File.open(pidfile, 'w') do |f|
           f.puts Process.pid
         end
-        at_exit do
-          FileUtils.rm_f path
-        end
       end
     end
 

data/lib/sidekiq/fetch.rb

@@ -1,4 +1,5 @@
 require 'sidekiq'
+require 'sidekiq/util'
 require 'sidekiq/actor'
 
 module Sidekiq

data/lib/sidekiq/logging.rb

@@ -85,6 +85,9 @@ module Sidekiq
         end
       end
       nr
+    rescue RuntimeError => ex
+      # RuntimeError: ObjectSpace is disabled; each_object will only work with Class, pass -X+O to enable
+      puts "Unable to reopen logs: #{ex.message}"
     end
 
     def logger

data/lib/sidekiq/manager.rb

@@ -133,9 +133,12 @@ module Sidekiq
     end
 
     def heartbeat(key, data)
-      return if stopped?
+      proctitle = ['sidekiq', Sidekiq::VERSION]
+      proctitle << data['tag'] unless data['tag'].empty?
+      proctitle << "[#{@busy.size} of #{data['concurrency']} busy]"
+      proctitle << 'stopping' if stopped?
+      $0 = proctitle.join(' ')
 
-      $0 = "sidekiq #{Sidekiq::VERSION} #{data['tag']}[#{@busy.size} of #{data['concurrency']} busy]#{stopped? ? ' stopping' : ''}"
       ❤(key)
       after(5) do
         heartbeat(key, data)

data/lib/sidekiq/middleware/server/active_record.rb

@@ -5,7 +5,7 @@ module Sidekiq
         def call(*args)
           yield
         ensure
-          ::ActiveRecord::Base.clear_active_connections! if defined?(::ActiveRecord)
+          ::ActiveRecord::Base.clear_active_connections!
         end
       end
     end

data/lib/sidekiq/middleware/server/retry_jobs.rb

@@ -118,10 +118,10 @@ module Sidekiq
               worker.sidekiq_retries_exhausted_block.call(msg)
             end
           rescue => e
-            handle_exception(e, { :context => "Error calling retries_exhausted" })
+            handle_exception(e, { :context => "Error calling retries_exhausted for #{worker.class}", :job => msg })
           end
 
-          send_to_morgue(msg)
+          send_to_morgue(msg) unless msg['dead'] == false
         end
 
         def send_to_morgue(msg)

data/lib/sidekiq/processor.rb

@@ -1,7 +1,6 @@
 require 'sidekiq/util'
 require 'sidekiq/actor'
 
-require 'sidekiq/middleware/server/active_record'
 require 'sidekiq/middleware/server/retry_jobs'
 require 'sidekiq/middleware/server/logging'
 
@@ -22,7 +21,10 @@ module Sidekiq
       Middleware::Chain.new do |m|
         m.add Middleware::Server::Logging
         m.add Middleware::Server::RetryJobs
-        m.add Middleware::Server::ActiveRecord
+        if defined?(::ActiveRecord::Base)
+          require 'sidekiq/middleware/server/active_record'
+          m.add Sidekiq::Middleware::Server::ActiveRecord
+        end
       end
     end
 

data/lib/sidekiq/rails.rb

@@ -1,17 +1,15 @@
 module Sidekiq
   def self.hook_rails!
-    if defined?(::ActiveRecord)
-      ::ActiveRecord::Base.__send__(:include, Sidekiq::Extensions::ActiveRecord)
+    ActiveSupport.on_load(:active_record) do
+      include Sidekiq::Extensions::ActiveRecord
     end
 
-    if defined?(::ActionMailer)
-      ::ActionMailer::Base.extend(Sidekiq::Extensions::ActionMailer)
+    ActiveSupport.on_load(:action_mailer) do
+      extend Sidekiq::Extensions::ActionMailer
     end
   end
 
   class Rails < ::Rails::Engine
-    config.autoload_paths << File.expand_path("#{config.root}/app/workers") if File.exist?("#{config.root}/app/workers")
-
     initializer 'sidekiq' do
       Sidekiq.hook_rails!
     end

data/lib/sidekiq/testing.rb

@@ -1,4 +1,5 @@
 require 'securerandom'
+require 'sidekiq'
 
 module Sidekiq
 

data/lib/sidekiq/version.rb

@@ -1,3 +1,3 @@
 module Sidekiq
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

data/lib/sidekiq/web.rb

@@ -51,6 +51,7 @@ module Sidekiq
       halt 404 unless params[:name]
       @count = (params[:count] || 25).to_i
       @name = params[:name]
+      @queue = Sidekiq::Queue.new(@name)
       (@current_page, @total_size, @messages) = page("queue:#{@name}", params[:page], @count)
       @messages = @messages.map {|msg| Sidekiq.load_json(msg) }
       erb :queue

data/sidekiq.gemspec

@@ -7,7 +7,10 @@ Gem::Specification.new do |gem|
   gem.description   = gem.summary = "Simple, efficient background processing for Ruby"
   gem.homepage      = "http://sidekiq.org"
   gem.license       = "LGPL-3.0"
-
+  
+  # Sidekiq 3 requires ruby 2.0.x
+  gem.required_ruby_version = '~> 2.0'
+  
   gem.executables   = ['sidekiq', 'sidekiqctl']
   gem.files         = `git ls-files | grep -Ev '^(myapp|examples)'`.split("\n")
   gem.test_files    = `git ls-files -- test/*`.split("\n")

data/test/test_manager.rb

@@ -4,6 +4,10 @@ require 'sidekiq/manager'
 class TestManager < Sidekiq::Test
 
   describe 'manager' do
+    before do
+      Sidekiq.redis {|c| c.flushdb }
+    end
+
     it 'creates N processor instances' do
       mgr = Sidekiq::Manager.new(options)
       assert_equal options[:concurrency], mgr.ready.size
@@ -77,9 +81,75 @@ class TestManager < Sidekiq::Test
       fetcher.verify
     end
 
+    describe 'heartbeat' do
+      before do
+        uow = Object.new
+
+        @processor = Minitest::Mock.new
+        @processor.expect(:async, @processor, [])
+        @processor.expect(:process, nil, [uow])
+
+        @mgr = Sidekiq::Manager.new(options)
+        @mgr.ready << @processor
+        @mgr.assign(uow)
+
+        @processor.verify
+        @proctitle = $0
+      end
+
+      after do
+        $0 = @proctitle
+      end
+
+      describe 'when manager is active' do
+        before do
+          @mgr.heartbeat('identity', heartbeat_data)
+        end
+
+        it 'sets useful info to proctitle' do
+          assert_equal "sidekiq #{Sidekiq::VERSION} myapp [1 of 3 busy]", $0
+        end
+
+        it 'stores process info in redis' do
+          info = Sidekiq.redis { |c| c.hmget('identity', 'busy') }
+          assert_equal ["1"], info
+          expires = Sidekiq.redis { |c| c.pttl('identity') }
+          assert_in_delta 60000, expires, 1
+        end
+      end
+
+      describe 'when manager is stopped' do
+        before do
+          @processor.expect(:alive?, [])
+          @processor.expect(:terminate, [])
+
+          @mgr.stop
+          @mgr.processor_done(@processor)
+          @mgr.heartbeat('identity', heartbeat_data)
+
+          @processor.verify
+        end
+
+        it 'indicates status in proctitle' do
+          assert_equal "sidekiq #{Sidekiq::VERSION} myapp [0 of 3 busy] stopping", $0
+        end
+
+        it 'stores process info in redis' do
+          info = Sidekiq.redis { |c| c.hmget('identity', 'busy') }
+          assert_equal ["0"], info
+          expires = Sidekiq.redis { |c| c.pttl('identity') }
+          assert_in_delta 60000, expires, 1
+        end
+      end
+    end
+
     def options
       { :concurrency => 3, :queues => ['default'] }
     end
+
+    def heartbeat_data
+      { 'concurrency' => 3, 'tag' => 'myapp' }
+    end
   end
 
 end

data/web/assets/stylesheets/application.css

@@ -197,6 +197,18 @@ td form {
   padding: 0px;
 }
 
+.table td {
+  /* Non standard for webkit */
+  word-break: break-word;
+
+  -webkit-hyphens: auto;
+  -moz-hyphens: auto;
+  hyphens: auto;
+
+  -ms-word-break: break-all;
+  word-break: break-all;
+}
+
 table .table-checkbox label {
   height: 100%;
   width: 100%;

data/web/locales/en.yml

@@ -66,3 +66,4 @@ en: # <---- change this to your locale code
   Thread: Thread
   Threads: Threads
   Jobs: Jobs
+  Paused: Paused

data/web/locales/fr.yml

@@ -13,9 +13,9 @@ fr:
   Retries: Tentatives
   Enqueued: En queue
   Worker: Travailleur
-  LivePoll: Live polling
-  StopPolling: Arrêt du polling
-  Queue: File
+  LivePoll: Temps réel
+  StopPolling: Arrêt du temps réel
+  Queue: Queue
   Class: Classe
   Job: Tâche
   Arguments: Arguments

data/web/locales/ja.yml

@@ -44,9 +44,9 @@ ja:
   ErrorMessage: エラーメッセージ
   ErrorBacktrace: エラーバックトレース
   GoBack: ← 戻る
-  NoScheduledFound: 予定された作業はありません
+  NoScheduledFound: 予定したジョブはありません
   When: いつ
-  ScheduledJobs: 予定された作業
+  ScheduledJobs: 予定したジョブ
   idle: アイドル
   active: アクティブ
   Version: バージョン
@@ -60,9 +60,9 @@ ja:
   SixMonths: 6 ヶ月
   Batches: バッチ
   Failures: 失敗
-  DeadJobs: 死んだジョブ
-  NoDeadJobsFound: 死んだジョブはありません
-  Dead: 死んだ
+  DeadJobs: 死亡したジョブ
+  NoDeadJobsFound: 死亡したジョブはありません
+  Dead: 死亡
   Processes: プロセス
   Thread: スレッド
   Threads: スレッド

data/web/locales/ko.yml

@@ -6,7 +6,7 @@ ko:
   Namespace: 네임스페이스
   Realtime: 실시간
   History: 히스토리
-  Busy: 바쁨
+  Busy: 작동
   Processed: 처리완료
   Failed: 실패
   Scheduled: 예약
@@ -59,3 +59,10 @@ ko:
   SixMonths: 6 달
   Batches: 배치
   Failures: 실패
+  DeadJobs: 죽은 작업
+  NoDeadJobsFound: 죽은 작업이 없습니다
+  Dead: 죽음
+  Processes: 프로세스
+  Thread: 스레드
+  Threads: 스레드
+  Jobs: 작업

data/web/views/queue.erb

@@ -2,6 +2,9 @@
   <div class="col-sm-5">
     <h3>
       <%= t('CurrentMessagesInQueue', :queue => @name) %>
+      <% if @queue.paused? %>
+        <span class="label label-danger"><%= t('Paused') %></span>
+      <% end %>
     </h3>
   </div>
   <div class="col-sm-4 pull-right">

data/web/views/queues.erb

@@ -10,6 +10,9 @@
     <tr>
       <td>
         <a href="<%= root_path %>queues/<%= queue.name %>"><%= queue.name %></a>
+        <% if queue.paused? %>
+          <span class="label label-danger"><%= t('Paused') %></span>
+        <% end %>
       </td>
       <td><%= number_with_delimiter(queue.size) %> </td>
       <td width="20%">

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Mike Perham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2014-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -328,9 +328,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="