sidekiq 4.1.1 → 4.2.0

data/lib/sidekiq/web/router.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+require 'rack'
+
+module Sidekiq
+  module WebRouter
+    GET = 'GET'.freeze
+    DELETE = 'DELETE'.freeze
+    POST = 'POST'.freeze
+    PUT = 'PUT'.freeze
+    PATCH = 'PATCH'.freeze
+    HEAD = 'HEAD'.freeze
+
+    ROUTE_PARAMS = 'rack.route_params'.freeze
+    REQUEST_METHOD = 'REQUEST_METHOD'.freeze
+    PATH_INFO = 'PATH_INFO'.freeze
+
+    def get(path, &block)
+      route(GET, path, &block)
+    end
+
+    def post(path, &block)
+      route(POST, path, &block)
+    end
+
+    def put(path, &block)
+      route(PUT, path, &block)
+    end
+
+    def patch(path, &block)
+      route(PATCH, path, &block)
+    end
+
+    def delete(path, &block)
+      route(DELETE, path, &block)
+    end
+
+    def route(method, path, &block)
+      @routes ||= { GET => [], POST => [], PUT => [], PATCH => [], DELETE => [], HEAD => [] }
+
+      @routes[method] << WebRoute.new(method, path, block)
+      @routes[HEAD] << WebRoute.new(method, path, block) if method == GET
+    end
+
+    def match(env)
+      request_method = env[REQUEST_METHOD]
+      path_info = ::Rack::Utils.unescape env[PATH_INFO]
+
+      @routes[request_method].each do |route|
+        if params = route.match(request_method, path_info)
+          env[ROUTE_PARAMS] = params
+
+          return WebAction.new(env, route.block)
+        end
+      end
+
+      nil
+    end
+  end
+
+  class WebRoute
+    attr_accessor :request_method, :pattern, :block, :name
+
+    NAMED_SEGMENTS_PATTERN = /\/([^\/]*):([^\.:$\/]+)/.freeze
+
+    def initialize(request_method, pattern, block)
+      @request_method = request_method
+      @pattern = pattern
+      @block = block
+    end
+
+    def matcher
+      @matcher ||= compile
+    end
+
+    def compile
+      if pattern.match(NAMED_SEGMENTS_PATTERN)
+        p = pattern.gsub(NAMED_SEGMENTS_PATTERN, '/\1(?<\2>[^$/]+)')
+
+        Regexp.new("\\A#{p}\\Z")
+      else
+        pattern
+      end
+    end
+
+    def match(request_method, path)
+      case matcher
+      when String
+        {} if path == matcher
+      else
+        if path_match = path.match(matcher)
+          Hash[path_match.names.map(&:to_sym).zip(path_match.captures)]
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/worker.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sidekiq/client'
 require 'sidekiq/core_ext'
 

data/sidekiq.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |gem|
   gem.add_dependency                  'redis', '~> 3.2', '>= 3.2.1'
   gem.add_dependency                  'connection_pool', '~> 2.2', '>= 2.2.0'
   gem.add_dependency                  'concurrent-ruby', '~> 1.0'
+  gem.add_dependency                  'rack-protection', '~> 1.5'
   gem.add_development_dependency      'redis-namespace', '~> 1.5', '>= 1.5.2'
-  gem.add_development_dependency      'sinatra', '~> 1.4', '>= 1.4.6'
   gem.add_development_dependency      'minitest', '~> 5.7', '>= 5.7.0'
   gem.add_development_dependency      'rake', '~> 10.0'
-  gem.add_development_dependency      'rails', '~> 4', '>= 3.2.0'
+  gem.add_development_dependency      'rails', '>= 3.2.0'
 end

data/test/fake_env.rb

@@ -0,0 +1 @@
+# frozen_string_literal: true

data/test/helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $TESTING = true
 # disable minitest/parallel threads
 ENV["N"] = "0"

data/test/test_actors.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 require 'sidekiq/cli'
 require 'sidekiq/fetch'

data/test/test_api.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 require 'sidekiq/api'
 require 'active_job'

data/test/test_cli.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 require 'sidekiq/cli'
 require 'tempfile'
@@ -41,6 +42,18 @@ class TestCli < Sidekiq::Test
       assert_equal 60, Sidekiq.options[:concurrency]
     end
 
+    it 'changes concurrency with ENV' do
+      begin
+        ENV['RAILS_MAX_THREADS'] = '9'
+        @cli.parse(['sidekiq', '-c', '60', '-r', './test/fake_env.rb'])
+        assert_equal 60, Sidekiq.options[:concurrency]
+        @cli.parse(['sidekiq', '-r', './test/fake_env.rb'])
+        assert_equal 9, Sidekiq.options[:concurrency]
+      ensure
+        ENV.delete('RAILS_MAX_THREADS')
+      end
+    end
+
     it 'changes queues' do
       @cli.parse(['sidekiq', '-q', 'foo', '-r', './test/fake_env.rb'])
       assert_equal ['foo'], Sidekiq.options[:queues]
