sidekiq 6.0.7 → 6.5.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 6.0.7
+  version: 6.5.0
 platform: ruby
 authors:
 - Mike Perham
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 2022-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rack-protection
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
 description: Simple, efficient background processing for Ruby.
 email:
 - mperham@gmail.com
@@ -75,74 +61,61 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".github/contributing.md"
-- ".github/issue_template.md"
-- ".gitignore"
-- ".standard.yml"
-- 3.0-Upgrade.md
-- 4.0-Upgrade.md
-- 5.0-Upgrade.md
-- 6.0-Upgrade.md
-- COMM-LICENSE
 - Changes.md
-- Ent-2.0-Upgrade.md
-- Ent-Changes.md
-- Gemfile
-- Gemfile.lock
 - LICENSE
-- Pro-2.0-Upgrade.md
-- Pro-3.0-Upgrade.md
-- Pro-4.0-Upgrade.md
-- Pro-5.0-Upgrade.md
-- Pro-Changes.md
 - README.md
-- Rakefile
 - bin/sidekiq
 - bin/sidekiqload
 - bin/sidekiqmon
-- code_of_conduct.md
-- lib/generators/sidekiq/templates/worker.rb.erb
-- lib/generators/sidekiq/templates/worker_spec.rb.erb
-- lib/generators/sidekiq/templates/worker_test.rb.erb
-- lib/generators/sidekiq/worker_generator.rb
+- lib/generators/sidekiq/job_generator.rb
+- lib/generators/sidekiq/templates/job.rb.erb
+- lib/generators/sidekiq/templates/job_spec.rb.erb
+- lib/generators/sidekiq/templates/job_test.rb.erb
 - lib/sidekiq.rb
 - lib/sidekiq/api.rb
 - lib/sidekiq/cli.rb
 - lib/sidekiq/client.rb
+- lib/sidekiq/component.rb
 - lib/sidekiq/delay.rb
-- lib/sidekiq/exception_handler.rb
 - lib/sidekiq/extensions/action_mailer.rb
 - lib/sidekiq/extensions/active_record.rb
 - lib/sidekiq/extensions/class_methods.rb
 - lib/sidekiq/extensions/generic_proxy.rb
 - lib/sidekiq/fetch.rb
+- lib/sidekiq/job.rb
 - lib/sidekiq/job_logger.rb
 - lib/sidekiq/job_retry.rb
+- lib/sidekiq/job_util.rb
 - lib/sidekiq/launcher.rb
 - lib/sidekiq/logger.rb
 - lib/sidekiq/manager.rb
 - lib/sidekiq/middleware/chain.rb
+- lib/sidekiq/middleware/current_attributes.rb
 - lib/sidekiq/middleware/i18n.rb
+- lib/sidekiq/middleware/modules.rb
 - lib/sidekiq/monitor.rb
 - lib/sidekiq/paginator.rb
 - lib/sidekiq/processor.rb
 - lib/sidekiq/rails.rb
+- lib/sidekiq/redis_client_adapter.rb
 - lib/sidekiq/redis_connection.rb
+- lib/sidekiq/ring_buffer.rb
 - lib/sidekiq/scheduled.rb
 - lib/sidekiq/sd_notify.rb
 - lib/sidekiq/systemd.rb
 - lib/sidekiq/testing.rb
 - lib/sidekiq/testing/inline.rb
-- lib/sidekiq/util.rb
+- lib/sidekiq/transaction_aware_client.rb
 - lib/sidekiq/version.rb
 - lib/sidekiq/web.rb
 - lib/sidekiq/web/action.rb
 - lib/sidekiq/web/application.rb
+- lib/sidekiq/web/csrf_protection.rb
 - lib/sidekiq/web/helpers.rb
 - lib/sidekiq/web/router.rb
 - lib/sidekiq/worker.rb
 - sidekiq.gemspec
+- web/assets/images/apple-touch-icon.png
 - web/assets/images/favicon.ico
 - web/assets/images/logo.png
 - web/assets/images/status.png
@@ -199,11 +172,16 @@ files:
 - web/views/retry.erb
 - web/views/scheduled.erb
 - web/views/scheduled_job_info.erb
