sidekiq 6.1.2 → 6.2.1

data/lib/sidekiq/web/action.rb

@@ -15,7 +15,7 @@ module Sidekiq
     end
 
     def halt(res)
-      throw :halt, res
+      throw :halt, [res, {"Content-Type" => "text/plain"}, [res.to_s]]
     end
 
     def redirect(location)

data/lib/sidekiq/web/application.rb

@@ -4,7 +4,6 @@ module Sidekiq
   class WebApplication
     extend WebRouter
 
-    CONTENT_LENGTH = "Content-Length"
     REDIS_KEYS = %w[redis_version uptime_in_days connected_clients used_memory_human used_memory_peak_human]
     CSP_HEADER = [
       "default-src 'self' https: http:",
@@ -42,6 +41,13 @@ module Sidekiq
       # nothing, backwards compatibility
     end
 
+    head "/" do
+      # HEAD / is the cheapest heartbeat possible,
+      # it hits Redis to ensure connectivity
+      Sidekiq.redis { |c| c.llen("queue:default") }
+      ""
+    end
+
     get "/" do
       @redis_info = redis_info.select { |k, v| REDIS_KEYS.include? k }
       stats_history = Sidekiq::Stats::History.new((params["days"] || 30).to_i)
@@ -76,10 +82,12 @@ module Sidekiq
       erb(:queues)
     end
 
+    QUEUE_NAME = /\A[a-z_:.\-0-9]+\z/i
+
     get "/queues/:name" do
       @name = route_params[:name]
 
-      halt(404) unless @name
+      halt(404) if !@name || @name !~ QUEUE_NAME
 
       @count = (params["count"] || 25).to_i
       @queue = Sidekiq::Queue.new(@name)
@@ -316,7 +324,7 @@ module Sidekiq
     end
 
     def self.helpers(mod = nil, &block)
-      if block_given?
+      if block
         WebAction.class_eval(&block)
       else
         WebAction.send(:include, mod)

data/lib/sidekiq/web/csrf_protection.rb

@@ -66,7 +66,31 @@ module Sidekiq
       end
 
       def session(env)
-        env["rack.session"] || fail("you need to set up a session middleware *before* #{self.class}")
+        env["rack.session"] || fail(<<~EOM)
+          Sidekiq::Web needs a valid Rack session for CSRF protection. If this is a Rails app,
+          make sure you mount Sidekiq::Web *inside* your application routes:
+
+
+          Rails.application.routes.draw do
+            mount Sidekiq::Web => "/sidekiq"
+            ....
+          end
+
+
+          If this is a Rails app in API mode, you need to enable sessions.
+
+            https://guides.rubyonrails.org/api_app.html#using-session-middlewares
+
+          If this is a bare Rack app, use a session middleware before Sidekiq::Web:
+
+            # first, use IRB to create a shared secret key for sessions and commit it
+            require 'securerandom'; File.open(".session.key", "w") {|f| f.write(SecureRandom.hex(32)) }
+
+            # now use the secret with a session cookie middleware
+            use Rack::Session::Cookie, secret: File.read(".session.key"), same_site: true, max_age: 86400
+            run Sidekiq::Web
+
+        EOM
       end
 
       def accept?(env)
@@ -90,13 +114,11 @@ module Sidekiq
         end
 
         sess = session(env)
-
-        # Checks that Rack::Session::Cookie did not return empty session
-        # object in case the digest verification failed
-        return false if sess.empty?
-
         localtoken = sess[:csrf]
 
+        # Checks that Rack::Session::Cookie actualy contains the csrf toekn
+        return false if localtoken.nil?
+
         # Rotate the session token after every use
         sess[:csrf] = SecureRandom.base64(TOKEN_LENGTH)
 

data/lib/sidekiq/web/helpers.rb

@@ -22,6 +22,14 @@ module Sidekiq
       end
     end
 
+    def singularize(str, count)
+      if count == 1 && str.respond_to?(:singularize) # rails
+        str.singularize
+      else
+        str
+      end
+    end
+
     def clear_caches
       @strings = nil
       @locale_files = nil
@@ -158,8 +166,7 @@ module Sidekiq
 
     def redis_connection
       Sidekiq.redis do |conn|
-        c = conn.connection
-        "redis://#{c[:location]}/#{c[:db]}"
+        conn.connection[:id]
       end
     end
 
@@ -258,7 +265,21 @@ module Sidekiq
       end
     end
 
+    def format_memory(rss_kb)
+      return "0" if rss_kb.nil? || rss_kb == 0
+
+      if rss_kb < 100_000
+        "#{number_with_delimiter(rss_kb)} KB"
+      elsif rss_kb < 10_000_000
+        "#{number_with_delimiter((rss_kb / 1024.0).to_i)} MB"
+      else
+        "#{number_with_delimiter((rss_kb / (1024.0 * 1024.0)).round(1))} GB"
+      end
+    end
+
     def number_with_delimiter(number)
+      return "" if number.nil?
+
       begin
         Float(number)
       rescue ArgumentError, TypeError

data/lib/sidekiq/web/router.rb

@@ -15,6 +15,10 @@ module Sidekiq
     REQUEST_METHOD = "REQUEST_METHOD"
     PATH_INFO = "PATH_INFO"
 
+    def head(path, &block)
+      route(HEAD, path, &block)
+    end
+
     def get(path, &block)
       route(GET, path, &block)
     end
@@ -39,7 +43,6 @@ module Sidekiq
       @routes ||= {GET => [], POST => [], PUT => [], PATCH => [], DELETE => [], HEAD => []}
 
       @routes[method] << WebRoute.new(method, path, block)
-      @routes[HEAD] << WebRoute.new(method, path, block) if method == GET
     end
 
     def match(env)

data/sidekiq.gemspec

@@ -5,15 +5,23 @@ Gem::Specification.new do |gem|
   gem.email = ["mperham@gmail.com"]
   gem.summary = "Simple, efficient background processing for Ruby"
   gem.description = "Simple, efficient background processing for Ruby."
-  gem.homepage = "http://sidekiq.org"
+  gem.homepage = "https://sidekiq.org"
   gem.license = "LGPL-3.0"
 
   gem.executables = ["sidekiq", "sidekiqmon"]
-  gem.files = `git ls-files | grep -Ev '^(test|myapp|examples)'`.split("\n")
+  gem.files = ["sidekiq.gemspec", "README.md", "Changes.md", "LICENSE"] + `git ls-files | grep -E '^(bin|lib|web)'`.split("\n")
   gem.name = "sidekiq"
   gem.version = Sidekiq::VERSION
   gem.required_ruby_version = ">= 2.5.0"
 
+  gem.metadata = {
+    "homepage_uri" => "https://sidekiq.org",
+    "bug_tracker_uri" => "https://github.com/mperham/sidekiq/issues",
+    "documentation_uri" => "https://github.com/mperham/sidekiq/wiki",
+    "changelog_uri" => "https://github.com/mperham/sidekiq/blob/master/Changes.md",
+    "source_code_uri" => "https://github.com/mperham/sidekiq"
+  }
+
   gem.add_dependency "redis", ">= 4.2.0"
   gem.add_dependency "connection_pool", ">= 2.2.2"
   gem.add_dependency "rack", "~> 2.0"

data/web/assets/stylesheets/application-dark.css

@@ -75,6 +75,12 @@ a.btn {
   color: #000;
 }
 
+input {
+  background-color: #444;
+  color: #ccc;
+  padding: 3px;
+}
+
 .summary_bar .summary {
   background-color: #222;
   border: 1px solid #555;
@@ -141,3 +147,14 @@ a.btn {
   fill: #ddd;
   color: #ddd;
 }
+
+.info-circle {
+  color: #282828;
+  background-color: #555555;
+  border-radius: 50%;
+  text-align: center;
+  vertical-align: middle;
+  padding: 3px 7px;
+  font-size: 0.7em;
+  margin-left: 5px;
+}

data/web/assets/stylesheets/application.css

@@ -127,6 +127,10 @@ header.row .pagination {
   width: 14%;
 }
 @media (max-width: 767px) and (min-width: 200px) {
+  .summary_bar {
+    font-size: 1.5em;
+  }
+
   .summary_bar ul li {
     width: 100%;
   }
@@ -186,7 +190,7 @@ form .btn {
 }
 
 form .btn-group .btn {
-  margin-right: 1px;
+  margin-right: 4px;
 }
 
 td form {
@@ -438,7 +442,7 @@ img.smallogo {
     margin: 5px 10px 5px 5px;
   }
   .stat p{
-    font-size: 1em;
+    font-size: 1.5em;
     margin: 5px 5px 5px 10px;
   }
 }
@@ -1152,3 +1156,14 @@ div.interval-slider input {
 .delete-confirm {
   width: 20%;
 }
+
+.info-circle {
+  color: #f3f3f3;
+  background-color: #dddddd;
+  border-radius: 50%;
+  text-align: center;
+  vertical-align: middle;
+  padding: 3px 7px;
+  font-size: 0.7em;
+  margin-left: 5px;
+}

data/web/locales/fr.yml

@@ -72,7 +72,7 @@ fr:
   Quiet: Clore
   StopAll: Tout arrêter
   QuietAll: Tout clore
-  PollingInterval: Interval de rafraîchissement
+  PollingInterval: Intervalle de rafraîchissement
   Plugins: Plugins
   NotYetEnqueued: Pas encore en file d'attente
   CreatedAt: Créée le

data/web/views/busy.erb

@@ -1,8 +1,39 @@
 <div class="row header">
-  <div class="col-sm-8 pull-left flip">
+  <div class="col-sm-4 pull-left flip">
+    <h3><%= t('Status') %></h3>
+  </div>
+</div>
+
+<div class="table_container">
+  <div class="stats-container">
+    <div class="stat">
+      <h3><%= s = processes.size; number_with_delimiter(s) %></h3>
+      <p><%= t('Processes') %></p>
+    </div>
+    <div class="stat">
+      <h3><%= x = processes.total_concurrency; number_with_delimiter(x) %></h3>
+      <p><%= t('Threads') %></p>
+    </div>
+    <div class="stat">
+      <h3><%= ws = workers.size; number_with_delimiter(ws) %></h3>
+      <p><%= t('Busy') %></p>
+    </div>
+    <div class="stat">
+      <h3><%= x == 0 ? 0 : ((ws / x.to_f) * 100).round(0) %>%</h3>
+      <p><%= t('Utilization') %></p>
+    </div>
+    <div class="stat">
+      <h3><%= format_memory(processes.total_rss) %></h3>
+      <p><%= t('RSS') %></p>
+    </div>
+  </div>
+</div>
+
+<div class="row header">
+  <div class="col-sm-4 pull-left flip">
     <h3><%= t('Processes') %></h3>
   </div>
-  <div class="col-sm-4 pull-right flip">
+  <div class="col-sm-3 pull-right flip">
     <form method="POST" class="warning-messages">
       <%= csrf_tag %>
       <div class="btn-group pull-right flip">
@@ -12,14 +43,14 @@
     </form>
   </div>
 </div>
-
 <div class="table_container">
   <table class="processes table table-hover table-bordered table-striped">
     <thead>
       <th><%= t('Name') %></th>
       <th><%= t('Started') %></th>
-      <th><%= t('Threads') %></th>
-      <th><%= t('Busy') %></th>
+      <th class="col-sm-1"><%= t('RSS') %><a href="https://github.com/mperham/sidekiq/wiki/Memory#rss"><span class="info-circle" title="Click to learn more about RSS">?</span></a></th>
+      <th class="col-sm-1"><%= t('Threads') %></th>
+      <th class="col-sm-1"><%= t('Busy') %></th>
       <th>&nbsp;</th>
     </thead>
     <% lead = processes.leader %>
@@ -42,19 +73,19 @@
           <%= process['queues'] * ", " %>
         </td>
         <td><%= relative_time(Time.at(process['started_at'])) %></td>
+        <td><%= format_memory(process['rss'].to_i) %></td>
         <td><%= process['concurrency'] %></td>
         <td><%= process['busy'] %></td>
         <td>
-          <div class="btn-group pull-right flip">
-            <form method="POST">
-              <%= csrf_tag %>
-              <input type="hidden" name="identity" value="<%= process['identity'] %>"/>
-              <% unless process.stopping? %>
-                <button class="btn btn-warn" type="submit" name="quiet" value="1"><%= t('Quiet') %></button>
-              <% end %>
+          <form method="POST">
+            <%= csrf_tag %>
+            <input type="hidden" name="identity" value="<%= process['identity'] %>"/>
+
+            <div class="btn-group pull-right flip">
+              <% unless process.stopping? %><button class="btn btn-warn" type="submit" name="quiet" value="1"><%= t('Quiet') %></button><% end %>
               <button class="btn btn-danger" type="submit" name="stop" value="1"><%= t('Stop') %></button>
-            </form>
-          </div>
+            </div>
+          </form>
         </td>
       </tr>
     <% end %>

data/web/views/layout.erb

@@ -16,6 +16,7 @@
     <link href="<%= root_path %>stylesheets/application-rtl.css" media="screen" rel="stylesheet" type="text/css" />
     <% end %>
 
+    <link rel="apple-touch-icon" href="<%= root_path %>images/apple-touch-icon.png">
     <link rel="shortcut icon" type="image/ico" href="<%= root_path %>images/favicon.ico" />
     <script type="text/javascript" src="<%= root_path %>javascripts/application.js"></script>
     <meta name="google" content="notranslate" />

data/web/views/queue.erb

@@ -52,4 +52,4 @@
     <% end %>
   </table>
 </div>
-<%= erb :_paging, locals: { url: "#{root_path}queues/#{@name}" } %>
+<%= erb :_paging, locals: { url: "#{root_path}queues/#{CGI.escape(@name)}" } %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 6.1.2
+  version: 6.2.1
 platform: ruby
 authors:
 - Mike Perham
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-07 00:00:00.000000000 Z
+date: 2021-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -61,33 +61,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/ISSUE_TEMPLATE/bug_report.md"
-- ".github/contributing.md"
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".standard.yml"
-- 3.0-Upgrade.md
-- 4.0-Upgrade.md
-- 5.0-Upgrade.md
-- 6.0-Upgrade.md
-- COMM-LICENSE
 - Changes.md
-- Ent-2.0-Upgrade.md
-- Ent-Changes.md
-- Gemfile
-- Gemfile.lock
 - LICENSE
-- Pro-2.0-Upgrade.md
-- Pro-3.0-Upgrade.md
-- Pro-4.0-Upgrade.md
-- Pro-5.0-Upgrade.md
-- Pro-Changes.md
 - README.md
-- Rakefile
 - bin/sidekiq
 - bin/sidekiqload
 - bin/sidekiqmon
-- code_of_conduct.md
 - lib/generators/sidekiq/templates/worker.rb.erb
 - lib/generators/sidekiq/templates/worker_spec.rb.erb
 - lib/generators/sidekiq/templates/worker_test.rb.erb
@@ -130,6 +109,7 @@ files:
 - lib/sidekiq/web/router.rb
 - lib/sidekiq/worker.rb
 - sidekiq.gemspec
+- web/assets/images/apple-touch-icon.png
 - web/assets/images/favicon.ico
 - web/assets/images/logo.png
 - web/assets/images/status.png
@@ -186,10 +166,15 @@ files:
 - web/views/retry.erb
 - web/views/scheduled.erb
 - web/views/scheduled_job_info.erb
-homepage: http://sidekiq.org
+homepage: https://sidekiq.org
 licenses:
 - LGPL-3.0
-metadata: {}
+metadata:
+  homepage_uri: https://sidekiq.org
+  bug_tracker_uri: https://github.com/mperham/sidekiq/issues
+  documentation_uri: https://github.com/mperham/sidekiq/wiki
+  changelog_uri: https://github.com/mperham/sidekiq/blob/master/Changes.md
+  source_code_uri: https://github.com/mperham/sidekiq
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -205,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Simple, efficient background processing for Ruby