sidekiq-undertaker 1.0.0.rc01

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 11a061d4335309c54a17ef8f34fc207c49a36ad772f74a145b15482d2dc4446e
+  data.tar.gz: b82c5d0d70efd96d4e32e9e1ef6e402f2ccce912bfe50ad4b7ea1ddf97b1c463
+SHA512:
+  metadata.gz: dba278326f094e4a3498f727791bc484e2e960be1d751f044a209a8f18583890e3cae95368692618eff8d4b315046806d94c24887a24b64b1b000d09f4f8f0d9
+  data.tar.gz: 48b3d817160a12606fec4a7f160c7b29062aca67bebcafc54ba8953a668c75ecf9b3cacf81f8e7315a2fd5abfa5a723d41e70e5b7b6fb50fd234bc7b5cb148fa

data/.codeclimate.yml

@@ -0,0 +1,6 @@
+version: "2"
+plugins:
+  git-legal:
+    enabled: true
+  # rubocop:
+  #   enabled: true

data/.gitignore

@@ -0,0 +1,22 @@
+_yardoc
+.approvals
+.bundle
+.config
+.idea/
+.ruby-version
+.rvmrc
+.yardoc
+*.gem
+*.rbc
+*.received.*
+coverage
+doc/
+Gemfile.lock
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rubocop.yml

@@ -0,0 +1,5 @@
+require:
+  - rubocop-rspec
+  - rt_rubocop_defaults
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,23 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-12-06 21:33:12 +0100 using RuboCop version 0.77.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: 2
+# Configuration parameters: Severity.
+Metrics/AbcSize:
+  Max: 22
+
+# Offense count: 3
+# Configuration parameters: CountComments, ExcludedMethods, Severity.
+Metrics/MethodLength:
+  Max: 19
+
+# Offense count: 5
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive

data/.travis.yml

