sidekiq-failures 0.4.5 → 1.1.0

data/test/web_extension_test.rb

@@ -5,192 +5,247 @@ module Sidekiq
   describe "WebExtension" do
     include Rack::Test::Methods
 
+    TOKEN = SecureRandom.base64(defined?(Sidekiq::Web::TOKEN_LENGTH) ? Sidekiq::Web::TOKEN_LENGTH : 32).freeze
+
     def app
       Sidekiq::Web
     end
 
     before do
-      Sidekiq.redis = REDIS
-      Sidekiq.redis {|c| c.flushdb }
+      env 'rack.session', { csrf: TOKEN }
+      env 'HTTP_X_CSRF_TOKEN', TOKEN
+      Sidekiq.redis(&:flushdb)
     end
 
     it 'can display home with failures tab' do
       get '/'
 
-      last_response.status.must_equal 200
-      last_response.body.must_match /Sidekiq/
-      last_response.body.must_match /Failures/
+      _(last_response.status).must_equal 200
+      _(last_response.body).must_match(/Sidekiq/)
+      _(last_response.body).must_match(/Failures/)
     end
 
     it 'can display failures page without any failures' do
       get '/failures'
-      last_response.status.must_equal 200
-      last_response.body.must_match /Failed Jobs/
-      last_response.body.must_match /No failed jobs found/
+      _(last_response.status).must_equal 200
+      _(last_response.body).must_match(/Failed Jobs/)
+      _(last_response.body).must_match(/No failed jobs found/)
     end
 
     it 'has the reset counter form and action' do
       get '/failures'
-      last_response.body.must_match /failures\/all\/reset/
-      last_response.body.must_match /Reset Counter/
+      _(last_response.body).must_match(/failures\/all\/reset/)
+      _(last_response.body).must_match(/Reset Counter/)
     end
 
     describe 'when there are failures' do
       before do
-        create_sample_failure
+        @failure = create_sample_failure
         get '/failures'
       end
 
       it 'should be successful' do
-        last_response.status.must_equal 200
+        _(last_response.status).must_equal 200
       end
 
       it 'can display failures page with failures listed' do
-        last_response.body.must_match /Failed Jobs/
-        last_response.body.must_match /HardWorker/
-        last_response.body.must_match /ArgumentError/
-        last_response.body.wont_match /No failed jobs found/
+        _(last_response.body).must_match(/Failed Jobs/)
+        _(last_response.body).must_match(/HardWorker/)
+        _(last_response.body).must_match(/ArgumentError/)
       end
 
       it 'can reset counter' do
         assert_equal failed_count, "1"
 
-        last_response.body.must_match /HardWorker/
+        _(last_response.body).must_match(/HardWorker/)
+        post '/failures/all/reset', { authenticity_token: TOKEN }
 
-        post '/failures/all/reset'
-        last_response.status.must_equal 302
-        last_response.location.must_match /failures$/
+        _(last_response.status).must_equal 302
+        _(last_response.location).must_match(/failures$/)
 
         get '/failures'
-        last_response.status.must_equal 200
-        last_response.body.must_match /HardWorker/
+        _(last_response.status).must_equal 200
+        _(last_response.body).must_match(/HardWorker/)
 
         assert_equal failed_count, "0"
       end
 
       it 'has the delete all form and action' do
-        last_response.body.must_match /failures\/all\/delete/
-        last_response.body.must_match /Delete All/
+        _(last_response.body).must_match(/failures\/all\/delete/)
+        _(last_response.body).must_match(/Delete All/)
       end
 
       it 'can delete all failures' do
         assert_equal failed_count, "1"
 
-        last_response.body.must_match /HardWorker/
+        _(last_response.body).must_match(/HardWorker/)
 
-        post '/failures/all/delete'
-        last_response.status.must_equal 302
-        last_response.location.must_match /failures$/
+        post '/failures/all/delete', { authenticity_token: TOKEN }
+        _(last_response.status).must_equal 302
+        _(last_response.location).must_match(/failures$/)
 
         get '/failures'
-        last_response.status.must_equal 200
-        last_response.body.must_match /No failed jobs found/
+        _(last_response.status).must_equal 200
+        _(last_response.body).must_match(/No failed jobs found/)
 
         assert_equal failed_count, "1"
       end
 
       it 'has the retry all form and action' do
