sidekiq-throttled 0.6.7 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec534fed2e493758df139b6245cf1f9e657c2e18
-  data.tar.gz: 3de82b6c63e63e59a7c14c47683b9a9bff3dd912
+  metadata.gz: cc5eb064ad2211b8e21d3a5936b953d68174545a
+  data.tar.gz: 90107848a47f41d73d2646d82a8a6c5c013cad20
 SHA512:
-  metadata.gz: cb31fced1ceae5050599471b39cbe8eedd7285bab72b77923fc471e4104eb1fdb85b7631622917ce423d3440abf06953123f289ce9d1917d1a33446beb39f3d2
-  data.tar.gz: eb34237d9b64bb9c3cc4b6a9d33dc79d439b7990e84a59d63a999361eed857eda4cdf100831fd6e1e1f944d118d7dda504c98980d7bc33aaeafe0c01af3bcefd
+  metadata.gz: f4471f6d39fa2e29071f6b66fa256e257040c61192b8110e6ef1bc15fd15e93e5b7318250b0f5c76259974c407278490069b9e6ed541f83ab0ce83218ffaf957
+  data.tar.gz: 4f53ef0e1b5c7cf1a2ba0a1c973525aa4a4ef0cb40809b08435d5d7403cee52664cf685ee0c8b61711573763913e89cc74c09136d65d2b173a560caf4c580dbe

data/.gitignore

@@ -8,3 +8,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.byebug_history

data/CHANGES.md

@@ -1,3 +1,10 @@
+## 0.7.0 (2017-03-22)
+
+* Expose pause/resume queues hidden feature to UI. This was available via API
+  since v0.6.0 and today it's finally got it's UI.
+  ([@ixti])
+
+
 ## 0.6.7 (2017-03-21)
 
 * Fix fetcher causing workers starvation upon low concurrency thresholds.

data/Gemfile

@@ -10,12 +10,14 @@ gem "rubocop", "~> 0.47.0", :require => false
 gem "sidekiq"
 
 group :development do
+  gem "byebug"
   gem "guard",         :require => false
   gem "guard-rspec",   :require => false
   gem "guard-rubocop", :require => false
 end
 
 group :test do
+  gem "capybara"
   gem "coveralls", :require => false
   gem "rack-test"
   gem "simplecov", ">= 0.9"

data/README.md

@@ -117,6 +117,39 @@ if you are using dynamic limit/period options. Otherwise you risk getting into
 some trouble.
 
 
