sidekiq 5.2.7 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 408fa69245bc5dbd48894529237ed6bd94fb62f084e12c3cf21c5c2b44466555
-  data.tar.gz: 7052699621d277bf59aaee779f93c0f98089a2d0bbc5d40f4d991faa52ef7b90
+  metadata.gz: fda3ed37e1d981e1b32eea70669c678d400c071a9146a919848bcc598612de25
+  data.tar.gz: 6580ab6c188b2514efe807479ca25c06ea584d1def175d84d94639bc20f80b1e
 SHA512:
-  metadata.gz: e128875c94c37f82fec77c4071e6abafd5326a1a949bff0ff90377d6a54c18b117a7753c439e7d9611e87dfc57c752251f6b2bf3cfb1c799d95016d2a112a211
-  data.tar.gz: 5aabe50f97494052e73190fb8aa96f57b253e5855416938ef0644013012678640d620c8e05484c4d945ea558d55413c7c1625967ab40f402680b7ded27133321
+  metadata.gz: 25682d3dbf99d29fa3f56b7c74419863d3549b6e0c182e69c83fbc02a2955d053bca85eec53b474d4d22c7526e44e865f378aa4111152a91377b373be27c4d47
+  data.tar.gz: e55d07434b1e2ab26df6748101bf10640fc08d4d93f00b75ed04d82ed309ee8529d652982430cd00671c98b5e53cc733bef4b686df58a6b0e116ba04c12139aa

data/.gitignore

@@ -1,8 +1,6 @@
 .rvmrc
 .ruby-version
 tags
