sidekiq-undertaker 1.7.0 → 1.8.0

data/spec/sidekiq/undertaker/web_extension_spec.rb

@@ -2,12 +2,6 @@
 
 require "spec_helper"
 
-require "sidekiq/api"
-require "sidekiq/web"
-require "sinatra"
-require "rack/test"
-require "stringio"
-
 module Sidekiq
   # rubocop:disable Metrics/ModuleLength
   module Undertaker
@@ -15,12 +9,17 @@ module Sidekiq
       include Rack::Test::Methods
 
       let(:app) do
-        Sidekiq::Web.new.tap do |app|
-          # In order to use the Web UI of Sidekiq `6.2` a session is required
-          # SEE: https://github.com/mperham/sidekiq/blob/master/Changes.md#620
-          app.use Rack::Session::Cookie, secret: "A-Test-Web-Session-Secret"
+        # In order to use the Web UI of Sidekiq a session is required
+        # SEE: https://github.com/mperham/sidekiq/blob/master/Changes.md#620
+        secret = "A-Test-Web-Session-Secret--A-Test-Web-Session-Secret--A-Test-Web-Session-Secret"
+        Sidekiq::Web.configure do |c|
+          c.middlewares.clear
+          c.use Rack::Session::Cookie, secrets: secret
         end
+
+        Sidekiq::Web.new
       end
+
       let(:job_refs) { [] }
 
       let(:jid1) { "4416aa76eb8cf03f56a49220" }
@@ -51,7 +50,7 @@ module Sidekiq
         job_refs.push add_dead("jid" => jid3, "error_class" => "NoMethodError")
         job_refs.push add_dead("jid" => jid4, "class" => "HardWorker1", "error_class" => "NoMethodError")
 
-        allow_any_instance_of(Sidekiq::WebAction).to receive(:root_path).and_return("/sidekiq/")
+        allow_any_instance_of(Sidekiq::Web::Action).to receive(:root_path).and_return("/sidekiq/")
 
         allow_any_instance_of(::Sidekiq::Web::CsrfProtection).to receive(:valid_token?).and_return(true)
       end
@@ -221,7 +220,7 @@ module Sidekiq
           it "redirects back to referer after delete" do
             subject
             expect(last_response.status).to eq 302
-            expect(last_response.header["Location"]).to include "/undertaker/morgue/all/all/total_dead"
+            expect(last_response.headers["Location"]).to include "/undertaker/morgue/all/all/total_dead"
           end
         end
 
@@ -445,7 +444,7 @@ module Sidekiq
                "key[]=#{job_refs[0]}&retry=Retry+Now",
                "HTTP_REFERER" => "/undertaker/morgue/all/all/all/total_dead")
           expect(last_response.status).to eq 302
-          expect(last_response.header["Location"]).to include("/undertaker/morgue/all/all/all/total_dead")
+          expect(last_response.headers["Location"]).to include("/undertaker/morgue/all/all/all/total_dead")
         end
       end
     end

data/spec/spec_helper.rb

@@ -11,9 +11,12 @@ ENV["RACK_ENV"] ||= ENV["ENVIRONMENT"] ||= "test"
 
 require "bundler/setup"
 Bundler.setup
+
 require "approvals/rspec"
 require "mock_redis"
 require "pry"
+require "rack/session"
+require "rack/test"
 require "sidekiq"
 require "timecop"
 
@@ -36,6 +39,12 @@ end
 
 require "sidekiq/undertaker"
 
+[
+  "spec/support/**/*.rb"
+].each do |pattern|
+  Dir[File.join(pattern)].each { |file| require file.gsub("spec/", "") }
+end
+
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
@@ -77,3 +86,7 @@ def push_job(params)
   queue_name = params["queue"] || "default"
   Sidekiq::Queue.new(queue_name).find_job(jid)
 end
+
+Approvals.configure do |c|
+  c.approvals_path = "spec/fixtures/approvals/"
+end

data/spec/support/monkey_patch/approvals/writers/text_writer.rb

@@ -0,0 +1,20 @@
+require "approvals/writer"
+
+module Approvals
+  module Writers
+    class TextWriter
+      # HINT: Monkey patch TextWriter to replace nonce value
+      alias orig_format format
+      def format(data)
+        formated_data = orig_format(data)
+        replace_nonce(formated_data)
+      end
+
+      private
+
+      def replace_nonce(data)
+        data.gsub(/nonce="(.*)"/, 'nonce="<nonce>"')
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-undertaker
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Thomas Koppensteiner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-16 00:00:00.000000000 Z
+date: 2025-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 description: |2
       Sidekiq::Undertaker is a plugin for Sidekiq.
       It allows exploring, reviving (retrying) or burying (deleting) dead jobs.