-        last_response.body.must_match /failures\/all\/retry/
-        last_response.body.must_match /Retry All/
+        _(last_response.body).must_match(/failures\/all\/retry/)
+        _(last_response.body).must_match(/Retry All/)
       end
 
       it 'can retry all failures' do
         assert_equal failed_count, "1"
 
-        last_response.body.must_match /HardWorker/
-        post '/failures/all/retry'
-        last_response.status.must_equal 302
-        last_response.location.must_match /failures/
+        _(last_response.body).must_match(/HardWorker/)
+        post '/failures/all/retry', { authenticity_token: TOKEN }
+        _(last_response.status).must_equal 302
+        _(last_response.location).must_match(/failures/)
 
         get '/failures'
-        last_response.status.must_equal 200
-        last_response.body.must_match(/No failed jobs found/)
+        _(last_response.status).must_equal 200
+        _(last_response.body).must_match(/No failed jobs found/)
       end
 
       it 'can delete failure from the list' do
         assert_equal failed_count, "1"
 
-        last_response.body.must_match /HardWorker/
+        _(last_response.body).must_match(/HardWorker/)
 
-        post '/failures', { :key => [failure_score], :delete => 'Delete' }
-        last_response.status.must_equal 302
-        last_response.location.must_match /failures/
+        post '/failures', { authenticity_token: TOKEN, :key => [build_param_key(@failure)], :delete => 'Delete' }
+        _(last_response.status).must_equal 302
+        _(last_response.location).must_match(/failures/)
 
         get '/failures'
-        last_response.status.must_equal 200
-        last_response.body.must_match /No failed jobs found/
+        _(last_response.status).must_equal 200
+        _(last_response.body).must_match(/No failed jobs found/)
       end
 
       it 'can retry failure from the list' do
         assert_equal failed_count, "1"
 
-        last_response.body.must_match /HardWorker/
+        _(last_response.body).must_match(/HardWorker/)
+
+        post '/failures', { authenticity_token: TOKEN, :key => [build_param_key(@failure)], :retry => 'Retry Now' }
+        _(last_response.status).must_equal 302
+        _(last_response.location).must_match(/failures/)
+
+        get '/failures'
+        _(last_response.status).must_equal 200
+        _(last_response.body).must_match(/No failed jobs found/)
+      end
 
-        post '/failures', { :key => [failure_score], :retry => 'Retry Now' }
-        last_response.status.must_equal 302
-        last_response.location.must_match /failures/
+      it 'can handle failures with nil error_message' do
+        create_sample_failure(error_message: nil)
 
         get '/failures'
-        last_response.status.must_equal 200
-        last_response.body.must_match /No failed jobs found/
+
+        _(last_response.status).must_equal 200
       end
     end
 
     describe 'when there is failure' do
       before do
-        create_sample_failure
-        get "/failures/#{failure_score}"
+        @failure = create_sample_failure
+        get "/failures/#{build_param_key(@failure)}"
       end
 
       it 'should be successful' do
-        last_response.status.must_equal 200
+        _(last_response.status).must_equal 200
       end
 
       it 'can display failure page' do
-        last_response.body.must_match /Job/
-        last_response.body.must_match /HardWorker/
-        last_response.body.must_match /ArgumentError/
-        last_response.body.must_match /file1/
+        _(last_response.body).must_match(/Job/)
+        _(last_response.body).must_match(/HardWorker/)
+        _(last_response.body).must_match(/ArgumentError/)
+        _(last_response.body).must_match(/file1/)
       end
 
       it 'can delete failure' do
-        last_response.body.must_match /HardWorker/
+        _(last_response.body).must_match(/HardWorker/)
 
-        post "/failures/#{failure_score}", :delete => 'Delete'
-        last_response.status.must_equal 302
-        last_response.location.must_match /failures/
+        post "/failures/#{build_param_key(@failure)}", { authenticity_token: TOKEN, :delete => 'Delete' }
+        _(last_response.status).must_equal 302
+        _(last_response.location).must_match(/failures/)
 