@@ -329,7 +342,7 @@ class TestCli < Sidekiq::Test
       end
 
       after do
-        File.unlink @tmp_log_path if File.exists? @tmp_log_path
+        File.unlink @tmp_log_path if File.exist? @tmp_log_path
       end
 
       it 'shuts down the worker' do
@@ -364,7 +377,7 @@ class TestCli < Sidekiq::Test
       end
 
       after do
-        File.unlink @tmp_log_path if File.exists? @tmp_log_path
+        File.unlink @tmp_log_path if File.exist? @tmp_log_path
       end
 
       describe 'with backtrace' do

data/test/test_client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 
 class TestClient < Sidekiq::Test
@@ -32,6 +33,23 @@ class TestClient < Sidekiq::Test
       assert_equal 24, jid.size
     end
 
+    it 'allows middleware to stop bulk jobs' do
+      mware = Class.new do
+        def call(worker_klass,msg,q,r)
+          msg['args'][0] == 1 ? yield : false
+        end
+      end
+      client = Sidekiq::Client.new
+      client.middleware do |chain|
+        chain.add mware
+      end
+      q = Sidekiq::Queue.new
+      q.clear
+      result = client.push_bulk('class' => 'Blah', 'args' => [[1],[2],[3]])
+      assert_equal 1, result.size
+      assert_equal 1, q.size
+    end
+
     it 'allows local middleware modification' do
       $called = false
       mware = Class.new { def call(worker_klass,msg,q,r); $called = true; msg;end }
@@ -108,6 +126,10 @@ class TestClient < Sidekiq::Test
         assert_match(/[0-9a-f]{12}/, jid)
       end
     end
+    it 'handles no jobs' do
+      result = Sidekiq::Client.push_bulk('class' => 'QueuedWorker', 'args' => [])
+      assert_equal 0, result.size
+    end
   end
 
   class BaseWorker
@@ -164,6 +186,18 @@ class TestClient < Sidekiq::Test
       conn.verify
     end
 
+    it 'allows #via to point to same Redi' do
+      conn = MiniTest::Mock.new
+      conn.expect(:multi, [0, 1])
+      sharded_pool = ConnectionPool.new(size: 1) { conn }
+      Sidekiq::Client.via(sharded_pool) do
+        Sidekiq::Client.via(sharded_pool) do
+          CWorker.perform_async(1,2,3)
+        end
+      end
+      conn.verify
+    end
+
     it 'allows #via to point to different Redi' do
       conn = MiniTest::Mock.new
       conn.expect(:multi, [0, 1])

data/test/test_exception_handler.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 require 'sidekiq/exception_handler'
 require 'stringio'
@@ -32,7 +33,7 @@ class TestExceptionHandler < Sidekiq::Test
       Component.new.invoke_exception(:a => 1)
       @str_logger.rewind
       log = @str_logger.readlines
