sidekiq-failures 1.0.4 → 1.1.0

data/lib/sidekiq/failures/web_extension.rb

@@ -1,49 +1,130 @@
 module Sidekiq
   module Failures
     module WebExtension
+      LEGACY_SIDEKIQ_VERSION = Gem::Version.new("7.3.9")
+
+      # Helper method to check Sidekiq version
+      def self.legacy_sidekiq?
+        Gem::Version.new(Sidekiq::VERSION) <= LEGACY_SIDEKIQ_VERSION
+      end
+
+      # Helper method to get parameters based on path and parameter name
+      def self.fetch_param_value(path, param_name)
+        if legacy_sidekiq?
+          # For newer Sidekiq, use route_params or url_params based on path
+          lambda { |env| env.params[param_name] }
+        else
+          # For legacy Sidekiq, just use params
+          if path.include?(":#{param_name}")
+            lambda { |env| env.route_params(param_name.to_sym) }
+          else
+            lambda { |env| env.url_params(param_name.to_s) }
+          end
+        end
+      end
+
+      # Helper method to handle parse_params vs parse_key compatibility
+      def self.parse_key_or_params
+        lambda do |env, key|
+          if env.respond_to?(:parse_key)
+            env.parse_key(key)
+          else
+            env.parse_params(key)
+          end
+        end
+      end
+
+      # Define the helper method implementation that will be used in both versions
+      # Instead of a static lambda, we'll return a method that needs to be evaluated in context
+      def self.safe_relative_time_implementation
+        lambda do |time, context|
+          return unless time
+
+          time = if time.is_a?(Numeric)
+            Time.at(time)
+          else
+            Time.parse(time)
+          end
+
+          # Use the context to call relative_time
+          context.relative_time(time)
+        end
+      end
+
+      # Define the helpers module for Sidekiq 8.0+
+      module FailuresHelpers
+        def safe_relative_time(time)
+          # Pass self (the context with relative_time) to the implementation
+          WebExtension.safe_relative_time_implementation.call(time, self)
+        end
+      end
 
       def self.registered(app)
         view_path = File.join(File.expand_path("..", __FILE__), "views")
+        if legacy_sidekiq?
+          failures_view_path = File.join(view_path, "failures_legacy.erb")
+          failure_view_path = File.join(view_path, "failure_legacy.erb")
+        else
+          failures_view_path = File.join(view_path, "failures.erb")
+          failure_view_path = File.join(view_path, "failure.erb")
+        end
 
-        app.helpers do
-          def safe_relative_time(time)
-            time = if time.is_a?(Numeric)
-              Time.at(time)
-            else
-              Time.parse(time)
-            end
+        # Create a parse helper for use in routes
+        parse_helper = parse_key_or_params
 
-            relative_time(time)
+        # Use appropriate helpers implementation based on Sidekiq version
+        if legacy_sidekiq?
+          # Original implementation for older Sidekiq versions
+          app.helpers do
+            define_method(:safe_relative_time) do |time|
+              # Pass self (the context with relative_time) to the implementation
+              WebExtension.safe_relative_time_implementation.call(time, self)
+            end
           end
+        else
+          # New implementation for Sidekiq 8.0+
+          app.helpers(FailuresHelpers)
         end
 
         app.get "/failures" do
-          @count = (params[:count] || 25).to_i
-          (@current_page, @total_size, @failures) = page(LIST_KEY, params[:page], @count, :reverse => true)
+          page_param = Sidekiq::Failures::WebExtension.fetch_param_value("/failures", "page").call(self)
+          count_param = Sidekiq::Failures::WebExtension.fetch_param_value("/failures", "count").call(self)
+          @count = (count_param || 25).to_i
+
+          (@current_page, @total_size, @failures) = page(LIST_KEY, page_param, @count, :reverse => true)
           @failures = @failures.map {|msg, score| Sidekiq::SortedEntry.new(nil, score, msg) }
 