-        get "/failures/#{failure_score}"
-        last_response.status.must_equal 302
-        last_response.location.must_match /failures/
+        get "/failures/#{build_param_key(@failure)}"
+        _(last_response.status).must_equal 302
+        _(last_response.location).must_match(/failures/)
       end
 
       it 'can retry failure' do
-        last_response.body.must_match /HardWorker/
+        _(last_response.body).must_match(/HardWorker/)
+
+        post "/failures/#{build_param_key(@failure)}", { authenticity_token: TOKEN, :retry => 'Retry Now' }
+        _(last_response.status).must_equal 302
+        _(last_response.location).must_match(/failures/)
 
-        post "/failures/#{failure_score}", :retry => 'Retry Now'
-        last_response.status.must_equal 302
-        last_response.location.must_match /failures/
+        get "/failures/#{build_param_key(@failure)}"
+        _(last_response.status).must_equal 302
+        _(last_response.location).must_match(/failures/)
+      end
 
-        get "/failures/#{failure_score}"
-        last_response.status.must_equal 302
-        last_response.location.must_match /failures/
+      if defined? Sidekiq::Pro
+        it 'can filter failure' do
+          create_sample_failure
+          post '/filter/failures', { authenticity_token: TOKEN, substr: 'new' }
+
+          _(last_response.status).must_equal 200
+        end
       end
     end
 
     describe 'when there is specific failure' do
       describe 'with unescaped data' do
-        before do
-          create_sample_failure(args: ['<h1>omg</h1>'], error_message: '<p>wow</p>')
-          get '/failures'
+        describe 'the index page' do
+          before do
+            create_sample_failure(args: ['<h1>omg</h1>'], error_message: '<p>wow</p>', error_class: '<script>alert("xss")</script>ArgumentError')
+            get '/failures'
+          end
+
+          it 'can escape arguments' do
+            _(last_response.body).must_match(/&quot;&lt;h1&gt;omg&lt;\/h1&gt;&quot;/)
+            _(last_response.body).wont_match(/<h1>omg<\/h1>/)
+          end
+
+          it 'can escape error message' do
+            _(last_response.body).must_match(/&lt;script&gt;alert\(&quot;xss&quot;\)&lt;\/script&gt;ArgumentError: &lt;p&gt;wow&lt;\/p&gt;/)
+            _(last_response.body).wont_match(/<script>alert\("xss"\)<\/script>ArgumentError/)
+            _(last_response.body).wont_match(/<p>wow<\/p>/)
+          end
         end
 
-        it 'can escape arguments' do
-          last_response.body.must_match /&quot;&lt;h1&gt;omg&lt;&#x2F;h1&gt;&quot;/
-        end
-
-        it 'can escape error message' do
-          last_response.body.must_match /ArgumentError: &lt;p&gt;wow&lt;&#x2F;p&gt;/
+        describe 'the details page' do
+          before do
+            @failure = create_sample_failure(
+              args: ['<h1>omg</h1>', '<script>alert("xss2")</script>'], 
+              error_message: '<p>wow</p>', 
+              error_class: '<script>alert("xss")</script>ArgumentError'
+            )
+            get "/failures/#{build_param_key(@failure)}"
+          end
+
+          it 'can escape error class' do
+            _(last_response.status).must_equal 200
+            _(last_response.body).must_match(/&lt;script&gt;alert\(&quot;xss&quot;\)&lt;\/script&gt;ArgumentError/)
+            _(last_response.body).wont_match(/<script>alert\("xss"\)<\/script>ArgumentError/)
+          end
+
+          it 'can escape error message' do
+            _(last_response.status).must_equal 200
+            _(last_response.body).must_match(/&lt;p&gt;wow&lt;\/p&gt;/)
+            _(last_response.body).wont_match(/<p>wow<\/p>/)
+          end
+
+          it 'can escape arguments' do
+            _(last_response.status).must_equal 200
+            _(last_response.body).must_match(/&quot;&lt;h1&gt;omg&lt;\/h1&gt;&quot;/)
+            # _(last_response.body).must_match(/&quot;&lt;script&gt;alert\(&quot;xss2&quot;\)&lt;\/script&gt;&quot;/)
+            _(last_response.body).wont_match(/<h1>omg<\/h1>/)
+            _(last_response.body).wont_match(/<script>alert\("xss2"\)<\/script>/)
+          end
         end
       end
 
