sidekiq 6.0.2 → 6.0.7

data/lib/sidekiq/monitor.rb

@@ -62,7 +62,7 @@ class Sidekiq::Monitor
       columns = {
         name: [:ljust, (["name"] + queue_data.map(&:name)).map(&:length).max + COL_PAD],
         size: [:rjust, (["size"] + queue_data.map(&:size)).map(&:length).max + COL_PAD],
-        latency: [:rjust, (["latency"] + queue_data.map(&:latency)).map(&:length).max + COL_PAD],
+        latency: [:rjust, (["latency"] + queue_data.map(&:latency)).map(&:length).max + COL_PAD]
       }
       columns.each { |col, (dir, width)| print col.to_s.upcase.public_send(dir, width) }
       puts
@@ -101,7 +101,7 @@ class Sidekiq::Monitor
       tags = [
         process["tag"],
         process["labels"],
-        (process["quiet"] == "true" ? "quiet" : nil),
+        (process["quiet"] == "true" ? "quiet" : nil)
       ].flatten.compact
       tags.any? ? "[#{tags.join("] [")}]" : nil
     end

data/lib/sidekiq/processor.rb

@@ -181,7 +181,7 @@ module Sidekiq
         # the retry subsystem (e.g. network partition).  We won't acknowledge the job
         # so it can be rescued when using Sidekiq Pro.
         handle_exception(ex, {context: "Internal exception!", job: job_hash, jobstr: jobstr})
-        raise e
+        raise ex
       ensure
         if ack
           # We don't want a shutdown signal to interrupt job acknowledgment.

data/lib/sidekiq/redis_connection.rb

@@ -12,8 +12,9 @@ module Sidekiq
           options[key.to_sym] = options.delete(key)
         end
 
-        options[:id] = "Sidekiq-#{Sidekiq.server? ? "server" : "client"}-PID-#{::Process.pid}" unless options.key?(:id)
-        options[:url] ||= determine_redis_provider
+        if !options[:url] && (u = determine_redis_provider)
+          options[:url] = u
+        end
 
         size = if options[:size]
           options[:size]
@@ -93,9 +94,10 @@ module Sidekiq
       end
 
       def log_info(options)
-        # Don't log Redis AUTH password
         redacted = "REDACTED"
-        scrubbed_options = options.dup
+
+        # deep clone so we can muck with these options all we want
+        scrubbed_options = Marshal.load(Marshal.dump(options))
         if scrubbed_options[:url] && (uri = URI.parse(scrubbed_options[:url])) && uri.password
           uri.password = redacted
           scrubbed_options[:url] = uri.to_s
@@ -103,6 +105,9 @@ module Sidekiq
         if scrubbed_options[:password]
           scrubbed_options[:password] = redacted
         end
+        scrubbed_options[:sentinels]&.each do |sentinel|
+          sentinel[:password] = redacted if sentinel[:password]
+        end
         if Sidekiq.server?
           Sidekiq.logger.info("Booting Sidekiq #{Sidekiq::VERSION} with redis options #{scrubbed_options}")
         else

data/lib/sidekiq/sd_notify.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+# The MIT License
+#
+# Copyright (c) 2017, 2018, 2019, 2020 Agis Anastasopoulos
+#
+# 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.
+
+# This is a copy of https://github.com/agis/ruby-sdnotify as of commit a7d52ee
+# The only changes made was "rehoming" it within the Sidekiq module to avoid
+# namespace collisions and applying standard's code formatting style.
+
+require "socket"
+
+# SdNotify is a pure-Ruby implementation of sd_notify(3). It can be used to
+# notify systemd about state changes. Methods of this package are no-op on
+# non-systemd systems (eg. Darwin).
+#
+# The API maps closely to the original implementation of sd_notify(3),
+# therefore be sure to check the official man pages prior to using SdNotify.
+#
+# @see https://www.freedesktop.org/software/systemd/man/sd_notify.html
+module Sidekiq
+  module SdNotify
+    # Exception raised when there's an error writing to the notification socket
+    class NotifyError < RuntimeError; end
+
+    READY = "READY=1"
+    RELOADING = "RELOADING=1"
+    STOPPING = "STOPPING=1"
+    STATUS = "STATUS="
+    ERRNO = "ERRNO="
+    MAINPID = "MAINPID="
+    WATCHDOG = "WATCHDOG=1"
+    FDSTORE = "FDSTORE=1"
+
+    def self.ready(unset_env = false)
+      notify(READY, unset_env)
+    end
+
+    def self.reloading(unset_env = false)
+      notify(RELOADING, unset_env)
+    end
+
+    def self.stopping(unset_env = false)
+      notify(STOPPING, unset_env)
+    end
+
+    # @param status [String] a custom status string that describes the current
+    #   state of the service
+    def self.status(status, unset_env = false)
+      notify("#{STATUS}#{status}", unset_env)
+    end
+
+    # @param errno [Integer]
+    def self.errno(errno, unset_env = false)
+      notify("#{ERRNO}#{errno}", unset_env)
+    end
+
+    # @param pid [Integer]
+    def self.mainpid(pid, unset_env = false)
+      notify("#{MAINPID}#{pid}", unset_env)
+    end
+
+    def self.watchdog(unset_env = false)
+      notify(WATCHDOG, unset_env)
+    end
+
+    def self.fdstore(unset_env = false)
+      notify(FDSTORE, unset_env)
+    end
+
+    # @param [Boolean] true if the service manager expects watchdog keep-alive
+    #   notification messages to be sent from this process.
+    #
+    # If the $WATCHDOG_USEC environment variable is set,
+    # and the $WATCHDOG_PID variable is unset or set to the PID of the current
+    # process
+    #
+    # @note Unlike sd_watchdog_enabled(3), this method does not mutate the
+    #   environment.
+    def self.watchdog?
+      wd_usec = ENV["WATCHDOG_USEC"]
+      wd_pid = ENV["WATCHDOG_PID"]
+
+      return false unless wd_usec
+
+      begin
+        wd_usec = Integer(wd_usec)
+      rescue
+        return false
+      end
+
+      return false if wd_usec <= 0
+      return true if !wd_pid || wd_pid == $$.to_s
+
+      false
+    end
+
+    # Notify systemd with the provided state, via the notification socket, if
+    # any.
+    #
+    # Generally this method will be used indirectly through the other methods
+    # of the library.
+    #
+    # @param state [String]
+    # @param unset_env [Boolean]
+    #
+    # @return [Fixnum, nil] the number of bytes written to the notification
+    #   socket or nil if there was no socket to report to (eg. the program wasn't
+    #   started by systemd)
+    #
+    # @raise [NotifyError] if there was an error communicating with the systemd
+    #   socket
+    #
+    # @see https://www.freedesktop.org/software/systemd/man/sd_notify.html
+    def self.notify(state, unset_env = false)
+      sock = ENV["NOTIFY_SOCKET"]
+
+      return nil unless sock
+
+      ENV.delete("NOTIFY_SOCKET") if unset_env
+
+      begin
+        Addrinfo.unix(sock, :DGRAM).connect do |s|
+          s.close_on_exec = true
+          s.write(state)
+        end
+      rescue => e
+        raise NotifyError, "#{e.class}: #{e.message}", e.backtrace
+      end
+    end
+  end
+end

data/lib/sidekiq/systemd.rb

@@ -0,0 +1,24 @@
+#
+# Sidekiq's systemd integration allows Sidekiq to inform systemd:
+#  1. when it has successfully started
+#  2. when it is starting shutdown
+#  3. periodically for a liveness check with a watchdog thread
+#
+module Sidekiq
+  def self.start_watchdog
+    usec = Integer(ENV["WATCHDOG_USEC"])
+    return Sidekiq.logger.error("systemd Watchdog too fast: " + usec) if usec < 1_000_000
+
+    sec_f = usec / 1_000_000.0
+    # "It is recommended that a daemon sends a keep-alive notification message
+    # to the service manager every half of the time returned here."
+    ping_f = sec_f / 2
+    Sidekiq.logger.info "Pinging systemd watchdog every #{ping_f.round(1)} sec"
+    Thread.new do
+      loop do
+        sleep ping_f
+        Sidekiq::SdNotify.watchdog
+      end
+    end
+  end
+end

data/lib/sidekiq/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sidekiq
-  VERSION = "6.0.2"
+  VERSION = "6.0.7"
 end

data/lib/sidekiq/web.rb

@@ -31,7 +31,7 @@ module Sidekiq
       "Queues" => "queues",
       "Retries" => "retries",
       "Scheduled" => "scheduled",
-      "Dead" => "morgue",
+      "Dead" => "morgue"
     }
 
     class << self