-          render(:erb, File.read(File.join(view_path, "failures.erb")))
+          render(:erb, File.read(failures_view_path))
         end
 
         app.get "/failures/:key" do
-          halt 404 unless params['key']
-
-          @failure = FailureSet.new.fetch(*parse_params(params['key'])).first
-          redirect "#{root_path}failures" if @failure.nil?
-          render(:erb, File.read(File.join(view_path, "failure.erb")))
+          key_param = Sidekiq::Failures::WebExtension.fetch_param_value("/failures/:key", "key").call(self)
+          halt 404 unless key_param
+
+          @failure = FailureSet.new.fetch(*parse_helper.call(self, key_param)).first
+          if @failure.nil?
+            redirect "#{root_path}failures"
+          else
+            render(:erb, File.read(failure_view_path))
+          end
         end
 
         app.post "/failures" do
-          halt 404 unless params['key']
+          key_param = Sidekiq::Failures::WebExtension.fetch_param_value("/failures", "key").call(self)
+          halt 404 unless key_param
 
-          params['key'].each do |key|
-            job = FailureSet.new.fetch(*parse_params(key)).first
+          key_param.each do |key|
+            job = FailureSet.new.fetch(*parse_helper.call(self, key)).first
             next unless job
 
-            if params['retry']
+            retry_param = Sidekiq::Failures::WebExtension.fetch_param_value("/failures", "retry").call(self)
+            if retry_param
               job.retry_failure
-            elsif params['delete']
-              job.delete
+            else
+              delete_param = Sidekiq::Failures::WebExtension.fetch_param_value("/failures", "delete").call(self)
+              if delete_param
+                job.delete
+              end
             end
           end
 
@@ -51,21 +132,26 @@ module Sidekiq
         end
 
         app.post "/failures/:key" do
-          halt 404 unless params['key']
+          key_param = Sidekiq::Failures::WebExtension.fetch_param_value("/failures/:key", "key").call(self)
+          halt 404 unless key_param
 
-          job = FailureSet.new.fetch(*parse_params(params['key'])).first
+          job = FailureSet.new.fetch(*parse_helper.call(self, key_param)).first
           if job
-            if params['retry']
+            retry_param = Sidekiq::Failures::WebExtension.fetch_param_value("/failures/:key", "retry").call(self)
+            if retry_param
               job.retry_failure
-            elsif params['delete']
-              job.delete
+            else
+              delete_param = Sidekiq::Failures::WebExtension.fetch_param_value("/failures/:key", "delete").call(self)
+              if delete_param
+                job.delete
+              end
             end
           end
           redirect_with_query("#{root_path}failures")
         end
 
         app.post "/failures/all/reset" do
-          Sidekiq::Failures.reset_failures
+          Sidekiq::Failures.reset_failure_count
           redirect "#{root_path}failures"
         end
 
@@ -84,10 +170,11 @@ module Sidekiq
         end
 
         app.post '/filter/failures' do
-          @failures = Sidekiq::Failures::FailureSet.new.scan("*#{params[:substr]}*")
+          substr_param = Sidekiq::Failures::WebExtension.fetch_param_value("/filter/failures", "substr").call(self)
+          @failures = Sidekiq::Failures::FailureSet.new.scan("*#{substr_param}*")
           @current_page = 1
-          @count = @total_size = @failures.count          
-          render(:erb, File.read(File.join(view_path, "failures.erb")))
+          @count = @total_size = @failures.count
+          render(:erb, File.read(failures_view_path))
         end
       end
     end

data/lib/sidekiq/failures.rb

@@ -59,9 +59,19 @@ module Sidekiq
     LIST_KEY = :failed
 
     def self.reset_failures
+      warn "NOTE: Sidekiq::Failures.reset_failures is deprecated; use Sidekiq::Failures.reset_failure_count instead."
+
+      reset_failure_count
+    end
+
+    def self.reset_failure_count
       Sidekiq.redis { |c| c.set("stat:failed", 0) }
     end
 
