sidekiq 7.0.1 → 7.0.8

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.8"
   MAJOR = 7
 end

data/lib/sidekiq/web/application.rb

@@ -20,6 +20,12 @@ module Sidekiq
       "worker-src 'self'",
       "base-uri 'self'"
     ].join("; ").freeze
+    METRICS_PERIODS = {
+      "1h" => 60,
+      "2h" => 120,
+      "4h" => 240,
+      "8h" => 480
+    }
 
     def initialize(klass)
       @klass = klass
@@ -62,14 +68,20 @@ module Sidekiq
 
     get "/metrics" do
       q = Sidekiq::Metrics::Query.new
-      @query_result = q.top_jobs
+      @period = h((params[:period] || "")[0..1])
+      @periods = METRICS_PERIODS
+      minutes = @periods.fetch(@period, @periods.values.first)
+      @query_result = q.top_jobs(minutes: minutes)
       erb(:metrics)
     end
 
     get "/metrics/:name" do
       @name = route_params[:name]
+      @period = h((params[:period] || "")[0..1])
       q = Sidekiq::Metrics::Query.new
-      @query_result = q.for_job(@name)
+      @periods = METRICS_PERIODS
+      minutes = @periods.fetch(@period, @periods.values.first)
+      @query_result = q.for_job(@name, minutes: minutes)
       erb(:metrics_for_job)
     end
 
@@ -82,11 +94,14 @@ module Sidekiq
 
     post "/busy" do
       if params["identity"]
-        p = Sidekiq::Process.new("identity" => params["identity"])
-        p.quiet! if params["quiet"]
-        p.stop! if params["stop"]
+        pro = Sidekiq::ProcessSet[params["identity"]]
+
+        pro.quiet! if params["quiet"]
+        pro.stop! if params["stop"]
       else
         processes.each do |pro|
+          next if pro.embedded?
+
           pro.quiet! if params["quiet"]
           pro.stop! if params["stop"]
         end

data/lib/sidekiq/web/helpers.rb

@@ -15,7 +15,7 @@ module Sidekiq
       # so extensions can be localized
       @strings[lang] ||= settings.locales.each_with_object({}) do |path, global|
         find_locale_files(lang).each do |file|
-          strs = YAML.safe_load(File.open(file))
+          strs = YAML.safe_load(File.read(file))
           global.merge!(strs[lang])
         end
       end
@@ -118,7 +118,7 @@ module Sidekiq
       }.join(" ")
     end
 
-    # mperham/sidekiq#3243
+    # sidekiq/sidekiq#3243
     def unfiltered?
       yield unless env["PATH_INFO"].start_with?("/filter/")
     end
@@ -137,7 +137,7 @@ module Sidekiq
     end
 
     def sort_direction_label
-      params[:direction] == "asc" ? "↑" : "↓"
+      (params[:direction] == "asc") ? "↑" : "↓"
     end
 
     def workset
@@ -161,13 +161,21 @@ module Sidekiq
       end
     end
 
+    def busy_weights(capsule_weights)
+      # backwards compat with 7.0.0, remove in 7.1
+      cw = [capsule_weights].flatten
+      cw.map { |hash|
+        hash.map { |name, weight| (weight > 0) ? +name << ": " << weight.to_s : name }.join(", ")
+      }.join("; ")
+    end
+
     def stats
       @stats ||= Sidekiq::Stats.new
     end
 
     def redis_url
       Sidekiq.redis do |conn|
-        conn._config.server_url
+        conn.config.server_url
       end
     end
 
@@ -184,7 +192,7 @@ module Sidekiq
     end
 
     def current_status
-      workset.size == 0 ? "idle" : "active"
+      (workset.size == 0) ? "idle" : "active"
     end
 
     def relative_time(time)
@@ -217,7 +225,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 +332,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

@@ -2,7 +2,7 @@ require_relative "lib/sidekiq/version"
 
 Gem::Specification.new do |gem|
   gem.authors = ["Mike Perham"]
-  gem.email = ["mperham@gmail.com"]
+  gem.email = ["info@contribsys.com"]
   gem.summary = "Simple, efficient background processing for Ruby"
   gem.description = "Simple, efficient background processing for Ruby."
   gem.homepage = "https://sidekiq.org"
@@ -16,35 +16,24 @@ Gem::Specification.new do |gem|
 
   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/main/Changes.md",
-    "source_code_uri" => "https://github.com/mperham/sidekiq"
+    "bug_tracker_uri" => "https://github.com/sidekiq/sidekiq/issues",
+    "documentation_uri" => "https://github.com/sidekiq/sidekiq/wiki",
+    "changelog_uri" => "https://github.com/sidekiq/sidekiq/blob/main/Changes.md",
+    "source_code_uri" => "https://github.com/sidekiq/sidekiq",
+    "rubygems_mfa_required" => "true"
   }
 