data/lib/sidekiq/web/application.rb

@@ -19,7 +19,7 @@ module Sidekiq
       "script-src 'self' https: http: 'unsafe-inline'",
       "style-src 'self' https: http: 'unsafe-inline'",
       "worker-src 'self'",
-      "base-uri 'self'",
+      "base-uri 'self'"
     ].join("; ").freeze
 
     def initialize(klass)
@@ -90,7 +90,15 @@ module Sidekiq
     end
 
     post "/queues/:name" do
-      Sidekiq::Queue.new(route_params[:name]).clear
+      queue = Sidekiq::Queue.new(route_params[:name])
+
+      if Sidekiq.pro? && params["pause"]
+        queue.pause!
+      elsif Sidekiq.pro? && params["unpause"]
+        queue.unpause!
+      else
+        queue.clear
+      end
 
       redirect "#{root_path}queues"
     end
@@ -267,7 +275,7 @@ module Sidekiq
           scheduled: sidekiq_stats.scheduled_size,
           retries: sidekiq_stats.retry_size,
           dead: sidekiq_stats.dead_size,
-          default_latency: sidekiq_stats.default_queue_latency,
+          default_latency: sidekiq_stats.default_queue_latency
         },
         redis: redis_stats,
         server_utc_time: server_utc_time
