sidekiq-results 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ec1187a73de7c8ff64f9c71f21e002c45b826ec663dba4f1a95a01c44ff1912
+  data.tar.gz: cd5acd9460e127d64948aa0fab090d211f0bcb30817363d0065595391b77f316
+SHA512:
+  metadata.gz: f4bdde695f29a1278715ae1cb9f8bcd70bbdbf29a7b0de1a913bd8d593ea281637ca9d315390dd1521669f949ff66413383c4e89bee29490424e1c3f6d3c2239
+  data.tar.gz: 9b67f07f80503a4b016f94e44e6f75012a72ce0e3a5f613412ca1e4a709a20523f54df1f41e61bf17705b2739d6f06a39fb8eca132461330cf54af5e72fe25ee

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sidekiq-results.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    sidekiq-results (0.1.0)
+      sidekiq (>= 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    connection_pool (2.2.2)
+    diff-lcs (1.3)
+    rack (2.0.6)
+    rack-protection (2.0.5)
+      rack
+    rake (10.5.0)
+    redis (4.1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sidekiq (5.2.3)
+      connection_pool (~> 2.2, >= 2.2.2)
+      rack-protection (>= 1.5.0)
+      redis (>= 3.3.5, < 5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sidekiq-results!
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 ichi
+
+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,35 @@
+# Sidekiq::Results
+
+Results for sidekiq jobs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-results'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-results
+
+## Usage
+
+Open `Results` tab on your sidekiq web UI.
+
+## TODO
+
+- test
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ichi/sidekiq-results.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/results"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sidekiq/results.rb

@@ -0,0 +1,32 @@
+require 'sidekiq/web'
+require 'sidekiq/results/version'
+require 'sidekiq/results/result_set'
+require 'sidekiq/results/middleware'
+require 'sidekiq/results/web_extension'
+
+module Sidekiq
+
+  def self.results_max_count=(value)
+    @results_max_count = value
+  end
+
+  def self.results_max_count
+    return false if @results_max_count === false
+    @results_max_count ||= 1000
+  end
+
+  module Results
+    LIST_KEY = 'sidekiq:results'
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Results::Middleware
+  end
+end
+
+if defined?(Sidekiq::Web)
+  Sidekiq::Web.register Sidekiq::Results::WebExtension
+  Sidekiq::Web.tabs['Results'] = 'results'
+end

data/lib/sidekiq/results/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  Results: Results
+  NoResultsFound: No results found
+  StartedAt: Started At
+  FinishedAt: Finished At
+  Processor: Processor

data/lib/sidekiq/results/locales/ja.yml

@@ -0,0 +1,6 @@
+ja:
+  Results: 結果
+  NoResultsFound: 結果はありません
+  StartedAt: 開始日時
+  FinishedAt: 完了日時
+  Processor: Processor

data/lib/sidekiq/results/middleware.rb

@@ -0,0 +1,66 @@
+require 'sidekiq/util'
+
+module Sidekiq
+  module Results
+    class Middleware
+      include Sidekiq::Util
+
+      def call(worker, msg, queue)
+        data = {
+          queue: queue,
+          status: 'busy',
+          started_at: Time.now.utc.to_f,
+          processor: identity,
+        }
+
+        start = msg.merge(data).freeze
+        save_result(start)
+
+        yield
+      rescue => e
+        data.merge!(
+          status: 'failed',
+          error_class: e.class.name,
+          error_message: e.message,
+          error_backtrace: e.backtrace,
+        )
+
+        raise e
+      else
+        data.merge!(
+          status: 'processed',
+        )
+      ensure
+        data.merge!(
+          finished_at: Time.now.utc.to_f,
+        )
+
+        finish = msg.merge(data).freeze
+        remove_result(start)
+        save_result(finish)
+      end
+
+      private
+
+      def save_result(msg)
+        payload = Sidekiq.dump_json(msg)
+
+        Sidekiq.redis do |conn|
+          conn.zadd(LIST_KEY, msg[:started_at], payload)
+
+          unless Sidekiq.results_max_count == false
+            conn.zremrangebyrank(LIST_KEY, 0, -(Sidekiq.results_max_count + 1))
+          end
+        end
+      end
+
+      def remove_result(msg)
+        payload = Sidekiq.dump_json(msg)
+
+        Sidekiq.redis do |conn|
+          conn.zrem(LIST_KEY, payload)
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/results/result_set.rb

@@ -0,0 +1,9 @@
+module Sidekiq
+  module Results
+    class ResultSet < Sidekiq::JobSet
+      def initialize
+        super LIST_KEY
+      end
+    end
+  end
+end

data/lib/sidekiq/results/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Results
+    VERSION = "0.1.0"
+  end
+end

data/lib/sidekiq/results/views/index.html.erb

@@ -0,0 +1,71 @@
+<header class="row">
+  <div class="col-sm-5">
+    <h3><%= t('Results') %></h3>
+  </div>
+  <% if @results.size > 0 && @total_size > @count %>
+    <div class="col-sm-4">
+      <%= erb :_paging, :locals => { :url => "#{root_path}results" } %>
+    </div>
+  <% end %>
+  <%= filtering('results') if respond_to?(:filtering) %>
+</header>
+
+<% if @results.size > 0 %>
+  <form action="<%= root_path %>results" method="post">
+    <%= csrf_tag if respond_to?(:csrf_tag) %>
+    <table class="table table-striped table-bordered table-white">
+      <thead>
+        <tr>
+          <th width="20px" class="table-checkbox">
+            <label>
+              <input type="checkbox" class="check_all" />
+            </label>
+          </th>
+          <th><%= t('Status') %></th>
+          <th><%= t('Job') %></th>
+          <th><%= t('Arguments') %></th>
+          <th><%= t('StartedAt') %></th>
+          <th><%= t('FinishedAt') %></th>
+          <th><%= t('Time') %></th>
+          <th><%= t('Queue') %></th>
+          <th><%= t('Processor') %></th>
+          <th><%= t('Error') %></th>
+        </tr>
+      </thead>
+      <% @results.each do |entry| %>
+        <tr>
+          <td class="table-checkbox">
+            <label>
+              <input type='checkbox' name='key[]' value='<%= job_params(entry.item, entry.score) %>' />
+            </label>
+          </td>
+          <td><%= status_label(entry['status']) %></td>
+          <td><a href="<%= root_path %>results/<%= job_params(entry.item, entry.score) %>"><%= entry.display_class %></a></td>
+          <td><%= entry.display_args %></td>
+          <td><%= Time.at(entry['started_at']) %></td>
+          <td><%= entry['finished_at'] && Time.at(entry['finished_at']) %></td>
+          <td><%= entry['finished_at'] && (entry['finished_at'] - entry['started_at']).to_f.round(3) %></td>
+          <td><a href="<%= root_path %>queues/<%= entry.queue %>"><%= entry.queue %></a></td>
+          <td><%= entry['processor'] %></td>
+          <td><%= h entry['error_class'] %></td>
+        </tr>
+      <% end %>
+    </table>
+    <input class="btn btn-primary btn-xs pull-left" type="submit" name="retry" value="<%= t('RetryNow') %>" />
+    <input class="btn btn-danger btn-xs pull-left" type="submit" name="delete" value="<%= t('Delete') %>" />
+  </form>
+
+  <form action="<%= root_path %>results/all/delete" method="post">
+    <%= csrf_tag if respond_to?(:csrf_tag) %>
+    <input class="btn btn-danger btn-xs pull-right" type="submit" name="delete" value="<%= t('DeleteAll') %>" data-confirm="<%= t('AreYouSure') %>" />
+  </form>
+
+  <% if @results.size > 0 && @total_size > @count %>
+    <div class="col-sm-4">
+      <%= erb :_paging, :locals => { :url => "#{root_path}results" } %>
+    </div>
+  <% end %>
+
+<% else %>
+  <div class="alert alert-success"><%= t('NoResultsFound') %></div>
+<% end %>

data/lib/sidekiq/results/views/show.html.erb

@@ -0,0 +1,64 @@
+<%= erb :_job_info, locals: {job: @result, type: @result['retry_count'] ? :retry : nil} %>
+
+<header>
+  <h3><%= t('Extra') %></h3>
+</header>
+<table class="error table table-bordered table-striped">
+  <tbody>
+    <tr>
+      <th><%= t('Status') %></th>
+      <td><%= status_label(@result['status']) %></td>
+    </tr>
+    <tr>
+      <th><%= t('StartedAt') %></th>
+      <td><%= Time.at(@result['started_at']) %></td>
+    </tr>
+    <tr>
+      <th><%= t('FinishedAt') %></th>
+      <td><%= @result['finished_at'] && Time.at(@result['finished_at']) %></td>
+    </tr>
+    <tr>
+      <th><%= t('Time') %></th>
+      <td><%= @result['finished_at'] && (@result['finished_at'] - @result['started_at']).to_f.round(3) %></td>
+    </tr>
+    <tr>
+      <th><%= t('Processor') %></th>
+      <td><%= @result['processor'] %></td>
+    </tr>
+  </tbody>
+</table>
+
+<% if @result['error_class'] %>
+  <header>
+    <h3><%= t('Error') %></h3>
+  </header>
+  <table class="error table table-bordered table-striped">
+    <tbody>
+      <tr>
+        <th><%= t('ErrorClass') %></th>
+        <td>
+          <code><%= @result['error_class'] %></code>
+        </td>
+      </tr>
+      <tr>
+        <th><%= t('ErrorMessage') %></th>
+        <td><%= @result['error_message'] %></td>
+      </tr>
+      <% unless @result['error_backtrace'].nil? %>
+        <tr>
+          <th><%= t('ErrorBacktrace') %></th>
+          <td>
+            <code><%= @result['error_backtrace'].join("<br/>") %></code>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+<% end %>
+
+<form class="form-horizontal" action="<%= root_path %>results/<%= job_params(@result, @result.score) %>" method="post">
+  <%= csrf_tag if respond_to?(:csrf_tag) %>
+  <a class="btn" href="<%= root_path %>results"><%= t('GoBack') %></a>
+  <input class="btn btn-primary" type="submit" name="retry" value="<%= t('RetryNow') %>" />
+  <input class="btn btn-danger" type="submit" name="delete" value="<%= t('Delete') %>" />
+</form>

data/lib/sidekiq/results/web_extension.rb

@@ -0,0 +1,76 @@
+module Sidekiq
+  module Results
+    class WebExtension
+      def self.registered(app)
+        view_path = File.join(File.expand_path("..", __FILE__), "views")
+        locale_path = File.expand_path(File.dirname(__FILE__) + '/locales')
+
+        Sidekiq::Web.settings.locales << locale_path
+
+        app.helpers do
+          def status_label(status)
+            labels = {
+              'busy' => '▶',
+              'processed' => '✅',
+              'failed' => '❌',
+            }
+            labels[status]
+          end
+        end
+
+        app.get '/results' do
+          @count = (params[:count] || 25).to_i
+          (@current_page, @total_size, @results) = page(LIST_KEY, params[:page], @count, reverse: true)
+          @results = @results.map { |msg, score| Sidekiq::SortedEntry.new(nil, score, msg) }
+
+          render(:erb, File.read(File.join(view_path, 'index.html.erb')))
+        end
+
+        app.post '/results' do
+          redirect("#{root_path}results") unless params['key']
+
+          params['key'].each do |key|
+            job = @result = ResultSet.new.fetch(*parse_params(params['key'])).first
+            retry_or_delete_or_kill job, params if job
+          end
+
+          redirect_with_query("#{root_path}morgue")
+        end
+
+        app.get '/results/:key' do
+          halt 404 unless params['key']
+
+          @result = ResultSet.new.fetch(*parse_params(params['key'])).first
+          redirect("#{root_path}results") unless @result
+
+          render(:erb, File.read(File.join(view_path, 'show.html.erb')))
+        end
+
+        app.post "/results/:key" do
+          halt 404 unless params['key']
+
+          job = ResultSet.new.fetch(*parse_params(params['key'])).first
+          retry_or_delete_or_kill job, params if job
+          redirect_with_query("#{root_path}results")
+        end
+
+        app.post "/results/all/delete" do
+          ResultSet.new.clear
+          redirect "#{root_path}results"
+        end
+
+        app.get '/filter/results' do
+          redirect "#{root_path}results"
+        end
+
+        app.post '/filter/results' do
+          @results = Sidekiq::Failures::FailureSet.new.scan("*#{params[:substr]}*")
+          @current_page = 1
+          @count = @total_size = @results.size
+
+          render(:erb, File.read(File.join(view_path, 'index.html.erb')))
+        end
+      end
+    end
+  end
+end

data/sidekiq-results.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sidekiq/results/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-results"
+  spec.version       = Sidekiq::Results::VERSION
+  spec.authors       = ["ichi"]
+  spec.email         = ["ichi.ttht.1@gmail.com"]
+
+  spec.summary       = %q{Results for sidekiq jobs.}
+  spec.description   = %q{Results for sidekiq jobs.}
+  spec.homepage      = "https://github.com/ichi/sidekiq-results"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sidekiq", ">= 5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-results
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ichi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Results for sidekiq jobs.
+email:
+- ichi.ttht.1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidekiq/results.rb
+- lib/sidekiq/results/locales/en.yml
+- lib/sidekiq/results/locales/ja.yml
+- lib/sidekiq/results/middleware.rb
+- lib/sidekiq/results/result_set.rb
+- lib/sidekiq/results/version.rb
+- lib/sidekiq/results/views/index.html.erb
+- lib/sidekiq/results/views/show.html.erb
+- lib/sidekiq/results/web_extension.rb
+- sidekiq-results.gemspec
+homepage: https://github.com/ichi/sidekiq-results
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Results for sidekiq jobs.
+test_files: []