sidekiq 7.0.1 → 7.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98aab60f0a9bd14122cf62b2f31c17e41b67feb8c9fb13865ef0a16002d38ed7
-  data.tar.gz: 94038f0176ccb7785c6112cd41e915e4a1c7f66298a9670457a68e6b62f2710c
+  metadata.gz: 9456d6050f916f7777b11ff32528c3c872fefa5a4e7afa32773e030ca9b6df7e
+  data.tar.gz: 501ca5569b669bb5c5eaf80d4ae3c1c8cc20e7c51235cfc72abcb2d3b25bc6ea
 SHA512:
-  metadata.gz: c41c724dc99aa3fdf49db46eeac0bec822bd6a67989792f4830900da7b74882c27837535a03a2ea6ed0575736fc895b23bb3440613d1f581e877bcbfe1c06934
-  data.tar.gz: 482af09f25f72f9fa0261f02e4e224dc58a400519f167f8cb0ea0dda4960b24a41b105731a4fcc2b81ff15f158497b9bf1cc86d55272ed8fe4ca7ed9029bc047
+  metadata.gz: 0267fbbfbf028e4f9c091e28c31b4b18de6c795e32359c38cf2f09da7c2bc43654c1b3482443befbaada0715fdb591ae74037bed99069bd26db5fca961befec1
+  data.tar.gz: f2a5275b2fa2a47e1aa0b6d5a5009cc373dddd64f0226d481f575079fee6a91ebc8ddacfc96536085df9bae685bf45fd42660eecf656d07521033b921f8125ed

data/Changes.md

