sidekiq 6.4.1 → 7.0.0

data/web/views/metrics.erb

@@ -0,0 +1,80 @@
+<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/metrics.js"></script>
+
+<div class="header-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>
+  </div>
+</div>
+
+<%
+  table_limit = 20
+  chart_limit = 5
+  job_results = @query_result.job_results.sort_by { |(kls, jr)| jr.totals["s"] }.reverse.first(table_limit)
+  visible_kls = job_results.first(chart_limit).map(&:first)
+%>
+
+<% if job_results.any? %>
+  <canvas id="job-metrics-overview-chart"></canvas>
+
+  <script>
+    window.jobMetricsChart = new JobMetricsOverviewChart(
+      document.getElementById("job-metrics-overview-chart"),
+      <%= Sidekiq.dump_json({
+        series: job_results.map { |(kls, jr)| [kls, jr.dig("series", "s")] }.to_h,
+        marks: @query_result.marks.map { |m| [m.bucket, m.label] },
+        labels: @query_result.buckets,
+        visibleKls: visible_kls,
+        yLabel: t('TotalExecutionTime'),
+        units: t('Seconds').downcase,
+        markLabel: t('Deploy'),
+      }) %>
+    )
+  </script>
+<% end %>
+
+<div class="table_container">
+  <table class="table table-bordered table-striped table-hover">
+    <tbody>
+      <tr>
+        <th><%= t('Name') %></th>
+        <th><%= t('Success') %></th>
+        <th><%= t('Failure') %></th>
+        <th><%= t('TotalExecutionTime') %></th>
+        <th><%= t('AvgExecutionTime') %></th>
+      </tr>
+      <% if job_results.any? %>
+        <% job_results.each_with_index do |(kls, jr), i| %>
+          <tr>
+            <td>
+              <div class="metrics-swatch-wrapper">
+                <% id = "metrics-swatch-#{kls}" %>
+                <input
+                  type="checkbox"
+                  id="<%= id %>"
+                  class="metrics-swatch"
+                  value="<%= kls %>"
+                  <%= visible_kls.include?(kls) ? 'checked' : '' %>
+                />
+                <code><a href="<%= root_path %>metrics/<%= kls %>"><%= kls %></a></code>
+              </div>
+              <script>jobMetricsChart.registerSwatch("<%= id %>")</script>
+            </td>
+            <td><%= jr.dig("totals", "p") - jr.dig("totals", "f") %></td>
+            <td><%= jr.dig("totals", "f") %></td>
+            <td><%= jr.dig("totals", "s").round(2) %> seconds</td>
+            <td><%= jr.total_avg("s").round(2) %> seconds</td>
+          </tr>
+        <% end %>
+      <% else %>
+          <tr><td colspan=5><%= t("NoDataFound") %></td></tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>
+
+<p><small>Data from <%= @query_result.starts_at %> to <%= @query_result.ends_at %></small></p>

data/web/views/metrics_for_job.erb

@@ -0,0 +1,69 @@
+<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/metrics.js"></script>
+
+<%
+  job_result = @query_result.job_results[@name]
+  hist_totals = job_result.hist.values.first.zip(*job_result.hist.values[1..-1]).map(&:sum)
+  bucket_labels =Sidekiq::Metrics::Histogram::LABELS
+  bucket_intervals =Sidekiq::Metrics::Histogram::BUCKET_INTERVALS.reverse
+
+  # Replace INFINITY since it can't be represented as JSON
+  bucket_intervals[0] = bucket_intervals[1] * 2
+%>
+
+<% if job_result.totals["s"] > 0 %>
+  <div class="header-container">
+    <h1>
+      <a href="<%= root_path %>metrics"><%= t(:metrics).to_s.titleize %></a> /
+      <%= h @name %>
+    </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>
+    </div>
+  </div>
+
+  <canvas id="hist-totals-chart"></canvas>
+
+  <script>
+    window.histTotalsChart = new HistTotalsChart(
+      document.getElementById("hist-totals-chart"),
+      <%= Sidekiq.dump_json({
+        series: hist_totals,
+        labels: bucket_labels,
+        xLabel: t('ExecutionTime'),
+        yLabel: t('Jobs'),
+        units: t('Jobs').downcase,
+      }) %>
+    )
+  </script>
+
+  <canvas id="hist-bubble-chart"></canvas>
+
+  <script>
+    window.histBubbleChart = new HistBubbleChart(
+      document.getElementById("hist-bubble-chart"),
+      <%= Sidekiq.dump_json({
+        hist: job_result.hist,
+        marks: @query_result.marks.map { |m| [m.bucket, m.label] },
+        labels: @query_result.buckets,
+        histIntervals: bucket_intervals,
+        yLabel: t('ExecutionTime'),
+        markLabel: t('Deploy'),
+        yUnits: t('Seconds').downcase,
+        zUnits: t('Jobs').downcase,
+      }) %>
+    )
+  </script>
+
+  <p><small>Data from <%= @query_result.starts_at %> to <%= @query_result.ends_at %></small></p>
+<% else %>
+  <h1>
+    <a href="<%= root_path %>/metrics"><%= t(:metrics).to_s.titleize %></a> /
+    <%= h @name %>
+  </h1>
+
+  <div class="alert alert-success"><%= t('NoJobMetricsFound') %></div>
+<% end %>