-  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"
   gem.post_install_message = <<~EOM
     
-    ####################################################
-    
-    
-      █████████  █████ ██████████   ██████████ █████   ████ █████    ██████       ██████████       █████
-     ███░░░░░███░░███ ░░███░░░░███ ░░███░░░░░█░░███   ███░ ░░███   ███░░░░███    ░███░░░░███     ███░░░███
-    ░███    ░░░  ░███  ░███   ░░███ ░███  █ ░  ░███  ███    ░███  ███    ░░███   ░░░    ███     ███   ░░███
-    ░░█████████  ░███  ░███    ░███ ░██████    ░███████     ░███ ░███     ░███         ███     ░███    ░███
-     ░░░░░░░░███ ░███  ░███    ░███ ░███░░█    ░███░░███    ░███ ░███   ██░███        ███      ░███    ░███
-     ███    ░███ ░███  ░███    ███  ░███ ░   █ ░███ ░░███   ░███ ░░███ ░░████        ███       ░░███   ███
-    ░░█████████  █████ ██████████   ██████████ █████ ░░████ █████ ░░░██████░██      ███      ██ ░░░█████░
-     ░░░░░░░░░  ░░░░░ ░░░░░░░░░░   ░░░░░░░░░░ ░░░░░   ░░░░ ░░░░░    ░░░░░░ ░░      ░░░      ░░    ░░░░░░
-    
+    Welcome to Sidekiq 7.0!
     
     1. Use `gem 'sidekiq', '<7'` in your Gemfile if you don't want this new version.
-    2. Read the release notes at https://github.com/mperham/sidekiq/blob/main/docs/7.0-Upgrade.md
-    3. Search for open/closed issues at https://github.com/mperham/sidekiq/issues/
-    
-    ####################################################
+    2. Read the release notes at https://github.com/sidekiq/sidekiq/blob/main/docs/7.0-Upgrade.md
+    3. If you have problems, search for open/closed issues at https://github.com/sidekiq/sidekiq/issues/
+
   EOM
 end

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/javascripts/metrics.js

@@ -4,6 +4,14 @@ class JobMetricsOverviewChart extends BaseChart {
     this.swatches = [];
     this.visibleKls = options.visibleKls;
 
+    const countBuckets = this.options.labels.length / 60;
+    this.labelBuckets = this.options.labels.reduce((acc, label, index) => {
+      const bucket = Math.floor(index / countBuckets);
+      acc[bucket] = acc[bucket] || [];
+      acc[bucket].push(label);
+      return acc;
+    }, []);
+
     this.init();
   }
 