@@ -2,6 +2,29 @@
 
 [Sidekiq Changes](https://github.com/mperham/sidekiq/blob/main/Changes.md) | [Sidekiq Pro Changes](https://github.com/mperham/sidekiq/blob/main/Pro-Changes.md) | [Sidekiq Enterprise Changes](https://github.com/mperham/sidekiq/blob/main/Ent-Changes.md)
 
+7.0.2
+----------
+
+- Improve compatibility with custom loggers [#5673]
+- Add queue weights on Busy page [#5640]
+- Add BID link on job_info page if job is part of a Batch [#5623]
+- Allow custom extensions to add rows/links within Job detail pages [#5624]
+```ruby
+Sidekiq::Web.custom_job_info_rows << AddAccountLink.new
+
+class AddAccountLink
+  include CGI::Util
+  def add_pair(job)
+    # yield a (name, value) pair
+    # You can include HTML tags and CSS, Sidekiq does not do any
+    # escaping so beware user data injection! Note how we use CGI's
+    # `h` escape helper.
+    aid = job["account_id"]
+    yield "Account", "<a href='/accounts/#{h aid}'>#{h aid}</a>" if aid
+  end
+end
+```
+
 7.0.1
 ----------
 

data/lib/sidekiq/api.rb

@@ -418,6 +418,10 @@ module Sidekiq
       self["jid"]
     end
 
+    def bid
+      self["bid"]
+    end
+
     def enqueued_at
       self["enqueued_at"] ? Time.at(self["enqueued_at"]).utc : nil
     end
@@ -967,6 +971,14 @@ module Sidekiq
       self["queues"]
     end
 
+    def weights
+      self["weights"]
+    end
+
+    def version
+      self["version"]
+    end
+
     # Signal this process to stop processing new jobs.
     # It will continue to execute jobs it has already fetched.
     # This method is *asynchronous* and it can take 5-10

data/lib/sidekiq/client.rb

@@ -189,7 +189,7 @@ module Sidekiq
       def enqueue_to_in(queue, interval, klass, *args)
         int = interval.to_f
         now = Time.now.to_f
-        ts = (int < 1_000_000_000 ? now + int : int)
+        ts = ((int < 1_000_000_000) ? now + int : int)
 
         item = {"class" => klass, "args" => args, "at" => ts, "queue" => queue}
         item.delete("at") if ts <= now

data/lib/sidekiq/config.rb

@@ -134,7 +134,7 @@ module Sidekiq
 
     def redis_info
       redis do |conn|
-        conn.info
+        conn.call("INFO") { |i| i.lines(chomp: true).map { |l| l.split(":", 2) }.select { |l| l.size == 2 }.to_h }
       rescue RedisClientAdapter::CommandError => ex
         # 2850 return fake version when INFO command has (probably) been renamed
         raise unless /unknown command/.match?(ex.message)
@@ -248,7 +248,6 @@ module Sidekiq
         return
       end
 
-      logger.extend(Sidekiq::LoggingUtils)
       @logger = logger
     end
 

data/lib/sidekiq/deploy.rb

@@ -21,15 +21,15 @@ module Sidekiq
     }
 
     def self.mark!(label = nil)
-      label ||= LABEL_MAKER.call
-      Sidekiq::Deploy.new.mark(label: label)
+      Sidekiq::Deploy.new.mark!(label: label)
     end
 
     def initialize(pool = Sidekiq::RedisConnection.create)
       @pool = pool
     end
 
-    def mark(at: Time.now, label: "")
+    def mark!(at: Time.now, label: nil)
+      label ||= LABEL_MAKER.call
       # we need to round the timestamp so that we gracefully
       # handle an very common error in marking deploys:
       # having every process mark its deploy, leading

data/lib/sidekiq/job.rb

@@ -258,7 +258,7 @@ module Sidekiq
       def at(interval)
         int = interval.to_f
         now = Time.now.to_f
-        ts = (int < 1_000_000_000 ? now + int : int)
+        ts = ((int < 1_000_000_000) ? now + int : int)
         # Optimization to enqueue something now that is scheduled to go out now or in the past
         @opts["at"] = ts if ts > now
         self
@@ -325,7 +325,7 @@ module Sidekiq
       def perform_in(interval, *args)
         int = interval.to_f
         now = Time.now.to_f
-        ts = (int < 1_000_000_000 ? now + int : int)
+        ts = ((int < 1_000_000_000) ? now + int : int)
 
         item = {"class" => self, "args" => args}
 

data/lib/sidekiq/job_logger.rb

@@ -33,7 +33,7 @@ module Sidekiq
 
       Thread.current[:sidekiq_context] = h
       level = job_hash["log_level"]
-      if level
+      if level && @logger.respond_to?(:log_at)
         @logger.log_at(level, &block)
       else
         yield

data/lib/sidekiq/launcher.rb

@@ -250,9 +250,11 @@ module Sidekiq
         "pid" => ::Process.pid,
         "tag" => @config[:tag] || "",
         "concurrency" => @config.total_concurrency,
-        "queues" => @config.capsules.values.map { |cap| cap.queues }.flatten.uniq,
+        "queues" => @config.capsules.values.flat_map { |cap| cap.queues }.uniq,
+        "weights" => @config.capsules.values.flat_map { |cap| cap.queues }.tally,
         "labels" => @config[:labels].to_a,
-        "identity" => identity
+        "identity" => identity,
+        "version" => Sidekiq::VERSION
       }
     end
 

data/lib/sidekiq/metrics/query.rb

@@ -123,7 +123,7 @@ module Sidekiq
         def series_avg(metric = "ms")
           series[metric].each_with_object(Hash.new(0)) do |(bucket, value), result|
             completed = series.dig("p", bucket) - series.dig("f", bucket)
-            result[bucket] = completed == 0 ? 0 : value.to_f / completed
+            result[bucket] = (completed == 0) ? 0 : value.to_f / completed
           end
         end
       end

data/lib/sidekiq/monitor.rb

@@ -49,10 +49,25 @@ class Sidekiq::Monitor
     def processes
       puts "---- Processes (#{process_set.size}) ----"
       process_set.each_with_index do |process, index|
+        # Keep compatibility with legacy versions since we don't want to break sidekiqmon during rolling upgrades or downgrades.
+        #
+        # Before:
+        #   ["default", "critical"]
+        #
+        # After:
+        #   {"default" => 1, "critical" => 10}
+        queues =
+          if process["weights"]
+            process["weights"].sort_by { |queue| queue[0] }.map { |queue| queue.join(": ") }
+          else
+            process["queues"].sort
+          end
+
         puts "#{process["identity"]} #{tags_for(process)}"
         puts "  Started: #{Time.at(process["started_at"])} (#{time_ago(process["started_at"])})"
         puts "  Threads: #{process["concurrency"]} (#{process["busy"]} busy)"
-        puts "   Queues: #{split_multiline(process["queues"].sort, pad: 11)}"
+        puts "   Queues: #{split_multiline(queues, pad: 11)}"
+        puts "  Version: #{process["version"] || "Unknown"}" if process["version"] != Sidekiq::VERSION
         puts "" unless (index + 1) == process_set.size
       end
     end
@@ -101,7 +116,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/paginator.rb

@@ -3,7 +3,7 @@
 module Sidekiq
   module Paginator
     def page(key, pageidx = 1, page_size = 25, opts = nil)
-      current_page = pageidx.to_i < 1 ? 1 : pageidx.to_i
+      current_page = (pageidx.to_i < 1) ? 1 : pageidx.to_i
       pageidx = current_page - 1
       total_size = 0
       items = []
@@ -45,7 +45,7 @@ module Sidekiq
     end
 
     def page_items(items, pageidx = 1, page_size = 25)
-      current_page = pageidx.to_i < 1 ? 1 : pageidx.to_i
+      current_page = (pageidx.to_i < 1) ? 1 : pageidx.to_i
       pageidx = current_page - 1
       starting = pageidx * page_size
       items = items.to_a

data/lib/sidekiq/redis_client_adapter.rb

@@ -9,10 +9,12 @@ module Sidekiq
     CommandError = RedisClient::CommandError
 
     module CompatMethods
+      # TODO Deprecate and remove this
       def info
         @client.call("INFO") { |i| i.lines(chomp: true).map { |l| l.split(":", 2) }.select { |l| l.size == 2 }.to_h }
       end
 
+      # TODO Deprecate and remove this
       def evalsha(sha, keys, argv)
         @client.call("EVALSHA", sha, keys.size, *keys, *argv)
       end
@@ -34,12 +36,7 @@ module Sidekiq
     CompatClient = RedisClient::Decorator.create(CompatMethods)
 
     class CompatClient
-      # underscore methods are not official API
-      def _client
-        @client
-      end
-
-      def _config
+      def config
         @client.config
       end
 

data/lib/sidekiq/scheduled.rb

@@ -54,7 +54,7 @@ module Sidekiq
           @lua_zpopbyscore_sha = conn.script(:load, LUA_ZPOPBYSCORE)
         end
 
-        conn.evalsha(@lua_zpopbyscore_sha, keys, argv)
+        conn.call("EVALSHA", @lua_zpopbyscore_sha, keys.size, *keys, *argv)
       rescue RedisClient::CommandError => e
         raise unless e.message.start_with?("NOSCRIPT")
 

data/lib/sidekiq/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Sidekiq
-  VERSION = "7.0.1"
+  VERSION = "7.0.2"
   MAJOR = 7
 end

data/lib/sidekiq/web/helpers.rb

@@ -137,7 +137,7 @@ module Sidekiq
     end
 
     def sort_direction_label
-      params[:direction] == "asc" ? "↑" : "↓"
+      (params[:direction] == "asc") ? "↑" : "↓"
     end
 
     def workset
@@ -167,7 +167,7 @@ module Sidekiq
 
     def redis_url
       Sidekiq.redis do |conn|
-        conn._config.server_url
+        conn.config.server_url
       end
     end
 
@@ -184,7 +184,7 @@ module Sidekiq
     end
 
     def current_status
-      workset.size == 0 ? "idle" : "active"
+      (workset.size == 0) ? "idle" : "active"
     end
 
     def relative_time(time)
@@ -217,7 +217,7 @@ module Sidekiq
     end
 
     def truncate(text, truncate_after_chars = 2000)
-      truncate_after_chars && text.size > truncate_after_chars ? "#{text[0..truncate_after_chars]}..." : text
+      (truncate_after_chars && text.size > truncate_after_chars) ? "#{text[0..truncate_after_chars]}..." : text
     end
 
     def display_args(args, truncate_after_chars = 2000)
@@ -324,7 +324,7 @@ module Sidekiq
     end
 
     def pollable?
-      !(current_path == "" || current_path.starts_with?("metrics"))
+      !(current_path == "" || current_path.start_with?("metrics"))
     end
 
     def retry_or_delete_or_kill(job, params)

data/lib/sidekiq/web.rb

@@ -48,6 +48,10 @@ module Sidekiq
       end
       alias_method :tabs, :custom_tabs
 
+      def custom_job_info_rows
+        @custom_job_info_rows ||= []
+      end
+
       def locales
         @locales ||= LOCALES
       end

data/sidekiq.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |gem|
     "source_code_uri" => "https://github.com/mperham/sidekiq"
   }
 
-  gem.add_dependency "redis-client", ">= 0.9.0"
+  gem.add_dependency "redis-client", ">= 0.11.0"
   gem.add_dependency "connection_pool", ">= 2.3.0"
   gem.add_dependency "rack", ">= 2.2.4"
   gem.add_dependency "concurrent-ruby", "< 2"

data/web/assets/javascripts/application.js

@@ -31,6 +31,7 @@ function addListeners() {
     node.addEventListener("click", addDataToggleListeners)
   })
 
+  addShiftClickListeners()
   updateFuzzyTimes();
   setLivePollFromUrl();
 
@@ -71,6 +72,23 @@ function addDataToggleListeners(event) {
   }
 }
 