data/web/views/queue.erb

@@ -18,6 +18,7 @@
       <th><a href="<%= url %>?direction=<%= params[:direction] == 'asc' ? 'desc' : 'asc' %>"># <%= sort_direction_label %></a></th>
       <th><%= t('Job') %></th>
       <th><%= t('Arguments') %></th>
+      <th><%= t('Context') %></th>
       <th></th>
     </thead>
     <% @jobs.each_with_index do |job, index| %>
@@ -35,12 +36,15 @@
           <% a = job.display_args %>
           <% if a.inspect.size > 100 %>
             <span id="job_<%= index %>"><%= h(a.inspect[0..100]) + "... " %></span>
-            <button data-toggle="job_<%= index %>" class="btn btn-default btn-xs"><%= t('ShowAll') %></button>
+            <button data-toggle="job_<%= index %>_full" class="btn btn-default btn-xs"><%= t('ShowAll') %></button>
             <div class="toggle" id="job_<%= index %>_full"><%= display_args(a) %></div>
           <% else %>
             <%= display_args(job.display_args) %>
           <% end %>
         </td>
+        <td>
+          <%= h(job["cattr"].inspect) if job["cattr"]&.any? %>
+        </td>
         <td>
           <form action="<%= root_path %>queues/<%= CGI.escape(@name) %>/delete" method="post">
             <%= csrf_tag %>

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 6.4.1
+  version: 7.0.0
 platform: ruby
 authors:
 - Mike Perham
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-07 00:00:00.000000000 Z
+date: 2022-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: redis-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.4
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2'
 description: Simple, efficient background processing for Ruby.
 email:
 - mperham@gmail.com
@@ -62,7 +76,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Changes.md
-- LICENSE
+- LICENSE.txt
 - README.md
 - bin/sidekiq
 - bin/sidekiqload
@@ -73,14 +87,13 @@ files:
 - lib/generators/sidekiq/templates/job_test.rb.erb
 - lib/sidekiq.rb
 - lib/sidekiq/api.rb
+- lib/sidekiq/capsule.rb
 - lib/sidekiq/cli.rb
 - lib/sidekiq/client.rb
-- lib/sidekiq/delay.rb
-- lib/sidekiq/exception_handler.rb
-- lib/sidekiq/extensions/action_mailer.rb
-- lib/sidekiq/extensions/active_record.rb
-- lib/sidekiq/extensions/class_methods.rb
-- lib/sidekiq/extensions/generic_proxy.rb
+- lib/sidekiq/component.rb
+- lib/sidekiq/config.rb
+- lib/sidekiq/deploy.rb
+- lib/sidekiq/embedded.rb
 - lib/sidekiq/fetch.rb
 - lib/sidekiq/job.rb
 - lib/sidekiq/job_logger.rb
@@ -89,20 +102,26 @@ files:
 - lib/sidekiq/launcher.rb
 - lib/sidekiq/logger.rb
 - lib/sidekiq/manager.rb
+- lib/sidekiq/metrics/query.rb
+- lib/sidekiq/metrics/shared.rb
+- lib/sidekiq/metrics/tracking.rb
 - lib/sidekiq/middleware/chain.rb
 - lib/sidekiq/middleware/current_attributes.rb
 - lib/sidekiq/middleware/i18n.rb
+- lib/sidekiq/middleware/modules.rb
 - lib/sidekiq/monitor.rb
 - lib/sidekiq/paginator.rb
 - lib/sidekiq/processor.rb
 - lib/sidekiq/rails.rb
+- lib/sidekiq/redis_client_adapter.rb
 - lib/sidekiq/redis_connection.rb
+- lib/sidekiq/ring_buffer.rb
 - lib/sidekiq/scheduled.rb
 - lib/sidekiq/sd_notify.rb
 - lib/sidekiq/systemd.rb
 - lib/sidekiq/testing.rb
 - lib/sidekiq/testing/inline.rb
-- lib/sidekiq/util.rb
+- lib/sidekiq/transaction_aware_client.rb
 - lib/sidekiq/version.rb
 - lib/sidekiq/web.rb
 - lib/sidekiq/web/action.rb
@@ -110,14 +129,19 @@ files:
 - lib/sidekiq/web/csrf_protection.rb
 - lib/sidekiq/web/helpers.rb
 - lib/sidekiq/web/router.rb
-- lib/sidekiq/worker.rb
+- lib/sidekiq/worker_compatibility_alias.rb
 - sidekiq.gemspec
 - web/assets/images/apple-touch-icon.png
 - web/assets/images/favicon.ico
 - web/assets/images/logo.png
 - web/assets/images/status.png
 - web/assets/javascripts/application.js
+- web/assets/javascripts/base-charts.js
+- web/assets/javascripts/chart.min.js
+- web/assets/javascripts/chartjs-plugin-annotation.min.js
+- web/assets/javascripts/dashboard-charts.js
 - web/assets/javascripts/dashboard.js
+- web/assets/javascripts/metrics.js
 - web/assets/stylesheets/application-dark.css
 - web/assets/stylesheets/application-rtl.css
 - web/assets/stylesheets/application.css
@@ -162,6 +186,8 @@ files:
 - web/views/dashboard.erb
 - web/views/dead.erb
 - web/views/layout.erb
+- web/views/metrics.erb
+- web/views/metrics_for_job.erb
 - web/views/morgue.erb
 - web/views/queue.erb
 - web/views/queues.erb
@@ -178,7 +204,28 @@ metadata:
   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
-post_install_message:
+post_install_message: |2
+
+  ####################################################
+
+
+    █████████  █████ ██████████   ██████████ █████   ████ █████    ██████       ██████████       █████
+   ███░░░░░███░░███ ░░███░░░░███ ░░███░░░░░█░░███   ███░ ░░███   ███░░░░███    ░███░░░░███     ███░░░███
+  ░███    ░░░  ░███  ░███   ░░███ ░███  █ ░  ░███  ███    ░███  ███    ░░███   ░░░    ███     ███   ░░███
+  ░░█████████  ░███  ░███    ░███ ░██████    ░███████     ░███ ░███     ░███         ███     ░███    ░███
+   ░░░░░░░░███ ░███  ░███    ░███ ░███░░█    ░███░░███    ░███ ░███   ██░███        ███      ░███    ░███
+   ███    ░███ ░███  ░███    ███  ░███ ░   █ ░███ ░░███   ░███ ░░███ ░░████        ███       ░░███   ███
+  ░░█████████  █████ ██████████   ██████████ █████ ░░████ █████ ░░░██████░██      ███      ██ ░░░█████░
+   ░░░░░░░░░  ░░░░░ ░░░░░░░░░░   ░░░░░░░░░░ ░░░░░   ░░░░ ░░░░░    ░░░░░░ ░░      ░░░      ░░    ░░░░░░
+
+
+  WARNING: This is a beta release, expect breakage!
+
+  1. Use `gem 'sidekiq', '<7'` in your Gemfile if you don't want to be a beta tester.
+  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/
+
+  ####################################################
 rdoc_options: []
 require_paths:
 - lib
@@ -186,7 +233,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/sidekiq/delay.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Sidekiq
-  module Extensions
-    def self.enable_delay!
-      warn "Sidekiq's Delayed Extensions will be removed in Sidekiq 7.0", uplevel: 1
-
-      if defined?(::ActiveSupport)
-        require "sidekiq/extensions/active_record"
-        require "sidekiq/extensions/action_mailer"
-
-        # Need to patch Psych so it can autoload classes whose names are serialized
-        # in the delayed YAML.
-        Psych::Visitors::ToRuby.prepend(Sidekiq::Extensions::PsychAutoload)
-
-        ActiveSupport.on_load(:active_record) do
-          include Sidekiq::Extensions::ActiveRecord
-        end
-        ActiveSupport.on_load(:action_mailer) do
-          extend Sidekiq::Extensions::ActionMailer
-        end
-      end
-
-      require "sidekiq/extensions/class_methods"
-      Module.__send__(:include, Sidekiq::Extensions::Klass)
-    end
-
-    module PsychAutoload
-      def resolve_class(klass_name)
-        return nil if !klass_name || klass_name.empty?
-        # constantize
-        names = klass_name.split("::")
-        names.shift if names.empty? || names.first.empty?
-
-        names.inject(Object) do |constant, name|
-          constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
-        end
-      rescue NameError
-        super
-      end
-    end
-  end
-end

data/lib/sidekiq/exception_handler.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require "sidekiq"
-
-module Sidekiq
-  module ExceptionHandler
-    class Logger
-      def call(ex, ctx)
-        Sidekiq.logger.warn(Sidekiq.dump_json(ctx)) unless ctx.empty?
-        Sidekiq.logger.warn("#{ex.class.name}: #{ex.message}")
-        Sidekiq.logger.warn(ex.backtrace.join("\n")) unless ex.backtrace.nil?
-      end
-
-      Sidekiq.error_handlers << Sidekiq::ExceptionHandler::Logger.new
-    end
-
-    def handle_exception(ex, ctx = {})
-      Sidekiq.error_handlers.each do |handler|
-        handler.call(ex, ctx)
-      rescue => ex
-        Sidekiq.logger.error "!!! ERROR HANDLER THREW AN ERROR !!!"
-        Sidekiq.logger.error ex
-        Sidekiq.logger.error ex.backtrace.join("\n") unless ex.backtrace.nil?
-      end
-    end
-  end
-end

data/lib/sidekiq/extensions/action_mailer.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require "sidekiq/extensions/generic_proxy"
-
-module Sidekiq
-  module Extensions
-    ##
-    # Adds +delay+, +delay_for+ and +delay_until+ methods to ActionMailer to offload arbitrary email
-    # delivery to Sidekiq.
-    #
-    # @example
-    #    UserMailer.delay.send_welcome_email(new_user)
-    #    UserMailer.delay_for(5.days).send_welcome_email(new_user)
-    #    UserMailer.delay_until(5.days.from_now).send_welcome_email(new_user)
-    class DelayedMailer
-      include Sidekiq::Worker
-
-      def perform(yml)
-        (target, method_name, args) = YAML.load(yml)
-        msg = target.public_send(method_name, *args)
-        # The email method can return nil, which causes ActionMailer to return
-        # an undeliverable empty message.
-        if msg
-          msg.deliver_now
-        else
-          raise "#{target.name}##{method_name} returned an undeliverable mail object"
-        end
-      end
-    end
-
-    module ActionMailer
-      def sidekiq_delay(options = {})
-        Proxy.new(DelayedMailer, self, options)
-      end
-
-      def sidekiq_delay_for(interval, options = {})
-        Proxy.new(DelayedMailer, self, options.merge("at" => Time.now.to_f + interval.to_f))
-      end
-
-      def sidekiq_delay_until(timestamp, options = {})
-        Proxy.new(DelayedMailer, self, options.merge("at" => timestamp.to_f))
-      end
-      alias_method :delay, :sidekiq_delay
-      alias_method :delay_for, :sidekiq_delay_for
-      alias_method :delay_until, :sidekiq_delay_until
-    end
-  end
-end

data/lib/sidekiq/extensions/active_record.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require "sidekiq/extensions/generic_proxy"
-
-module Sidekiq
-  module Extensions
-    ##
-    # Adds +delay+, +delay_for+ and +delay_until+ methods to ActiveRecord to offload instance method
-    # execution to Sidekiq.
-    #
-    # @example
-    #   User.recent_signups.each { |user| user.delay.mark_as_awesome }
-    #
-    # Please note, this is not recommended as this will serialize the entire
-    # object to Redis.  Your Sidekiq jobs should pass IDs, not entire instances.
-    # This is here for backwards compatibility with Delayed::Job only.
-    class DelayedModel
-      include Sidekiq::Worker
-
-      def perform(yml)
-        (target, method_name, args) = YAML.load(yml)
-        target.__send__(method_name, *args)
-      end
-    end
-
-    module ActiveRecord
-      def sidekiq_delay(options = {})
-        Proxy.new(DelayedModel, self, options)
-      end
-
-      def sidekiq_delay_for(interval, options = {})
-        Proxy.new(DelayedModel, self, options.merge("at" => Time.now.to_f + interval.to_f))
-      end
-
-      def sidekiq_delay_until(timestamp, options = {})
-        Proxy.new(DelayedModel, self, options.merge("at" => timestamp.to_f))
-      end
-      alias_method :delay, :sidekiq_delay
-      alias_method :delay_for, :sidekiq_delay_for
-      alias_method :delay_until, :sidekiq_delay_until
-    end
-  end
-end

data/lib/sidekiq/extensions/class_methods.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require "sidekiq/extensions/generic_proxy"
-
-module Sidekiq
-  module Extensions
-    ##
-    # Adds `delay`, `delay_for` and `delay_until` methods to all Classes to offload class method
-    # execution to Sidekiq.
-    #
-    # @example
-    #   User.delay.delete_inactive
-    #   Wikipedia.delay.download_changes_for(Date.today)
-    #
-    class DelayedClass
-      include Sidekiq::Worker
-
-      def perform(yml)
-        (target, method_name, args) = YAML.load(yml)
-        target.__send__(method_name, *args)
-      end
-    end
-
-    module Klass
-      def sidekiq_delay(options = {})
-        Proxy.new(DelayedClass, self, options)
-      end
-
-      def sidekiq_delay_for(interval, options = {})
-        Proxy.new(DelayedClass, self, options.merge("at" => Time.now.to_f + interval.to_f))
-      end
-
-      def sidekiq_delay_until(timestamp, options = {})
-        Proxy.new(DelayedClass, self, options.merge("at" => timestamp.to_f))
-      end
-      alias_method :delay, :sidekiq_delay
-      alias_method :delay_for, :sidekiq_delay_for
-      alias_method :delay_until, :sidekiq_delay_until
-    end
-  end
-end
-
-Module.__send__(:include, Sidekiq::Extensions::Klass) unless defined?(::Rails)

data/lib/sidekiq/extensions/generic_proxy.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require "yaml"
-
-module Sidekiq
-  module Extensions
-    SIZE_LIMIT = 8_192
-
-    class Proxy < BasicObject
-      def initialize(performable, target, options = {})
-        @performable = performable
-        @target = target
-        @opts = options
-      end
-
-      def method_missing(name, *args)
-        # Sidekiq has a limitation in that its message must be JSON.
-        # JSON can't round trip real Ruby objects so we use YAML to
-        # serialize the objects to a String.  The YAML will be converted
-        # to JSON and then deserialized on the other side back into a
-        # Ruby object.
-        obj = [@target, name, args]
-        marshalled = ::YAML.dump(obj)
-        if marshalled.size > SIZE_LIMIT
-          ::Sidekiq.logger.warn { "#{@target}.#{name} job argument is #{marshalled.bytesize} bytes, you should refactor it to reduce the size" }
-        end
-        @performable.client_push({"class" => @performable,
-                                  "args" => [marshalled],
-                                  "display_class" => "#{@target}.#{name}"}.merge(@opts))
-      end
-    end
-  end
-end