sidekiq 5.2.9 → 6.0.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 575db4e3e544aee9b13d0cd23610bf39c4167e3a9835d4c046a9b355d2cb9c0e
-  data.tar.gz: 3f1f5806001515d03e206ce8d0695e59f9ff563ac5d84472294799424187591c
+  metadata.gz: 66e4721768942652832cd78e2ff64152e0bfe87e43a591d10c456999988838b4
+  data.tar.gz: 3186e6bec7a002151d7d6fb4baf83f6072aa3823434d96dbfac8ed52c3ea9ea9
 SHA512:
-  metadata.gz: 525fe03fcc6911d231696182d46de5da5d4c072681c924b14a0732aeb6aed3a1310baa4f9827f0f50925b69bede7218d485c4a81ebeb2feb712881b39da996e7
-  data.tar.gz: 586fb51fff5bfefaa6db779e470b6040c8d98a2d4e8fb319cde6087c3f02ffc242ae0a067e32cb8f25585cd6d8d6c12e40f05507514b9406bdb1eadb3ac6f2dd
+  metadata.gz: c97aaa9b382b95c01c42019bdc12bc80f3805bbe9fa28921c0d5bd0b1383affd5e081464c75004dd07b780cc60d865cfea03ea1585a52ce3d9f89a06b5801353
+  data.tar.gz: f9de3b4b488af11c085cd8c1f577e98f661e446ce0074f7da63fa36ba559892bd53e29abcb2c09215c82c866c98e8d7afeb6d42563aa516be587dfe66b37e265

data/.standard.yml

@@ -0,0 +1,20 @@
+ruby_version: 2.5.0
+fix: false
+parallel: true
+ignore:
+  - test/**/*
+  - examples/**/*
+  - myapp/**/*
+  - 'lib/sidekiq.rb':
+    - Lint/InheritException
+  - 'lib/sidekiq/extensions/**/*':
+    - Style/MethodMissingSuper
+    - Style/MissingRespondToMissing
+  - 'lib/**/*':
+    - Naming/AsciiIdentifiers
+    - Lint/RescueException
+    - Security/YAMLLoad
+    - Naming/AccessorMethodName
+    - Naming/MethodName
+    - Style/GlobalVars
+    - Style/Alias

data/.travis.yml

@@ -3,9 +3,12 @@ sudo: false
 cache: bundler
 services:
   - redis-server
+bundler_args: --without development load_test
 rvm:
-  - 2.3.7
-  - 2.4.4
   - 2.5.1
   - 2.6.0
   - jruby-9.2.6.0
+
+script:
+  - bundle exec rake test
+  - bundle exec rake standard

data/6.0-Upgrade.md

