sidekiq 4.2.10 → 5.0.0.beta1

data/test/test_web_auth.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+# frozen_string_literal: true
+require_relative 'helper'
+require 'sidekiq/web'
+require 'rack/test'
+
+class TestWebAuth < Sidekiq::Test
+  describe 'sidekiq web with basic auth' do
+    include Rack::Test::Methods
+
+    def app
+      app = Sidekiq::Web.new
+      app.use(Rack::Auth::Basic) { |user, pass| user == "a" && pass == "b" }
+
+      app
+    end
+
+    it 'requires basic authentication' do
+      get '/'
+
+      assert_equal 401, last_response.status
+      refute_nil last_response.header["WWW-Authenticate"]
+    end
+
+    it 'authenticates successfuly' do
+      basic_authorize 'a', 'b'
+
+      get '/'
+
+      assert_equal 200, last_response.status
+    end
+  end
+
+  describe 'sidekiq web with custom session' do
+    include Rack::Test::Methods
+
+    def app
+      app = Sidekiq::Web.new
+
+      app.use Rack::Session::Cookie, secret: 'v3rys3cr31', host: 'nicehost.org'
+
+      app
+    end
+
+    it 'requires basic authentication' do
+      get '/'
+
+      session_options = last_request.env['rack.session'].options
+
+      assert_equal 'v3rys3cr31', session_options[:secret]
+      assert_equal 'nicehost.org', session_options[:host]
+    end
+  end
+end

data/test/test_web_helpers.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+require_relative 'helper'
+
+class TestWebHelpers < Sidekiq::Test
+
+  class Helpers
+    include Sidekiq::WebHelpers
+
+    def initialize(params={})
+      @thehash = default.merge(params)
+    end
+
+    def request
+      self
+    end
+
+    def settings
+      self
+    end
+
+    def locales
+      ['web/locales']
+    end
+
+    def env
+      @thehash
+    end
+
+    def default
+      {
+      }
+    end
+  end
+
+  def test_locale_determination
+    obj = Helpers.new
+    assert_equal 'en', obj.locale
+
+    obj = Helpers.new('HTTP_ACCEPT_LANGUAGE' => 'fr-FR,fr;q=0.8,en-US;q=0.6,en;q=0.4,ru;q=0.2')
+    assert_equal 'fr', obj.locale
+
+    obj = Helpers.new('HTTP_ACCEPT_LANGUAGE' => 'zh-CN,zh;q=0.8,en-US;q=0.6,en;q=0.4,ru;q=0.2')
+    assert_equal 'zh-cn', obj.locale
+
+    obj = Helpers.new('HTTP_ACCEPT_LANGUAGE' => 'nb-NO,nb;q=0.2')
+    assert_equal 'nb', obj.locale
+
+    obj = Helpers.new('HTTP_ACCEPT_LANGUAGE' => 'en-us; *')
+    assert_equal 'en', obj.locale
+
+    obj = Helpers.new('HTTP_ACCEPT_LANGUAGE' => '*')
+    assert_equal 'en', obj.locale
+  end
+end

