sidekiq-undertaker 1.6.0 → 1.8.0.rc01

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f75ca3784fd83c8eecbaa7cd9a8159577b0f1fe8dd6b7a0d05a7873d58650778
-  data.tar.gz: 59c031dc4a5d2aceeea04a099fce4935ab7f43989e50f4353c03d0c5a6690c89
+  metadata.gz: c2ccb3fbe284cdf7f6b60c6a54a3d6908a46353c8c38e6c05d3a53eb1e006c87
+  data.tar.gz: 13302f23e5c7120e74db0a82768bf5bfcc0b80b4ebd922c882338bcf7c5d8bdf
 SHA512:
-  metadata.gz: f5a04ed46664c16dcea8107c76b9421bea08516d08a343d82bfeebd2323d97ff4b57ec1f5c1c1c0ad400af09746341db141d2fdcd35533ca5c5d6b2330182efd
-  data.tar.gz: 52f8e24affefceed9019eb88c82318ff391096fa00c17ea2200da4d69297edc0f238b072a2446154678a4e5c4de38eed818f1025aac896ab06cd73a7e7c33ff0
+  metadata.gz: 5433a9ee7ac4ce59929f96d7df81f37e812a793a84b2aec52eaf371b1a8d3dc24f3295be7f13e385aec3ad57797968061a2e5faa60b8a37a6d79b8616ed9b39d
+  data.tar.gz: 4b4d850c9dd183e9edf73094facc0aafcddb8ebef9f5ac8ba7c1d09c7ffdd52b324260e9eb9b9b92a728847a14874d25a96d097009ee6b68b37089b337f2e98c

data/.github/workflows/ruby-build.yml

@@ -30,9 +30,11 @@ jobs:
       matrix:
         # SEE: https://github.com/ruby/setup-ruby#supported-versions
         # https://docs.github.com/en/actions/using-jobs/using-a-matrix-for-your-jobs#expanding-or-adding-matrix-configurations
-        ruby-version: ['ruby', '3.1', '2.7.6', 'jruby', 'jruby-9.3.9.0']
+        ruby-version: ['ruby', '3.3', '3.2']
         experimental: [false]
         include: # HINT: Do not use arrays for values here
+          - ruby-version: 'jruby'
+            experimental: true
           - ruby-version: 'truffleruby'
             experimental: true
           - ruby-version: 'truffleruby+graalvm'
@@ -42,7 +44,7 @@ jobs:
       JRUBY_OPTS: '--debug'
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - 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):
@@ -53,7 +55,7 @@ jobs:
     - name: Run tests
       run: COVERAGE=true bundle exec rspec
     - name: 'Upload Coverage Report'
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       if: ${{ matrix.ruby-version == 'ruby' }}
       with:
         name: coverage-report
@@ -65,13 +67,13 @@ jobs:
     name: coverage
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Download Coverage Report
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: coverage-report
         path: ./coverage
-    - uses: paambaati/codeclimate-action@v3.2.0
+    - uses: paambaati/codeclimate-action@v9.0.0
       env:
         # Set CC_TEST_REPORTER_ID as secret of your repo
         CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}

data/.rubocop.yml

@@ -1,13 +1,14 @@
-require:
+inherit_from: .rubocop_todo.yml
+
+plugins:
   - rubocop-rake
   - rubocop-rspec
-  - rt_rubocop_defaults
 
-inherit_from: .rubocop_todo.yml
+require:
+  - rt_rubocop_defaults
 
 AllCops:
-  TargetRubyVersion: 2.6
-
+  TargetRubyVersion: 3.2
 Layout/LineLength:
   Exclude:
     - 'sidekiq-undertaker.gemspec'

data/.rubocop_codeclimate.yml

@@ -7,7 +7,7 @@ inherit_from:
   - .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.1
 
 Layout/LineLength:
   Exclude:

data/.rubocop_todo.yml

@@ -1,23 +1,35 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-01-26 20:10:48 UTC using RuboCop version 1.8.1.
+# on 2025-03-13 16:14:24 UTC using RuboCop version 1.74.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 2
-# Configuration parameters: IgnoredMethods, CountRepeatedAttributes, Severity.
+# Offense count: 3
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Severity.
 Metrics/AbcSize:
-  Max: 22
+  Max: 19
 