@@ -52,7 +60,7 @@ class JobMetricsOverviewChart extends BaseChart {
 
     return {
       label: kls,
-      data: this.options.series[kls],
+      data: this.buildSeries(kls),
       borderColor: color,
       backgroundColor: color,
       borderWidth: 2,
@@ -60,6 +68,26 @@ class JobMetricsOverviewChart extends BaseChart {
     };
   }
 
+  buildSeries(kls) {
+    // `series` is an object that maps labels to counts => { "20:15" => 2, "20:16" => 3, ... }
+    const series = this.options.series[kls];
+    return this.labelBuckets.reduce((acc, labels) => {
+      const bucketValues = labels.map(label => series[label]).filter(v => v);
+      if (bucketValues.length > 0) {
+        // Sum up the values for each bucket that has data.
+        // The new label is the bucket's first label, its start time.
+        acc[labels[0]] = bucketValues.reduce((a, b) => a + b, 0);
+      }
+      return acc;
+    }, {});
+  }
+
+  buildTooltipTitle(items) {
+    const [first, ...rest] = this.labelBuckets.find((labels) => labels[0] === items[0].label);
+    const title = [first, rest[rest.length - 1]].filter(v => v).join(" - ");
+    return `${title} UTC`
+  }
+
   get chartOptions() {
     return {
       ...super.chartOptions,
@@ -80,7 +108,7 @@ class JobMetricsOverviewChart extends BaseChart {
         tooltip: {
           ...super.chartOptions.plugins.tooltip,
           callbacks: {
-            title: (items) => `${items[0].label} UTC`,
+            title: (items) => this.buildTooltipTitle(items),
             label: (item) =>
               `${item.dataset.label}: ${item.parsed.y.toFixed(1)} ` +
               `${this.options.units}`,

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

@@ -72,7 +72,7 @@ h1, h2, h3 {
   line-height: 45px;
 }
 
-.header-container {
+.header-container, .header-container .page-title-container {
   display: flex;
   justify-content: space-between;
   align-items: center;
@@ -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/locales/da.yml

@@ -1,11 +1,12 @@
 # elements like %{queue} are variables and should not be translated
 da:
-  Actions: Actions
+  Actions: Handlinger
   AddToQueue: Tilføj til kø
   AreYouSure: Er du sikker?
   AreYouSureDeleteJob: Er du sikker på at du vil slette dette job?
   AreYouSureDeleteQueue: Er du sikker på at du vil slette %{queue} køen?
   Arguments: Argumenter
+  AvgExecutionTime: Gennemsnitlig eksekveringstid
   Busy: Travl
   Class: Klasse
   Connections: Forbindelser
@@ -18,21 +19,25 @@ da:
   Enqueued: I kø
   Error: Fejl
   ErrorBacktrace: Fejl backtrace
-  ErrorClass: Fejl klasse
-  ErrorMessage: Fejl besked
+  ErrorClass: Fejlklasse
+  ErrorMessage: Fejlbesked
   Extras: Ekstra
   Failed: Fejlet
+  Failure: Fejl
   Failures: Fejl
   GoBack: ← Tilbage
   History: Historik
   Job: Job
   Jobs: Jobs
+  Latency: Forsinkelse
   LastRetry: Sidste forsøg
   LivePoll: Live Poll
   MemoryUsage: RAM forbrug
+  Name: Navn
   Namespace: Namespace
   NextRetry: Næste forsøg
   NoDeadJobsFound: Ingen døde jobs fundet
+  NoJobMetricsFound: Ingen nylig job-metrics blev fundet
   NoRetriesFound: Ingen gen-forsøg var fundet
   NoScheduledFound: Ingen jobs i kø fundet
   OneMonth: 1 måned
@@ -43,7 +48,7 @@ da:
   Processes: Processer
   Queue: Kø
   Queues: Køer
-  Realtime: Real-time
+  Realtime: Realtid
   Retries: Forsøg
   RetryAll: Forsøg alle
   RetryCount: Antal forsøg
@@ -56,10 +61,12 @@ da:
   Started: Startet
   Status: Status
   StopPolling: Stop Polling
+  Success: Succes
   Thread: Tråd
   Threads: Tråde
   ThreeMonths: 3 måneder
   Time: Tid
+  TotalExecutionTime: Total eksekveringstid
   Uptime: Oppetid (dage)
   Version: Version
   When: Når

data/web/locales/ja.yml

@@ -27,6 +27,7 @@ ja:
   Extras: エクストラ
   Failed: 失敗
   Failures: 失敗
+  Failure: 失敗
   GoBack: ← 戻る
   History: 履歴
   Job: ジョブ
@@ -75,6 +76,7 @@ ja:
   Stop: 停止
   StopAll: すべて停止
   StopPolling: ポーリング停止
+  Success: 成功
   Thread: スレッド
   Threads: スレッド
   ThreeMonths: 3 ヶ月
@@ -82,7 +84,7 @@ ja:
   Unpause: 一時停止を解除
   Metrics: メトリクス
   NoDataFound: データが見つかりませんでした
-  ExecutionTime: 合計実行時間
+  TotalExecutionTime: 合計実行時間
   AvgExecutionTime: 平均実行時間
   Context: コンテキスト
   Bucket: バケット

data/web/views/_footer.erb

@@ -12,10 +12,10 @@
             <p id="serverUtcTime" class="navbar-text server-utc-time"><%= server_utc_time %></p>
           </li>
           <li>
-            <p class="navbar-text"><a rel=help href="https://github.com/mperham/sidekiq/wiki">docs</a></p>
+            <p class="navbar-text"><a rel=help href="https://github.com/sidekiq/sidekiq/wiki">docs</a></p>
           </li>
           <li>
-            <p class="navbar-text"><a rel=external href="https://github.com/mperham/sidekiq/tree/main/web/locales"><%= locale %></a></p>
+            <p class="navbar-text"><a rel=external href="https://github.com/sidekiq/sidekiq/tree/main/web/locales"><%= locale %></a></p>
           </li>
         </ul>
     </div>

data/web/views/_job_info.erb

@@ -1,6 +1,6 @@
-<header>
+<div class="header-container">
   <h3><%= t('Job') %></h3>
-</header>
+</div>
 
 <div class="table_container">
   <table class="table table-bordered table-striped table-hover">
@@ -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/_metrics_period_select.erb

@@ -0,0 +1,12 @@
+<div>
+  <select class="form-control" onchange="window.location.href = '<%= path %>?period=' + event.target.value">
+    <% periods.each_key do |code| %>
+
+      <% if code == period %>
+        <option selected value="<%= code %>"><%= code %></option>
+      <% else %>
+        <option value="<%= code %>"><%= code %></option>
+      <% end %>
+    <% end %>
+  </select>
+</div>

data/web/views/_paging.erb

@@ -1,3 +1,4 @@
+<div>
 <% if @total_size > @count %>
   <ul class="pagination pull-right flip">
     <li class="<%= 'disabled' if @current_page == 1 %>">
@@ -21,3 +22,4 @@
     </li>
   </ul>
 <% end %>
+</div>

data/web/views/busy.erb

@@ -1,7 +1,5 @@
-<div class="row header">
-  <div class="col-sm-4 pull-left flip">
-    <h3><%= t('Status') %></h3>
-  </div>
+<div class="header-container">
+  <h1><%= t('Status') %></h1>
 </div>
 
 <div class="stats-wrapper">
@@ -29,11 +27,9 @@
   </div>
 </div>
 
-<div class="row header">
-  <div class="col-sm-4 pull-left flip">
-    <h3><%= t('Processes') %></h3>
-  </div>
-  <div class="col-sm-3 pull-right flip">
+<div class="header-container">
+  <h1><%= t('Processes') %></h1>
+  <div>
     <form method="POST" class="warning-messages">
       <%= csrf_tag %>
       <div class="btn-group pull-right flip">
@@ -43,12 +39,13 @@
     </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 class="col-sm-1"><%= t('RSS') %><a target="blank" 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('RSS') %><a target="blank" href="https://github.com/sidekiq/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>
@@ -62,6 +59,9 @@
           <% process.labels.each do |label| %>
             <span class="label label-info"><%= label %></span>
           <% end %>
+          <% if process.embedded? %>
+            <span class="label label-default">embedded</span>
+          <% end %>
           <% if process.stopping? %>
             <span class="label label-danger">quiet</span>
           <% end %>
@@ -70,36 +70,47 @@
           <% end %>
           <br>
           <b><%= "#{t('Queues')}: " %></b>
-          <%= process.queues.join(", ") %>
+          <% if process.weights %>
+            <%= busy_weights(process.weights) %>
+          <% 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>
         <td><%= process['concurrency'] %></td>
         <td><%= process['busy'] %></td>
         <td>
-          <form method="POST">
-            <%= csrf_tag %>
-            <input type="hidden" name="identity" value="<%= process['identity'] %>"/>
+          <% unless process.embedded? %>
+            <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-xs btn-warn" type="submit" name="quiet" value="1"><%= t('Quiet') %></button><% end %>
-              <button class="btn btn-xs btn-danger" type="submit" name="stop" value="1"><%= t('Stop') %></button>
-            </div>
-          </form>
+              <div class="btn-group pull-right flip">
+                <% unless process.stopping? %><button class="btn btn-xs btn-warn" type="submit" name="quiet" value="1"><%= t('Quiet') %></button><% end %>
+                <button class="btn btn-xs btn-danger" type="submit" name="stop" value="1"><%= t('Stop') %></button>
+              </div>
+            </form>
+          <% end %>
         </td>
       </tr>
     <% end %>
   </table>
 </div>
 
-<div class="row header">
-  <div class="col-sm-7">
-    <h3><%= t('Jobs') %></h3>
-  </div>
+<div class="header-container">
+  <h1><%= t('Jobs') %></h1>
   <% if @workset.size > 0 && @total_size > @count %>
-    <div class="col-sm-4">
-      <%= erb :_paging, locals: { url: "#{root_path}busy" } %>
-    </div>
+    <%= erb :_paging, locals: { url: "#{root_path}busy" } %>
   <% end %>
 </div>
 

data/web/views/metrics.erb

@@ -4,11 +4,13 @@
 <script type="text/javascript" src="<%= root_path %>javascripts/metrics.js"></script>
 
 <div class="header-container">
-  <h1><%= t('Metrics') %></h1>
+  <div class="page-title-container">
+    <h1><%= t('Metrics') %></h1>
 
-  <div>
-    <a target="blank" href="https://github.com/mperham/sidekiq/wiki/Metrics"><span class="info-circle" title="Click to learn more about metrics">?</span></a>
+    <a target="blank" href="https://github.com/sidekiq/sidekiq/wiki/Metrics"><span class="info-circle" title="Click to learn more about metrics">?</span></a>
   </div>
+
+  <%= erb :_metrics_period_select, locals: { periods: @periods, period: @period, path: "#{root_path}metrics" } %>
 </div>
 
 <%
@@ -60,7 +62,7 @@
                   value="<%= kls %>"
                   <%= visible_kls.include?(kls) ? 'checked' : '' %>
                 />
-                <code><a href="<%= root_path %>metrics/<%= kls %>"><%= kls %></a></code>
+                <code><a href="<%= root_path %>metrics/<%= kls %>?period=<%= @period %>"><%= kls %></a></code>
               </div>
               <script>jobMetricsChart.registerSwatch("<%= id %>")</script>
             </td>