data/test/test_web_sessions.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+# frozen_string_literal: true
+require_relative 'helper'
+require 'sidekiq/web'
+require 'rack/test'
+
+class TestWebSessions < Sidekiq::Test
+  describe 'sidekiq web sessions options' do
+    include Rack::Test::Methods
+
+    describe 'using #disable' do
+      def app
+        app = Sidekiq::Web.new
+        app.disable(:sessions)
+        app
+      end
+
+      it "doesn't create sessions" do
+        get '/'
+        assert_nil last_request.env['rack.session']
+      end
+    end
+
+    describe 'using #set with false argument' do
+      def app
+        app = Sidekiq::Web.new
+        app.set(:sessions, false)
+        app
+      end
+
+      it "doesn't create sessions" do
+        get '/'
+        assert_nil last_request.env['rack.session']
+      end
+    end
+
+    describe 'using #set with an hash' do
+      def app
+        app = Sidekiq::Web.new
+        app.set(:sessions, { domain: :all })
+        app
+      end
+
+      it "creates sessions" do
+        get '/'
+        refute_nil   last_request.env['rack.session']
+        refute_empty last_request.env['rack.session'].options
+        assert_equal :all, last_request.env['rack.session'].options[:domain]
+      end
+    end
+
+    describe 'using #enable' do
+      def app
+        app = Sidekiq::Web.new
+        app.enable(:sessions)
+        app
+      end
+
+      it "creates sessions" do
+        get '/'
+        refute_nil   last_request.env['rack.session']
+        refute_empty last_request.env['rack.session'].options
+        refute_nil   last_request.env['rack.session'].options[:secret]
+      end
+    end
+  end
+end

data/web/assets/javascripts/dashboard.js