-# Offense count: 2
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods, Severity.
-Metrics/MethodLength:
-  Max: 14
+# Offense count: 21
+# Configuration parameters: Max, AllowedIdentifiers, AllowedPatterns.
+RSpec/IndexedLet:
+  Exclude:
+    - 'spec/sidekiq/undertaker/job_distributor_spec.rb'
+    - 'spec/sidekiq/undertaker/job_filter_spec.rb'
+    - 'spec/sidekiq/undertaker/web_extension_spec.rb'
 
 # Offense count: 5
 # Configuration parameters: .
 # SupportedStyles: have_received, receive
 RSpec/MessageSpies:
   EnforcedStyle: receive
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - '**/*.arb'
+    - 'spec/support/monkey_patch/approvals/writers/text_writer.rb'

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 ## Unreleased
 
+## [1.8.0]
+
+## Changed
+- Remove Dependabot
+- Add Renovate dependency dashboard
+- Update test dependency sinatra to v4
+- Update paambaati/codeclimate-action action to v9
+- Update build config
+- Upgrade Sidekiq to version 8
+- Drop Ruby 3.1 suppport
+
+## [1.7.0] - 2023-12-15
+
+### Changed
+- Dropped Ruby 2.x support
+- Dropped Sidekiq 6.x support
+- Updated rspec-sidekiq to 4.1
+- Updated sinatra to 3.1
+- Updated actions/checkout, actions/upload-artifact and actions/download-artifact to v4
+- Updated paambaati/codeclimate-action to v5
+
 ## [1.6.0] - 2022-11-02
 
 ### Changed

data/Gemfile

@@ -2,10 +2,27 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in sidekiq-undertaker.gemspec
-gemspec
+gem "approvals", "~> 0.1.0"
+gem "mock_redis", "~> 0.19"
+gem "pry", "~> 0.12"
+gem "rack-test", "~> 2.0"
+gem "rake", "~> 13.0"
+gem "rb-readline", "~> 0.5"
+gem "rspec", "~> 3.12"
+gem "rspec-sidekiq", "~> 5.0"
+gem "rt_rubocop_defaults", "~> 2.6"
+gem "rubocop", "~> 1.59"
+gem "rubocop-rake", "~> 0.6"
+gem "rubocop-rspec", "~> 3.0"
+gem "rubocop_runner", "~> 2.2"
+gem "simplecov", "~> 0.21"
+gem "sinatra", "~> 4.0"
+gem "timecop", "~> 0.9"
 
 # Good for debuging on travis-ci.org
 # group :development, :test do
 #   gem "approvals", git: "https://github.com/br/approvals", branch: "diff-preview"
 # end
+
+# Specify your gem's dependencies in sidekiq-undertaker.gemspec
+gemspec

data/lib/sidekiq/undertaker/dead_job.rb

@@ -17,7 +17,7 @@ module Sidekiq
           job_time_elapsed_since_failure = Time.now.to_i - job_failed_at.to_i
           job_bucket_name                = Bucket.for_elapsed_time(job_time_elapsed_since_failure)
 
