sidekiq 5.2.8 → 6.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 736ce0e629bd4a115422342ccb49c3cf8199372ced62e0bb0a9463974d2cb6cd
-  data.tar.gz: 60857bf5d87f618ece94183f4553636ae6221f567ada9489da82bbbbd88e0930
+  metadata.gz: eafcca9d632a83e39c7e69e47d104493f32b07974d58724347181ea1d9c47511
+  data.tar.gz: '08b987ddd7686f813f29a24d9d9027093f97307e7a22e24c355ed8b3d4c49362'
 SHA512:
-  metadata.gz: 363885cb52ed06abe653a9fbb6627e9931064fc7d3c607d605a2c915ff2e2ef236c1afd15d22e29a2ee11807f9682fd404c324a24fcd0163637a89f7b0d97458
-  data.tar.gz: b772dbcd3a911a7a2e48cc75c51f996e59aeca84372188f14972ded218c56a11457e0b3fbd715f28f4c5a2e5b88ededf0ece59933a2e5a2cdb64815d96a02c06
+  metadata.gz: 615b18ce20c57301cb4117e6fbeab847b6ba41377ed1ba22d98e32e2df579f1cef1138b0c2757a51a988b0ecef83e47992754fbdb5b96a6f6d653a294755e36c
+  data.tar.gz: c3f3a44a85fc7a1c9405f59bba34842892c8a23e49a3ebac8dce5ba35b48738a9c5ba71635b671d2c6b9b711e5692d780a71ebf4a0b3c66ba8ac95c8ab9f319b

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,20 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+Ruby version:
+Rails version:
+Sidekiq / Pro / Enterprise version(s):
+
+Please include your initializer, sidekiq.yml, and any error message with the full backtrace.
+
+If you are using an old version, have you checked the changelogs to see if your issue has been fixed in a later version?
+
+https://github.com/mperham/sidekiq/blob/master/Changes.md
+https://github.com/mperham/sidekiq/blob/master/Pro-Changes.md
+https://github.com/mperham/sidekiq/blob/master/Ent-Changes.md

data/.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7]
+    services:
+      redis:
+        image: redis
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 6379:6379
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

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