+## Enhanced Queues list
+
+This gem provides ability to pause/resume queues from processing by workers.
+So you may simply pause particular queue without need to stop and reconfigure
+workers by simply pushing a button on sidekiq web UI.
+
+By default we add *Enhanced Queues* tab with this functionality. But if you
+want you can override default *Queues* tab completely (notice that page will
+still be available using it's URL, but tab will be pointing enhanced version).
+To do so, just call `Sidekiq::Throttled::Web.enhance_queues_tab!` somewhere
+in your initializer/bootstrap code. If you are using rails, you might want to
+add it right into your `config/routes.rb` file:
+
+``` ruby
+# file config/routes.rb
+
+require "sidekiq/web"
+require "sidekiq/throttled/web"
+
+Rails.application.routes.draw do
+  # ...
+
+  # Replace Sidekiq Queues with enhanced version!
+  Sidekiq::Throttled::Web.enhance_queues_tab!
+
+  # Mount Sidekiq Web UI to `/sidekiq` endpoint
+  mount Sidekiq::Web => "/sidekiq"
+
+  # ...
+end
+```
+
+
 ## Supported Ruby Versions
 
 This library aims to support and is [tested against][travis] the following Ruby

data/gemfiles/sidekiq_4.0.gemfile

@@ -10,12 +10,14 @@ gem "rubocop", "~> 0.47.0", :require => false
 gem "sidekiq", "~> 4.0.0"
 
 group :development do
+  gem "byebug"
   gem "guard", :require => false
   gem "guard-rspec", :require => false
   gem "guard-rubocop", :require => false
 end
 
 group :test do
+  gem "capybara"
   gem "coveralls", :require => false
   gem "rack-test"
   gem "simplecov", ">= 0.9"

data/gemfiles/sidekiq_4.1.gemfile

@@ -10,12 +10,14 @@ gem "rubocop", "~> 0.47.0", :require => false
 gem "sidekiq", "~> 4.1.0"
 
 group :development do
+  gem "byebug"
   gem "guard", :require => false
   gem "guard-rspec", :require => false
   gem "guard-rubocop", :require => false
 end
 
 group :test do
+  gem "capybara"
   gem "coveralls", :require => false
   gem "rack-test"
   gem "simplecov", ">= 0.9"

data/gemfiles/sidekiq_4.2.gemfile

@@ -10,12 +10,14 @@ gem "rubocop", "~> 0.47.0", :require => false
 gem "sidekiq", "~> 4.2.0"
 
 group :development do
+  gem "byebug"
   gem "guard", :require => false
   gem "guard-rspec", :require => false
   gem "guard-rubocop", :require => false
 end
 
 group :test do
+  gem "capybara"
   gem "coveralls", :require => false
   gem "rack-test"
   gem "simplecov", ">= 0.9"

data/lib/sidekiq/throttled.rb

@@ -58,21 +58,6 @@ module Sidekiq
         end
       end
 
-      # (see QueuesPauser#pause!)
-      def pause!(queue)
-        QueuesPauser.instance.pause!(queue)
-      end
-
-      # (see QueuesPauser#resume!)
-      def resume!(queue)
-        QueuesPauser.instance.resume!(queue)
-      end
-
-      # (see QueuesPauser#paused_queues)
-      def paused_queues
-        QueuesPauser.instance.paused_queues
-      end
-
       # Tells whenever job is throttled or not.
       #
       # @param [String] message Job's JSON payload

data/lib/sidekiq/throttled/patches/queue.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Throttled
+    module Patches
+      module Queue
+        def paused?
+          QueuesPauser.instance.paused? name
+        end
+
+        def self.apply!
+          require "sidekiq/api"
+          ::Sidekiq::Queue.send(:prepend, self)
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/throttled/queues_pauser.rb

@@ -3,6 +3,7 @@
 require "set"
 require "singleton"
 
+require "sidekiq/throttled/patches/queue"
 require "sidekiq/throttled/communicator"
 require "sidekiq/throttled/queue_name"
 
@@ -45,6 +46,8 @@ module Sidekiq
       # @private
       # @return [void]
       def setup!
+        Patches::Queue.apply!
+
         Sidekiq.configure_server do
           @communicator.receive PAUSE_MESSAGE do |queue|
             @paused_queues << QueueName.expand(queue)
@@ -88,6 +91,15 @@ module Sidekiq
         end
       end
 
+      # Checks if given `queue` is paused.
+      #
+      # @param queue [#to_s]
+      # @return [Boolean]
+      def paused?(queue)
+        queue = QueueName.normalize queue.to_s
+        Sidekiq.redis { |conn| conn.sismember(PAUSED_QUEUES, queue) }
+      end
+
       # Resumes given `queue`.
       #
       # @param [#to_s] queue

data/lib/sidekiq/throttled/version.rb

@@ -3,6 +3,6 @@
 module Sidekiq
   module Throttled
     # Gem version
-    VERSION = "0.6.7"
+    VERSION = "0.7.0"
   end
 end

data/lib/sidekiq/throttled/web.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # stdlib
 require "pathname"
 
@@ -13,19 +14,64 @@ require "sidekiq/throttled/web/stats"
 module Sidekiq
   module Throttled
     # Provides Sidekiq tab to monitor and reset throttled stats.
-    #
-    # @private
     module Web
+      VIEWS         = Pathname.new(__dir__).join("web")
+      THROTTLED_TPL = VIEWS.join("throttled.html.erb").read.freeze
+      QUEUES_TPL    = VIEWS.join("queues.html.erb").read.freeze
+
       class << self
+        # Replace default Queues tab with enhanced one.
+        def enhance_queues_tab!
+          Sidekiq::Web::DEFAULT_TABS["Queues"] = "enhanced-queues"
+          Sidekiq::Web.tabs.delete("Enhanced Queues")
+        end
+
+        # Restore original Queues tab.
+        #
+        # @api There's next to absolutely no value in this method for real
+        #   users. The only it's purpose is to restore virgin state in specs.
+        def restore_queues_tab!
+          Sidekiq::Web::DEFAULT_TABS["Queues"] = "queues"
+          Sidekiq::Web.tabs["Enhanced Queues"] = "enhanced-queues"
+        end
+
+        # @api private
         def registered(app)
-          template = Pathname.new(__FILE__).join("../web/index.html.erb").read
-          app.get("/throttled") { erb template.dup }
+          register_throttled_tab app
+          register_enhanced_queues_tab app
+        end
+
+        private
+
+        def register_throttled_tab(app)
+          app.get("/throttled") { erb THROTTLED_TPL.dup }
 
           app.delete("/throttled/:id") do
             Registry.get(params[:id], &:reset!)
             redirect "#{root_path}throttled"
           end
         end
+
+        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        def register_enhanced_queues_tab(app)
+          pauser = QueuesPauser.instance
+
+          app.get("/enhanced-queues") do
+            @queues = Sidekiq::Queue.all
+            erb QUEUES_TPL.dup
+          end
+
+          app.post("/enhanced-queues/:name") do
+            case params[:action]
+            when "delete" then Sidekiq::Queue.new(params[:name]).clear
+            when "pause"  then pauser.pause!(params[:name])
+            else               pauser.resume!(params[:name])
+            end
+
+            redirect "#{root_path}enhanced-queues"
+          end
+        end
+        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
       end
     end
   end
@@ -33,3 +79,4 @@ end
 
 Sidekiq::Web.register Sidekiq::Throttled::Web
 Sidekiq::Web.tabs["Throttled"] = "throttled"
+Sidekiq::Web.tabs["Enhanced Queues"] = "enhanced-queues"

data/lib/sidekiq/throttled/web/queues.html.erb

@@ -0,0 +1,49 @@
+<h3><%= t('Queues') %></h3>
+
+<div class="table_container">
+  <table class="queues table table-hover table-bordered table-striped table-white">
+    <thead>
+      <th><%= t('Queue') %></th>
+      <th><%= t('Size') %></th>
+      <th><%= t('Actions') %></th>
+    </thead>
+    <% @queues.each do |queue| %>
+      <tr>
+        <td>
+          <a href="<%= root_path %>queues/<%= CGI.escape(queue.name) %>"><%= queue.name %></a>
+        </td>
+        <td><%= number_with_delimiter(queue.size) %> </td>
+        <td width="20%">
+          <form action="<%=root_path %>enhanced-queues/<%= CGI.escape(queue.name) %>" method="post" style="display:inline">
+            <%= csrf_tag %>
+            <% if queue.paused? %>
+              <button class="btn btn-primary btn-pauser-resume btn-xs" type="submit" name="action" value="resume">Resume</button>
+            <% else %>
+              <button class="btn btn-danger btn-pauser-pause btn-xs" type="submit" name="action" value="pause">Pause</button>
+            <% end %>
+
+            <button class="btn btn-danger btn-xs" type="submit" name="action" value="delete" data-confirm="<%= t('AreYouSureDeleteQueue', :queue => h(queue.name)) %>"><%= t('Delete') %></button>
+          </form>
+        </td>
+      </tr>
+    <% end %>
+  </table>
+</div>
+
+<style>
+.btn-pauser-pause {
+  background-image: -webkit-gradient(linear, 50% 0%, 50% 100%, color-stop(0%, #b13e00), color-stop(100%, #983500));
+  background-image: -webkit-linear-gradient(#b13e00, #983500);
+  background-image: -moz-linear-gradient(#b13e00, #983500);
+  background-image: -o-linear-gradient(#b13e00, #983500);
+  background-image: linear-gradient(#b13e00, #983500);
+}
+
+.btn-pauser-resume {
+  background-image: -webkit-gradient(linear, 50% 0%, 50% 100%, color-stop(0%, #00b13e), color-stop(100%, #009835));
+  background-image: -webkit-linear-gradient(#00b13e, #009835);
+  background-image: -moz-linear-gradient(#00b13e, #009835);
+  background-image: -o-linear-gradient(#00b13e, #009835);
+  background-image: linear-gradient(#00b13e, #009835);
+}
+</style>

data/lib/sidekiq/throttled/web/{index.html.erb → throttled.html.erb}

@@ -1,21 +1,15 @@
-<div class="col-sm-12">
-  <div class="row header">
-    <div class="col-sm-8 pull-left">
-      <h3>Throttled</h3>
-    </div>
-  </div>
-</div>
+<h3>Throttled</h3>
 
-<table class="table table-hover table-bordered table-striped table-white">
-  <thead>
-    <tr>
-      <th>Name</th>
-      <th style="text-align:center;">Concurrency</th>
-      <th style="text-align:center;">Threshold</th>
-      <th></th>
-    </tr>
-  </thead>
-  <tbody>
+<div class="table_container">
+  <table class="table table-hover table-bordered table-striped table-white">
+    <thead>
+      <tr>
+        <th>Name</th>
+        <th style="text-align:center;">Concurrency</th>
+        <th style="text-align:center;">Threshold</th>
+        <th style="text-align:center;">Actions</th>
+      </tr>
+    </thead>
     <% Sidekiq::Throttled::Registry.each_with_static_keys do |name, strategy| %>
       <tr>
         <td style="vertical-align:middle;"><%= name %></td>
@@ -26,7 +20,7 @@
           <%= Sidekiq::Throttled::Web::Stats.new(strategy.threshold).to_html %>
         </td>
         <td style="vertical-align:middle;text-align:center;">
-          <form action="<%= root_path %>throttled/<%= name %>" method="POST">
+          <form action="<%= root_path %>throttled/<%= CGI.escape name %>" method="post">
             <%= csrf_tag %>
             <input type="hidden" name="_method" value="delete" />
             <button class="btn btn-danger" type="submit">Reset</button>
@@ -34,5 +28,5 @@
         </td>
       </tr>
     <% end %>
-  </tbody>
-</table>
+  </table>
+</div>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-throttled
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 0.7.0
 platform: ruby
 authors:
 - Alexey V Zapparov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-20 00:00:00.000000000 Z
+date: 2017-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -71,6 +71,7 @@ files:
 - lib/sidekiq/throttled/fetch.rb
 - lib/sidekiq/throttled/fetch/unit_of_work.rb
 - lib/sidekiq/throttled/middleware.rb
+- lib/sidekiq/throttled/patches/queue.rb
 - lib/sidekiq/throttled/queue_name.rb
 - lib/sidekiq/throttled/queues_pauser.rb
 - lib/sidekiq/throttled/registry.rb
@@ -83,8 +84,9 @@ files:
 - lib/sidekiq/throttled/testing.rb
 - lib/sidekiq/throttled/version.rb
 - lib/sidekiq/throttled/web.rb
-- lib/sidekiq/throttled/web/index.html.erb
+- lib/sidekiq/throttled/web/queues.html.erb
 - lib/sidekiq/throttled/web/stats.rb
+- lib/sidekiq/throttled/web/throttled.html.erb
 - lib/sidekiq/throttled/worker.rb
 - sidekiq-throttled.gemspec
 homepage: https://github.com/sensortower/sidekiq-throttled
@@ -107,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Concurrency and threshold throttling for Sidekiq.