-homepage: http://sidekiq.org
+homepage: https://sidekiq.org
 licenses:
 - LGPL-3.0
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://sidekiq.org
+  bug_tracker_uri: https://github.com/mperham/sidekiq/issues
+  documentation_uri: https://github.com/mperham/sidekiq/wiki
+  changelog_uri: https://github.com/mperham/sidekiq/blob/main/Changes.md
+  source_code_uri: https://github.com/mperham/sidekiq
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -218,8 +196,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Simple, efficient background processing for Ruby
 test_files: []

data/.circleci/config.yml

@@ -1,60 +0,0 @@
-version: 2
-references:
-  unit: &unit
-    run:
-      name: Run test suite
-      command: bundle exec rake
-  restore: &restore
-    restore_cache:
-      keys:
-        - v1-dependencies-{{ checksum "Gemfile.lock" }}
-        # fallback to using the latest cache if no exact match is found
-        - v1-dependencies-
-  bundle: &bundle
-    run:
-      name: install dependencies
-      command: |
-        bundle install --jobs=4 --retry=3 --path vendor/bundle
-  save: &save
-    save_cache:
-      paths:
-        - ./vendor/bundle
-      key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-jobs:
-  "ruby-2.5":
-    docker:
-      - image: circleci/ruby:2.5
-      - image: circleci/redis:4.0
-    steps:
-      - checkout
-      - <<: *restore
-      - <<: *bundle
-      - <<: *save
-      - <<: *unit
-  "ruby-2.6":
-    docker:
-      - image: circleci/ruby:2.6
-      - image: circleci/redis:4.0
-    steps:
-      - checkout
-      - <<: *restore
-      - <<: *bundle
-      - <<: *save
-      - <<: *unit
-  "jruby":
-    docker:
-      - image: circleci/jruby:latest
-      - image: circleci/redis:4.0
-    steps:
-      - checkout
-      - <<: *restore
-      - <<: *bundle
-      - <<: *save
-      - <<: *unit
-
-workflows:
-  version: 2
-  build:
-    jobs:
-      - "ruby-2.5"
-      - "ruby-2.6"

data/.github/contributing.md

@@ -1,32 +0,0 @@
-# Contributing
-
-## Issues
-
-When opening an issue:
-
-* include the full **backtrace** with your error
-* include your Sidekiq initializer
-* list versions you are using: Ruby, Rails, Sidekiq, OS, etc.
-
-It's always better to include more info rather than less.
-
-## Code
-
-It's always best to open an issue before investing a lot of time into a
-fix or new functionality.  Functionality must meet my design goals and
-vision for the project to be accepted; I would be happy to discuss how
-your idea can best fit into Sidekiq.
-
-## Legal
-
-By submitting a Pull Request, you disavow any rights or claims to any changes
-submitted to the Sidekiq project and assign the copyright of
-those changes to Contributed Systems LLC.
-
-If you cannot or do not want to reassign those rights (your employment
-contract for your employer may not allow this), you should not submit a PR.
-Open an issue and someone else can do the work.
-
-This is a legal way of saying "If you submit a PR to us, that code becomes ours".
-99.9% of the time that's what you intend anyways; we hope it doesn't scare you
-away from contributing.

data/.github/issue_template.md

@@ -1,11 +0,0 @@
-Ruby version:
-Sidekiq / Pro / Enterprise version(s):
-
-Please include your initializer and any error message with the full backtrace.
-
-Are you 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/.gitignore

