sidekiq 4.2.2 → 4.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16084a1269ac7fe480effaf07d9f6b360685e50d
-  data.tar.gz: cdf1982622b75f401b982418bea515eb1c729bea
+  metadata.gz: f5611a44077288f2a7a7c1e46d4fdf39aa05be0f
+  data.tar.gz: 7c406cd5d25b49faa1af246dd12a6f3e8ccc827a
 SHA512:
-  metadata.gz: 22858e281ef82252dac1c31b11ddd9841fc280dd4321f7a8def5b2b9911c3c1c0afa0501b113646f516736b314aae9a425a242111db205fd3d504a9ef9e49a65
-  data.tar.gz: 77a536da34d30a5327314ee8391b22d8eb7867d6c866c3f6a958c644644844e2884b4ec00982f5ece04dfa020f4135b197766dd512fd68724be2dc27e1ead390
+  metadata.gz: eec6ef8ffffbb53e2717a82fd85de7d089b2accc799905ba8a277a4a2fe8a4ba18382eef0e5a7939deb94b4070a96f785b9513c7ffecc61499f8fb79de083dd6
+  data.tar.gz: 2fc1f05e9c47a36e5451665b76acfda798f5787fee4bd833f65d955a434ad375cb2c7517b1ee4500e87e9854ad957fa38ec56fe606b9bf9d7802140ac9fca34d

data/Changes.md

@@ -1,5 +1,19 @@
 # Sidekiq Changes
 