@@ -0,0 +1,58 @@
+# Welcome to Sidekiq 6.0!
+
+Sidekiq 6.0 contains some breaking changes which streamline proper operation
+of Sidekiq. It also drops support for EOL versions of Ruby and Rails.
+
+## What's New
+
+This release has major breaking changes.  Read and test carefully in production.
+
+- Logging has been redesigned to allow pluggable formatters and several
+  formats ship with Sidekiq:
+  * default - your typical output on macOS
+  * heroku - enabled specifically when running in Heroku
+  * json - a JSON format for search indexing, one hash per line
+
+Sidekiq will enable the best formatter for the detected environment but
+you can override it by configuring the log formatter explicitly. See
+'sidekiq/logger' for implementation details.
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.log_formatter = AcmeCorp::PlainLogFormatter.new
+  # config.log_formatter = Sidekiq::Logger::Format::JSON.new
+end
+```
+- **Remove the daemonization, logfile and pidfile command line arguments**.
+I've [noted for years](https://www.mikeperham.com/2014/09/22/dont-daemonize-your-daemons/)
+how modern services should be managed with a proper init system.
+Managing services manually is more error-prone, let your operating system do it for you. See the Deployment wiki page for options.
+- **Validate proper usage of the `REDIS_PROVIDER` variable.**
+This variable is meant to hold the name of the environment
+variable which contains your Redis URL, so that you can switch Redis
+providers quickly and easily with a single variable change.  It is not
+meant to hold the actual Redis URL itself.  If you want to manually set
+the Redis URL then you may set `REDIS_URL` directly. [#3969]
+- **Increase default shutdown timeout from 8 seconds to 25 seconds.**
+Both Heroku and ECS now use 30 second shutdown timeout
+by default and we want Sidekiq to take advantage of this time.  If you
+have deployment scripts which depend on the old default timeout, use `-t 8` to
+get the old behavior. [#3968]
+* **Rails <5** is no longer supported.
+* **Ruby <2.5** is no longer supported.
+* **Redis <4** is no longer supported.
+
+## Upgrade
+
+As always, please upgrade Sidekiq **one major version at a time**.
+If you are already running Sidekiq 5.x, then:
+
+* Upgrade to the latest Sidekiq 5.x.
+```ruby
+gem 'sidekiq', '< 6'
+```
+* Fix any deprecation warnings you see.
+* Upgrade to 6.x.
+```ruby
+gem 'sidekiq', '< 7'
+```

data/Changes.md

@@ -2,17 +2,29 @@
 
 [Sidekiq Changes](https://github.com/mperham/sidekiq/blob/master/Changes.md) | [Sidekiq Pro Changes](https://github.com/mperham/sidekiq/blob/master/Pro-Changes.md) | [Sidekiq Enterprise Changes](https://github.com/mperham/sidekiq/blob/master/Ent-Changes.md)
 
-5.2.9
+6.0
 ---------
 
-- Release Rack lock due to a cascade of CVEs. [#4566]
-  Pro-tip: don't lock Rack.
-
-5.2.8
----------
-
-- Lock to Rack 2.0.x to prevent future incompatibilities
-- Fix invalid reference in `sidekiqctl`
+This release has major breaking changes.  Read and test carefully in production.
+
+- **BREAKING CHANGE** Validate proper usage of the `REDIS_PROVIDER`
+  variable.  This variable is meant to hold the name of the environment
+  variable which contains your Redis URL, so that you can switch Redis
+  providers quickly and easily with a single variable change.  It is not
+  meant to hold the actual Redis URL itself.  If you want to manually set
+  the Redis URL (not recommended as it implies you have no failover),
+  then you may set `REDIS_URL` directly. [#3969]
+- **BREAKING CHANGE** Increase default shutdown timeout from 8 seconds
+  to 25 seconds.  Both Heroku and ECS now use 30 second shutdown timeout
+  by default and we want Sidekiq to take advantage of this time.  If you
+  have deployment scripts which depend on the old default timeout, use `-t 8` to
+  get the old behavior. [#3968]
+- **BREAKING CHANGE** Remove the daemonization, logfile and pidfile
+  arguments to Sidekiq. Use a proper process supervisor (e.g. systemd or
+  foreman) to manage Sidekiq.  See the Deployment wiki page for links to
+  more resources.
+- Integrate the StandardRB code formatter to ensure consistent code
+  styling. [#4114, gearnode]
 
 5.2.7
 ---------

data/Gemfile

@@ -1,23 +1,24 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-gem 'rake'
-gem 'redis-namespace'
-gem 'rails', '~> 5.2'
-gem 'sqlite3', '~> 1.3.6', platforms: :ruby
-gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
+gem "rake"
+gem "redis-namespace"
+gem "rails"
+gem "sqlite3", platforms: :ruby
+gem "activerecord-jdbcsqlite3-adapter", platforms: :jruby
 
 group :test do
-  gem 'minitest'
-  gem 'simplecov'
+  gem "minitest"
+  gem "simplecov"
 end
 
 group :development, :test do
-  gem 'pry-byebug', platforms: :mri
+  gem "pry-byebug", platforms: :mri
+  gem "standard"
 end
 
 group :load_test do
-  gem 'hiredis'
-  gem 'toxiproxy'
+  gem "hiredis"
+  gem "toxiproxy"
 end

data/Rakefile

@@ -1,9 +1,10 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "standard/rake"
 
 Rake::TestTask.new(:test) do |test|
   test.warning = true
-  test.pattern = 'test/**/test_*.rb'
+  test.pattern = "test/**/test_*.rb"
 end
 
-task default: :test
+task default: [:standard, :test]

data/bin/sidekiqctl

@@ -7,14 +7,5 @@ require 'sidekiq/ctl'
 if ARGV[0] == 'status'
   Sidekiq::Ctl::Status.new.display(ARGV[1])
 else
-  if ARGV.length < 2
-    Sidekiq::Ctl.print_usage
-  else
-    stage = ARGV[0]
-    pidfile = ARGV[1]
-    timeout = ARGV[2].to_i
-    timeout = Sidekiq::Ctl::DEFAULT_KILL_TIMEOUT if timeout == 0
-
-    Sidekiq::Ctl.new(stage, pidfile, timeout)
-  end
+  Sidekiq::Ctl.print_usage
 end

data/lib/generators/sidekiq/worker_generator.rb

@@ -1,18 +1,18 @@
-require 'rails/generators/named_base'
+require "rails/generators/named_base"
 
 module Sidekiq
   module Generators # :nodoc:
     class WorkerGenerator < ::Rails::Generators::NamedBase # :nodoc:
-      desc 'This generator creates a Sidekiq Worker in app/workers and a corresponding test'
+      desc "This generator creates a Sidekiq Worker in app/workers and a corresponding test"
 
-      check_class_collision suffix: 'Worker'
+      check_class_collision suffix: "Worker"
 
       def self.default_generator_root
         File.dirname(__FILE__)
       end
 
       def create_worker_file
-        template 'worker.rb.erb', File.join('app/workers', class_path, "#{file_name}_worker.rb")
+        template "worker.rb.erb", File.join("app/workers", class_path, "#{file_name}_worker.rb")
       end
 
       def create_test_file
@@ -27,23 +27,21 @@ module Sidekiq
 
       def create_worker_spec
         template_file = File.join(
-            'spec/workers',
-            class_path,
-            "#{file_name}_worker_spec.rb"
+          "spec/workers",
+          class_path,
+          "#{file_name}_worker_spec.rb"
         )
-        template 'worker_spec.rb.erb', template_file
+        template "worker_spec.rb.erb", template_file
       end
 
       def create_worker_test
         template_file = File.join(
-            'test/workers',
-            class_path,
-            "#{file_name}_worker_test.rb"
+          "test/workers",
+          class_path,
+          "#{file_name}_worker_test.rb"
         )
-        template 'worker_test.rb.erb', template_file
+        template "worker_test.rb.erb", template_file
       end
-
-
     end
   end
 end

data/lib/sidekiq.rb

@@ -1,27 +1,27 @@
 # frozen_string_literal: true
 
-require 'sidekiq/version'
-fail "Sidekiq #{Sidekiq::VERSION} does not support Ruby versions below 2.2.2." if RUBY_PLATFORM != 'java' && Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.2.2')
+require "sidekiq/version"
+fail "Sidekiq #{Sidekiq::VERSION} does not support Ruby versions below 2.5.0." if RUBY_PLATFORM != "java" && Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.5.0")
 
-require 'sidekiq/logging'
-require 'sidekiq/client'
-require 'sidekiq/worker'
-require 'sidekiq/redis_connection'
-require 'sidekiq/delay'
+require "sidekiq/logger"
+require "sidekiq/client"
+require "sidekiq/worker"
+require "sidekiq/redis_connection"
+require "sidekiq/delay"
 
-require 'json'
+require "json"
 
 module Sidekiq
-  NAME = 'Sidekiq'
-  LICENSE = 'See LICENSE and the LGPL-3.0 for licensing details.'
+  NAME = "Sidekiq"
+  LICENSE = "See LICENSE and the LGPL-3.0 for licensing details."
 
   DEFAULTS = {
     queues: [],
     labels: [],
     concurrency: 10,
-    require: '.',
+    require: ".",
     environment: nil,
-    timeout: 8,
+    timeout: 25,
     poll_interval_average: nil,
     average_scheduled_poll_interval: 5,
     error_handlers: [],
@@ -38,8 +38,8 @@ module Sidekiq
   }
 
   DEFAULT_WORKER_OPTIONS = {
-    'retry' => true,
-    'queue' => 'default'
+    "retry" => true,
+    "queue" => "default",
   }
 
   FAKE_INFO = {
@@ -47,7 +47,7 @@ module Sidekiq
     "uptime_in_days" => "9999",
     "connected_clients" => "9999",
     "used_memory_human" => "9P",
-    "used_memory_peak_human" => "9P"
+    "used_memory_peak_human" => "9P",
   }
 
   def self.❨╯°□°❩╯︵┻━┻
@@ -96,9 +96,13 @@ module Sidekiq
       begin
         yield conn
       rescue Redis::CommandError => ex
-        #2550 Failover can cause the server to become a replica, need
+        # 2550 Failover can cause the server to become a replica, need
         # to disconnect and reopen the socket to get back to the primary.
-        (conn.disconnect!; retryable = false; retry) if retryable && ex.message =~ /READONLY/
+        if retryable && ex.message =~ /READONLY/
+          conn.disconnect!
+          retryable = false
+          retry
+        end
         raise
       end
     end
@@ -106,19 +110,17 @@ module Sidekiq
 
   def self.redis_info
     redis do |conn|
-      begin
-        # admin commands can't go through redis-namespace starting
-        # in redis-namespace 2.0
-        if conn.respond_to?(:namespace)
-          conn.redis.info
-        else
-          conn.info
-        end
-      rescue Redis::CommandError => ex
-        #2850 return fake version when INFO command has (probably) been renamed
-        raise unless ex.message =~ /unknown command/
-        FAKE_INFO
+      # admin commands can't go through redis-namespace starting
+      # in redis-namespace 2.0
+      if conn.respond_to?(:namespace)
+        conn.redis.info
+      else
+        conn.info
       end
+    rescue Redis::CommandError => ex
+      # 2850 return fake version when INFO command has (probably) been renamed
+      raise unless ex.message =~ /unknown command/
+      FAKE_INFO
     end
   end
 
@@ -152,18 +154,13 @@ module Sidekiq
 
   def self.default_worker_options=(hash)
     # stringify
-    @default_worker_options = default_worker_options.merge(Hash[hash.map{|k, v| [k.to_s, v]}])
+    @default_worker_options = default_worker_options.merge(Hash[hash.map {|k, v| [k.to_s, v]}])
   end
+
   def self.default_worker_options
     defined?(@default_worker_options) ? @default_worker_options : DEFAULT_WORKER_OPTIONS
   end
 
-  def self.default_retries_exhausted=(prok)
-    logger.info { "default_retries_exhausted is deprecated, please use `config.death_handlers << -> {|job, ex| }`" }
-    return nil unless prok
-    death_handlers << prok
-  end
-
   ##
   # Death handlers are called when all retries for a job have been exhausted and
   # the job dies.  It's the notification to your application
@@ -180,15 +177,29 @@ module Sidekiq
   def self.load_json(string)
     JSON.parse(string)
   end
+
   def self.dump_json(object)
     JSON.generate(object)
   end
 
+  def self.log_formatter
+    @log_formatter ||= if ENV["DYNO"]
+      Sidekiq::Logger::Formatters::WithoutTimestamp.new
+    else
+      Sidekiq::Logger::Formatters::Pretty.new
+    end
+  end
+
+  def self.log_formatter=(log_formatter)
+    @log_formatter = log_formatter
+  end
+
   def self.logger
-    Sidekiq::Logging.logger
+    @logger ||= Sidekiq::Logger.new(STDOUT, level: Logger::INFO)
   end
-  def self.logger=(log)
-    Sidekiq::Logging.logger = log
+
+  def self.logger=(logger)
+    @logger = logger
   end
 
   # How frequently Redis should be checked by a random Sidekiq process for
@@ -197,7 +208,7 @@ module Sidekiq
   #
   # See sidekiq/scheduled.rb for an in-depth explanation of this value
   def self.average_scheduled_poll_interval=(interval)
-    self.options[:average_scheduled_poll_interval] = interval
+    options[:average_scheduled_poll_interval] = interval
   end
 
   # Register a proc to handle any error which occurs within the Sidekiq process.
@@ -208,7 +219,7 @@ module Sidekiq
   #
   # The default error handler logs errors to Sidekiq.logger.
   def self.error_handlers
-    self.options[:error_handlers]
+    options[:error_handlers]
   end
 
   # Register a block to run at a point in the Sidekiq lifecycle.
@@ -234,4 +245,4 @@ module Sidekiq
   class Shutdown < Interrupt; end
 end
 
-require 'sidekiq/rails' if defined?(::Rails::Engine)
+require "sidekiq/rails" if defined?(::Rails::Engine)