@@ -14,7 +14,7 @@ versions of Ruby and Rails and adds support for RTL languages in the Web UI.
   integrated as Sidekiq middleware; the logging/retry logic had to be pulled out
   too.  Sidekiq 4.2 had a hack to make it work but this redesign provides
   a cleaner integration. [#3235]
-* The Delayed Extensions `delay`, `delay_in` and `delay_until` APIs are
+* The Delayed Extensions `delay`, `delay_for` and `delay_until` APIs are
   no longer available by default.  The extensions allow you to marshal
   job arguments as YAML, leading to cases where job payloads could be many
   100s of KB or larger if not careful, leading to Redis networking

data/6.0-Upgrade.md

@@ -0,0 +1,72 @@
+# 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.
+  (requires Rails 6.0.2)
+```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::Formatters::JSON.new
+end
+```
+Please see the [Logging](https://github.com/mperham/sidekiq/wiki/Logging) wiki page for the latest documentation and notes.
+- **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,202 @@
 
 [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.1.3
+---------
+
+- Warn if Redis is configured to evict data under memory pressure [#4752]
+- Add process RSS on the Busy page [#4717]
+
+6.1.2
+---------
+
+- Improve readability in dark mode Web UI [#4674]
+- Fix Web UI crash with corrupt session [#4672]
+- Allow middleware to yield arguments [#4673, @eugeneius]
+- Migrate CI from CircleCI to GitHub Actions [#4677]
+
+6.1.1
+---------
+
+- Jobs are now sorted by age in the Busy Workers table. [#4641]
+- Fix "check all" JS logic in Web UI [#4619]
+
+6.1.0
+---------
+
+- Web UI - Dark Mode fixes [#4543, natematykiewicz]
+- Ensure `Rack::ContentLength` is loaded as middleware for correct Web UI responses [#4541]
+- Avoid exception dumping SSL store in Redis connection logging [#4532]
+- Better error messages in Sidekiq::Client [#4549]
+- Remove rack-protection, reimplement CSRF protection [#4588]
+- Require redis-rb 4.2 [#4591]
+- Update to jquery 1.12.4 [#4593]
+- Refactor internal fetch logic and API [#4602]
+
+6.0.7
+---------
+
+- Refactor systemd integration to work better with custom binaries [#4511]
+- Don't connect to Redis at process exit if not needed [#4502]
+- Remove Redis connection naming [#4479]
+- Fix Redis Sentinel password redaction [#4499]
+- Add Vietnamese locale (vi) [#4528]
+
+6.0.6
+---------
+
+- **Integrate with systemd's watchdog and notification features** [#4488]
+  Set `Type=notify` in [sidekiq.service](https://github.com/mperham/sidekiq/blob/4b8a8bd3ae42f6e48ae1fdaf95ed7d7af18ed8bb/examples/systemd/sidekiq.service#L30-L39). The integration works automatically.
+- Use `setTimeout` rather than `setInterval` to avoid thundering herd [#4480]
+- Fix edge case where a job can be pushed without a queue.
+- Flush job stats at exit [#4498]
+- Check RAILS_ENV before RACK_ENV [#4493]
+- Add Lithuanian locale [#4476]
+
+6.0.5
+---------
+
+- Fix broken Web UI response when using NewRelic and Rack 2.1.2+. [#4440]
+- Update APIs to use `UNLINK`, not `DEL`. [#4449]
+- Fix Ruby 2.7 warnings [#4412]
+- Add support for `APP_ENV` [[95fa5d9]](https://github.com/mperham/sidekiq/commit/95fa5d90192148026e52ca2902f1b83c70858ce8)
+
+6.0.4
+---------
+
+- Fix ActiveJob's `sidekiq_options` integration [#4404]
+- Sidekiq Pro users will now see a Pause button next to each queue in
+  the Web UI, allowing them to pause queues manually [#4374, shayonj]
+- Fix Sidekiq::Workers API unintentional change in 6.0.2 [#4387]
+
+
+6.0.3
+---------
+
+- Fix `Sidekiq::Client.push_bulk` API which was erroneously putting
+  invalid `at` values in the job payloads [#4321]
+
+6.0.2
+---------
+
+- Fix Sidekiq Enterprise's rolling restart functionality, broken by refactoring in 6.0.0. [#4334]
+- More internal refactoring and performance tuning [fatkodima]
+
+6.0.1
+---------
+
+- **Performance tuning**, Sidekiq should be 10-15% faster now [#4303, 4299,
+  4269, fatkodima]
+- **Dark Mode support in Web UI** (further design polish welcome!) [#4227, mperham,
+  fatkodima, silent-e]
+- **Job-specific log levels**, allowing you to turn on debugging for
+  problematic workers. [fatkodima, #4287]
+```ruby
+MyWorker.set(log_level: :debug).perform_async(...)
+```
+- **Ad-hoc job tags**. You can tag your jobs with, e.g, subdomain, tenant, country,
+  locale, application, version, user/client, "alpha/beta/pro/ent", types of jobs,
+  teams/people responsible for jobs, additional metadata, etc.
+  Tags are shown on different pages with job listings. Sidekiq Pro users
+  can filter based on them [fatkodima, #4280]
+```ruby
+class MyWorker
+  include Sidekiq::Worker
+  sidekiq_options tags: ['bank-ops', 'alpha']
+  ...
+end
+```
+- Fetch scheduled jobs in batches before pushing into specific queues.
+  This will decrease enqueueing time of scheduled jobs by a third. [fatkodima, #4273]
+```
+ScheduledSet with 10,000 jobs
+Before: 56.6 seconds
+After:  39.2 seconds
+```
+- Compress error backtraces before pushing into Redis, if you are
+  storing error backtraces, this will halve the size of your RetrySet
+  in Redis [fatkodima, #4272]
+```
+RetrySet with 100,000 jobs
+Before: 261 MB
+After:  129 MB
+```
+- Support display of ActiveJob 6.0 payloads in the Web UI [#4263]
+- Add `SortedSet#scan` for pattern based scanning. For large sets this API will be **MUCH** faster
+  than standard iteration using each. [fatkodima, #4262]
+```ruby
+  Sidekiq::DeadSet.new.scan("UnreliableApi") do |job|
+    job.retry
+  end
+```
+- Dramatically speed up SortedSet#find\_job(jid) by using Redis's ZSCAN
+  support, approx 10x faster. [fatkodima, #4259]
+```
+zscan   0.179366   0.047727   0.227093 (  1.161376)
+enum    8.522311   0.419826   8.942137 (  9.785079)
+```
+- Respect rails' generators `test_framework` option and gracefully handle extra `worker` suffix on generator [fatkodima, #4256]
+- Add ability to sort 'Enqueued' page on Web UI by position in the queue [fatkodima, #4248]
+- Support `Client.push_bulk` with different delays [fatkodima, #4243]
+```ruby
+Sidekiq::Client.push_bulk("class" => FooJob, "args" => [[1], [2]], "at" => [1.minute.from_now.to_f, 5.minutes.from_now.to_f])
+```
+- Easier way to test enqueuing specific ActionMailer and ActiveRecord delayed jobs. Instead of manually
+  parsing embedded class, you can now test by fetching jobs for specific classes. [fatkodima, #4292]
+```ruby
+assert_equal 1, Sidekiq::Extensions::DelayedMailer.jobs_for(FooMailer).size
+```
+- Add `sidekiqmon` to gemspec executables [#4242]
+- Gracefully handle `Sidekiq.logger = nil` [#4240]
+- Inject Sidekiq::LogContext module if user-supplied logger does not include it [#4239]
+
+6.0
+---------
+
+This release has major breaking changes.  Read and test carefully in production.
+
+- With Rails 6.0.2+, 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
+```
+- Logging has been redesigned to allow for pluggable log formatters:
+```ruby
+Sidekiq.configure_server do |config|
+  config.log_formatter = Sidekiq::Logger::Formatters::JSON.new
+end
+```
+See the [Logging wiki page](https://github.com/mperham/sidekiq/wiki/Logging) for more details.
+- **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.9
+---------
+
+- Release Rack lock due to a cascade of CVEs. [#4566]
+  Pro-tip: don't lock Rack.
+
 5.2.8
 ---------
 

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

@@ -2,7 +2,78 @@
 
 [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)
 
-Please see [http://sidekiq.org/](http://sidekiq.org/) for more details and how to buy.
+Please see [sidekiq.org](https://sidekiq.org) for more details and how to buy.
+
+2.2.1
+-------------
+
+- Support configurable timezones for periodic jobs [#4749]
+- Handle edge case leading to negative expiry in uniqueness [#4763]
+
+2.2.0
+-------------
+
+- Add new **leaky bucket** rate limiter [#4414]
+  This allows clients to burst up to X calls before throttling
+  back to X calls per Y seconds. To limit the user to 60 calls
+  per minute:
+```ruby
+leaker = Sidekiq::Limiter.leaky("shopify", 60, :minute)
+leaker.within_limit do
+  ...
+end
+```
+  See the Rate Limiting wiki page for more detail.
+- Rate limiters may now customize their reschedule count [#4725]
+  To disable rate limit reschedules, use `reschedule: 0`.
+```ruby
+Sidekiq::Limiter.concurrent("somename", 5, reschedule: 0)
+```
+- Allow filtering by name in the Rate Limiter UI [#4695]
+- Add IT locale
+
+2.1.2
+-------------
+
+- The Sidekiq Pro and Enterprise gem servers now `bundle install` much faster with **Bundler 2.2+** [#4158]
+- Now that ActiveJobs support `sidekiq_options`, add support for uniqueness in AJs [#4667]
+
+2.1.1
+-------------
+
+- Add optional **app preload** in swarm, saves even more memory [#4646]
+- Fix incorrect queue tags in historical metrics [#4377]
+
+2.1.0
+-------------
+
+- Move historical metrics to use tags rather than interpolating name [#4377]
+```
+sidekiq.enqueued.#{name} -> sidekiq.queue.size with tag queue:#{name}
+sidekiq.latency.#{name} -> sidekiq.queue.latency with tag queue:#{name}
+```
+- Remove `concurrent-ruby` gem dependency [#4586]
+- Add systemd `Type=notify` support for swarm [#4511]
+- Length swarm's boot timeout to 60 sec [#4544]
+- Add NL locale
+
+2.0.1
+-------------
+
+- Periodic job registration API adjusted to avoid loading classes in initializer [#4271]
+- Remove support for deprecated ENV variables (COUNT, MAXMEM\_MB, INDEX) in swarm code
+
+2.0.0
+-------------
+
+- Except for the [newly required credentials](https://github.com/mperham/sidekiq/issues/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", ">= 6.0.2"
+gem "sqlite3", platforms: :ruby
+gem "activerecord-jdbcsqlite3-adapter", platforms: :jruby
 
 group :test do
-  gem 'minitest'
-  gem 'simplecov'
+  gem "minitest"
+  gem "simplecov"
+  gem "codecov", require: false
 end
 
 group :development, :test do
-  gem 'pry-byebug', platforms: :mri
+  gem "standard"
 end
 
 group :load_test do
-  gem 'hiredis'
-  gem 'toxiproxy'
+  gem "hiredis"
+  gem "toxiproxy"
 end