-Gemfile.lock
-gemfiles/*.lock
 *.swp
 dump.rdb
 .rbx

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/6.0-Upgrade.md

@@ -0,0 +1,70 @@
+# 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.
+
+- ActiveJobs can now use `sidekiq_options` directly to configure Sidekiq
+  features/internals like the retry subsystem. Prefer the native
+  Sidekiq::Worker APIs as some Sidekiq features (e.g. unique jobs) do not work well with AJ.
+```ruby
+class MyJob < ActiveJob::Base
+  queue_as :myqueue
+  sidekiq_options retry: 10, backtrace: 20
+  def perform(...)
+  end
+end
+```
+- 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 and `sidekiqctl` binary**.
+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.
+systemd, upstart, and foreman are three options. See the Deployment wiki page for the latest details.
+- **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. Rails 6+ only works in zeitwerk mode.
+* **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,6 +2,40 @@
 
 [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)
 
+6.0
+---------
+
+This release has major breaking changes.  Read and test carefully in production.
+
+- ActiveJobs can now use `sidekiq_options` directly to configure Sidekiq
+  features/internals like the retry subsystem. [#4213, pirj]
+```ruby
+class MyJob < ActiveJob::Base
+  queue_as :myqueue
+  sidekiq_options retry: 10, backtrace: 20
+  def perform(...)
+  end
+end
+```
+- **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/Ent-2.0-Upgrade.md

@@ -0,0 +1,37 @@
+# Welcome to Sidekiq Enterprise 2.0!
+
+Sidekiq Enterprise 2.0 adds a few new features and adds the requirement that license
+credentials be available at runtime.  Note that Sidekiq 6.0 does have major breaking changes.
+
+## What's New
+
+* Sidekiq Enterprise now requires license credentials at runtime.  If you
+  configured Bundler as described in the access email you need do
+nothing, everything should just work.  If you are vendoring Sidekiq
+Enterprise you will need to configure Bundler also or set
+`SIDEKIQ_ENT_USERNAME=abcdef12 bundle exec sidekiq...` when starting the
+process. [#4232]
+* Dead jobs now release any unique locks they were holding when they died [#4162]
+* Backoff can now be customized per rate limiter by passing in a Proc [#4219]
+```ruby
+limiter = Sidekiq::Limiter.bucket(:stripe, 10, :second, backoff: ->(limiter, job) {
+  return job['overrated'] || 5 # wait for N seconds, where N is the number of
+                               # times we've failed the rate limit
+})
+```
+* Removed deprecated APIs and warnings.
+* Various changes for Sidekiq 6.0
+* Requires Ruby 2.5+ and Redis 4.0+
+* Requires Sidekiq 6.0+ and Sidekiq Pro 5.0+
+
+## Upgrade
+
+* Upgrade to the latest Sidekiq Enterprise 1.x.
+```ruby
+gem 'sidekiq-ent', '< 2'
+```
+* Fix any deprecation warnings you see.
+* Upgrade to 2.x.
+```ruby
+gem 'sidekiq-ent', '< 3'
+```

data/Ent-Changes.md

@@ -4,6 +4,18 @@
 
 Please see [http://sidekiq.org/](http://sidekiq.org/) for more details and how to buy.
 
+2.0.0
+-------------
+
+- Except for the [newly required credentials](/mperham/sidekiq/issue/4232), Sidekiq Enterprise 2.0 does
+  not have any significant migration steps.
+- Sidekiq Enterprise must now be started with valid license credentials. [#4232]
+- Call `GC.compact` if possible in sidekiqswarm before forking [#4181]
+- Changes for forward-compatibility with Sidekiq 6.0.
+- Add death handler to remove any lingering unique locks [#4162]
+- Backoff can now be customized per rate limiter [#4219]
+- Code formatting changes for StandardRB
+
 1.8.1
 -------------
 

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/Gemfile.lock

@@ -0,0 +1,196 @@
+PATH
+  remote: .
+  specs:
+    sidekiq (6.0.0)
+      connection_pool (>= 2.2.2)
+      rack (>= 2.0.0)
+      rack-protection (>= 2.0.0)
+      redis (>= 4.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.0)
+      actionpack (= 6.0.0)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.0)
+      actionpack (= 6.0.0)
+      activejob (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      mail (>= 2.7.1)
+    actionmailer (6.0.0)
+      actionpack (= 6.0.0)
+      actionview (= 6.0.0)
+      activejob (= 6.0.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.0)
+      actionview (= 6.0.0)
+      activesupport (= 6.0.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.0)
+      actionpack (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.0)
+      activesupport (= 6.0.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.0)
+      activesupport (= 6.0.0)
+      globalid (>= 0.3.6)
+    activemodel (6.0.0)
+      activesupport (= 6.0.0)
+    activerecord (6.0.0)
+      activemodel (= 6.0.0)
+      activesupport (= 6.0.0)
+    activestorage (6.0.0)
+      actionpack (= 6.0.0)
+      activejob (= 6.0.0)
+      activerecord (= 6.0.0)
+      marcel (~> 0.3.1)
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    ast (2.4.0)
+    builder (3.2.3)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    connection_pool (2.2.2)
+    crass (1.0.4)
+    docile (1.3.2)
+    erubi (1.8.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    hiredis (0.6.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.3)
+    json (2.2.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nio4r (2.5.1)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rack (2.0.7)
+    rack-protection (2.0.7)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.0)
+      actioncable (= 6.0.0)
+      actionmailbox (= 6.0.0)
+      actionmailer (= 6.0.0)
+      actionpack (= 6.0.0)
+      actiontext (= 6.0.0)
+      actionview (= 6.0.0)
+      activejob (= 6.0.0)
+      activemodel (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      bundler (>= 1.3.0)
+      railties (= 6.0.0)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.2.0)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (6.0.0)
+      actionpack (= 6.0.0)
+      activesupport (= 6.0.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    redis (4.1.2)
+    redis-namespace (1.6.0)
+      redis (>= 3.0.4)
+    rubocop (0.72.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.4.1)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    simplecov (0.17.0)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.1)
+    standard (0.1.2)
+      rubocop (~> 0.72.0)
+      rubocop-performance (~> 1.4.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    toxiproxy (1.0.3)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    zeitwerk (2.1.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-jdbcsqlite3-adapter
+  hiredis
+  minitest
+  pry-byebug
+  rails
+  rake
+  redis-namespace
+  sidekiq!
+  simplecov
+  sqlite3
+  standard
+  toxiproxy

data/Pro-5.0-Upgrade.md

@@ -0,0 +1,25 @@
+# Welcome to Sidekiq Pro 5.0!
+
+Sidekiq Pro 5.0 is mainly a cleanup release for Sidekiq 6.0. The
+migration should be as close to trivial as a major version bump can be.
+Note that Sidekiq 6.0 does have major breaking changes.
+
+## What's New
+
+* New localizations for the Sidekiq Pro Web UI: ES, ZH, PT, JA, RU
+* Removed deprecated APIs and warnings.
+* Various changes for Sidekiq 6.0
+* Requires Ruby 2.5+ and Redis 4.0+
+* Requires Sidekiq 6.0+.
+
+## Upgrade
+
+* Upgrade to the latest Sidekiq Pro 4.x.
+```ruby
+gem 'sidekiq-pro', '< 5'
+```
+* Fix any deprecation warnings you see.
+* Upgrade to 5.x.
+```ruby
+gem 'sidekiq-pro', '< 6'
+```