sidekiq-undertaker 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0359e510258ac3be48937b1bccc12a4585c99fb3c75aa3e3add9239ac0ec4cff'
-  data.tar.gz: 1ba883ee46aa19e5887b3d6bd17bd2efcbb0c73c7f7b3abead70f36ea7e18957
+  metadata.gz: 0ac5227e064151d05774f0446bf8aa4cf02e488c9689c1a8bb3c71ed93b9f0fc
+  data.tar.gz: 42c47061b8a366b275f486f4dc7866ef066bc3ecbe8cbf3cb20c9a17d2299f7f
 SHA512:
-  metadata.gz: 37d24a25149c44d1884b840face88728f89187cafae0cbe2c734dd3f39d3412ad6bf3a3faec596daac144b58efc5bec348cb24eab1bc3a5c531ce31d3342fc39
-  data.tar.gz: 2da7fee92e23648bf9f1a051f40adf358c605ec108e58666a81ee654164fd5792573417f1a8157ca061e79816d62e6b582d5f1182efdc8816d757a741702b1a5
+  metadata.gz: 7b462971e556909f8ace910d541c993a0a5ced6f081262da4497a57799bfe89b7247826a4b2a42931d4974dc9ad952a1647e191390aa9a315ed275f9583cdec9
+  data.tar.gz: 3032d2ee35ff319103150e3c3600c9c2905db3f9d60d1038e408a6a7a63ca1febf3b9f9e3554596903ab78fce8c3a86fc007c4335a0ddbe274c8c3f77f23f9b2

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', '3.2', 'jruby', 'jruby-9.4.4.0']
+        ruby-version: ['head', '3.4', '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'
@@ -71,7 +73,7 @@ jobs:
       with:
         name: coverage-report
         path: ./coverage
-    - uses: paambaati/codeclimate-action@v5.0.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 @@
 inherit_from: .rubocop_todo.yml
 
-require:
+plugins:
   - rubocop-rake
   - rubocop-rspec
 
+require:
   - rt_rubocop_defaults
 
 AllCops:
-  TargetRubyVersion: 3.1
+  TargetRubyVersion: 3.2
 Layout/LineLength:
   Exclude:
     - 'sidekiq-undertaker.gemspec'

data/.rubocop_todo.yml

@@ -1,20 +1,15 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-12-16 11:38:55 UTC using RuboCop version 1.59.0.
+# 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: 4
+# Offense count: 3
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Severity.
 Metrics/AbcSize:
-  Max: 22
-
-# Offense count: 1
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, Severity.
-Metrics/MethodLength:
-  Max: 14
+  Max: 19
 
 # Offense count: 21
 # Configuration parameters: Max, AllowedIdentifiers, AllowedPatterns.
@@ -29,3 +24,12 @@ RSpec/IndexedLet:
 # 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,9 +2,20 @@
 
 ## Unreleased
 
-## [1.7.0] - 2023-12-15
+## [1.8.0] - 2025-03-17
 
 ## 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

data/Gemfile

@@ -2,21 +2,21 @@
 
 source "https://rubygems.org"
 
-gem "approvals", "~> 0.0.25"
+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", "~> 4.1"
+gem "rspec-sidekiq", "~> 5.0"
 gem "rt_rubocop_defaults", "~> 2.6"
 gem "rubocop", "~> 1.59"
 gem "rubocop-rake", "~> 0.6"
-gem "rubocop-rspec", "~> 2.25"
+gem "rubocop-rspec", "~> 3.0"
 gem "rubocop_runner", "~> 2.2"
 gem "simplecov", "~> 0.21"
-gem "sinatra", "~> 3.1"
+gem "sinatra", "~> 4.0"
 gem "timecop", "~> 0.9"
 
 # Good for debuging on travis-ci.org

data/README.md

@@ -84,6 +84,7 @@ The [Sidekiq-Cleaner](https://github.com/HackingHabits/sidekiq-cleaner) gem was
 [Zlatko Rednjak](https://github.com/Rednjak) added the initial version of the `CHANGELOG.md`.
 [Lucas Dell'Isola](https://github.com/ldellisola) added the export/import feature for dead jobs.
 [thoesl](https://github.com/thoesl) added the error message based filter.
+[Simon Himmelreich](https://github.com/shimel1) prepared the upgrade to Sidekiq 8.
 
 For the complete list of network members have a look at the [fork overview](https://github.com/ThomasKoppensteiner/sidekiq-undertaker/network/members).
 

data/lib/sidekiq/undertaker/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Undertaker
-    VERSION = "1.7.0"
+    VERSION = "1.8.0"
   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

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,12 +27,12 @@ Gem::Specification.new do |spec|
     "rubygems_mfa_required" => "true"
   }
 
-  spec.required_ruby_version = ">= 3.1.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_runtime_dependency "rubyzip", "~> 2.3"
-  spec.add_runtime_dependency "sidekiq", "~> 7"
+  spec.add_dependency "rubyzip", "~> 2.3"
+  spec.add_dependency "sidekiq", "~> 8"
 end