sidekiq-undertaker 1.0.0.rc01

data/lib/sidekiq/undertaker/job_filter.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "sidekiq/undertaker/dead_job"
+
+module Sidekiq
+  module Undertaker
+    class JobFilter
+      class << self
+        def filter_dead_jobs(filters = {})
+          # filters can have keys in (job_class, error_class, bucket_name)
+          dead_jobs = []
+          Sidekiq::Undertaker::DeadJob.for_each do |dead_job|
+            filter_passed = true
+            filters.each do |filter, value|
+              next if skip?(filter, value)
+
+              filter_passed = false if dead_job.respond_to?(filter) && dead_job.public_send(filter) != value
+            end
+            dead_jobs << dead_job if filter_passed
+          end
+
+          dead_jobs
+        end
+
+        def skip?(filter, value)
+          value.nil? ||
+            total_dead_bucket?(filter, value) ||
+            all_jobs?(filter, value) ||
+            all_errors?(filter, value)
+        end
+
+        def total_dead_bucket?(filter, value)
+          filter == "bucket_name" && value == "total_dead"
+        end
+
+        def all_jobs?(filter, value)
+          filter == "job_class" && value == "all"
+        end
+
+        def all_errors?(filter, value)
+          filter == "error_class" && value == "all"
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/undertaker/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Undertaker
+    VERSION = "1.0.0.rc01"
+  end
+end

data/lib/sidekiq/undertaker/web_extension.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "sidekiq/undertaker/web_extension/api_helpers"
+
+module Sidekiq
+  module Undertaker
+    module WebExtension
+      def self.registered(app)
+        app.helpers APIHelpers
+
+        app.get "/undertaker/filter" do
+          show_filter
+        end
+
+        app.get "/undertaker/filter/:job_class/:bucket_name" do
+          show_filter_by_job_class_bucket_name
+        end
+
+        app.get "/undertaker/morgue/:job_class/:error_class/:bucket_name" do
+          show_undertaker_by_job_class_error_class_bucket_name
+        end
+
+        app.post "/undertaker/morgue" do
+          post_undertaker
+        end
+
+        app.post "/undertaker/morgue/:job_class/:error_class/:bucket_name/delete" do
+          post_undertaker_job_class_error_class_buckent_name_delete
+        end
+
+        app.post "/undertaker/morgue/:job_class/:error_class/:bucket_name/retry" do
+          post_undertaker_job_class_error_class_buckent_name_retry
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require "sidekiq/undertaker/job_distributor"
+require "sidekiq/undertaker/job_filter"
+
+module Sidekiq
+  module Undertaker
+    module WebExtension
+      module APIHelpers
+        def show_filter
+          store_request_params
+
+          @dead_jobs    = Sidekiq::Undertaker::JobFilter.filter_dead_jobs(params)
+          @distribution = Sidekiq::Undertaker::JobDistributor.new(@dead_jobs).group_by_job_class
+          @total_dead   = @dead_jobs.size
+
+          render_result("filter.erb")
+        end
+
+        def show_filter_by_job_class_bucket_name
+          store_request_params
+
+          @dead_jobs    = Sidekiq::Undertaker::JobFilter.filter_dead_jobs(params)
+          @distribution = Sidekiq::Undertaker::JobDistributor.new(@dead_jobs).group_by_error_class
+          @total_dead   = @dead_jobs.size
+
+          render_result("filter_job_class.erb")
+        end
+
+        def show_undertaker_by_job_class_error_class_bucket_name
+          store_request_params
+
+          @dead_jobs = Sidekiq::Undertaker::JobFilter.filter_dead_jobs(params)
+
+          # Display dead jobs as list
+          @dead_jobs = @dead_jobs.map(&:job)
+
+          @undertaker_path = "undertaker/#{@req_job_class}/#{@req_error_class}/#{@req_bucket_name}"
+
+          # Pagination
+          @total_dead   = @dead_jobs.size
+          @current_page = (params[:page] || 1).to_i
+          @count        = 50 # per page
+          @dead_jobs    = @dead_jobs[((@current_page - 1) * @count), @count]
+
+          # 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")
+
+          render_result("morgue.erb")
+        end
+
+        def post_undertaker
+          raise ::ArgumentError.new("Key missing") unless params["key"]
+
+          params["key"].each do |key|
+            job = Sidekiq::DeadSet.new.fetch(*parse_params(key)).first
+            if job
+              if params["retry"]
+                job.retry
+              elsif params["delete"]
+                job.delete
+              end
+            end
+          end
+
+          redirect redirect_path(request)
+        rescue ::ArgumentError
+          bad_request
+        end
+
+        def post_undertaker_job_class_error_class_buckent_name_delete
+          store_request_params
+          @dead_jobs = Sidekiq::Undertaker::JobFilter.filter_dead_jobs(params)
+          @dead_jobs.each do |dead_job|
+            dead_job.job.delete
+          end
+
+          redirect redirect_path(request)
+        end
+
+        def post_undertaker_job_class_error_class_buckent_name_retry
+          store_request_params
+
+          @dead_jobs = Sidekiq::Undertaker::JobFilter.filter_dead_jobs(params)
+          @dead_jobs.each do |dead_job|
+            dead_job.job.retry
+          end
+
+          redirect redirect_path(request)
+        end
+
+        def render_result(template)
+          render(:erb, File.read(File.join(view_path, template)))
+        end
+
+        def store_request_params
+          @req_job_class   = params["job_class"]
+          @req_bucket_name = params["bucket_name"]
+          @req_error_class = params["error_class"]
+        end
+
+        def view_path
+          File.join(File.expand_path(__dir__), "../../../../web/views")
+        end
+
+        def redirect_path(request)
+          path = request.referer ? URI.parse(request.referer).path : request.path
+          path.gsub("/delete", "").gsub("/retry", "")
+        end
+
+        def bad_request
+          [400, { "Content-Type" => "text/plain" }, ["Bad Request"]]
+        end
+      end
+    end
+  end
+end