-      assert_match(/a=>1/, log[0], "didn't include the context")
+      assert_match(/"a":1/, log[0], "didn't include the context")
       assert_match(/Something didn't work!/, log[1], "didn't include the exception message")
       assert_match(/test\/test_exception_handler.rb/, log[2], "didn't include the backtrace")
     end

data/test/test_extensions.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 require 'sidekiq'
 require 'active_record'

data/test/test_fetch.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 require 'sidekiq/fetch'
 

data/test/test_launcher.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 require 'sidekiq/launcher'
 
@@ -14,8 +15,6 @@ class TestLauncher < Sidekiq::Test
 
     describe 'heartbeat' do
       before do
-        uow = Object.new
-
         @mgr = new_manager(options)
         @launcher = Sidekiq::Launcher.new(options)
         @launcher.manager = @mgr
@@ -30,6 +29,18 @@ class TestLauncher < Sidekiq::Test
         $0 = @proctitle
       end
 
+      it 'fires new heartbeat events' do
+        i = 0
+        Sidekiq.on(:heartbeat) do
+          i += 1
+        end
+        assert_equal 0, i
+        @launcher.heartbeat('identity', heartbeat_data, Sidekiq.dump_json(heartbeat_data))
+        assert_equal 1, i
+        @launcher.heartbeat('identity', heartbeat_data, Sidekiq.dump_json(heartbeat_data))
+        assert_equal 1, i
+      end
+
       describe 'when manager is active' do
         before do
           Sidekiq::CLI::PROCTITLES << proc { "xyz" }
@@ -55,6 +66,10 @@ class TestLauncher < Sidekiq::Test
           @launcher.heartbeat('identity', heartbeat_data, Sidekiq.dump_json(heartbeat_data))
         end
 
+        #after do
+          #puts system('redis-cli -n 15 keys  "*" | while read LINE ; do TTL=`redis-cli -n 15 ttl "$LINE"`; if [ "$TTL" -eq -1 ]; then echo "$LINE"; fi; done;')
+        #end
+
         it 'indicates stopping status in proctitle' do
           assert_equal "sidekiq #{Sidekiq::VERSION} myapp [1 of 3 busy] stopping", $0
         end

data/test/test_logging.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 require 'sidekiq/logging'
 

data/test/test_manager.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 require 'sidekiq/manager'
 

data/test/test_middleware.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 require 'sidekiq/middleware/chain'
 require 'sidekiq/processor'

data/test/test_processor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 require 'sidekiq/fetch'
 require 'sidekiq/cli'

data/test/test_rails.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 
 $HAS_AJ = true

data/test/test_redis_connection.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 
 class TestRedisConnection < Sidekiq::Test
@@ -26,11 +27,16 @@ class TestRedisConnection < Sidekiq::Test
     end
 
     describe "namespace" do
-      it "uses a given :namespace" do
+      it "uses a given :namespace set by a symbol key" do
         pool = Sidekiq::RedisConnection.create(:namespace => "xxx")
         assert_equal "xxx", pool.checkout.namespace
       end
 
+      it "uses a given :namespace set by a string key" do
+        pool = Sidekiq::RedisConnection.create("namespace" => "xxx")
+        assert_equal "xxx", pool.checkout.namespace
+      end
+
       it "uses given :namespace over :namespace from Sidekiq.options" do
         Sidekiq.options[:namespace] = "xxx"
         pool = Sidekiq::RedisConnection.create(:namespace => "yyy")

data/test/test_retry.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # encoding: utf-8
 require_relative 'helper'
 require 'sidekiq/scheduled'

data/test/test_scheduled.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 require 'sidekiq/scheduled'
 

data/test/test_scheduling.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 require 'sidekiq/scheduled'
 

data/test/test_sidekiq.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # encoding: utf-8
 require_relative 'helper'
 

data/test/test_testing.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 
 require 'active_record'

data/test/test_testing_fake.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 
 require 'active_record'

data/test/test_testing_inline.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 
 require 'active_record'
@@ -86,7 +87,7 @@ class TestInline < Sidekiq::Test
     end
 
     it 'should relay parameters through json' do
-      assert Sidekiq::Client.enqueue(InlineWorkerWithTimeParam, Time.now)
+      assert Sidekiq::Client.enqueue(InlineWorkerWithTimeParam, Time.now.to_f)
     end
 
   end

data/test/test_util.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'helper'
 
 class TestUtil < Sidekiq::Test

data/test/test_web.rb

@@ -1,11 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
 require_relative 'helper'
 require 'sidekiq/web'
 require 'rack/test'
-require 'tilt/erubis'
 
 class TestWeb < Sidekiq::Test
-
   describe 'sidekiq web' do
     include Rack::Test::Methods
 
@@ -306,7 +305,7 @@ class TestWeb < Sidekiq::Test
     it 'calls updatePage() once when polling' do
       get '/busy?poll=true'
       assert_equal 200, last_response.status
-      assert_equal 1, last_response.body.scan('updatePage(').count
+      assert_equal 1, last_response.body.scan('data-poll-path="/busy').count
     end
 
     it 'escape job args and error messages' do
@@ -340,7 +339,6 @@ class TestWeb < Sidekiq::Test
       assert last_response.body.include?( "&lt;a&gt;hello&lt;&#x2F;a&gt;" )
       assert !last_response.body.include?( "<a>hello</a>" )
 
-
       # on /queues page
       params = add_xss_retry # sorry, don't know how to easily make this show up on queues page otherwise.
       post "/retries/#{job_params(*params)}", 'retry' => 'Retry'
@@ -373,7 +371,7 @@ class TestWeb < Sidekiq::Test
       before do
         Sidekiq::Web.settings.locales << File.join(File.dirname(__FILE__), "fixtures")
         Sidekiq::Web.tabs['Custom Tab'] = '/custom'
-        Sidekiq::Web.get('/custom') do
+        Sidekiq::WebApplication.get('/custom') do
           clear_caches # ugly hack since I can't figure out how to access WebHelpers outside of this context
           t('translated_text')
         end
@@ -386,6 +384,7 @@ class TestWeb < Sidekiq::Test
 
       it 'can show user defined tab with custom locales' do
         get '/custom'
+
         assert_match(/Changed text/, last_response.body)
       end
     end
@@ -563,6 +562,7 @@ class TestWeb < Sidekiq::Test
       Sidekiq.redis do |conn|
         conn.zadd('retry', score, Sidekiq.dump_json(msg))
       end
+
       [msg, score]
     end
 
@@ -595,6 +595,7 @@ class TestWeb < Sidekiq::Test
       Sidekiq.redis do |conn|
         conn.zadd('retry', score, Sidekiq.dump_json(msg))
       end
+
       [msg, score]
     end
 
@@ -610,4 +611,51 @@ class TestWeb < Sidekiq::Test
       end
     end
   end
+
+  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