-          new(job:                        job,
+          new(job:,
               time_elapsed_since_failure: job_time_elapsed_since_failure,
               bucket_name:                job_bucket_name)
         end

data/lib/sidekiq/undertaker/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Undertaker
-    VERSION = "1.6.0"
+    VERSION = "1.8.0.rc01"
   end
 end

data/lib/sidekiq/undertaker/web_extension/api_helpers.rb

@@ -16,7 +16,7 @@ module Sidekiq
         def show_filter
           store_request_params
 
-          @dead_jobs    = Sidekiq::Undertaker::JobFilter.filter_dead_jobs(parsed_params)
+          @dead_jobs    = Sidekiq::Undertaker::JobFilter.filter_dead_jobs(filter_params)
           @distribution = Sidekiq::Undertaker::JobDistributor.new(@dead_jobs).group_by_job_class
           @total_dead   = @dead_jobs.size
 
@@ -26,7 +26,7 @@ module Sidekiq
         def show_filter_by_job_class_bucket_name
           store_request_params
 
-          @dead_jobs    = Sidekiq::Undertaker::JobFilter.filter_dead_jobs(parsed_params)
+          @dead_jobs    = Sidekiq::Undertaker::JobFilter.filter_dead_jobs(filter_params)
           @distribution = Sidekiq::Undertaker::JobDistributor.new(@dead_jobs).group_by_error_class
           @total_dead   = @dead_jobs.size
 
@@ -36,7 +36,7 @@ module Sidekiq
         def show_filter_by_job_class_error_class_bucket_name
           store_request_params
 
-          @dead_jobs    = Sidekiq::Undertaker::JobFilter.filter_dead_jobs(parsed_params)
+          @dead_jobs    = Sidekiq::Undertaker::JobFilter.filter_dead_jobs(filter_params)
           @distribution = Sidekiq::Undertaker::JobDistributor.new(@dead_jobs).group_by_error_msg
           @total_dead   = @dead_jobs.size
 
@@ -46,7 +46,7 @@ module Sidekiq
         def show_undertaker_by_job_class_error_class_error_msg_bucket_name
           store_request_params
 
-          @dead_jobs = Sidekiq::Undertaker::JobFilter.filter_dead_jobs(parsed_params)
+          @dead_jobs = Sidekiq::Undertaker::JobFilter.filter_dead_jobs(filter_params)
 
           # Display dead jobs as list
           @dead_jobs = @dead_jobs.map(&:job)
@@ -55,7 +55,7 @@ module Sidekiq
 
           # Pagination
           @total_dead   = @dead_jobs.size
-          @current_page = (parsed_params[:page] || 1).to_i
+          @current_page = (url_params("page") || 1).to_i
           @count        = 50 # per page
           @dead_jobs    = @dead_jobs[((@current_page - 1) * @count), @count]
 
@@ -65,18 +65,19 @@ module Sidekiq
 
           # Remove unrelated arguments to allow _paginate url to be clean
           # Hack to continue to reuse sidekiq's _pagination template
-          params.delete("job_class")
-          params.delete("bucket_name")
-          params.delete("error_class")
-          params.delete("error_msg")
+          # FIXME: https://github.com/sidekiq/sidekiq/blob/main/lib/sidekiq/web/action.rb#L64-L67
+          # params.delete("job_class")
+          # params.delete("bucket_name")
+          # params.delete("error_class")
+          # params.delete("error_msg")
 
           render_result("morgue.erb")
         end
 
         def post_undertaker
-          raise ::ArgumentError.new("Key missing") unless parsed_params["key"]
+          raise ::ArgumentError.new("Key missing") unless url_params("key")
 
-          jobs = parsed_params["key"].map { |k| Sidekiq::DeadSet.new.fetch(*parse_params(k)).first }.compact
+          jobs = url_params("key").map { |k| Sidekiq::DeadSet.new.fetch(*parse_key(k)).first }.compact
 
           handle_selected_jobs jobs
         rescue ::ArgumentError
@@ -84,11 +85,11 @@ module Sidekiq
         end
 
         def handle_selected_jobs(jobs)
-          return send_data(*prepare_data(jobs.map(&:item), EXPORT_CHUNK_SIZE)) if parsed_params["export"]
+          return send_data(*prepare_data(jobs.map(&:item), EXPORT_CHUNK_SIZE)) if url_params("export")
 
-          if parsed_params["retry"]
+          if url_params("retry")
             jobs.each(&:retry)
-          elsif parsed_params["delete"]
+          elsif url_params("delete")
             jobs.each(&:delete)
           end
 
@@ -97,7 +98,7 @@ module Sidekiq
 
         def post_undertaker_job_class_error_class_error_msg_bucket_name_delete
           store_request_params
-          @dead_jobs = Sidekiq::Undertaker::JobFilter.filter_dead_jobs(parsed_params)
+          @dead_jobs = Sidekiq::Undertaker::JobFilter.filter_dead_jobs(filter_params)
           @dead_jobs.each do |dead_job|
             dead_job.job.delete
           end
@@ -108,7 +109,7 @@ module Sidekiq
         def post_undertaker_job_class_error_class_error_msg_bucket_name_retry
           store_request_params
 
-          @dead_jobs = Sidekiq::Undertaker::JobFilter.filter_dead_jobs(parsed_params)
+          @dead_jobs = Sidekiq::Undertaker::JobFilter.filter_dead_jobs(filter_params)
           @dead_jobs.each do |dead_job|
             dead_job.job.retry
           end
@@ -118,16 +119,15 @@ module Sidekiq
 
         def post_undertaker_job_class_error_class_error_msg_bucket_name_export
           store_request_params
-
-          @dead_jobs = Sidekiq::Undertaker::JobFilter.filter_dead_jobs(parsed_params)
+          @dead_jobs = Sidekiq::Undertaker::JobFilter.filter_dead_jobs(filter_params)
           send_data(*prepare_data(@dead_jobs.map { |j| j.job.item }, EXPORT_CHUNK_SIZE))
         end
 
         def post_import_jobs
-          file = parsed_params["upload_file"]
+          file = url_params("upload_file")
           raise ::ArgumentError.new("The file is not a json") if file.nil? || file[:type] != "application/json"
 
-          data = parsed_params["upload_file"][:tempfile].read
+          data = url_params("upload_file")[:tempfile].read
           dead_set = Sidekiq::DeadSet.new
 
           JSON.parse(data).each do |job|
@@ -143,18 +143,29 @@ module Sidekiq
         end
 
         def store_request_params
-          @req_job_class   = parsed_params["job_class"]
-          @req_bucket_name = parsed_params["bucket_name"]
-          @req_error_class = parsed_params["error_class"]
-          @req_error_msg   = parsed_params["error_msg"]
-        end
-
-        def parsed_params
-          @parsed_params ||= if params["error_msg"] && params["error_msg"] != "all"
-                               params.merge("error_msg" => Base64.urlsafe_decode64(params["error_msg"]))
-                             else
-                               params
-                             end
+          @req_bucket_name = parsed_route_params(:bucket_name)
+          @req_error_class = parsed_route_params(:error_class)
+          @req_error_msg   = parsed_route_params(:error_msg)
+          @req_job_class   = parsed_route_params(:job_class)
+        end
+
+        def filter_params
+          {
+            "bucket_name" => parsed_route_params(:bucket_name),
+            "error_class" => parsed_route_params(:error_class),
+            "error_msg"   => parsed_route_params(:error_msg),
+            "job_class"   => parsed_route_params(:job_class)
+          }
+        end
+
+        def parsed_route_params(key)
+          if key == :error_msg
+            msg = route_params(key)
+            msg = Base64.urlsafe_decode64(msg) if !msg.nil? && msg != "all"
+            msg
+          else
+            route_params(key)
+          end
         end
 
         def view_path
@@ -172,7 +183,7 @@ module Sidekiq
 
           filename = "#{@req_job_class}_#{filename}"
           zip = Zip::OutputStream.write_buffer do |file|
-            data.each_slice(chunk_size).each_with_index do |chunk, index|
+            data.each_slice(chunk_size).with_index do |chunk, index|
               file.put_next_entry("#{filename}_part-#{index + 1}.json")
               file.write chunk.to_json
             end

data/lib/sidekiq/undertaker.rb

@@ -10,9 +10,11 @@ rescue LoadError
 end
 
 if defined?(Sidekiq::Web)
-  Sidekiq::Web.register Sidekiq::Undertaker::WebExtension
-  Sidekiq::Web.tabs["Undertaker"] = "undertaker/filter"
-  Sidekiq::Web.settings.locales << File.join(File.dirname(__FILE__), "../../web/locales")
+  Sidekiq::Web.configure do |config|
+    config.register(Sidekiq::Undertaker::WebExtension, name: "Undertaker", tab: "Undertaker",
+index: "undertaker/filter")
+    config.locales << File.join(File.dirname(__FILE__), "../../web/locales")
+  end
 end
 
 module Sidekiq

data/renovate.json

@@ -1,5 +1,6 @@
 {
   "extends": [
-    "config:base"
-  ]
+    "config:recommended"
+  ],
+  "dependencyDashboard": true
 }