@@ -20,7 +20,7 @@ factory.defined&&factory.defined(function(d){return d.y!==null});return factory}
 var poller;
 
 var realtimeGraph = function(updatePath) {
-  var timeInterval = parseInt(localStorage.timeInterval || '5000');
+  var timeInterval = parseInt(localStorage.timeInterval || '2000');
 
   var graphElement = document.getElementById("realtime");
 

data/web/views/_job_info.erb

@@ -80,7 +80,7 @@
       <% if type == :dead %>
         <tr>
           <th><%= t('LastRetry') %></th>
-          <td><%= relative_time(job.at) if job['retry_count'] %></td>
+          <td><%= relative_time(job.at) %></td>
         </tr>
       <% end %>
     </tbody>

data/web/views/dashboard.erb

@@ -9,9 +9,9 @@
   </h3>
   <div class="interval-slider">
     <span class="interval-slider-label"><%= t('PollingInterval') %>:</span>
-    <span class="current-interval">5 sec</span>
+    <span class="current-interval">2 sec</span>
     <br/>
-    <input type="range" min="2000" max="20000" step="1000" value="5000"/>
+    <input type="range" min="2000" max="20000" step="1000" value="2000"/>
   </div>
 </div>
 

data/web/views/morgue.erb

@@ -47,9 +47,7 @@
               <div class="args"><%= display_args(entry.display_args) %></div>
             </td>
             <td>
-              <% if entry.error? %>
               <div><%= h truncate("#{entry['error_class']}: #{entry['error_message']}", 200) %></div>
-              <% end %>
             </td>
           </tr>
         <% end %>

data/web/views/queue.erb

@@ -34,7 +34,7 @@
         <td>
           <form action="<%= root_path %>queues/<%= CGI.escape(@name) %>/delete" method="post">
             <%= csrf_tag %>
-            <input name="key_val" value="<%= h Sidekiq.dump_json(msg.item) %>" type="hidden" />
+            <input name="key_val" value="<%= h msg.value %>" type="hidden" />
             <input class="btn btn-danger btn-xs" type="submit" name="delete" value="<%= t('Delete') %>" data-confirm="<%= t('AreYouSure') %>" />
           </form>
         </td>

data/web/views/retry.erb

@@ -7,7 +7,7 @@
       <tr>
         <th><%= t('ErrorClass') %></th>
         <td>
-          <code><%= h @retry['error_class'] %></code>
+          <code><%= h @retry.display_class %></code>
         </td>
       </tr>
       <tr>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 4.2.10
+  version: 5.0.0.beta1
 platform: ruby
 authors:
 - Mike Perham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2017-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -231,6 +231,7 @@ files:
 - ".travis.yml"
 - 3.0-Upgrade.md
 - 4.0-Upgrade.md
+- 5.0-Upgrade.md
 - COMM-LICENSE
 - Changes.md
 - Ent-Changes.md
@@ -254,20 +255,21 @@ files:
 - lib/sidekiq/cli.rb
 - lib/sidekiq/client.rb
 - lib/sidekiq/core_ext.rb
+- lib/sidekiq/delay.rb
 - 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/job_logger.rb
+- lib/sidekiq/job_retry.rb
 - lib/sidekiq/launcher.rb
 - lib/sidekiq/logging.rb
 - lib/sidekiq/manager.rb
 - lib/sidekiq/middleware/chain.rb
 - lib/sidekiq/middleware/i18n.rb
 - lib/sidekiq/middleware/server/active_record.rb
-- lib/sidekiq/middleware/server/logging.rb
-- lib/sidekiq/middleware/server/retry_jobs.rb
 - lib/sidekiq/paginator.rb
 - lib/sidekiq/processor.rb
 - lib/sidekiq/rails.rb
@@ -284,6 +286,38 @@ files:
 - lib/sidekiq/web/router.rb
 - lib/sidekiq/worker.rb
 - sidekiq.gemspec
+- test/config.yml
+- test/env_based_config.yml
+- test/fake_env.rb
+- test/fixtures/en.yml
+- test/helper.rb
+- test/test_actors.rb
+- test/test_api.rb
+- test/test_cli.rb
+- test/test_client.rb
+- test/test_exception_handler.rb
+- test/test_extensions.rb
+- test/test_fetch.rb
+- test/test_launcher.rb
+- test/test_logging.rb
+- test/test_manager.rb
+- test/test_middleware.rb
+- test/test_processor.rb
+- test/test_rails.rb
+- test/test_redis_connection.rb
+- test/test_retry.rb
+- test/test_retry_exhausted.rb
+- test/test_scheduled.rb
+- test/test_scheduling.rb
+- test/test_sidekiq.rb
+- test/test_testing.rb
+- test/test_testing_fake.rb
+- test/test_testing_inline.rb
+- test/test_util.rb
+- test/test_web.rb
+- test/test_web_auth.rb
+- test/test_web_helpers.rb
+- test/test_web_sessions.rb
 - web/assets/images/favicon.ico
 - web/assets/images/logo.png
 - web/assets/images/status.png
@@ -297,7 +331,6 @@ files:
 - web/locales/el.yml
 - web/locales/en.yml
 - web/locales/es.yml
-- web/locales/fa.yml
 - web/locales/fr.yml
 - web/locales/hi.yml
 - web/locales/it.yml
@@ -347,13 +380,45 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Simple, efficient background processing for Ruby
-test_files: []
+test_files:
+- test/config.yml
+- test/env_based_config.yml
+- test/fake_env.rb
+- test/fixtures/en.yml
+- test/helper.rb
+- test/test_actors.rb
+- test/test_api.rb
+- test/test_cli.rb
+- test/test_client.rb
+- test/test_exception_handler.rb
+- test/test_extensions.rb
+- test/test_fetch.rb
+- test/test_launcher.rb
+- test/test_logging.rb
+- test/test_manager.rb
+- test/test_middleware.rb
+- test/test_processor.rb
+- test/test_rails.rb
+- test/test_redis_connection.rb
+- test/test_retry.rb
+- test/test_retry_exhausted.rb
+- test/test_scheduled.rb
+- test/test_scheduling.rb
+- test/test_sidekiq.rb
+- test/test_testing.rb
+- test/test_testing_fake.rb
+- test/test_testing_inline.rb
+- test/test_util.rb
+- test/test_web.rb
+- test/test_web_auth.rb
+- test/test_web_helpers.rb
+- test/test_web_sessions.rb

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

@@ -1,31 +0,0 @@
-module Sidekiq
-  module Middleware
-    module Server
-      class Logging
-
-        def call(worker, item, queue)
-          begin
-            start = Time.now
-            logger.info("start".freeze)
-            yield
-            logger.info("done: #{elapsed(start)} sec")
-          rescue Exception
-            logger.info("fail: #{elapsed(start)} sec")
-            raise
-          end
-        end
-
-        private
-
-        def elapsed(start)
-          (Time.now - start).round(3)
-        end
-
-        def logger
-          Sidekiq.logger
-        end
-      end
-    end
-  end
-end
-

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

@@ -1,205 +0,0 @@
-require 'sidekiq/scheduled'
-require 'sidekiq/api'
-
-module Sidekiq
-  module Middleware
-    module Server
-      ##
-      # Automatically retry jobs that fail in Sidekiq.
-      # Sidekiq's retry support assumes a typical development lifecycle:
-      #
-      #   0. Push some code changes with a bug in it.
-      #   1. Bug causes job processing to fail, Sidekiq's middleware captures
-      #      the job and pushes it onto a retry queue.
-      #   2. Sidekiq retries jobs in the retry queue multiple times with
-      #      an exponential delay, the job continues to fail.
-      #   3. After a few days, a developer deploys a fix. The job is
-      #      reprocessed successfully.
-      #   4. Once retries are exhausted, Sidekiq will give up and move the
-      #      job to the Dead Job Queue (aka morgue) where it must be dealt with
-      #      manually in the Web UI.
-      #   5. After 6 months on the DJQ, Sidekiq will discard the job.
-      #
-      # A job looks like:
-      #
-      #     { 'class' => 'HardWorker', 'args' => [1, 2, 'foo'], 'retry' => true }
-      #
-      # The 'retry' option also accepts a number (in place of 'true'):
-      #
-      #     { 'class' => 'HardWorker', 'args' => [1, 2, 'foo'], 'retry' => 5 }
-      #
-      # The job will be retried this number of times before giving up. (If simply
-      # 'true', Sidekiq retries 25 times)
-      #
-      # We'll add a bit more data to the job to support retries:
-      #
-      #  * 'queue' - the queue to use
-      #  * 'retry_count' - number of times we've retried so far.
-      #  * 'error_message' - the message from the exception
-      #  * 'error_class' - the exception class
-      #  * 'failed_at' - the first time it failed
-      #  * 'retried_at' - the last time it was retried
-      #  * 'backtrace' - the number of lines of error backtrace to store
-      #
-      # We don't store the backtrace by default as that can add a lot of overhead
-      # to the job and everyone is using an error service, right?
-      #
-      # The default number of retry attempts is 25 which works out to about 3 weeks
-      # of retries. You can pass a value for the max number of retry attempts when
-      # adding the middleware using the options hash:
-      #
-      #   Sidekiq.configure_server do |config|
-      #     config.server_middleware do |chain|
-      #       chain.add Sidekiq::Middleware::Server::RetryJobs, :max_retries => 7
-      #     end
-      #   end
-      #
-      # or limit the number of retries for a particular worker with:
-      #
-      #    class MyWorker
-      #      include Sidekiq::Worker
-      #      sidekiq_options :retry => 10
-      #    end
-      #
-      class RetryJobs
-        include Sidekiq::Util
-
-        DEFAULT_MAX_RETRY_ATTEMPTS = 25
-
-        def initialize(options = {})
-          @max_retries = options.fetch(:max_retries, DEFAULT_MAX_RETRY_ATTEMPTS)
-        end
-
-        def call(worker, msg, queue)
-          yield
-        rescue Sidekiq::Shutdown
-          # ignore, will be pushed back onto queue during hard_shutdown
-          raise
-        rescue Exception => e
-          # ignore, will be pushed back onto queue during hard_shutdown
-          raise Sidekiq::Shutdown if exception_caused_by_shutdown?(e)
-
-          raise e unless msg['retry']
-          attempt_retry(worker, msg, queue, e)
-        end
-
-        private
-
-        def attempt_retry(worker, msg, queue, exception)
-          max_retry_attempts = retry_attempts_from(msg['retry'], @max_retries)
-
-          msg['queue'] = if msg['retry_queue']
-            msg['retry_queue']
-          else
-            queue
-          end
-
-          # App code can stuff all sorts of crazy binary data into the error message
-          # that won't convert to JSON.
-          m = exception.message.to_s[0, 10_000]
-          if m.respond_to?(:scrub!)
-            m.force_encoding("utf-8")
-            m.scrub!
-          end
-
-          msg['error_message'] = m
-          msg['error_class'] = exception.class.name
-          count = if msg['retry_count']
-            msg['retried_at'] = Time.now.to_f
-            msg['retry_count'] += 1
-          else
-            msg['failed_at'] = Time.now.to_f
-            msg['retry_count'] = 0
-          end
-
-          if msg['backtrace'] == true
-            msg['error_backtrace'] = exception.backtrace
-          elsif !msg['backtrace']
-            # do nothing
-          elsif msg['backtrace'].to_i != 0
-            msg['error_backtrace'] = exception.backtrace[0...msg['backtrace'].to_i]
-          end
-
-          if count < max_retry_attempts
-            delay = delay_for(worker, count, exception)
-            logger.debug { "Failure! Retry #{count} in #{delay} seconds" }
-            retry_at = Time.now.to_f + delay
-            payload = Sidekiq.dump_json(msg)
-            Sidekiq.redis do |conn|
-              conn.zadd('retry', retry_at.to_s, payload)
-            end
-          else
-            # Goodbye dear message, you (re)tried your best I'm sure.
-            retries_exhausted(worker, msg, exception)
-          end
-
-          raise exception
-        end
-
-        def retries_exhausted(worker, msg, exception)
-          logger.debug { "Retries exhausted for job" }
-          begin
-            block = worker.sidekiq_retries_exhausted_block || Sidekiq.default_retries_exhausted
-            block.call(msg, exception) if block
-          rescue => e
-            handle_exception(e, { context: "Error calling retries_exhausted for #{worker.class}", job: msg })
-          end
-
-          send_to_morgue(msg) unless msg['dead'] == false
-        end
-
-        def send_to_morgue(msg)
-          Sidekiq.logger.info { "Adding dead #{msg['class']} job #{msg['jid']}" }
-          payload = Sidekiq.dump_json(msg)
-          now = Time.now.to_f
-          Sidekiq.redis do |conn|
-            conn.multi do
-              conn.zadd('dead', now, payload)
-              conn.zremrangebyscore('dead', '-inf', now - DeadSet.timeout)
-              conn.zremrangebyrank('dead', 0, -DeadSet.max_jobs)
-            end
-          end
-        end
-
-        def retry_attempts_from(msg_retry, default)
-          if msg_retry.is_a?(Integer)
-            msg_retry
-          else
-            default
-          end
-        end
-
-        def delay_for(worker, count, exception)
-          worker.sidekiq_retry_in_block? && retry_in(worker, count, exception) || seconds_to_delay(count)
-        end
-
-        # delayed_job uses the same basic formula
-        def seconds_to_delay(count)
-          (count ** 4) + 15 + (rand(30)*(count+1))
-        end
-
-        def retry_in(worker, count, exception)
-          begin
-            worker.sidekiq_retry_in_block.call(count, exception).to_i
-          rescue Exception => e
-            handle_exception(e, { context: "Failure scheduling retry using the defined `sidekiq_retry_in` in #{worker.class.name}, falling back to default" })
-            nil
-          end
-        end
-
-        def exception_caused_by_shutdown?(e, checked_causes = [])
-          # In Ruby 2.1.0 only, check if exception is a result of shutdown.
-          return false unless defined?(e.cause)
-
-          # Handle circular causes
-          checked_causes << e.object_id
-          return false if checked_causes.include?(e.cause.object_id)
-
-          e.cause.instance_of?(Sidekiq::Shutdown) ||
-            exception_caused_by_shutdown?(e.cause, checked_causes)
-        end
-
-      end
-    end
-  end
-end