@@ -201,8 +256,7 @@ module Sidekiq
         end
 
         it 'should be successful' do
-          last_response.status.must_equal 200
-          last_response.body.wont_match /No failed jobs found/
+          _(last_response.status).must_equal 200
         end
       end
 
@@ -213,31 +267,44 @@ module Sidekiq
         end
 
         it 'should be successful' do
-          last_response.status.must_equal 200
-          last_response.body.wont_match /No failed jobs found/
+          _(last_response.status).must_equal 200
         end
       end
     end
 
     def create_sample_failure(data = {})
+      failed_at = Time.now.utc.to_i - 10000
+      enqueued_at = failed_at - 1000
+
       data = {
         :queue => 'default',
         :class => 'HardWorker',
         :args  => ['bob', 5],
-        :jid   => 1,
-        :enqueued_at     => Time.now.utc.to_f,
-        :failed_at       => Time.now.utc.to_f,
+        :jid   => SecureRandom.hex(12),
+        :enqueued_at     => failed_at.to_f,
+        :failed_at       => enqueued_at.to_f,
         :error_class     => 'ArgumentError',
         :error_message   => 'Some new message',
         :error_backtrace => ["path/file1.rb", "path/file2.rb"]
       }.merge(data)
 
+      # Store the score so we can use it for retrieving the failure later
+      score = failure_score
+
       Sidekiq.redis do |c|
         c.multi do
-          c.zadd(Sidekiq::Failures::LIST_KEY, failure_score, Sidekiq.dump_json(data))
+          c.zadd(Sidekiq::Failures::LIST_KEY, score, Sidekiq.dump_json(data))
           c.set("stat:failed", 1)
         end
       end
+
+      # Update data with the score used so tests can reference it
+      data[:score] = score
+      data
+    end
+
+    def build_param_key(failure)
+      "#{failure[:score]}-#{failure[:jid]}"
     end
 
     def failed_count
@@ -245,7 +312,7 @@ module Sidekiq
     end
 
     def failure_score
-      Time.at(1).to_f
+      Time.now.to_f
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-failures
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Marcelo Silveira
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-21 00:00:00.000000000 Z
+date: 2025-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -16,14 +15,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.16.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.16.0
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -87,8 +100,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -98,20 +112,26 @@ files:
 - lib/sidekiq/failures.rb
 - lib/sidekiq/failures/failure_set.rb
 - lib/sidekiq/failures/locales/en.yml
+- lib/sidekiq/failures/locales/ja.yml
+- lib/sidekiq/failures/locales/pt-BR.yml
+- lib/sidekiq/failures/locales/zh-cn.yml
 - lib/sidekiq/failures/middleware.rb
 - lib/sidekiq/failures/sorted_entry.rb
 - lib/sidekiq/failures/version.rb
 - lib/sidekiq/failures/views/failure.erb
+- lib/sidekiq/failures/views/failure_legacy.erb
 - lib/sidekiq/failures/views/failures.erb
+- lib/sidekiq/failures/views/failures_legacy.erb
 - lib/sidekiq/failures/web_extension.rb
 - sidekiq-failures.gemspec
+- test/failures_test.rb
 - test/middleware_test.rb
 - test/test_helper.rb
 - test/web_extension_test.rb
 homepage: https://github.com/mhfs/sidekiq-failures/
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -126,13 +146,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Keeps track of Sidekiq failed jobs and adds a tab to the Web UI to let you
   browse them. Makes use of Sidekiq's custom tabs and middleware chain.
-test_files:
-- test/middleware_test.rb
-- test/test_helper.rb
-- test/web_extension_test.rb
+test_files: []

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-services:
-  - redis-server
-rvm:
-  - 1.9.3
-  - jruby-19mode
-  - 2.0.0
-  - 2.1
-env:
-  matrix:
-    - SIDEKIQ_VERSION="~> 2.16"
-    - SIDEKIQ_VERSION="~> 2.17"
-    - SIDEKIQ_VERSION="~> 3.0"
-    - SIDEKIQ_VERSION="~> 3.1"
-matrix:
-  allow_failures:
-    - rvm: 1.9.3
-    - rvm: jruby-19mode