sidekiq 7.2.4 → 7.3.2

data/lib/sidekiq/web/helpers.rb

@@ -6,8 +6,51 @@ require "yaml"
 require "cgi"
 
 module Sidekiq
-  # This is not a public API
+  # These methods are available to pages within the Web UI and UI extensions.
+  # They are not public APIs for applications to use.
   module WebHelpers
+    def style_tag(location, **kwargs)
+      global = location.match?(/:\/\//)
+      location = root_path + location if !global && !location.start_with?(root_path)
+      attrs = {
+        type: "text/css",
+        media: "screen",
+        rel: "stylesheet",
+        nonce: csp_nonce,
+        href: location
+      }
+      html_tag(:link, attrs.merge(kwargs))
+    end
+
+    def script_tag(location, **kwargs)
+      global = location.match?(/:\/\//)
+      location = root_path + location if !global && !location.start_with?(root_path)
+      attrs = {
+        type: "text/javascript",
+        nonce: csp_nonce,
+        src: location
+      }
+      html_tag(:script, attrs.merge(kwargs)) {}
+    end
+
+    # NB: keys and values are not escaped; do not allow user input
+    # in the attributes
+    private def html_tag(tagname, attrs)
+      s = +"<#{tagname}"
+      attrs.each_pair do |k, v|
+        next unless v
+        s << " #{k}=\"#{v}\""
+      end
+      if block_given?
+        s << ">"
+        yield s
+        s << "</#{tagname}>"
+      else
+        s << " />"
+      end
+      s
+    end
+
     def strings(lang)
       @strings ||= {}
 
@@ -46,7 +89,7 @@ module Sidekiq
     end
 
     def available_locales
-      @available_locales ||= locale_files.map { |path| File.basename(path, ".yml") }.uniq
+      @available_locales ||= Set.new(locale_files.map { |path| File.basename(path, ".yml") })
     end
 
     def find_locale_files(lang)
@@ -122,10 +165,9 @@ module Sidekiq
     # Inspiration taken from https://github.com/iain/http_accept_language/blob/master/lib/http_accept_language/parser.rb
     def locale
       # session[:locale] is set via the locale selector from the footer
-      # defined?(session) && session are used to avoid exceptions when running tests
-      return session[:locale] if defined?(session) && session&.[](:locale)
-
-      @locale ||= begin
+      @locale ||= if (l = session&.fetch(:locale, nil)) && available_locales.include?(l)
+        l
+      else
         matched_locale = user_preferred_languages.map { |preferred|
           preferred_language = preferred.split("-", 2).first
 
@@ -267,6 +309,10 @@ module Sidekiq
       "<input type='hidden' name='authenticity_token' value='#{env[:csrf_token]}'/>"
     end
 
+    def csp_nonce
+      env[:csp_nonce]
+    end
+
     def to_display(arg)
       arg.inspect
     rescue
@@ -310,7 +356,7 @@ module Sidekiq
     end
 
     def h(text)
-      ::Rack::Utils.escape_html(text)
+      ::Rack::Utils.escape_html(text.to_s)
     rescue ArgumentError => e
       raise unless e.message.eql?("invalid byte sequence in UTF-8")
       text.encode!("UTF-16", "UTF-8", invalid: :replace, replace: "").encode!("UTF-8", "UTF-16")

data/lib/sidekiq/web.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "erb"
+require "securerandom"
 
 require "sidekiq"
 require "sidekiq/api"
@@ -39,11 +40,13 @@ module Sidekiq
       CONTENT_SECURITY_POLICY = "Content-Security-Policy"
       LOCATION = "Location"
       X_CASCADE = "X-Cascade"
+      X_CONTENT_TYPE_OPTIONS = "X-Content-Type-Options"
     else
       CONTENT_LANGUAGE = "content-language"
       CONTENT_SECURITY_POLICY = "content-security-policy"
       LOCATION = "location"
       X_CASCADE = "x-cascade"
+      X_CONTENT_TYPE_OPTIONS = "x-content-type-options"
     end
 
     class << self
@@ -114,6 +117,7 @@ module Sidekiq
     end
 
     def call(env)
+      env[:csp_nonce] = SecureRandom.base64(16)
       app.call(env)
     end
 
@@ -138,7 +142,50 @@ module Sidekiq
       send(:"#{attribute}=", value)
     end
 
-    def self.register(extension)
+    # Register a class as a Sidekiq Web UI extension. The class should
+    # provide one or more tabs which map to an index route. Options:
+    #
+    # @param extension [Class] Class which contains the HTTP actions, required
+    # @param name [String] the name of the extension, used to namespace assets
+    # @param tab [String | Array] labels(s) of the UI tabs
+    # @param index [String | Array] index route(s) for each tab
+    # @param root_dir [String] directory location to find assets, locales and views, typically `web/` within the gemfile
+    # @param asset_paths [Array] one or more directories under {root}/assets/{name} to be publicly served, e.g. ["js", "css", "img"]
+    # @param cache_for [Integer] amount of time to cache assets, default one day
+    #
+    # TODO name, tab and index will be mandatory in 8.0
+    #
+    # Web extensions will have a root `web/` directory with `locales/`, `assets/`
+    # and `views/` subdirectories.
+    def self.register(extension, name: nil, tab: nil, index: nil, root_dir: nil, cache_for: 86400, asset_paths: nil)
+      tab = Array(tab)
+      index = Array(index)
+      tab.zip(index).each do |tab, index|
+        tabs[tab] = index
+      end
+      if root_dir
+        locdir = File.join(root_dir, "locales")
+        locales << locdir if File.directory?(locdir)
+
+        if asset_paths && name
+          # if you have {root}/assets/{name}/js/scripts.js
+          # and {root}/assets/{name}/css/styles.css
+          # you would pass in:
+          #   asset_paths: ["js", "css"]
+          # See script_tag and style_tag in web/helpers.rb
+          assdir = File.join(root_dir, "assets")
+          assurls = Array(asset_paths).map { |x| "/#{name}/#{x}" }
+          assetprops = {
+            urls: assurls,
+            root: assdir,
+            cascade: true
+          }
+          assetprops[:header_rules] = [[:all, {Rack::CACHE_CONTROL => "private, max-age=#{cache_for.to_i}"}]] if cache_for
+          middlewares << [[Rack::Static, assetprops], nil]
+        end
+      end
+
+      yield self if block_given?
       extension.registered(WebApplication)
     end
 

data/lib/sidekiq.rb

@@ -32,6 +32,7 @@ require "sidekiq/logger"
 require "sidekiq/client"
 require "sidekiq/transaction_aware_client"
 require "sidekiq/job"
+require "sidekiq/iterable_job"
 require "sidekiq/worker_compatibility_alias"
 require "sidekiq/redis_client_adapter"
 
@@ -112,7 +113,7 @@ module Sidekiq
   #   end
   #   inst.run
   #   sleep 10
-  #   inst.terminate
+  #   inst.stop
   #
   # NB: it is really easy to overload a Ruby process with threads due to the GIL.
   # I do not recommend setting concurrency higher than 2-3.

data/sidekiq.gemspec

@@ -23,8 +23,9 @@ Gem::Specification.new do |gem|
     "rubygems_mfa_required" => "true"
   }
 
-  gem.add_dependency "redis-client", ">= 0.19.0"
+  gem.add_dependency "redis-client", ">= 0.22.2"
   gem.add_dependency "connection_pool", ">= 2.3.0"
   gem.add_dependency "rack", ">= 2.2.4"
   gem.add_dependency "concurrent-ruby", "< 2"
+  gem.add_dependency "logger"
 end

data/web/assets/javascripts/application.js

@@ -34,6 +34,7 @@ function addListeners() {
   addShiftClickListeners()
   updateFuzzyTimes();
   updateNumbers();
+  updateProgressBars();
   setLivePollFromUrl();
 
   var buttons = document.querySelectorAll(".live-poll");
@@ -180,4 +181,8 @@ function showError(error) {
 
 function updateLocale(event) {
   event.target.form.submit();
-};
+}
+
+function updateProgressBars() {
+  document.querySelectorAll('.progress-bar').forEach(bar => { bar.style.width = bar.dataset.width + "%"})
+}

data/web/assets/javascripts/dashboard-charts.js

@@ -108,17 +108,27 @@ class RealtimeChart extends DashboardChart {
   }
 
   renderLegend(dp) {
-    this.legend.innerHTML = `
-      <span>
-        <span class="swatch" style="background-color: ${dp[0].dataset.borderColor};"></span>
-        <span>${dp[0].dataset.label}: ${dp[0].formattedValue}</span>
-      </span>
-      <span>
-        <span class="swatch" style="background-color: ${dp[1].dataset.borderColor};"></span>
-        <span>${dp[1].dataset.label}: ${dp[1].formattedValue}</span>
-      </span>
-      <span class="time">${dp[0].label}</span>
-    `;
+    const entry1 = this.legendEntry(dp[0]);
+    const entry2 = this.legendEntry(dp[1]);
+    const time = document.createElement("span");
+    time.classList.add("time");
+    time.innerText = dp[0].label;
+
+    this.legend.replaceChildren(entry1, entry2, time)
+  }
+
+  legendEntry(dp) {
+    const wrapper = document.createElement("span");
+
+    const swatch = document.createElement("span");
+    swatch.classList.add("swatch");
+    swatch.style.backgroundColor = dp.dataset.borderColor;
+    wrapper.appendChild(swatch)
+    
+    const label = document.createElement("span");
+    label.innerText = `${dp.dataset.label}: ${dp.formattedValue}`;
+    wrapper.appendChild(label)
+    return wrapper;
   }
 
   renderCursor(dp) {
@@ -179,4 +189,4 @@ class RealtimeChart extends DashboardChart {
   if (hc != null) {
     var htc = new DashboardChart(hc, JSON.parse(hc.textContent))
     window.historyChart = htc
-  }
+  }

data/web/assets/javascripts/dashboard.js

@@ -28,7 +28,7 @@ var pulseBeacon = function() {
 }
 
 var setSliderLabel = function(val) {
-  document.getElementById('sldr-text').innerText = Math.round(parseFloat(val) / 1000) + ' sec';
+  document.getElementById('sldr-text').innerText = Math.round(parseFloat(val) / 1000) + ' s';
 }
 
 var ready = (callback) => {

data/web/assets/stylesheets/application.css

@@ -72,6 +72,14 @@ h1, h2, h3 {
   line-height: 45px;
 }
 
+.progress {
+  margin-bottom: 0;
+}
+
+.w-50 {
+  width: 50%;
+}
+
 .header-container, .header-container .page-title-container {
   display: flex;
   justify-content: space-between;
@@ -640,18 +648,18 @@ div.interval-slider input {
 
 @media (min-width: 768px) {
   .redis-url {
-    max-width: 250px;
+    max-width: 160px;
   }
 }
 
 @media (min-width: 992px) {
   .redis-url {
-    max-width: 490px;
+    max-width: 380px;
   }
 }
 @media (min-width: 1200px) {
   .redis-url {
-    max-width: 600px;
+    max-width: 580px;
   }
 }
 

data/web/locales/tr.yml

@@ -0,0 +1,101 @@
+# elements like %{queue} are variables and should not be translated
+tr:
+  Actions: Eylemler
+  AddToQueue: Kuyruğa ekle
+  AreYouSure: Emin misiniz?
+  AreYouSureDeleteJob: Bu işi silmek istediğinizden emin misiniz?
+  AreYouSureDeleteQueue: "%{queue} kuyruğunu silmek istediğinizden emin misiniz?"
+  Arguments: Argümanlar
+  BackToApp: Uygulamaya geri dön
+  Busy: Meşgul
+  Class: Sınıf
+  Connections: Bağlantılar
+  CreatedAt: Oluşturulma Tarihi
+  CurrentMessagesInQueue: Şu anki işler <span class='title'>%{queue}</span>
+  Dashboard: Gösterge Paneli
+  Dead: Ölü
+  DeadJobs: Ölü İşler
+  Delete: Sil
+  DeleteAll: Hepsini Sil
+  Deploy: Dağıt
+  Enqueued: Kuyruğa Alındı
+  Error: Hata
+  ErrorBacktrace: Hata Geri İzleme
+  ErrorClass: Hata Sınıfı
+  ErrorMessage: Hata Mesajı
+  ExecutionTime: Yürütme Süresi
+  Extras: Ekstralar
+  Failed: Başarısız
+  Failures: Başarısızlıklar
+  Failure: Başarısızlık
+  GoBack: ← Geri Dön
+  History: Geçmiş
+  Job: İş
+  Jobs: İşler
+  Kill: Sonlandır
+  KillAll: Hepsini Sonlandır
+  LastRetry: Son Yeniden Deneme
+  Latency: Gecikme
+  LivePoll: Canlı Anket
+  MemoryUsage: Bellek Kullanımı
+  Name: İsim
+  Namespace: Ad Alanı
+  NextRetry: Bir Sonraki Yeniden Deneme
+  NoDeadJobsFound: Ölü iş bulunamadı
+  NoRetriesFound: Yeniden deneme bulunamadı
+  NoScheduledFound: Zamanlanmış iş bulunamadı
+  NotYetEnqueued: Henüz kuyruğa alınmadı
+  OneMonth: 1 ay
+  OneWeek: 1 hafta
+  OriginallyFailed: İlk Başarısızlık
+  Pause: Duraklat
+  Paused: Duraklatıldı
+  PeakMemoryUsage: Maksimum Bellek Kullanımı
+  Plugins: Eklentiler
+  PollingInterval: Anket Aralığı
+  Process: Süreç
+  Processed: İşlendi
+  Processes: Süreçler
+  Queue: Kuyruk
+  Queues: Kuyruklar
+  Quiet: Sessiz
+  QuietAll: Hepsini Sessiz Yap
+  Realtime: Gerçek Zamanlı
+  Retries: Yeniden Denemeler
+  RetryAll: Hepsini Yeniden Dene
+  RetryCount: Yeniden Deneme Sayısı
+  RetryNow: Şimdi Yeniden Dene
+  Scheduled: Zamanlanmış
+  ScheduledJobs: Zamanlanmış İşler
+  Seconds: Saniye
+  ShowAll: Hepsini Göster
+  SixMonths: 6 ay
+  Size: Boyut
+  Started: Başlatıldı
+  Status: Durum
+  Stop: Durdur
+  StopAll: Hepsini Durdur
+  StopPolling: Anketi Durdur
+  Success: Başarı
+  Summary: Özet
+  Thread: İplik
+  Threads: İplikler
+  ThreeMonths: 3 ay
+  Time: Zaman
+  Unpause: Duraklatmayı Kaldır
+  Uptime: Çalışma Süresi (gün)
+  Utilization: Kullanım
+  Version: Sürüm
+  When: Ne Zaman
+  Worker: İşçi
+  active: aktif
+  idle: boşta
+  Metrics: Metrikler
+  NoDataFound: Veri bulunamadı
+  TotalExecutionTime: Toplam Yürütme Süresi
+  AvgExecutionTime: Ortalama Yürütme Süresi
+  Context: Bağlam
+  Bucket: Kova
+  NoJobMetricsFound: Son iş metrikleri bulunamadı
+  Filter: Filtre
+  AnyJobContent: Herhangi bir iş içeriği

data/web/views/dashboard.erb

@@ -1,4 +1,4 @@
-<script type="text/javascript" src="<%= root_path %>javascripts/dashboard.js"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/dashboard.js" nonce="<%= csp_nonce %>"></script>
 <div class= "dashboard clearfix">
   <h3 >
     <%= t('Dashboard') %>
@@ -9,7 +9,7 @@
   </h3>
   <div class="interval-slider ltr">
     <span class="interval-slider-label"><%= t('PollingInterval') %>:</span>
-    <span id="sldr-text" class="current-interval">5 sec</span>
+    <span id="sldr-text" class="current-interval">5 s</span>
     <br/>
     <input id="sldr" type="range" min="2000" max="20000" step="1000" value="5000"/>
   </div>
@@ -99,7 +99,7 @@
   </div>
 </div>
 
-<script type="text/javascript" src="<%= root_path %>javascripts/chart.min.js"></script>
-<script type="text/javascript" src="<%= root_path %>javascripts/chartjs-plugin-annotation.min.js"></script>
-<script type="text/javascript" src="<%= root_path %>javascripts/base-charts.js"></script>
-<script type="text/javascript" src="<%= root_path %>javascripts/dashboard-charts.js"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/chart.min.js" nonce="<%= csp_nonce %>"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/chartjs-plugin-annotation.min.js" nonce="<%= csp_nonce %>"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/base-charts.js" nonce="<%= csp_nonce %>"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/dashboard-charts.js" nonce="<%= csp_nonce %>"></script>

data/web/views/layout.erb

@@ -5,20 +5,20 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width,initial-scale=1.0" />
 
-    <link href="<%= root_path %>stylesheets/bootstrap.css" media="screen" rel="stylesheet" type="text/css" />
+    <link href="<%= root_path %>stylesheets/bootstrap.css" media="screen" rel="stylesheet" type="text/css" nonce="<%= csp_nonce %>" />
     <% if rtl? %>
-    <link href="<%= root_path %>stylesheets/bootstrap-rtl.min.css" media="screen" rel="stylesheet" type="text/css"/>
+    <link href="<%= root_path %>stylesheets/bootstrap-rtl.min.css" media="screen" rel="stylesheet" type="text/css" nonce="<%= csp_nonce %>"/>
     <% end %>
 
-    <link href="<%= root_path %>stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" />
-    <link href="<%= root_path %>stylesheets/application-dark.css" media="screen and (prefers-color-scheme: dark)" rel="stylesheet" type="text/css" />
+    <link href="<%= root_path %>stylesheets/application.css" media="screen" rel="stylesheet" type="text/css" nonce="<%= csp_nonce %>" />
+    <link href="<%= root_path %>stylesheets/application-dark.css" media="screen and (prefers-color-scheme: dark)" rel="stylesheet" type="text/css" nonce="<%= csp_nonce %>" />
     <% if rtl? %>
-    <link href="<%= root_path %>stylesheets/application-rtl.css" media="screen" rel="stylesheet" type="text/css" />
+    <link href="<%= root_path %>stylesheets/application-rtl.css" media="screen" rel="stylesheet" type="text/css" nonce="<%= csp_nonce %>" />
     <% 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>
+    <script type="text/javascript" src="<%= root_path %>javascripts/application.js" nonce="<%= csp_nonce %>"></script>
     <meta name="google" content="notranslate" />
     <%= display_custom_head %>
   </head>

data/web/views/metrics.erb

@@ -1,6 +1,6 @@
-<script type="text/javascript" src="<%= root_path %>javascripts/chart.min.js"></script>
-<script type="text/javascript" src="<%= root_path %>javascripts/chartjs-plugin-annotation.min.js"></script>
-<script type="text/javascript" src="<%= root_path %>javascripts/base-charts.js"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/chart.min.js" nonce="<%= csp_nonce %>"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/chartjs-plugin-annotation.min.js" nonce="<%= csp_nonce %>"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/base-charts.js" nonce="<%= csp_nonce %>"></script>
 
 <div class="header-container">
   <div class="page-title-container">
@@ -88,4 +88,4 @@
 
 <!--p><small>Data from <%= @query_result.starts_at %> to <%= @query_result.ends_at %></small></p-->
 
-<script type="text/javascript" src="<%= root_path %>javascripts/metrics.js"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/metrics.js" nonce="<%= csp_nonce %>"></script>

data/web/views/metrics_for_job.erb

@@ -1,6 +1,6 @@
-<script type="text/javascript" src="<%= root_path %>javascripts/chart.min.js"></script>
-<script type="text/javascript" src="<%= root_path %>javascripts/chartjs-plugin-annotation.min.js"></script>
-<script type="text/javascript" src="<%= root_path %>javascripts/base-charts.js"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/chart.min.js" nonce="<%= csp_nonce %>"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/chartjs-plugin-annotation.min.js" nonce="<%= csp_nonce %>"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/base-charts.js" nonce="<%= csp_nonce %>"></script>
 
 <%
   job_result = @query_result.job_results[@name]
@@ -56,4 +56,4 @@
   <div class="alert alert-success"><%= t('NoJobMetricsFound') %></div>
 <% end %>
 
-<script type="text/javascript" src="<%= root_path %>javascripts/metrics.js"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/metrics.js" nonce="<%= csp_nonce %>"></script>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 7.2.4
+  version: 7.3.2
 platform: ruby
 authors:
 - Mike Perham
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-26 00:00:00.000000000 Z
+date: 2024-09-04 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.19.0
+        version: 0.22.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.22.2
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simple, efficient background processing for Ruby.
 email:
 - info@contribsys.com
@@ -96,7 +110,13 @@ files:
 - lib/sidekiq/deploy.rb
 - lib/sidekiq/embedded.rb
 - lib/sidekiq/fetch.rb
+- lib/sidekiq/iterable_job.rb
 - lib/sidekiq/job.rb
+- lib/sidekiq/job/interrupt_handler.rb
+- lib/sidekiq/job/iterable.rb
+- lib/sidekiq/job/iterable/active_record_enumerator.rb
+- lib/sidekiq/job/iterable/csv_enumerator.rb
+- lib/sidekiq/job/iterable/enumerators.rb
 - lib/sidekiq/job_logger.rb
 - lib/sidekiq/job_retry.rb
 - lib/sidekiq/job_util.rb
@@ -172,6 +192,7 @@ files:
 - web/locales/ru.yml
 - web/locales/sv.yml
 - web/locales/ta.yml
+- web/locales/tr.yml
 - web/locales/uk.yml
 - web/locales/ur.yml
 - web/locales/vi.yml
@@ -224,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Simple, efficient background processing for Ruby