+4.2.3
+-----------
+
+- Disable use of Rails 5's Reloader API in non-development modes, it has proven
+  to be unstable under load [#3154]
+- Allow disabling of Sidekiq::Web's cookie session to handle the
+  case where the app provides a session already [#3180, inkstak]
+```ruby
+Sidekiq::Web.set :sessions, false
+```
+- Fix Web UI sharding support broken in 4.2.2. [#3169]
+- Fix timestamps not updating during UI polling [#3193, shaneog]
+- Relax rack-protection version to >= 1.5.0
+
 4.2.2
 -----------
 

data/Pro-Changes.md

@@ -3,6 +3,21 @@ Sidekiq Pro Changelog
 
 Please see [http://sidekiq.org/](http://sidekiq.org/) for more details and how to buy.
 
+3.4.0
+---------
+
+- Introducing the newest reliable fetching algorithm: `super_fetch`!  This
+  algorithm will replace reliable\_fetch in Pro 4.0.  super\_fetch is
+  bullet-proof across all environments, no longer requiring stable
+  hostnames or an index to be set per-process. [#3077]
+```ruby
+Sidekiq.configure_server do |config|
+  config.super_fetch!
+end
+```
+  Thank you to @jonhyman for code review and the Sidekiq Pro customers that
+  beta tested super\_fetch.
+
 3.3.3
 ---------
 

data/lib/sidekiq.rb

@@ -150,10 +150,6 @@ module Sidekiq
     Middleware::Chain.new do |m|
       m.add Middleware::Server::Logging
       m.add Middleware::Server::RetryJobs
-      if defined?(::ActiveRecord::Base)
-        require 'sidekiq/middleware/server/active_record'
-        m.add Sidekiq::Middleware::Server::ActiveRecord
-      end
     end
   end
 

data/lib/sidekiq/cli.rb

@@ -240,7 +240,6 @@ module Sidekiq
         else
           require 'sidekiq/rails'
           require File.expand_path("#{options[:require]}/config/environment.rb")
-          Sidekiq.options[:reloader] = Sidekiq::Rails::Reloader.new
         end
         options[:tag] ||= default_tag
       else

data/lib/sidekiq/processor.rb

@@ -143,7 +143,7 @@ module Sidekiq
           # we didn't properly finish it.
           ack = false
         rescue Exception => ex
-          handle_exception(ex, job || { :job => jobstr })
+          handle_exception(ex, { :context => "Job raised exception", :job => job, :jobstr => jobstr })
           raise
         ensure
           work.acknowledge if ack

data/lib/sidekiq/rails.rb

@@ -32,10 +32,47 @@ module Sidekiq
   end
 
   class Rails < ::Rails::Engine
+    # We need to setup this up before any application configuration which might
+    # change Sidekiq middleware.
+    #
+    # This hook happens after `Rails::Application` is inherited within
+    # config/application.rb and before config is touched, usually within the
+    # class block. Definitely before config/environments/*.rb and
+    # config/initializers/*.rb.
+    config.before_configuration do
+      if ::Rails::VERSION::MAJOR < 5 && defined?(::ActiveRecord)
+        Sidekiq.server_middleware do |chain|
+          require 'sidekiq/middleware/server/active_record'
+          chain.add Sidekiq::Middleware::Server::ActiveRecord
+        end
+      end
+    end
+
     initializer 'sidekiq' do
       Sidekiq.hook_rails!
     end
 
+    # We have to add the reloader after initialize to see if cache_classes has
+    # been turned on.
+    #
+    # This hook happens after all initialziers are run, just before returning
+    # from config/environment.rb back to sidekiq/cli.rb.
+    config.after_initialize do
+      if ::Rails::VERSION::MAJOR >= 5
+        # The reloader also takes care of ActiveRecord but is incompatible with
+        # the ActiveRecord middleware so make sure it's not in the chain already.
+        if defined?(Sidekiq::Middleware::Server::ActiveRecord) && Sidekiq.server_middleware.exists?(Sidekiq::Middleware::Server::ActiveRecord)
+          raise ArgumentError, "You are using the Sidekiq ActiveRecord middleware and the new Rails 5 reloader which are incompatible. Please remove the ActiveRecord middleware from your Sidekiq middleware configuration."
+        elsif ::Rails.application.config.cache_classes
+          # The reloader API has proven to be troublesome under load in production.
+          # We won't use it at all when classes are cached, see #3154
+          Sidekiq.logger.debug { "Autoload disabled in #{::Rails.env}, Sidekiq will not reload changed classes" }
+        else
+          Sidekiq.options[:reloader] = Sidekiq::Rails::Reloader.new
+        end
+      end
+    end
+
     class Reloader
       def initialize(app = ::Rails.application)
         Sidekiq.logger.debug "Enabling Rails 5+ live code reloading, so hot!" unless app.config.cache_classes

data/lib/sidekiq/util.rb

@@ -53,7 +53,7 @@ module Sidekiq
         begin
           block.call
         rescue => ex
-          handle_exception(ex, { event: event })
+          handle_exception(ex, { context: "Exception during Sidekiq lifecycle event.", event: event })
         end
       end
       arr.clear

data/lib/sidekiq/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Sidekiq
-  VERSION = "4.2.2"
+  VERSION = "4.2.3"
 end

data/lib/sidekiq/web.rb

@@ -63,15 +63,30 @@ module Sidekiq
         @views ||= VIEWS
       end
 
+      def enable(*opts)
+        opts.each {|key| set(key, true) }
+      end
+
+      def disable(*opts)
+        opts.each {|key| set(key, false) }
+      end
+
       # Helper for the Sinatra syntax: Sidekiq::Web.set(:session_secret, Rails.application.secrets...)
       def set(attribute, value)
         send(:"#{attribute}=", value)
       end
 
-      attr_accessor :app_url, :session_secret, :redis_pool
+      attr_accessor :app_url, :session_secret, :redis_pool, :sessions
       attr_writer :locales, :views
     end
 
+    def self.inherited(child)
+      child.app_url = self.app_url
+      child.session_secret = self.session_secret
+      child.redis_pool = self.redis_pool
+      child.sessions = self.sessions
+    end
+
     def settings
       self.class.settings
     end
@@ -97,6 +112,32 @@ module Sidekiq
       @app ||= build
     end
 
+    def enable(*opts)
+      opts.each {|key| set(key, true) }
+    end
+
+    def disable(*opts)
+      opts.each {|key| set(key, false) }
+    end
+
+    def set(attribute, value)
+      send(:"#{attribute}=", value)
+    end
+
+    # Default values
+    set :sessions, true
+
+    attr_writer :sessions
+
+    def sessions
+      unless instance_variable_defined?("@sessions")
+        @sessions = self.class.sessions
+        @sessions = @sessions.to_hash.dup if @sessions.respond_to?(:to_hash)
+      end
+
+      @sessions
+    end
+
     def self.register(extension)
       extension.registered(WebApplication)
     end
@@ -109,22 +150,34 @@ module Sidekiq
       end
     end
 
-    def build
+    def build_sessions
       middlewares = self.middlewares
-      klass = self.class
 
       unless using?(::Rack::Protection) || ENV['RACK_ENV'] == 'test'
         middlewares.unshift [[::Rack::Protection, { use: :authenticity_token }], nil]
       end
 
+      s = sessions
+      return unless s
+
       unless using? ::Rack::Session::Cookie
         unless secret = Web.session_secret
           require 'securerandom'
           secret = SecureRandom.hex(64)
         end
 
-        middlewares.unshift [[::Rack::Session::Cookie, { secret: secret }], nil]
+        options = { secret: secret }
+        options = options.merge(s.to_hash) if s.respond_to? :to_hash
+
+        middlewares.unshift [[::Rack::Session::Cookie, options], nil]
       end
+    end
+
+    def build
+      build_sessions
+
+      middlewares = self.middlewares
+      klass = self.class
 
       ::Rack::Builder.new do
         %w(stylesheets javascripts images).each do |asset_dir|
@@ -147,7 +200,7 @@ module Sidekiq
 end
 
 if defined?(::ActionDispatch::Request::Session) &&
-    !::ActionDispatch::Request::Session.respond_to?(:each)
+    !::ActionDispatch::Request::Session.method_defined?(:each)
   # mperham/sidekiq#2460
   # Rack apps can't reuse the Rails session store without
   # this monkeypatch, fixed in Rails 5.

data/lib/sidekiq/web/action.rb

@@ -3,8 +3,6 @@
 module Sidekiq
   class WebAction
     RACK_SESSION = 'rack.session'.freeze
-    TEXT_HTML = { "Content-Type" => "text/html", "Cache-Control" => "no-cache" }.freeze
-    APPLICATION_JSON = { "Content-Type" => "application/json", "Cache-Control" => "no-cache" }.freeze
 
     attr_accessor :env, :block, :type
 
@@ -70,7 +68,7 @@ module Sidekiq
     end
 
     def json(payload)
-      [200, APPLICATION_JSON, [Sidekiq.dump_json(payload)]]
+      [200, { "Content-Type" => "application/json", "Cache-Control" => "no-cache" }, [Sidekiq.dump_json(payload)]]
     end
 
     def initialize(env, block)

data/lib/sidekiq/web/application.rb

@@ -7,7 +7,6 @@ module Sidekiq
     CONTENT_LENGTH = "Content-Length".freeze
     CONTENT_TYPE = "Content-Type".freeze
     REDIS_KEYS = %w(redis_version uptime_in_days connected_clients used_memory_human used_memory_peak_human)
-    NOT_FOUND = [404, {"Content-Type" => "text/plain", "X-Cascade" => "pass" }.freeze, ["Not Found"]]
 
     def initialize(klass)
       @klass = klass
@@ -28,7 +27,7 @@ module Sidekiq
     def self.set(key, val)
       # nothing, backwards compatibility
     end
-    
+
     get "" do
       redirect(root_path)
     end
@@ -262,7 +261,7 @@ module Sidekiq
 
     def call(env)
       action = self.class.match(env)
-      return NOT_FOUND unless action
+      return [404, {"Content-Type" => "text/plain", "X-Cascade" => "pass" }, ["Not Found"]] unless action
 
       resp = catch(:halt) do
         app = @klass
@@ -284,11 +283,11 @@ module Sidekiq
       else
         type_header = case action.type
         when :json
-          WebAction::APPLICATION_JSON
+          { "Content-Type" => "application/json", "Cache-Control" => "no-cache" }
         when String
-          { WebAction::CONTENT_TYPE => action.type, "Cache-Control" => "no-cache" }
+          { "Content-Type" => action.type, "Cache-Control" => "no-cache" }
         else
-          WebAction::TEXT_HTML
+          { "Content-Type" => "text/html", "Cache-Control" => "no-cache" }
         end
 
         [200, type_header, [resp]]

data/lib/sidekiq/worker.rb

@@ -64,13 +64,13 @@ module Sidekiq
       #   numeric (like an activesupport time interval).
       def perform_in(interval, *args)
         int = interval.to_f
-        now = Time.now
-        ts = (int < 1_000_000_000 ? (now + interval).to_f : int)
+        now = Time.now.to_f
+        ts = (int < 1_000_000_000 ? now + int : int)
 
         item = { 'class' => self, 'args' => args, 'at' => ts }
 
         # Optimization to enqueue something now that is scheduled to go out now or in the past
-        item.delete('at'.freeze) if ts <= now.to_f
+        item.delete('at'.freeze) if ts <= now
 
         client_push(item)
       end

data/sidekiq.gemspec

@@ -18,7 +18,7 @@ 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_dependency                  'rack-protection', '>= 1.5.0'
   gem.add_development_dependency      'redis-namespace', '~> 1.5', '>= 1.5.2'
   gem.add_development_dependency      'minitest', '~> 5.7', '>= 5.7.0'
   gem.add_development_dependency      'rake', '~> 10.0'

data/test/test_scheduling.rb

@@ -11,6 +11,11 @@ class TestScheduling < Sidekiq::Test
       end
     end
 
+    # Assume we can pass any class as time to perform_in
+    class TimeDuck
+      def to_f; 42.0 end
+    end
+
     it 'schedules jobs' do
       ss = Sidekiq::ScheduledSet.new
       ss.clear
@@ -34,6 +39,9 @@ class TestScheduling < Sidekiq::Test
 
       assert Sidekiq::Client.push_bulk('class' => ScheduledWorker, 'args' => [['mike'], ['mike']], 'at' => 600)
       assert_equal 5, ss.size
+
+      assert ScheduledWorker.perform_in(TimeDuck.new, 'samwise')
+      assert_equal 6, ss.size
     end
 
     it 'removes the enqueued_at field when scheduling' do

data/test/test_web.rb

@@ -663,4 +663,64 @@ class TestWeb < Sidekiq::Test
       assert_equal 'nicehost.org', session_options[:host]
     end
   end
+
+  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/application.js

@@ -39,16 +39,20 @@ $(function() {
     $($(this).attr('data-target')).toggle();
   });
 
-  var locale = $('body').data('locale');
+  updateFuzzyTimes($('body').data('locale'));
+});
+
+function updateFuzzyTimes(locale) {
   var parts = locale.split('-');
   if (typeof parts[1] !== 'undefined') {
     parts[1] = parts[1].toUpperCase();
     locale = parts.join('_');
   }
+
   var t = timeago()
   t.render(document.querySelectorAll('time'), locale);
   t.cancel();
-});
+}
 
 function updatePage(url) {
   setInterval(function () {
@@ -63,10 +67,14 @@ function updatePage(url) {
 
       var $header_status = $data.find('.status')
       $('.status').replaceWith($header_status)
+
+      updateFuzzyTimes($('body').data('locale'));
     })
   }, parseInt(localStorage.timeInterval) || 2000);
 }
 
+
+
 $(function() {
   'use strict';
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 4.2.2
+  version: 4.2.3
 platform: ruby
 authors:
 - Mike Perham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-26 00:00:00.000000000 Z
+date: 2016-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -68,16 +68,16 @@ dependencies:
   name: rack-protection
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: redis-namespace
   requirement: !ruby/object:Gem::Requirement