@@ -292,22 +300,20 @@ module Sidekiq
 
       resp = case resp
       when Array
+        # redirects go here
         resp
       else
+        # rendered content goes here
         headers = {
           "Content-Type" => "text/html",
           "Cache-Control" => "no-cache",
           "Content-Language" => action.locale,
-          "Content-Security-Policy" => CSP_HEADER,
+          "Content-Security-Policy" => CSP_HEADER
         }
-
+        # we'll let Rack calculate Content-Length for us.
         [200, headers, [resp]]
       end
 
-      resp[1] = resp[1].dup
-
-      resp[1][CONTENT_LENGTH] = resp[2].sum(&:bytesize).to_s
-
       resp
     end
 

data/lib/sidekiq/web/helpers.rb

@@ -295,7 +295,7 @@ module Sidekiq
     end
 
     def environment_title_prefix
-      environment = Sidekiq.options[:environment] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
+      environment = Sidekiq.options[:environment] || ENV["APP_ENV"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
 
       "[#{environment.upcase}] " unless environment == "production"
     end

data/lib/sidekiq/web/router.rb

@@ -94,9 +94,7 @@ module Sidekiq
         {} if path == matcher
       else
         path_match = path.match(matcher)
-        if path_match
-          Hash[path_match.names.map(&:to_sym).zip(path_match.captures)]
-        end
+        path_match&.named_captures&.transform_keys(&:to_sym)
       end
     end
   end

data/lib/sidekiq/worker.rb

@@ -48,8 +48,8 @@ module Sidekiq
         # In practice, any option is allowed.  This is the main mechanism to configure the
         # options for a specific job.
         def sidekiq_options(opts = {})
-          opts = Hash[opts.map { |k, v| [k.to_s, v] }] # stringify
-          self.sidekiq_options_hash = get_sidekiq_options.merge(Hash[opts.map { |k, v| [k.to_s, v] }])
+          opts = opts.transform_keys(&:to_s) # stringify
+          self.sidekiq_options_hash = get_sidekiq_options.merge(opts)
         end
 
         def sidekiq_retry_in(&block)

data/sidekiq.gemspec

@@ -16,6 +16,6 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "redis", ">= 4.1.0"
   gem.add_dependency "connection_pool", ">= 2.2.2"
-  gem.add_dependency "rack", ">= 2.0.0"
+  gem.add_dependency "rack", "~> 2.0"
   gem.add_dependency "rack-protection", ">= 2.0.0"
 end

data/web/assets/javascripts/application.js

@@ -19,7 +19,8 @@ Sidekiq = {};
 $(function() {
   var pollpath = $('body').data('poll-path');
   if (pollpath != "") {
-    updatePage(pollpath);
+    var ti = parseInt(localStorage.timeInterval) || 2000;
+    setTimeout(function(){updatePage(pollpath)}, ti);
   }
 
   $(document).on('click', '.check_all', function() {
@@ -55,26 +56,28 @@ function updateFuzzyTimes(locale) {
 }
 
 function updatePage(url) {
-  setInterval(function () {
-    $.ajax({
-      url: url,
-      dataType: 'html'
-    }).done(function (data) {
-      $data = $(data)
-
-      var $page = $data.filter('#page')
-      $('#page').replaceWith($page)
-
-      var $header_status = $data.find('.status')
-      $('.status').replaceWith($header_status)
-
-      updateFuzzyTimes($('body').data('locale'));
-    })
-  }, parseInt(localStorage.timeInterval) || 2000);
+  $.ajax({
+    url: url,
+    dataType: 'html'
+  }).done(function(data) {
+    $data = $(data)
+
+    var $page = $data.filter('#page')
+    $('#page').replaceWith($page)
+
+    var $header_status = $data.find('.status')
+    $('.status').replaceWith($header_status)
+
+    updateFuzzyTimes($('body').data('locale'));
+
+    var ti = parseInt(localStorage.timeInterval) || 2000;
+    setTimeout(function(){updatePage(url)}, ti)
+  }).fail(function() {
+    var ti = parseInt(localStorage.timeInterval) || 2000;
+    setTimeout(function(){updatePage(url)}, ti)
+  })
 }
 
-
-
 $(function() {
   'use strict';
 

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

@@ -1,125 +1,122 @@
-@media (prefers-color-scheme: dark) {
-
-  body {
-    background-color: #000;
-    color: #ccc;
-  }
-
-  a,
-  .title,
-  .summary_bar ul .count,
-  .navbar .navbar-brand {
-    color: #af0014;
-  }
-
-  .navbar .navbar-brand:hover {
-    color: #ccc;
-  }
-
-  .navbar .navbar-brand .status {
-    color: #ccc;
-  }
-
-  .navbar-inverse {
-    background-color: #000;
-    border-color: #333;
-  }
-
-  table.table-white {
-    background-color: #111;
-  }
-
-  .table-striped > tbody > tr:nth-of-type(odd) {
-    background-color: #222;
-  }
-
-  .table-bordered,
-  .table-bordered > tbody > tr > td,
-  .table-bordered > tbody > tr > th,
-  .table-bordered > tfoot > tr > td,
-  .table-bordered > tfoot > tr > th,
-  .table-bordered > thead > tr > td,
-  .table-bordered > thead > tr > th {
-    border: 1px solid #333;
-  }
-
-  .table-hover > tbody > tr:hover {
-    background-color: #333;
-  }
-
-  .alert {
-    border: none;
-    color: #ccc;
-  }
-
-  .alert-success {
-    background-color: #000;
-  }
-
-  a:link,
-  a:active,
-  a:hover,
-  a:visited {
-    color: #63798c;
-  }
-
-  a.btn {
-    color: #000;
-  }
-
-  .summary_bar .summary {
-    background-color: #000;
-    border: 1px solid #333;
-  }
-
-  .navbar-default {
-    background-color: #000;
-    border-color: #3d3d3d;
-  }
-
-  .navbar-default .navbar-nav > .active > a,
-  .navbar-default .navbar-nav > .active > a:focus,
-  .navbar-default .navbar-nav > .active > a:hover {
-    color: #ccc;
-    background-color: #282828;
-  }
-
-  .navbar-default .navbar-nav > li > a:hover {
-    color: #ccc;
-  }
-
-  .pagination > li > a,
-  .pagination > li > a:hover,
-  .pagination > li > span {
-    color: #ccc;
-    background-color: #282828;
-    border-color: #353535;
-  }
-  .pagination > .disabled > a,
-  .pagination > .disabled > a:focus,
-  .pagination > .disabled > a:hover,
-  .pagination > .disabled > span,
-  .pagination > .disabled > span:focus,
-  .pagination > .disabled > span:hover {
-    color: #a5a5a5;
-    background-color: #282828;
-    border-color: #353535;
-  }
-
-  .stat {
-    border: 1px solid rgba(255, 255, 255, 0.1);
-  }
-
-  #live-poll {
-    color: #ccc;
-  }
-
-  .btn-warn {
-    color: #333;
-  }
-
-  .rickshaw_graph .y_ticks.glow text {
-    fill: #ccc;
-    color: #ccc;
-  }
+body {
+  background-color: #000;
+  color: #ccc;
+}
+
+a,
+.title,
+.summary_bar ul .count,
+.navbar .navbar-brand {
+  color: #af0014;
+}
+
+.navbar .navbar-brand:hover {
+  color: #ccc;
+}
+
+.navbar .navbar-brand .status {
+  color: #ccc;
+}
+
+.navbar-inverse {
+  background-color: #000;
+  border-color: #333;
+}
+
+table.table-white {
+  background-color: #111;
+}
+
+.table-striped > tbody > tr:nth-of-type(odd) {
+  background-color: #222;
+}
+
+.table-bordered,
+.table-bordered > tbody > tr > td,
+.table-bordered > tbody > tr > th,
+.table-bordered > tfoot > tr > td,
+.table-bordered > tfoot > tr > th,
+.table-bordered > thead > tr > td,
+.table-bordered > thead > tr > th {
+  border: 1px solid #333;
+}
+
+.table-hover > tbody > tr:hover {
+  background-color: #333;
+}
+
+.alert {
+  border: none;
+  color: #ccc;
+}
+
+.alert-success {
+  background-color: #000;
+}
+
+a:link,
+a:active,
+a:hover,
+a:visited {
+  color: #63798c;
+}
+
+a.btn {
+  color: #000;
+}
+
+.summary_bar .summary {
+  background-color: #000;
+  border: 1px solid #333;
+}
+
+.navbar-default {
+  background-color: #000;
+  border-color: #3d3d3d;
+}
+
+.navbar-default .navbar-nav > .active > a,
+.navbar-default .navbar-nav > .active > a:focus,
+.navbar-default .navbar-nav > .active > a:hover {
+  color: #ccc;
+  background-color: #282828;
+}
+
+.navbar-default .navbar-nav > li > a:hover {
+  color: #ccc;
+}
+
+.pagination > li > a,
+.pagination > li > a:hover,
+.pagination > li > span {
+  color: #ccc;
+  background-color: #282828;
+  border-color: #353535;
+}
+.pagination > .disabled > a,
+.pagination > .disabled > a:focus,
+.pagination > .disabled > a:hover,
+.pagination > .disabled > span,
+.pagination > .disabled > span:focus,
+.pagination > .disabled > span:hover {
+  color: #a5a5a5;
+  background-color: #282828;
+  border-color: #353535;
+}
+
+.stat {
+  border: 1px solid rgba(255, 255, 255, 0.1);
+}
+
+#live-poll {
+  color: #ccc;
+}
+
+.btn-warn {
+  color: #333;
+}
+
+.rickshaw_graph .y_ticks.glow text {
+  fill: #ccc;
+  color: #ccc;
 }