@@ -49,7 +49,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
-- ".github/dependabot.yml"
 - ".github/workflows/ruby-build.yml"
 - ".gitignore"
 - ".rspec"
@@ -76,16 +75,16 @@ files:
 - lib/sidekiq/undertaker/web_extension/api_helpers.rb
 - renovate.json
 - sidekiq-undertaker.gemspec
-- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_filter/when_filter_page_is_called/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv7.approved.txt
-- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_filter/when_job_classbucket_page_is_called/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv7.approved.txt
-- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_filter/when_job_classbucket_page_is_polled/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv7.approved.txt
-- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_filter/when_job_classerror_classbucket_page_is_called/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv7.approved.txt
-- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_filter/when_job_classerror_classbucket_page_is_polled/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv7.approved.txt
-- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_morgue/when_job_classerrorbucket_is_called/with_all_failures_and_errors/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv7.approved.txt
-- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_morgue/when_job_classerrorbucket_is_called/with_job_class_error_and_specific_error_message/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv7.approved.txt
-- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_morgue/when_job_classerrorbucket_is_called/with_job_class_error_and_specific_error_message/with_pagination/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv7.approved.txt
-- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_morgue/when_job_classerrorbucket_is_called/with_specific_job_class_and_a_specific_error/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv7.approved.txt
-- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_morgue/when_job_classerrorbucket_is_called/with_specific_job_class_and_a_specific_error/with_pagination/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv7.approved.txt
+- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_filter/when_filter_page_is_called/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv8.approved.txt
+- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_filter/when_job_classbucket_page_is_called/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv8.approved.txt
+- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_filter/when_job_classbucket_page_is_polled/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv8.approved.txt
+- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_filter/when_job_classerror_classbucket_page_is_called/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv8.approved.txt
+- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_filter/when_job_classerror_classbucket_page_is_polled/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv8.approved.txt
+- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_morgue/when_job_classerrorbucket_is_called/with_all_failures_and_errors/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv8.approved.txt
+- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_morgue/when_job_classerrorbucket_is_called/with_job_class_error_and_specific_error_message/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv8.approved.txt
+- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_morgue/when_job_classerrorbucket_is_called/with_job_class_error_and_specific_error_message/with_pagination/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv8.approved.txt
+- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_morgue/when_job_classerrorbucket_is_called/with_specific_job_class_and_a_specific_error/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv8.approved.txt
+- spec/fixtures/approvals/sidekiq_undertaker_webextension/show_morgue/when_job_classerrorbucket_is_called/with_specific_job_class_and_a_specific_error/with_pagination/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv8.approved.txt
 - spec/sidekiq/undertaker/bucket_spec.rb
 - spec/sidekiq/undertaker/dead_jobs_spec.rb
 - spec/sidekiq/undertaker/job_distributor_spec.rb
@@ -93,6 +92,7 @@ files:
 - spec/sidekiq/undertaker/web_extension_spec.rb
 - spec/sidekiq/undertaker_spec.rb
 - spec/spec_helper.rb
+- spec/support/monkey_patch/approvals/writers/text_writer.rb
 - web/locales/en.yml
 - web/views/filter.erb
 - web/views/filter_job_class.erb
@@ -117,14 +117,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Sidekiq::Undertaker allows exploring, reviving or burying dead jobs

data/.github/dependabot.yml

@@ -1,8 +0,0 @@
-version: 2
-updates:
-- package-ecosystem: bundler
-  directory: "/"
-  schedule:
-    interval: monthly
-  open-pull-requests-limit: 10
-  versioning-strategy: increase

data/spec/fixtures/approvals/sidekiq_undertaker_webextension/show_filter/when_filter_page_is_called/behaves_like_a_page/the_displayed_page_is_correct_for_sidekiqv7.approved.txt

