sidekiq-restart 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80063a8294300dc8b0ff7b3523b9ff573d84f7f5
+  data.tar.gz: 22b2fab8f1b3f69181ecaf0e7367feef0defd5b9
+SHA512:
+  metadata.gz: 71738950003b0db441995bb3e7e21d1559e36dce51278d9f46260bd9b8e515e119b99f856f1f948e8f83c53b6ca7adbbfcb0006ec09e199169d44e44c11f5f24
+  data.tar.gz: 30b30b5043b2ba986fb9fc02392750e0f3acb0ccecee1bb68394a0cbaf56b4048289b6d07582d67b610c2476d9c5bd633f6f28de18ca3b949c40c5cfa971b656

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+pkg
+/tmp

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+-I ./lib
+-r spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sidekiq-restart.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jon Rowe
+
+MIT License
+
+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,33 @@
+# Sidekiq::Restart
+
+Restart workers for Sidekiq via the web interface.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sidekiq-restart'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-restart
+
+## Usage
+
+Wherever you mount `Sidekiq::Web`
+
+```Ruby
+require 'sidekiq/restart'
+```
+
+## Contributing
+
+1. Fork it
+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

data/Rakefile

@@ -0,0 +1,16 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc "Run tests"
+  RSpec::Core::RakeTask.new do |t|
+    t.ruby_opts = %w[-w]
+  end
+
+  task default: %w[spec]
+
+rescue LoadError
+  puts "RSpec Unavailable"
+end

data/lib/sidekiq-restart.rb

@@ -0,0 +1 @@
+require "sidekiq/restart"

data/lib/sidekiq/restart.rb

@@ -0,0 +1,22 @@
+require "sidekiq/restart/version"
+require "sidekiq/restart/command"
+require "sidekiq/restart/web_extension"
+
+begin
+  require "sinatra"
+  require "sidekiq/web"
+
+  Sidekiq::Web.register Sidekiq::Restart::WebExtension
+rescue LoadError
+  # client-only usage
+end
+
+module Sidekiq
+  module Restart
+    module_function
+
+    def worker id
+      Command.new(Sidekiq).run id
+    end
+  end
+end

data/lib/sidekiq/restart/command.rb

@@ -0,0 +1,26 @@
+module Sidekiq
+  module Restart
+    class Command
+
+      def initialize sidekiq
+        @sidekiq = sidekiq
+      end
+
+      def run id
+        @sidekiq.redis do |conn|
+          payload = conn.get("worker:#{id}")
+          if payload
+            msg = @sidekiq.load_json(payload)['payload']
+            Sidekiq::Client.push msg
+
+            # cleanup redis details about the worker
+            conn.srem("workers", id)
+            conn.del("worker:#{id}")
+            conn.del("worker:#{id}:started")
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/sidekiq/restart/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Restart
+    VERSION = "0.0.1"
+  end
+end

data/lib/sidekiq/restart/web_extension.rb

@@ -0,0 +1,23 @@
+module Sidekiq
+  module Restart
+    module WebExtension
+
+      def self.registered(app)
+        app.use Rack::MethodOverride
+
+        app.helpers do
+          def find_template(sidekiq_views, name, engine, &block)
+            view_path = File.join(File.expand_path("../../../../web", __FILE__), "views")
+            super(view_path, name, engine, &block)
+            super(sidekiq_views, name, engine, &block)
+          end
+        end
+
+        app.delete "/workers/:id" do |id|
+          Restart.worker id
+          redirect "#{root_path}workers", 301
+        end
+      end
+    end
+  end
+end