@@ -1,13 +0,0 @@
-.rvmrc
-.ruby-version
-tags
-*.swp
-dump.rdb
-.rbx
-coverage/
-vendor/
-.bundle/
-.sass-cache/
-tmp/
-pkg/*.gem
-.byebug_history

data/.standard.yml

@@ -1,20 +0,0 @@
-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/3.0-Upgrade.md

@@ -1,70 +0,0 @@
-# Upgrading to Sidekiq 3.0
-
-Sidekiq 3.0 brings several new features but also removes old APIs and
-changes a few data elements in Redis.  To upgrade cleanly:
-
-* Upgrade to the latest Sidekiq 2.x and run it for a few weeks.
-  `gem 'sidekiq', '< 3'`
-  This is only needed if you have retries pending.
-* 3rd party gems which use **client-side middleware** will need to update
-  due to an API change.  The Redis connection for a particular job is
-  passed thru the middleware to handle sharding where jobs can
-  be pushed to different redis server instances.
-
-  `def call(worker_class, msg, queue, redis_pool)`
-
-  Client-side middleware should use `redis_pool.with { |conn| ... }` to
-  perform Redis operations and **not** `Sidekiq.redis`.
-* If you used the capistrano integration, you'll need to pull in the
-  new [capistrano-sidekiq](https://github.com/seuros/capistrano-sidekiq)
-  gem and use it in your deploy.rb.
-* API changes:
-  - `Sidekiq::Client.registered_workers` replaced by `Sidekiq::Workers.new`
-  - `Sidekiq::Client.registered_queues` replaced by `Sidekiq::Queue.all`
-  - `Sidekiq::Worker#retries_exhausted` replaced by `Sidekiq::Worker.sidekiq_retries_exhausted`
-  - `Sidekiq::Workers#each` has changed significantly with a reworking
-    of Sidekiq's internal process/thread data model.
-* `sidekiq/api` is no longer automatically required.  If your code uses
-  the API, you will need to require it.
-* Redis-to-Go is no longer transparently activated on Heroku so as to not play
-  favorites with any particular Redis service. You need to set a config option
-  for your app:
-  `heroku config:set REDIS_PROVIDER=REDISTOGO_URL`.  You may also use 
-  the generic `REDIS_URL`.  See
-  [Advanced Options: Setting the Location of your Redis server][1]
-  for details.
-* Anyone using Airbrake, Honeybadger, Exceptional or ExceptionNotifier
-  will need to update their error gem version to the latest to pull in
-  Sidekiq support.  Sidekiq will not provide explicit support for these
-  services so as to not play favorites with any particular error service.
-* MRI 1.9 is no longer officially supported.  Sidekiq's official
-  support policy is to support the current and previous major releases
-  of MRI and Rails.  As of February 2014, that's MRI 2.1, MRI 2.0, JRuby 1.7, Rails 4.0
-  and Rails 3.2.  I will consider PRs to fix issues found by users for
-  other platforms/versions.
-
-## Error Service Providers
-
-If you previously provided a middleware to capture job errors, you
-should instead provide a global error handler with Sidekiq 3.0.  This
-ensures **any** error within Sidekiq will be logged appropriately, not
-just during job execution.
-
-```ruby
-if Sidekiq::VERSION < '3'
-  # old behavior
-  Sidekiq.configure_server do |config|
-    config.server_middleware do |chain|
-      chain.add MyErrorService::Middleware
-    end
-  end
-else
-  Sidekiq.configure_server do |config|
-    config.error_handlers << proc {|ex,context| MyErrorService.notify(ex, context) }
-  end
-end
-```
-
-Your error handler must respond to `call(exception, context_hash)`.
-
-[1]: https://github.com/mperham/sidekiq/wiki/Advanced-Options#via-env-variable

data/4.0-Upgrade.md

@@ -1,53 +0,0 @@
-# Welcome to Sidekiq 4.0!
-
-Sidekiq 4.0 contains a redesigned, more efficient core with less overhead per job.
-See my blog for [an overview of Sidekiq 4's higher performance](http://www.mikeperham.com/2015/10/14/optimizing-sidekiq/).
-
-## What's New
-
-* Sidekiq no longer uses Celluloid.  If your application code uses Celluloid,
-  you will need to pull it in yourself.
-
-* `redis-namespace` has been removed from Sidekiq's gem dependencies. If
-  you want to use namespacing ([and I strongly urge you not to](http://www.mikeperham.com/2015/09/24/storing-data-with-redis/)), you'll need to add the gem to your Gemfile:
-```ruby
-gem 'redis-namespace'
-```
-
-* **Redis 2.8.0 or greater is required.**  Redis 2.8 was released two years
-  ago and contains **many** useful features which Sidekiq couldn't
-  leverage until now.  **Redis 3.0.3 or greater is recommended** for large
-  scale use [#2431](https://github.com/mperham/sidekiq/issues/2431).
-
-* Jobs are now fetched from Redis in parallel, making Sidekiq more
-  resilient to high network latency.  This means that Sidekiq requires
-  more Redis connections per process.  You must have a minimum of
-  `concurrency + 2` connections in your pool or Sidekiq will exit.
-  When in doubt, let Sidekiq size the connection pool for you.
-
-* Worker data is no longer updated in real-time but rather upon every
-  heartbeat.  Don't expect the `Sidekiq::Workers` API to be millisecond-precise.
-
-* There's a new testing API based off the `Sidekiq::Queues` namespace. All
-  assertions made against the Worker class still work as expected.
-```ruby
-assert_equal 0, Sidekiq::Queues["default"].size
-HardWorker.perform_async("log")
-assert_equal 1, Sidekiq::Queues["default"].size
-assert_equal "log", Sidekiq::Queues["default"].first['args'][0]
-Sidekiq::Queues.clear_all
-```
-
-## Upgrade
-
-First, make sure you are using Redis 2.8 or greater. Next:
-
-* Upgrade to the latest Sidekiq 3.x.
-```ruby
-gem 'sidekiq', '< 4'
-```
-* Fix any deprecation warnings you see.
-* Upgrade to 4.x.
-```ruby
-gem 'sidekiq', '< 5'
-```

data/5.0-Upgrade.md

@@ -1,56 +0,0 @@
-# Welcome to Sidekiq 5.0!
-
-Sidekiq 5.0 contains a reworked job dispatch and execution core to integrate
-better with the new Rails 5.0 Executor.  It also drops support for older
-versions of Ruby and Rails and adds support for RTL languages in the Web UI.
-
-## What's New
-
-* Integrate job logging and retry logic directly in with the job
-  execution logic in Sidekiq::Processor.  Previously this logic was
-  defined as middleware.  In Rails 5.0, ActiveSupport::Executor handles ActiveRecord
-  connection management, job callbacks, development mode class loading,
-  etc.  Because of its extensive responsibilities, the Executor can't be
-  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
-  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
-  timeouts or other problems.  As noted in the Best Practices wiki page,
-  Sidekiq is designed for jobs with small, simple arguments.
-
-  Add this line to your initializer to re-enable them and get the old behavior:
-  ```ruby
-  Sidekiq::Extensions.enable_delay!
-  ```
-  The old `Sidekiq.remove_delay!` API has been removed as it is now the default. [#3299]
-* Sidekiq's quiet signal is now `TSTP` (think of it as **T**hread
-  **ST**o**P**) instead of USR1 as USR1 is not available on JRuby.
-  USR1 will continue to be supported in Sidekiq 5.x for backwards
-  compatibility and will be removed in Sidekiq 6.x. [#3302]
-* The Web UI is now bi-directional - it can render either LTR
-  (left-to-right) or RTL languages. With this change, **Farsi, Arabic,
-  Hebrew and Urdu** are officially supported. [#3381]
-* Jobs which can't be parsed due to invalid JSON are now pushed
-  immediately to the Dead set since they require manual intervention and
-  will never execute successfully as is.  The Web UI has been updated to
-  more gracefully display these jobs. [#3296]
-* **Rails 3.2** is no longer supported.
-* **Ruby 2.0 and Ruby 2.1** are no longer supported. Ruby 2.2.2+ is required.
-
-## Upgrade
-
-As always, please upgrade Sidekiq **one major version at a time**.
-If you are already running Sidekiq 4.x, then:
-
-* Upgrade to the latest Sidekiq 4.x.
-```ruby
-gem 'sidekiq', '< 5'
-```
-* Fix any deprecation warnings you see.
-* Upgrade to 5.x.
-```ruby
-gem 'sidekiq', '< 6'
-```

data/6.0-Upgrade.md

@@ -1,72 +0,0 @@
-# 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'
-```