data/sidekiq-undertaker.gemspec

@@ -27,33 +27,12 @@ Gem::Specification.new do |spec|
     "rubygems_mfa_required" => "true"
   }
 
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 3.2.0"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib", "lib/sidekiq/undertaker"]
 
-  spec.add_development_dependency "bundler", ">= 1.17", "<3"
-  spec.add_development_dependency "rake", "~> 13.0"
-
-  spec.add_development_dependency "approvals", "~> 0.0.25"
-  spec.add_development_dependency "mock_redis", "~> 0.19"
-  spec.add_development_dependency "pry", "~> 0.12"
-  spec.add_development_dependency "rack-test", "~> 2.0"
-  spec.add_development_dependency "rb-readline", "~> 0.5"
-  spec.add_development_dependency "rspec", "~> 3.8"
-  spec.add_development_dependency "rspec-core", "~> 3.8"
-  spec.add_development_dependency "rspec-mocks", "~> 3.8"
-  spec.add_development_dependency "rspec-sidekiq", "~> 3.0"
-  spec.add_development_dependency "rt_rubocop_defaults", "~> 2.4"
-  spec.add_development_dependency "rubocop", "~> 1.37"
-  spec.add_development_dependency "rubocop-rake", "~> 0.6"
-  spec.add_development_dependency "rubocop-rspec", "~> 2.14"
-  spec.add_development_dependency "rubocop_runner", "~> 2.2"
-  spec.add_development_dependency "simplecov", "~> 0.21"
-  spec.add_development_dependency "sinatra", "~> 2.0"
-  spec.add_development_dependency "timecop", "~> 0.9"
-
-  spec.add_runtime_dependency "rubyzip", "~> 2.3"
-  spec.add_runtime_dependency "sidekiq", ">= 6.4", "< 8"
+  spec.add_dependency "rubyzip", "~> 2.3"
+  spec.add_dependency "sidekiq", "~> 8"
 end