+function addShiftClickListeners() {
+  let checkboxes = Array.from(document.querySelectorAll(".shift_clickable"));
+  let lastChecked = null;
+  checkboxes.forEach(checkbox => {
+    checkbox.addEventListener("click", (e) => {
+      if (e.shiftKey && lastChecked) {
+        let myIndex = checkboxes.indexOf(checkbox);
+        let lastIndex = checkboxes.indexOf(lastChecked);
+        let [min, max] = [myIndex, lastIndex].sort();
+        let newState = checkbox.checked;
+        checkboxes.slice(min, max).forEach(c => c.checked = newState);
+      }
+      lastChecked = checkbox;
+    });
+  });
+}
+
 function updateFuzzyTimes() {
   var locale = document.body.getAttribute("data-locale");
   var parts = locale.split('-');

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

@@ -72,6 +72,10 @@ table {
   background-color: #31708f;
 }
 
+.alert-warning {
+  background-color: #c47612;
+}
+
 a:link, a:active, a:hover, a:visited {
   color: #ddd;
 }

data/web/assets/stylesheets/application.css

@@ -676,8 +676,8 @@ div.interval-slider input {
 }
 
 .info-circle {
-  color: #ccc;
-  background-color: #000;
+  color: #333;
+  background-color: #ccc;
   border-radius: 50%;
   text-align: center;
   vertical-align: middle;

data/web/views/_job_info.erb

@@ -33,6 +33,14 @@
           <code><%= job.jid %></code>
         </td>
       </tr>
+      <% if job.bid %>
+      <tr>
+        <th>BID</th>
+        <td>
+          <a href="<%= root_path %>batches/<%= job.bid %>"><%= job.bid %>
+        </td>
+      </tr>
+      <% end %>
       <tr>
         <th><%= t('CreatedAt') %></th>
         <td><%= relative_time(job.created_at) %></td>
@@ -84,6 +92,14 @@
           <td><%= relative_time(job.at) if job['retry_count'] %></td>
         </tr>
       <% end %>
+      <% Sidekiq::Web.custom_job_info_rows.each do |helper| %>
+        <% helper.add_pair(job) do |name, value| %>
+          <tr>
+            <th><%= name %></th>
+            <td><%= value %></td>
+          </tr>
+        <% end %>
+      <% end %>
     </tbody>
   </table>
 </div>

data/web/views/busy.erb

@@ -70,7 +70,20 @@
           <% end %>
           <br>
           <b><%= "#{t('Queues')}: " %></b>
-          <%= process.queues.join(", ") %>
+          <% if process.weights %>
+            <%= process.weights.sort_by { |weight| weight[0] }.map { |weight| weight.join(": ") }.join(", ") %>
+          <% else %>
+            <%= process.queues.sort.join(", ") %>
+          <% end %>
+          <% if process.version != Sidekiq::VERSION %>
+            <br>
+            <b><%= "#{t('Version')}: " %></b>
+            <% if process.version %>
+              <%= process.version %>
+            <% else %>
+              <%= t('Unknown') %>
+            <% end %>
+          <% end %>
         </td>
         <td><%= relative_time(Time.at(process['started_at'])) %></td>
         <td><%= format_memory(process['rss'].to_i) %></td>

data/web/views/morgue.erb

@@ -33,7 +33,7 @@
           <tr>
             <td class="table-checkbox">
               <label>
-                <input type='checkbox' name='key[]' value='<%= job_params(entry.item, entry.score) %>' />
+                <input type='checkbox' name='key[]' value='<%= job_params(entry.item, entry.score) %>' class='shift_clickable' />
               </label>
             </td>
             <td>

data/web/views/retries.erb

@@ -34,7 +34,7 @@
           <tr>
             <td class="table-checkbox">
               <label>
-                <input type='checkbox' name='key[]' value='<%= job_params(entry.item, entry.score) %>' />
+                <input type='checkbox' name='key[]' value='<%= job_params(entry.item, entry.score) %>' class='shift_clickable' />
               </label>
             </td>
             <td>

data/web/views/scheduled.erb

@@ -30,7 +30,7 @@
         <% @scheduled.each do |entry| %>
           <tr>
             <td>
-              <input type='checkbox' name='key[]' value='<%= job_params(entry.item, entry.score) %>' />
+              <input type='checkbox' name='key[]' value='<%= job_params(entry.item, entry.score) %>' class='shift_clickable' />
             </td>
             <td>
                <a href="<%= root_path %>scheduled/<%= job_params(entry.item, entry.score) %>"><%= relative_time(entry.at) %></a>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 7.0.1
+  version: 7.0.2
 platform: ruby
 authors:
 - Mike Perham
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-04 00:00:00.000000000 Z
+date: 2022-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement