sidekiq 8.1.1 → 8.1.6

data/lib/sidekiq/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Sidekiq
-  VERSION = "8.1.1"
+  VERSION = "8.1.6"
   MAJOR = 8
 
   def self.gem_version

data/lib/sidekiq/web/action.rb

@@ -24,8 +24,8 @@ module Sidekiq
         @request ||= ::Rack::Request.new(env)
       end
 
-      def halt(res)
-        throw :halt, [res, {"content-type" => "text/plain"}, [res.to_s]]
+      def halt(res, msg = nil)
+        throw :halt, [res, {"content-type" => "text/plain"}, [msg || res.to_s]]
       end
 
       # external redirect

data/lib/sidekiq/web/application.rb

@@ -90,7 +90,18 @@ module Sidekiq
 
       get "/busy" do
         @count = (url_params("count") || 100).to_i
-        (@current_page, @total_size, @workset) = page_items(workset, url_params("page"), @count)
+
+        # Use /busy?only=(jobs|processes) to limit page data
+        only = url_params("only")
+        halt 401, "Invalid value for only" unless only.nil? || only == "jobs" || only == "processes"
+
+        @show_jobs = (only != "processes")
+        @show_processes = (only != "jobs")
+
+        if @show_jobs
+          (@current_page, @total_size, @workset) = page_items(workset, url_params("page"), @count)
+          @iterable_states = Sidekiq::IterableJobQuery.new(workset.map { |_, _, work| work.job.jid })
+        end
 
         erb(:busy)
       end
@@ -226,6 +237,8 @@ module Sidekiq
           @retries = @retries.map { |msg, score| Sidekiq::SortedEntry.new(nil, score, msg) }
         end
 
+        @iterable_states = Sidekiq::IterableJobQuery.new(@retries.map(&:jid))
+
         erb(:retries)
       end
 

data/lib/sidekiq/web/helpers.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "uri"
-require "yaml"
 require "cgi/escape"
 
 module Sidekiq
@@ -73,12 +72,37 @@ module Sidekiq
       # so extensions can be localized
       @@strings[lang] ||= config.locales.each_with_object({}) do |path, global|
         find_locale_files(lang).each do |file|
-          strs = YAML.safe_load_file(file)
+          strs = parse_yaml(file)
           global.merge!(strs[lang])
         end
       end
     end
 
+    def parse_yaml(path)
+      locale = nil
+      map = {}
+      IO.readlines(path, chomp: true).each do |line|
+        case line
+        when /\A\s*\#.*/
+          # line comment
+        when !locale && /\A([a-zA-Z\-_]+):/
+          locale = $1
+          map[locale] = {}
+        when /\A\s+(\w+):\s+(.+)\z/
+          # A few values have double quotes to include special characters in YAML.
+          # Strip them off manually as our greedy match will include them.
+          key = $1
+          s = $2
+          s = s[1..] if s[0] == "\""
+          s = s[0..-2] if s[-1] == "\""
+          map[locale][key] = s
+        else
+          raise ArgumentError, "unable to parse #{path}: #{line}"
+        end
+      end
+      map
+    end
+
     def to_json(x)
       Sidekiq.dump_json(x)
     end
@@ -126,17 +150,18 @@ module Sidekiq
       erb(:filtering, locals: {which:, placeholder_key:, label_key:})
     end
 
-    def filter_link(jid, within = "retries")
+    def filter_link(str, within = "retries")
+      hstr = h(str)
       if within.nil?
-        ::Rack::Utils.escape_html(jid)
+        hstr
       else
-        "<a href='#{root_path}#{within}?substr=#{jid}'>#{::Rack::Utils.escape_html(jid)}</a>"
+        "<a href='#{root_path}#{within}?substr=#{hstr}'>#{hstr}</a>"
       end
     end
 
     def display_tags(job, within = "retries")
       job.tags.map { |tag|
-        "<span class='label label-info jobtag jobtag-#{Rack::Utils.escape_html(tag)}'>#{filter_link(tag, within)}</span>"
+        "<span class='label label-info jobtag jobtag-#{h(tag)}'>#{filter_link(tag, within)}</span>"
       }.join(" ")
     end
 
@@ -294,7 +319,7 @@ module Sidekiq
       else
         # DEPRECATED Backwards compatibility with older processes.
         # 'capsules' element added in v8.0.9
-        process.queues.join(", ")
+        pro.queues.join(", ")
       end
     end
 
@@ -307,7 +332,7 @@ module Sidekiq
       [score.to_f, jid]
     end
 
-    SAFE_QPARAMS = %w[page direction]
+    SAFE_QPARAMS = %w[page direction only]
 
     # Merge options with current params, filter safe params, and stringify to query string
     def qparams(options)
@@ -390,7 +415,7 @@ module Sidekiq
     end
 
     def h(text)
-      ::Rack::Utils.escape_html(text.to_s)
+      ::CGI.escapeHTML(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/router.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "rack"
+require "uri"
 
 module Sidekiq
   class Web
@@ -28,7 +28,7 @@ module Sidekiq
 
       def match(env)
         request_method = env["REQUEST_METHOD"].downcase.to_sym
-        path_info = ::Rack::Utils.unescape_path env["PATH_INFO"]
+        path_info = ::URI::RFC2396_PARSER.unescape env["PATH_INFO"]
 
         # There are servers which send an empty string when requesting the root.
         # These servers should be ashamed of themselves.

data/lib/sidekiq.rb

@@ -48,7 +48,7 @@ module Sidekiq
   end
 
   def self.testing!(mode = :fake, &block)
-    raise "Unknown testing mode: #{mode}" unless %i[fake disabled inline].include?(mode)
+    raise "Unknown testing mode: #{mode}" unless %i[fake disable inline].include?(mode)
 
     require "sidekiq/test_api"
     Sidekiq::Testing.__set_test_mode(mode, &block)

data/sidekiq.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.homepage = "https://sidekiq.org"
   gem.license = "LGPL-3.0"
 
-  gem.executables = ["sidekiq", "sidekiqmon"]
+  gem.executables = ["sidekiq", "sidekiqmon", "kiq"]
   gem.files = %w[sidekiq.gemspec README.md Changes.md LICENSE.txt] + `git ls-files | grep -E '^(bin|lib|web)'`.split("\n")
   gem.name = "sidekiq"
   gem.version = Sidekiq::VERSION
@@ -23,7 +23,7 @@ Gem::Specification.new do |gem|
     "rubygems_mfa_required" => "true"
   }
 
-  gem.add_dependency "redis-client", ">= 0.26.0"
+  gem.add_dependency "redis-client", ">= 0.29.0"
   gem.add_dependency "connection_pool", ">= 3.0.0"
   gem.add_dependency "rack", ">= 3.2.0"
   gem.add_dependency "json", ">= 2.16.0"

data/web/assets/stylesheets/style.css

@@ -534,6 +534,8 @@ input[type="checkbox"] { accent-color: var(--color-primary); }
 
 .pagination a { text-decoration: none; }
 
+.pagination .active a { color: var(--color-primary); font-weight: 700; }
+
 .pagination .disabled { opacity: 0.3; }
 
 div:has(.pagination.pull-right) { margin-left: auto; }

data/web/locales/ar.yml

@@ -74,7 +74,7 @@ ar:
   Stop: إيقاف
   StopAll: إيقاف الكل
   StopPolling: إيقاف الاستعلامات
-  TextDirection: 'rtl'
+  TextDirection: rtl
   Thread: نيسب
   Threads: نياسب
   ThreeMonths: ثلاثة أشهر

data/web/locales/fa.yml

@@ -69,7 +69,7 @@ fa:
   Stop: توقف
   StopAll: توقف همه
   StopPolling: Stop Polling
-  TextDirection: 'rtl'
+  TextDirection: rtl
   Thread: رشته
   Threads: رشته ها
   ThreeMonths: ۳ ماه

data/web/locales/gd.yml

@@ -1,6 +1,6 @@
-# elements like %{queue} are variables and should not be translated
+# elements like %{queue} are variables and should not be translated
 gd:
-  LanguageName: Gaeilge
+  LanguageName: Gàidhlig
   Actions: Gnìomhan
   AddToQueue: Cuir ris a’ chiutha
   AddAllToQueue: Cuir a h-uile ris a’ chiutha
@@ -36,6 +36,8 @@ gd:
   Jobs: Obraichean
   Kill: Marbh
   KillAll: Marbh na h-uile
+  Language: Cànan
+  LastDashboardUpdateTemplateLiteral: "An t-ath-nuadhachadh mu dheireadh: Air pròiseasadh: PROCESSED_COUNT. Air fàilligeadh: FAILED_COUNT."
   LastRetry: An oidhirp mu dheireadh
   Latency: Foillidheachd
   LivePoll: Ath-nuadhachadh beò
@@ -55,6 +57,7 @@ gd:
   PeakMemoryUsage: Bàrr cleachdadh a’ chuimhne
   Plugins: Plugain
   PollingInterval: Eadaramh an ath-nuadhachaidh
+  PollingIntervalMilliseconds: Milidiogan eadaramh an ath-nuadhachaidh
   Process: Pròiseas
   Processed: Air pròiseasadh
   Processes: Pròiseasan
@@ -98,3 +101,10 @@ gd:
   AvgExecutionTime: Ùine cuibheasach nan gnìomhan
   Context: Co-theacsa
   NoJobMetricsFound: Cha deach meatraigeachd o chionn goirid air obair a lorg
+  Filter: Criathraich
+  AnyJobContent: Susbaint obrach sam bith
+  Profiles: Pròifilean
+  Data: Dàta
+  View: Seall
+  Token: Tòcan
+  ElapsedTime: An ùine a chaidh seachad

data/web/locales/he.yml

@@ -69,7 +69,7 @@ he:
   Stop: עצור
   StopAll: עצור הכל
   StopPolling: עצור תשאול
-  TextDirection: 'rtl'
+  TextDirection: rtl
   Thread: חוט
   Threads: חוטים
   ThreeMonths: 3 חדשים

data/web/locales/pt-BR.yml

@@ -1,4 +1,4 @@
-"pt-BR":
+pt-BR:
   LanguageName: Português (Brasil)
   Actions: Ações
   AddToQueue: Adicionar à fila

data/web/locales/ur.yml

@@ -69,7 +69,7 @@ ur:
   Stop: بند کرو
   StopAll: ﺗﻤﺎﻡ ﺑﻨﺪ کﺭﻭ
   StopPolling: ﺑﺮاﮦ ﺭاﺳﺖ روکيے
-  TextDirection: 'rtl'
+  TextDirection: rtl
   Thread: موضوع
   Threads: موضوع
   ThreeMonths: تین ماہ

data/web/locales/zh-TW.yml

@@ -1,6 +1,6 @@
 # elements like %{queue} are variables and should not be translated
 zh-TW: # <---- change this to your locale code
-  LanguageName: 臺灣話
+  LanguageName: 繁體中文
   Dashboard: 資訊主頁
   Status: 狀態
   Time: 時間

data/web/views/_job_info.html.erb

@@ -34,6 +34,14 @@
             <code><%= job.jid %></code>
           </td>
         </tr>
+        <% if (state = job.iterable_state) %>
+        <tr>
+          <th>Iteration</th>
+          <td>
+            <code>cursor=<%= h(state.cursor.inspect) %>; exec=<%= state.executions %>; rt=<%= number_with_delimiter(state.runtime, precision: 3) %>s</code>
+          </td>
+        </tr>
+        <% end %>
         <% if job.bid %>
         <tr>
           <th>BID</th>

data/web/views/_paging.html.erb

@@ -10,7 +10,7 @@
           <a href="<%= url %>?<%= qparams(page: @current_page - 1) %>"><%= @current_page - 1 %></a>
         </li>
       <% end %>
-      <li class="disabled">
+      <li class="active">
         <a href="<%= url %>?<%= qparams(page: @current_page) %>"><%= @current_page %></a>
       </li>
       <% if @total_size > @current_page * @count %>

data/web/views/busy.html.erb

@@ -27,6 +27,7 @@
   </div>
 </section>
 
+<% if @show_processes %>
 <section>
   <header>
     <h2><%= t('Processes') %></h2>
@@ -102,45 +103,53 @@
     </table>
   </div>
 </section>
+<% end %>
 
-<section>
-  <header>
-    <h2><%= t('Jobs') %></h2>
-    <% if @workset.size > 0 && @total_size > @count %>
-      <%= erb :_paging, locals: { url: "#{root_path}busy" } %>
-    <% end %>
-  </header>
-
-  <div class="table_container">
-    <table>
-      <thead>
-        <th><%= t('Process') %></th>
-        <th><%= t('TID') %></th>
-        <th><%= t('JID') %></th>
-        <th><%= t('Queue') %></th>
-        <th><%= t('Job') %></th>
-        <th><%= t('Arguments') %></th>
-        <th><%= t('Started') %></th>
-      </thead>
-      <% @workset.each do |process, thread, work| %>
-        <% job = work.job %>
-        <tr>
-          <td><%= process %></td>
-          <td><%= thread %></td>
-          <td><%= job.jid %></td>
-          <td>
-            <a href="<%= root_path %>queues/<%= work.queue %>"><%= work.queue %></a>
-          </td>
-          <td>
-            <%= job.display_class %>
-            <%= display_tags(job, nil) %>
-          </td>
-          <td>
-            <code><div class="args"><%= display_args(job.display_args) %></div></code>
-          </td>
-          <td><%= relative_time(work.run_at) %></td>
-        </tr>
+<% if @show_jobs %>
+  <section>
+    <header>
+      <h2><%= t('Jobs') %></h2>
+      <% if @workset.size > 0 && @total_size > @count %>
+        <%= erb :_paging, locals: { url: "#{root_path}busy" } %>
       <% end %>