@@ -1,265 +0,0 @@
-<!doctype html>
-<html dir="ltr">
-  <head>
-    <title>[TEST] Sidekiq</title>
-    <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
-
-    <link href="/sidekiq/stylesheets/bootstrap.css" media="screen" rel="stylesheet" type="text/css" />
-    
-
-    <link href="/sidekiq/stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" />
-    <link href="/sidekiq/stylesheets/application-dark.css" media="screen and (prefers-color-scheme: dark)" rel="stylesheet" type="text/css" />
-    
-
-    <link rel="apple-touch-icon" href="/sidekiq/images/apple-touch-icon.png">
-    <link rel="shortcut icon" type="image/ico" href="/sidekiq/images/favicon.ico" />
-    <script type="text/javascript" src="/sidekiq/javascripts/application.js"></script>
-    <meta name="google" content="notranslate" />
-    
-  </head>
-  <body class="admin" data-locale="en">
-    <div class="navbar navbar-default navbar-fixed-top">
-  <div class="container-fluid">
-    <div class="navbar-header" data-navbar="static">
-      <button type="button" class="navbar-toggle collapsed" data-toggle="navbar-menu" data-target="#navbar-menu">
-        <span class="icon-bar"></span>
-        <span class="icon-bar"></span>
-        <span class="icon-bar"></span>
-      </button>
-      <div class="navbar-toggle collapsed navbar-livereload">
-        
-    <a class="live-poll-start live-poll btn btn-primary">Live Poll</a>
-    <a class="live-poll-stop live-poll btn btn-primary active">Stop Polling</a>
-
-
-        
-      </div>
-      <a class="navbar-brand" href="/sidekiq/">
-        Sidekiq
-        <span class="status">
-  <i class="status-sprite status-idle"></i>
-  idle
-</span>
-
-      </a>
-    </div>
-
-    <div class="collapse navbar-collapse" id="navbar-menu">
-      <ul class="nav navbar-nav" data-navbar="static">
-        
-          
-            <li class="">
-            <a href="/sidekiq/">Dashboard</a>
-            </li>
-          
-        
-          
-            <li class="">
-            <a href="/sidekiq/busy">Busy</a>
-            </li>
-          
-        
-          
-            <li class="">
-            <a href="/sidekiq/queues">Queues</a>
-            </li>
-          
-        
-          
-            <li class="">
-            <a href="/sidekiq/retries">Retries</a>
-            </li>
-          
-        
-          
-            <li class="">
-            <a href="/sidekiq/scheduled">Scheduled</a>
-            </li>
-          
-        
-          
-            <li class="">
-            <a href="/sidekiq/morgue">Dead</a>
-            </li>
-          
-        
-          
-            <li class="">
-            <a href="/sidekiq/metrics">Metrics</a>
-            </li>
-          
-        
-
-        
-          <li class="active" data-navbar="custom-tab">
-            <a href="/sidekiq/undertaker/filter">Undertaker</a>
-          </li>
-        
-
-        <li class="navbar-livereload">
-          <div class="poll-wrapper">
-            
-    <a class="live-poll-start live-poll btn btn-primary">Live Poll</a>
-    <a class="live-poll-stop live-poll btn btn-primary active">Stop Polling</a>
-
-
-            
-          </div>
-        </li>
-      </ul>
-    </div>
-  </div>
-</div>
-
-    <div id="page">
-      <div class="container">
-        <div class="row">
-          <div class="col-sm-12 summary_bar">
-            <ul class="list-unstyled summary row">
-  <li class="processed col-sm-1">
-    <span id="txtProcessed" class="count" data-nwp>0</span>
-    <span class="desc">Processed</span>
-  </li>
-  <li class="failed col-sm-1">
-    <span id="txtFailed" class="count" data-nwp>0</span>
-    <span class="desc">Failed</span>
-  </li>
-  <li class="busy col-sm-1">
-    <a href="/sidekiq/busy">
-      <span id="txtBusy" class="count" data-nwp>0</span>
-      <span class="desc">Busy</span>
-    </a>
-  </li>
-  <li class="enqueued col-sm-1">
-    <a href="/sidekiq/queues">
-      <span id="txtEnqueued" class="count" data-nwp>0</span>
-      <span class="desc">Enqueued</span>
-    </a>
-  </li>
-  <li class="retries col-sm-1">
-    <a href="/sidekiq/retries">
-      <span id="txtRetries" class="count" data-nwp>0</span>
-      <span class="desc">Retries</span>
-    </a>
-  </li>
-  <li class="scheduled col-sm-1">
-    <a href="/sidekiq/scheduled">
-      <span id="txtScheduled" class="count" data-nwp>0</span>
-      <span class="desc">Scheduled</span>
-    </a>
-  </li>
-  <li class="dead col-sm-1">
-    <a href="/sidekiq/morgue">
-      <span id="txtDead" class="count" data-nwp>4</span>
-      <span class="desc">Dead</span>
-    </a>
-  </li>
-</ul>
-
-          </div>
-
-          <div class="col-sm-12">
-            <header class="row header">
-  <div class="col-sm-12">
-    <h3>
-      <b>4</b> dead jobs
-    </h3>
-  </div>
-</header>
-
-<table class="table table-striped table-bordered table-white">
-  <thead>
-    <tr>
-      <th style="width: 20%">Jobs</th>
-      <th style="width: 10%">All</th>
-      <th style="width: 10%">1 hour</th>
-      <th style="width: 10%">3 hours</th>
-      <th style="width: 10%">1 day</th>
-      <th style="width: 10%">3 days</th>
-      <th style="width: 10%">1 week</th>
-      <th style="width: 10%">Older</th>
-    </tr>
-  </thead>
-  
-      <tr>
-        <td><a href='/sidekiq/undertaker/morgue/all/all/all/total_dead'> all</a></td>
-        <td><a href='/sidekiq/undertaker/filter/all/total_dead'>4</a></td>
-        <td><a href='/sidekiq/undertaker/filter/all/1_hour'>4</a></td>
-        <td><a href='/sidekiq/undertaker/filter/all/3_hours'>0</a></td>
-        <td><a href='/sidekiq/undertaker/filter/all/1_day'>0</a></td>
-        <td><a href='/sidekiq/undertaker/filter/all/3_days'>0</a></td>
-        <td><a href='/sidekiq/undertaker/filter/all/1_week'>0</a></td>
-        <td><a href='/sidekiq/undertaker/filter/all/older'>0</a></td>
-      </tr>
-  
-      <tr>
-        <td><a href='/sidekiq/undertaker/morgue/HardWorker/all/all/total_dead'> HardWorker</a></td>
-        <td><a href='/sidekiq/undertaker/filter/HardWorker/total_dead'>3</a></td>
-        <td><a href='/sidekiq/undertaker/filter/HardWorker/1_hour'>3</a></td>
-        <td><a href='/sidekiq/undertaker/filter/HardWorker/3_hours'>0</a></td>
-        <td><a href='/sidekiq/undertaker/filter/HardWorker/1_day'>0</a></td>
-        <td><a href='/sidekiq/undertaker/filter/HardWorker/3_days'>0</a></td>
-        <td><a href='/sidekiq/undertaker/filter/HardWorker/1_week'>0</a></td>
-        <td><a href='/sidekiq/undertaker/filter/HardWorker/older'>0</a></td>
-      </tr>
-  
-      <tr>
-        <td><a href='/sidekiq/undertaker/morgue/HardWorker1/all/all/total_dead'> HardWorker1</a></td>
-        <td><a href='/sidekiq/undertaker/filter/HardWorker1/total_dead'>1</a></td>
-        <td><a href='/sidekiq/undertaker/filter/HardWorker1/1_hour'>1</a></td>
-        <td><a href='/sidekiq/undertaker/filter/HardWorker1/3_hours'>0</a></td>
-        <td><a href='/sidekiq/undertaker/filter/HardWorker1/1_day'>0</a></td>
-        <td><a href='/sidekiq/undertaker/filter/HardWorker1/3_days'>0</a></td>
-        <td><a href='/sidekiq/undertaker/filter/HardWorker1/1_week'>0</a></td>
-        <td><a href='/sidekiq/undertaker/filter/HardWorker1/older'>0</a></td>
-      </tr>
-  
-</table>
-
-<header class="row header">
-  <div class="col-sm-12">
-    <h3>
-      Import Jobs
-    </h3>
-  </div>
-</header>
-
-<form enctype="multipart/form-data" method="post" action='/sidekiq/undertaker/import_jobs'>
-  <input type='hidden' name='authenticity_token' value='stubbed-csrf-token'/>
-    <input type="file" id=upload_file" name="upload_file" >
-    <button class="btn btn-danger" style="margin-top: 10px" type="submit">
-      Import
-    </button>
-</form>
-
-          </div>
-        </div>
-      </div>
-    </div>
-    <div class="navbar navbar-fixed-bottom navbar-inverse ltr">
-  <div class="navbar-inner">
-    <div class="container text-center">
-        <ul class="nav">
-          <li>
-            <p class="navbar-text product-version">Sidekiq v*EXCLUDED*</p>
-          </li>
-          <li>
-            <p class="navbar-text redis-url" title="redis://localhost:6379/0">redis://localhost:6379/0</p>
-          </li>
-          <li>
-            <p id="serverUtcTime" class="navbar-text server-utc-time">20:57:00 UTC</p>
-          </li>
-          <li>
-            <p class="navbar-text"><a rel=help href="https://github.com/sidekiq/sidekiq/wiki">docs</a></p>
-          </li>
-          <li>
-            <p class="navbar-text"><a rel=external href="https://github.com/sidekiq/sidekiq/tree/main/web/locales">en</a></p>
-          </li>
-        </ul>
-    </div>
-  </div>
-</div>
-
-  </body>
-</html>