data/sidekiq-restart.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/restart/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-restart"
+  spec.version       = Sidekiq::Restart::VERSION
+  spec.authors       = ["Jon Rowe"]
+  spec.email         = ["hello@jonrowe.co.uk"]
+  spec.license       = "MIT"
+  spec.description   = %q{Allows manual restarts of Sidekiq workers.}
+  spec.summary       = %q{Allows manual restarts of Sidekiq workers via the Web UI.}
+  spec.homepage      = "https://github.com/JonRowe/sidekiq-restart/"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sidekiq", "~> 2.17.2"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "sinatra"
+  spec.add_development_dependency "rspec",   "~> 3.0.0.beta1"
+end

data/spec/integration/sidekiq_web_integration_spec.rb

@@ -0,0 +1,62 @@
+require 'rack/test'
+require 'logger'
+
+describe "integrating with sidekiq web", type: :integration do
+  include Rack::Test::Methods
+
+  before :all do
+    require 'sidekiq/restart'
+    require 'sidekiq/testing'
+    Sidekiq.logger = Logger.new(nil)
+    Sidekiq::Testing.disable!
+  end
+
+  let(:app) do
+    Sidekiq::Web
+  end
+
+  it "overrides the workers index" do
+    get '/workers'
+
+    expect(last_response).to be_ok
+    expect(last_response.body).to match '<th>Controls</th>'
+  end
+
+  context "when there are stuck workers" do
+    before do
+      hash = { queue: 'test', payload: { class: Class, args: [], queue: 'test' }, run_at: Time.now.to_i }
+      Sidekiq.redis do |conn|
+        conn.del 'queue:test'
+        conn.sadd('workers', 'my_id')
+        conn.set("worker:my_id:started", Time.now.to_s)
+        conn.set("worker:my_id", Sidekiq.dump_json(hash))
+      end
+    end
+
+    it "allows the developer to restart workers" do
+      get '/workers'
+
+      expect(last_response).to be_ok
+      expect(last_response.body).to match(
+        %r%<form action="/workers/my_id" [^>]*>.*<button[^>]*>Restart</button>.*</form>%m
+      )
+    end
+
+    it "will restart a stuck job" do
+      delete "/workers/my_id"
+      expect(last_response).to be_redirect
+      expect(last_response.location).to eq 'http://example.org/workers'
+      Sidekiq.redis do |conn|
+        expect(conn.llen('queue:test')).to eq 1
+      end
+    end
+  end
+
+  context "when there are no stuck workers" do
+    it "is idemoptent against non existant jobs" do
+      delete "/workers/my_id"
+      expect(last_response).to be_redirect
+      expect(last_response.location).to eq 'http://example.org/workers'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+#loaded by .rspec
+
+RSpec.configure do |config|
+  config.register_ordering :global do |examples|
+    unit, integration = examples.partition { |example| example.metadata[:type] != :integration }
+    unit.shuffle + integration.shuffle
+  end
+end

data/spec/unit/sidekiq/restart/command_spec.rb

@@ -0,0 +1,56 @@
+require 'sidekiq/restart/command'
+
+describe "Sidekiq::Restart::Command" do
+  let(:sidekiq) { double "Sidekiq" }
+  let(:command) { Sidekiq::Restart::Command.new sidekiq }
+
+  describe '#run' do
+    let(:id)    { "my_id" }
+
+    before do
+      allow(sidekiq).to receive(:redis).and_yield(redis)
+    end
+
+    context "theres a worker with id" do
+      let(:redis) { instance_double "Redis", get: json, del: nil, srem: nil }
+      let(:data)  { { 'payload' => msg } }; let(:json) { double }; let(:msg) { double }
+
+      before do
+        class_double("Sidekiq::Client", push: nil).as_stubbed_const
+        allow(sidekiq).to receive(:load_json).and_return(data)
+      end
+
+      it 'uses sidekiqs redis instance' do
+        expect(sidekiq).to receive(:redis).and_yield(redis)
+        command.run id
+      end
+
+      it 'retrieves the job details' do
+        expect(redis).to receive(:get).with("worker:my_id")
+        expect(sidekiq).to receive(:load_json).with(json)
+        command.run id
+      end
+
+      it 'requeues the job' do
+        expect(Sidekiq::Client).to receive(:push).with(msg)
+        command.run id
+      end
+
+      it 'cleans up the old worker details' do
+        expect(redis).to receive(:srem).with("workers", id)
+        expect(redis).to receive(:del).with("worker:my_id")
+        expect(redis).to receive(:del).with("worker:my_id:started")
+        command.run id
+      end
+    end
+
+    context "no such worker exists" do
+      let(:redis) { instance_double "Redis", get: nil }
+
+      it 'uses sidekiqs redis instance' do
+        expect(sidekiq).to receive(:redis).and_yield(redis)
+        command.run id
+      end
+    end
+  end
+end