+    def self.clear_failures
+      FailureSet.new.clear
+    end
+
     def self.count
       Sidekiq.redis {|r| r.zcard(LIST_KEY) }
     end
@@ -87,7 +97,14 @@ Sidekiq.configure_server do |config|
 end
 
 if defined?(Sidekiq::Web)
-  Sidekiq::Web.register Sidekiq::Failures::WebExtension
-  Sidekiq::Web.tabs["Failures"] = "failures"
-  Sidekiq::Web.settings.locales << File.join(File.dirname(__FILE__), "failures/locales")
+  if Sidekiq::Failures::WebExtension.legacy_sidekiq?
+    Sidekiq::Web.register Sidekiq::Failures::WebExtension
+    Sidekiq::Web.tabs["Failures"] = "failures"
+    Sidekiq::Web.settings.locales << File.join(File.dirname(__FILE__), "failures/locales")
+  else
+    Sidekiq::Web.configure do |config|
+      config.locales << File.join(File.dirname(__FILE__), "failures/locales")
+      config.register(Sidekiq::Failures::WebExtension, name: "failures", tab: ["Failures"], index: ["failures"])
+    end
+  end
 end

data/sidekiq-failures.gemspec

@@ -28,5 +28,4 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rack-test"
   gem.add_development_dependency "sprockets"
   gem.add_development_dependency "sinatra"
-  gem.add_development_dependency "pry"
 end

data/test/failures_test.rb

@@ -3,7 +3,7 @@ require "test_helper"
 module Sidekiq
   describe Failures do
     describe '.retry_middleware_class' do
-      it 'returns based on Sidekiq::VERISON' do
+      it 'returns based on Sidekiq::VERSION' do
         case Sidekiq::VERSION[0]
         when '5'
           assert_equal Failures.retry_middleware_class, Sidekiq::JobRetry

data/test/middleware_test.rb

@@ -29,20 +29,29 @@ end
 
 class SidekiqPost63
   def new_processor(boss)
-    config = Sidekiq
+    config = ::Sidekiq
     config[:queues] = ['default']
-    config[:fetch] = Sidekiq::BasicFetch.new(config)
+    config[:fetch] = ::Sidekiq::BasicFetch.new(config)
     config[:error_handlers] << Sidekiq.method(:default_error_handler)
     ::Sidekiq::Processor.new(config) { |processor, reason = nil| }
   end
 end
 
+class SidekiqPost7
+  def new_processor(boss)
+    config = ::Sidekiq.default_configuration
+    ::Sidekiq::Processor.new(config.default_capsule) { |*args| }
+  end
+end
+
 module Sidekiq
   module Failures
     describe "Middleware" do
       def new_provider
         version = Gem::Version.new(Sidekiq::VERSION)
-        if version >= Gem::Version.new('6.4.0')
+        if version >= Gem::Version.new('7')
+          SidekiqPost7
+        elsif version >= Gem::Version.new('6.4.0')
           SidekiqPost63
         elsif version >= Gem::Version.new('6.0')
           SidekiqPre63
@@ -53,13 +62,16 @@ module Sidekiq
 
       before do
         $invokes = 0
-        @boss = MiniTest::Mock.new
+        @boss = Minitest::Mock.new
         @provider = new_provider
         @processor = @provider.new_processor(@boss)
 
-        Sidekiq.server_middleware {|chain| chain.add Sidekiq::Failures::Middleware }
-        Sidekiq.redis = REDIS
-        Sidekiq.redis { |c| c.flushdb }
+        Sidekiq.configure_server do |config|
+          config.server_middleware do |chain|
+            chain.add Sidekiq::Failures::Middleware
+          end
+        end
+        Sidekiq.redis(&:flushdb)
         Sidekiq.instance_eval { @failures_default_mode = nil }
       end
 