@@ -0,0 +1,53 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
+  - jruby-9.1.17.0
+  - jruby-9.2.9.0
+jdk:
+  - oraclejdk11
+env:
+  global:
+    - CC_TEST_REPORTER_ID=9fd6c503f8bb89483410c1fc0578e5845c3fe0d3e773a32eb2788713fb101a93
+  matrix:
+    - "JRUBY_OPTS='--dev --debug'"
+    - "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
+
+matrix:
+  exclude:
+    - rvm: 2.4.9
+      jdk: oraclejdk8
+      env: "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
+    - rvm: 2.5.7
+      jdk: oraclejdk8
+      env: "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
+    - rvm: 2.6.5
+      jdk: oraclejdk8
+      env: "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
+    - rvm: truffleruby
+      jdk: oraclejdk8
+      env: "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
+  allow_failures:
+    - rvm: jruby-9.1.17.0
+      env: "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
+    - rvm: jruby-9.2.9.0
+      env: "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
+
+services:
+  - redis-server
+
+before_install:
+ - gem update --system
+ - gem install bundler -v "~> 1.0"
+ - gem install bundler -v "~> 2.0"
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - COVERAGE=true bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sidekiq-undertaker.gemspec
+gemspec
+
+# Good for debuging on travis-ci.org
+# group :development, :test do
+#   gem "approvals", git: "https://github.com/br/approvals", branch: "diff-preview"
+# end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Thomas Koppensteiner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# Sidekiq::Undertaker
+
+[![Build Status](https://travis-ci.org/ThomasKoppensteiner/sidekiq-under.svg?branch=master)](https://travis-ci.org/ThomasKoppensteiner/sidekiq-undertaker)
+[![Code Climate](https://codeclimate.com/github/ThomasKoppensteiner/sidekiq-undertaker.svg)](https://codeclimate.com/github/ThomasKoppensteiner/sidekiq-undertaker)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/9d75b8b7d3ff076e1ef1/test_coverage)](https://codeclimate.com/github/ThomasKoppensteiner/sidekiq-undertaker/test_coverage)
+
+## About
+
+Sidekiq::Undertaker is a plugin for [Sidekiq](https://rubygems.org/gems/sidekiq).
+It allows exploring, reviving (retrying) or burying (deleting) dead jobs.
+For easy exploring the dead-jobs queue is broken down into time windows (buckets) of hours, days and weeks.
+
+## Installation
+
+#### Install the Gem
+
+Add this line to your application's Gemfile:
+
+````ruby
+  gem "sidekiq-undertaker"
+````
+
+And then execute:
+````sh
+  $ bundle
+````
+
+Or install it yourself as:
+
+````sh
+  $ gem install sidekiq-undertaker
+````
+
+#### Install the Rubocop Pre-Commit Hook
+
+````sh
+  $ rake rubocop:install
+````
+
+## Impressions
+
+#### Filter View
+
+The filter page shows a table with time-buckets as columns and rows for each job class.
+
+![Sidekiq Undertaker](Demo_Filter.png)
+
+#### Job Filter View
+
+For each job class, you can drill down to view error distribution based on
+error class.
+
+![Sidekiq Undertaker](Demo_Job_Filter.png)
+
+#### Morgue View
+Finally, click on the individual error counts to display details of the
+errors in a list form.
+
+![Sidekiq Undertaker](Demo_Morgue_1_Job.png)
+
+The morgue view can, for example, also show an error distribution over all job classes.
+
+![Sidekiq Undertaker](Demo_Morgue_all.png)
+
+## Contributing
+
+1. Fork it ( https://github.com/ThomasKoppensteiner/sidekiq-undertaker/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Naming
+
+As another gem with the name `sidekiq-cleaner` is already released on rubygems.org,
+this fork was renamed to `sidekiq-undertaker`.
+
+## Thanks
+
+The [Sidekiq-Cleaner](https://github.com/HackingHabits/sidekiq-cleaner) gem was originally created by [Madan Thangavelu](https://github.com/HackingHabits).
+[Tout](https://github.com/Tout/sidekiq-cleaner) and [TheWudu](https://github.com/TheWudu/sidekiq-cleaner) also contributed to it.
+For the complete list of network members have a look at the [fork overview](https://github.com/ThomasKoppensteiner/sidekiq-under/network/members).
+
+## Alternative Projects
+
+* [sidekiq-cleaner](https://rubygems.org/gems/sidekiq-cleaner)
+* [sidekiq_cleaner](https://rubygems.org/gems/sidekiq_cleaner)
+
+## Author
+
+Thomas Koppensteiner | [Github](https://github.com/ThomasKoppensteiner) | [RubyGems](https://rubygems.org/profiles/thomaskoppensteiner) | [@koppensteiner_t](https://twitter.com/koppensteiner_t)
+
+## License
+
+See the [License](https://github.com/ThomasKoppensteiner/sidekiq-under/blob/master/LICENSE.txt) file.

data/Rakefile

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+$LOAD_PATH.unshift("lib")
+
+desc "setup gem for development"
+task :init do
+  Rake::Task["rubocop:install"].execute
+end
+
+#
+# RubocopRunner
+#
+begin
+  require "rubocop_runner/rake_task"
+  RubocopRunner::RakeTask.new
+rescue LoadError
+  puts "RubocopRunner not available!"
+end
+
+#
+# RSpec
+#
+begin
+  require "rspec/core/rake_task"
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: :spec
+  task test: :spec
+rescue LoadError
+  puts "RSpec not available!"
+end

data/lib/sidekiq/undertaker.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "sidekiq/undertaker/version"
+require "sidekiq/undertaker/web_extension"
+
+begin
+  require "sidekiq/web"
+rescue LoadError # rubocop:disable Lint/SuppressedException
+  # client-only usage
+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")
+end

data/lib/sidekiq/undertaker/bucket.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Undertaker
+    class Bucket
+      class << self
+        def bucket_names
+          %w[1_hour 3_hours 1_day 3_days 1_week older]
+        end
+
+        def for_elapsed_time(elapsed_time)
+          return "1_hour"  if elapsed_time <= ONE_HOUR
+          return "3_hours" if elapsed_time <= THREE_HOURS
+          return "1_day"   if elapsed_time <= ONE_DAY
+          return "3_days"  if elapsed_time <= THREE_DAYS
+          return "1_week"  if elapsed_time <= ONE_WEEK
+
+          "older"
+        end
+
+        ONE_HOUR    = 60 * 60 * 1
+        THREE_HOURS = ONE_HOUR * 3
+        ONE_DAY     = ONE_HOUR * 24
+        THREE_DAYS  = ONE_DAY  * 3
+        ONE_WEEK    = ONE_DAY  * 7
+      end
+    end
+  end
+end

data/lib/sidekiq/undertaker/dead_job.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "sidekiq/undertaker/bucket"
+
+module Sidekiq
+  module Undertaker
+    class DeadJob
+      class << self
+        def for_each
+          Sidekiq::DeadSet.new.each do |job|
+            yield to_dead_job(job)
+          end
+        end
+
+        def to_dead_job(job)
+          job_failed_at                  = parsed_failed_at(job)
+          job_time_elapsed_since_failure = Time.now.to_i - job_failed_at.to_i
+          job_bucket_name                = Bucket.for_elapsed_time(job_time_elapsed_since_failure)
+
+          new(job:                        job,
+              time_elapsed_since_failure: job_time_elapsed_since_failure,
+              bucket_name:                job_bucket_name)
+        end
+
+        def parsed_failed_at(job)
+          job.item["failed_at"].is_a?(String) ? Time.parse(job.item["failed_at"]) : job.item["failed_at"]
+        end
+      end
+
+      attr_reader :job_class, :time_elapsed_since_failure, :error_class, :bucket_name, :job
+
+      def initialize(args)
+        @job                        = args.fetch(:job)
+        @time_elapsed_since_failure = args.fetch(:time_elapsed_since_failure)
+        @bucket_name                = args.fetch(:bucket_name)
+        @job_class                  = args.fetch(:job_class, job.item["class"])
+        @error_class                = args.fetch(:error_class, job.item["error_class"])
+      end
+
+      def ==(other)
+        job_class == other.job_class &&
+          time_elapsed_since_failure == other.time_elapsed_since_failure &&
+          error_class                == other.error_class &&
+          bucket_name                == other.bucket_name &&
+          job_eql?(other.job)
+      end
+      alias eql? ==
+
+      private
+
+      attr_writer :job_class, :time_elapsed_since_failure, :error_class, :bucket_name, :job
+
+      def job_eql?(other_job) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+        job.jid == other_job.jid &&
+          job.item        == other_job.item &&
+          job.args        == other_job.args &&
+          job.queue       == other_job.queue &&
+          job.score       == other_job.score &&
+          job.parent.name == other_job.parent.name &&
+          job.parent.size == other_job.parent.size
+      end
+    end
+  end
+end

data/lib/sidekiq/undertaker/job_distributor.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "sidekiq/undertaker/bucket"
+
+module Sidekiq
+  module Undertaker
+    class JobDistributor
+      attr_reader :dead_jobs
+
+      def initialize(dead_jobs)
+        @dead_jobs = dead_jobs
+      end
+
+      def group_by_job_class
+        group_by(:job_class)
+      end
+
+      def group_by_error_class
+        group_by(:error_class)
+      end
+
+      private
+
+      def distribute
+        distribution = init_counters({}, "all")
+
+        dead_jobs.each do |dead_job|
+          bucket_name = dead_job.bucket_name
+
+          incr_counters(distribution, "all", bucket_name)
+          yield distribution, dead_job, bucket_name if block_given?
+        end
+
+        sort_by_total_dead(distribution)
+      end
+
+      def group_by(attribute)
+        distribute do |distribution, dead_job, bucket_name|
+          attr = dead_job.public_send(attribute)
+          init_counters(distribution, attr) unless distribution[attr]
+          incr_counters(distribution, attr, bucket_name)
+        end
+      end
+
+      def sort_by_total_dead(distribution)
+        distribution.map { |k, v| [k, v] }.sort do |x, y|
+          x[1]["total_dead"] <=> y[1]["total_dead"]
+        end.reverse
+      end
+
+      def init_counters(distribution, attr)
+        distribution[attr] = {}
+        Bucket.bucket_names.each { |bucket| distribution[attr][bucket] = 0 }
+        distribution[attr]["total_dead"] = 0
+        distribution
+      end
+
+      def incr_counters(distribution, attr, bucket_name, value = 1)
+        distribution[attr][bucket_name] += value
+        distribution[attr]["total_dead"] += value
+      end
+    end
+  end
+end