data/sidekiq-undertaker.gemspec

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sidekiq/undertaker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-undertaker"
+  spec.version       = Sidekiq::Undertaker::VERSION
+  spec.authors       = ["Thomas Koppensteiner"]
+  spec.email         = ["thomas.koppensteiner@gmx.net "]
+  spec.summary       = "Sidekiq::Undertaker makes exploring the Sidekiq dead job queue easier"
+  spec.description   = <<-DES
+    Sidekiq::Undertaker is a plugin for Sidekiq.
+    It makes exploring the dead job queue easier
+    by breaking down the dead jobs into time windows (buckets) of hours and days.
+    The gems allows retrying or deleting a certain subset of failures.
+  DES
+  spec.license       = "MIT"
+
+  spec.homepage      = "https://github.com/ThomasKoppensteiner/sidekiq-undertaker"
+  spec.metadata      = {
+    "homepage_uri"     => "https://github.com/ThomasKoppensteiner/sidekiq-undertaker",
+    "source_code_uri"  => "https://github.com/ThomasKoppensteiner/sidekiq-undertaker",
+    "bug_tracker_uri"  => "https://github.com/ThomasKoppensteiner/sidekiq-undertaker/issues",
+    "build_status_uri" => "https://travis-ci.org/ThomasKoppensteiner/sidekiq-undertaker"
+  }
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib", "lib/sidekiq/undertaker"]
+
+  spec.add_development_dependency "bundler", ">= 1.17", "<3"
+  spec.add_development_dependency "rake", "~> 12.3"
+
+  spec.add_development_dependency "approvals", "~> 0.0", ">= 0.0.24"
+  spec.add_development_dependency "mock_redis", "~> 0.19"
+  spec.add_development_dependency "pry", "~> 0.12"
+  spec.add_development_dependency "rack-test", "~> 1.1"
+  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", "~> 1.2"
+  spec.add_development_dependency "rubocop", "~> 0.77"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.30"
+  spec.add_development_dependency "rubocop_runner", "~> 2.1"
+  spec.add_development_dependency "simplecov", "~> 0.14"
+  spec.add_development_dependency "sinatra", "~> 2.0"
+  spec.add_development_dependency "timecop", "~> 0.9"
+
+  spec.add_runtime_dependency "sidekiq", "~> 5.2"
+end

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

@@ -0,0 +1,240 @@
+<!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 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-poll-path="" 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="collapse" 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 id="live-poll" class="btn btn-primary" href="/sidekiq/undertaker/filter?poll=true">Live Poll</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="active" data-navbar="custom-tab">
+            <a href="/sidekiq/undertaker/filter">Undertaker</a>
+          </li>
+        
+
+        <li class="navbar-livereload">
+          <div class="poll-wrapper">
+            
+  
+    <a id="live-poll" class="btn btn-primary" href="/sidekiq/undertaker/filter?poll=true">Live Poll</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 class="count">0</span>
+    <span class="desc">Processed</span>
+  </li>
+  <li class="failed col-sm-1">
+    <span class="count">0</span>
+    <span class="desc">Failed</span>
+  </li>
+  <li class="busy col-sm-1">
+    <a href="/sidekiq/busy">
+      <span class="count">0</span>
+      <span class="desc">Busy</span>
+    </a>
+  </li>
+  <li class="enqueued col-sm-1">
+    <a href="/sidekiq/queues">
+      <span class="count">0</span>
+      <span class="desc">Enqueued</span>
+    </a>
+  </li>
+  <li class="retries col-sm-1">
+    <a href="/sidekiq/retries">
+      <span class="count">0</span>
+      <span class="desc">Retries</span>
+    </a>
+  </li>
+  <li class="scheduled col-sm-1">
+    <a href="/sidekiq/scheduled">
+      <span class="count">0</span>
+      <span class="desc">Scheduled</span>
+    </a>
+  </li>
+  <li class="dead col-sm-1">
+    <a href="/sidekiq/morgue">
+      <span class="count">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/total_dead'> all</a></td>
+        <td><a href='/all/total_dead'>4</a></td>
+        <td><a href='/all/1_hour'>4</a></td>
+        <td><a href='/all/3_hours'>0</a></td>
+        <td><a href='/all/1_day'>0</a></td>
+        <td><a href='/all/3_days'>0</a></td>
+        <td><a href='/all/1_week'>0</a></td>
+        <td><a href='/all/older'>0</a></td>
+      </tr>
+  
+      <tr>
+        <td><a href='/sidekiq/undertaker/morgue/HardWorker/all/total_dead'> HardWorker</a></td>
+        <td><a href='/HardWorker/total_dead'>3</a></td>
+        <td><a href='/HardWorker/1_hour'>3</a></td>
+        <td><a href='/HardWorker/3_hours'>0</a></td>
+        <td><a href='/HardWorker/1_day'>0</a></td>
+        <td><a href='/HardWorker/3_days'>0</a></td>
+        <td><a href='/HardWorker/1_week'>0</a></td>
+        <td><a href='/HardWorker/older'>0</a></td>
+      </tr>
+  
+      <tr>
+        <td><a href='/sidekiq/undertaker/morgue/HardWorker1/all/total_dead'> HardWorker1</a></td>
+        <td><a href='/HardWorker1/total_dead'>1</a></td>
+        <td><a href='/HardWorker1/1_hour'>1</a></td>
+        <td><a href='/HardWorker1/3_hours'>0</a></td>
+        <td><a href='/HardWorker1/1_day'>0</a></td>
+        <td><a href='/HardWorker1/3_days'>0</a></td>
+        <td><a href='/HardWorker1/1_week'>0</a></td>
+        <td><a href='/HardWorker1/older'>0</a></td>
+      </tr>
+  
+</table>
+
+          </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://127.0.0.1:6379/0">redis://127.0.0.1:6379/0</p>
+          </li>
+          <li>
+            <p class="navbar-text server-utc-time">20:57:00 UTC</p>
+          </li>
+          <li>
+            <p class="navbar-text"><a style="color: gray;" href="https://github.com/mperham/sidekiq/wiki">docs</a></p>
+          </li>
+        </ul>
+    </div>
+  </div>
+</div>
+
+  </body>
+</html>