@@ -96,7 +108,7 @@ module Sidekiq
         assert_equal 0, failures_count
 
         assert_raises TestException do
-          @processor.process(msg)
+          @processor.send(:process, msg)
         end
 
         assert_equal 1, failures_count
@@ -109,7 +121,7 @@ module Sidekiq
         assert_equal 0, failures_count
 
         assert_raises TestException do
-          @processor.process(msg)
+          @processor.send(:process, msg)
         end
 
         assert_equal 1, failures_count
@@ -121,7 +133,7 @@ module Sidekiq
 
         assert_equal 0, failures_count
 
-        @processor.process(msg)
+        @processor.send(:process, msg)
 
         assert_equal 0, failures_count
         assert_equal 1, $invokes
@@ -133,7 +145,7 @@ module Sidekiq
         assert_equal 0, failures_count
 
         assert_raises TestException do
-          @processor.process(msg)
+          @processor.send(:process, msg)
         end
 
         assert_equal 0, failures_count
@@ -148,21 +160,20 @@ module Sidekiq
         assert_equal 0, failures_count
 
         assert_raises TestException do
-          @processor.process(msg)
+          @processor.send(:process, msg)
         end
 
         assert_equal 0, failures_count
         assert_equal 1, $invokes
       end
 
-
       it "doesn't record failure if going to be retired again and configured to track exhaustion" do
         msg = create_work('class' => MockWorker.to_s, 'args' => ['myarg'], 'retry' => true, 'failures' => 'exhausted')
 
         assert_equal 0, failures_count
 
         assert_raises TestException do
-          @processor.process(msg)
+          @processor.send(:process, msg)
         end
 
         assert_equal 0, failures_count
@@ -175,7 +186,7 @@ module Sidekiq
         assert_equal 0, failures_count
 
         assert_raises TestException do
-          @processor.process(msg)
+          @processor.send(:process, msg)
         end
 
         assert_equal 1, failures_count
@@ -188,7 +199,7 @@ module Sidekiq
         assert_equal 0, failures_count
 
         assert_raises TestException do
-          @processor.process(msg)
+          @processor.send(:process, msg)
         end
 
         assert_equal 1, failures_count
@@ -203,7 +214,7 @@ module Sidekiq
         assert_equal 0, failures_count
 
         assert_raises TestException do
-          @processor.process(msg)
+          @processor.send(:process, msg)
         end
 
         assert_equal 1, failures_count
@@ -218,7 +229,7 @@ module Sidekiq
         assert_equal 0, failures_count
 
         assert_raises TestException do
-          @processor.process(msg)
+          @processor.send(:process, msg)
         end
 
         assert_equal 1, failures_count
@@ -234,11 +245,11 @@ module Sidekiq
         assert_equal 0, failures_count
 
         3.times do
-          boss = MiniTest::Mock.new
+          boss = Minitest::Mock.new
           processor = @provider.new_processor(boss)
 
           assert_raises TestException do
-            processor.process(msg)
+            processor.send(:process, msg)
           end
 
           boss.verify
@@ -259,7 +270,7 @@ module Sidekiq
         assert_equal 0, Sidekiq::Failures.count
 
         assert_raises TestException do
-          @processor.process(msg)
+          @processor.send(:process, msg)
         end
 
         assert_equal 1, Sidekiq::Failures.count

data/test/test_helper.rb

@@ -1,5 +1,7 @@
 $TESTING = true
 
+ENV["MT_CPU"] = "1" # Disable parallel testing to avoid flaky tests, force a single CPU for minitest
+
 require "minitest/autorun"
 require "minitest/spec"
 require "minitest/mock"
@@ -15,4 +17,4 @@ require "sidekiq/cli"
 
 Sidekiq.logger.level = Logger::ERROR
 
-REDIS = Sidekiq::RedisConnection.create(url: "redis://localhost/15")
+REDIS = Sidekiq::RedisConnection.create(url: "redis://127.0.0.1:6379/15") # Use DB 15 for testing