-    </table>
-  </div>
-</section>
+    </header>
+
+    <div class="table_container">
+      <table>
+        <thead>
+          <th><%= t('Process') %></th>
+          <th><%= t('TID') %></th>
+          <th><%= t('JID') %></th>
+          <th><%= t('Queue') %></th>
+          <th><%= t('Job') %></th>
+          <th><%= t('Arguments') %></th>
+          <th><%= t('Started') %></th>
+        </thead>
+        <% @workset.each do |process, thread, work| %>
+          <% job = work.job %>
+          <tr>
+            <td><%= process %></td>
+            <td><%= thread %></td>
+            <td><%= job.jid %></td>
+            <td>
+              <a href="<%= root_path %>queues/<%= work.queue %>"><%= work.queue %></a>
+            </td>
+            <td>
+              <%= job.display_class %>
+              <%= display_tags(job, nil) %>
+            </td>
+            <td>
+              <code><div class="args"><%= display_args(job.display_args) %></div></code>
+            </td>
+            <td>
+              <%= relative_time(work.run_at) %>
+              <% if (state = @iterable_states[job.jid]) %>
+                <div><small>cursor=<%= h(truncate(state.cursor.inspect, 100)) %>; exec=<%= state.executions %>; rt=<%= number_with_delimiter(state.runtime, precision: 3) %>s</small></div>
+              <% end %>
+            </td>
+          </tr>
+        <% end %>
+      </table>
+    </div>
+  </section>
+<% end %>

data/web/views/retries.html.erb

@@ -52,6 +52,9 @@
               </td>
               <td>
                 <div><a href="<%= root_path %>retries/<%= job_params(entry.item, entry.score) %>"><%= h truncate("#{entry['error_class']}: #{entry['error_message']}", 200) %></a></div>
+                <% if (state = @iterable_states[entry.jid]) %>
+                  <div><small>cursor=<%= h(truncate(state.cursor.inspect, 100)) %>; exec=<%= state.executions %>; rt=<%= number_with_delimiter(state.runtime, precision: 3) %>s</small></div>
+                <% end %>
               </td>
             </tr>
           <% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 8.1.1
+  version: 8.1.6
 platform: ruby
 authors:
 - Mike Perham
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.26.0
+        version: 0.29.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.26.0
+        version: 0.29.0
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
@@ -83,6 +83,7 @@ description: Simple, efficient background processing for Ruby.
 email:
 - info@contribsys.com
 executables:
+- kiq
 - sidekiq
 - sidekiqmon
 extensions: []
@@ -91,12 +92,12 @@ files:
 - Changes.md
 - LICENSE.txt
 - README.md
+- bin/kiq
 - bin/lint-herb
 - bin/multi_queue_bench
 - bin/sidekiq
 - bin/sidekiqload
 - bin/sidekiqmon
-- bin/tui
 - bin/webload
 - lib/active_job/queue_adapters/sidekiq_adapter.rb
 - lib/generators/sidekiq/job_generator.rb
@@ -150,6 +151,18 @@ files:
 - lib/sidekiq/testing/inline.rb
 - lib/sidekiq/transaction_aware_client.rb
 - lib/sidekiq/tui.rb
+- lib/sidekiq/tui/controls.rb
+- lib/sidekiq/tui/filtering.rb
+- lib/sidekiq/tui/tabs.rb
+- lib/sidekiq/tui/tabs/base_tab.rb
+- lib/sidekiq/tui/tabs/busy.rb
+- lib/sidekiq/tui/tabs/dead.rb
+- lib/sidekiq/tui/tabs/home.rb
+- lib/sidekiq/tui/tabs/metrics.rb
+- lib/sidekiq/tui/tabs/queues.rb
+- lib/sidekiq/tui/tabs/retries.rb
+- lib/sidekiq/tui/tabs/scheduled.rb
+- lib/sidekiq/tui/tabs/set_tab.rb
 - lib/sidekiq/version.rb
 - lib/sidekiq/web.rb
 - lib/sidekiq/web/action.rb

data/bin/tui

@@ -1,5 +0,0 @@
-#!/usr/bin/env ruby
-
-require_relative "../lib/sidekiq/tui"
-
-Sidekiq::TUI.new.run