data/web/views/index.erb

@@ -0,0 +1,51 @@
+<div class="row header">
+  <div class="col-sm-7">
+    <h3><%= t('Workers') %></h3>
+  </div>
+</div>
+
+<table class="workers table table-hover table-bordered table-striped table-white">
+  <thead>
+    <th><%= t('Worker') %></th>
+    <th><%= t('Queue') %></th>
+    <th><%= t('Class') %></th>
+    <th><%= t('Arguments') %></th>
+    <th><%= t('Started') %></th>
+    <th><%= t('Controls') %></th>
+  </thead>
+  <% workers.each_with_index do |(worker, msg), index| %>
+    <tr>
+      <td><%= worker %></td>
+      <td>
+        <a href="<%= root_path %>queues/<%= msg['queue'] %>"><%= msg['queue'] %></a>
+      </td>
+
+      <td><%= msg['payload']['class'] %></td>
+      <td>
+        <% if msg['payload']['args'].to_s.size > 100 %>
+          <%= h(msg['payload']['args'].inspect[0..100]) + "... " %>
+          <button data-toggle="collapse" data-target="#worker_<%= index %>" class="btn btn-default btn-xs"><%= t('ShowAll') %></button>
+          <div class="toggle" id="worker_<%= index %>" style="display: none;max-width: 750px;"><%= h(msg['payload']['args']) %></div>
+        <% else %>
+          <%= h(msg['payload']['args']) %>
+        <% end %>
+      </td>
+      <td><%= relative_time(msg['run_at'].is_a?(Numeric) ? Time.at(msg['run_at']) : Time.parse(msg['run_at'])) %></td>
+      <td>
+        <form action="<%= root_path %>workers/<%= worker %>" method="post">
+          <input name="_method" type="hidden" value="delete" />
+          <button class="btn btn-primary btn-block" type="submit">Restart</button>
+        </form>
+      </td>
+    </tr>
+  <% end %>
+</table>
+<% if workers_size > 0 %>
+  <div class="row">
+    <div class="col-sm-2 pull-right">
+      <form action="<%= root_path %>reset" method="post">
+        <button class="btn btn-primary btn-block" type="submit"><%= t('ClearWorkerList') %></button>
+      </form>
+    </div>
+  </div>
+<% end %>

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-restart
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jon Rowe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.17.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.17.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rack-test
+  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: sinatra
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+description: Allows manual restarts of Sidekiq workers.
+email:
+- hello@jonrowe.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq-restart.rb
+- lib/sidekiq/restart.rb
+- lib/sidekiq/restart/command.rb
+- lib/sidekiq/restart/version.rb
+- lib/sidekiq/restart/web_extension.rb
+- sidekiq-restart.gemspec
+- spec/integration/sidekiq_web_integration_spec.rb
+- spec/spec_helper.rb
+- spec/unit/sidekiq/restart/command_spec.rb
+- web/views/index.erb
+homepage: https://github.com/JonRowe/sidekiq-restart/
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Allows manual restarts of Sidekiq workers via the Web UI.
+test_files:
+- spec/integration/sidekiq_web_integration_spec.rb
+- spec/spec_helper.rb
+- spec/unit/sidekiq/restart/command_spec.rb