sidekiq-unique-jobs 3.0.11 → 8.0.10

data/lib/sidekiq_unique_jobs/web/helpers.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  module Web
+    #
+    # Provides view helpers for the Sidekiq::Web extension
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    #
+    module Helpers
+      #
+      # @return [String] the path to gem specific views
+      VIEW_PATH    = File.expand_path("../web/views", __dir__).freeze
+      #
+      # @return [Array<String>] safe params
+      SAFE_CPARAMS = %w[
+        filter count cursor prev_cursor poll direction
+      ].freeze
+
+      extend self
+
+      #
+      # Opens a template file contained within this gem
+      #
+      # @param [Symbol] name the name of the template
+      #
+      # @return [String] the file contents of the template
+      #
+      def unique_template(name)
+        File.read(unique_filename(name))
+      end
+
+      #
+      # Construct template file name
+      #
+      # @param [Symbol] name the name of the template
+      #
+      # @return [String] the full name of the file
+      #
+      def unique_filename(name)
+        File.join(VIEW_PATH, "#{name}.erb")
+      end
+
+      #
+      # The collection of digests
+      #
+      #
+      # @return [SidekiqUniqueJobs::Digests] the sorted set with digests
+      #
+      def digests
+        @digests ||= SidekiqUniqueJobs::Digests.new
+      end
+
+      #
+      # The collection of digests
+      #
+      #
+      # @return [SidekiqUniqueJobs::ExpiringDigests] the sorted set with expiring digests
+      #
+      def expiring_digests
+        @expiring_digests ||= SidekiqUniqueJobs::ExpiringDigests.new
+      end
+
+      #
+      # The collection of changelog entries
+      #
+      #
+      # @return [SidekiqUniqueJobs::Digests] the sorted set with digests
+      #
+      def changelog
+        @changelog ||= SidekiqUniqueJobs::Changelog.new
+      end
+
+      #
+      # Creates url safe parameters
+      #
+      # @param [Hash] options the key/value to parameterize
+      #
+      # @return [String] a url safe parameter string
+      #
+      def cparams(options)
+        stringified_options = options.transform_keys(&:to_s)
+        params.merge(stringified_options).filter_map do |key, value|
+          next unless SAFE_CPARAMS.include?(key)
+
+          "#{key}=#{CGI.escape(value.to_s)}"
+        end.join("&")
+      end
+
+      #
+      # Used to avoid incompatibility with older sidekiq versions
+      #
+      #
+      # @param [Array] args the unique arguments to display
+      # @param [Integer] truncate_after_chars
+      #
+      # @return [String] a string containing all non-truncated arguments
+      #
+      def display_lock_args(args, truncate_after_chars = 2000)
+        return "Invalid job payload, args is nil" if args.nil?
+        return "Invalid job payload, args must be an Array, not #{args.class.name}" unless args.is_a?(Array)
+
+        begin
+          args.map do |arg|
+            h(truncate(to_display(arg), truncate_after_chars))
+          end.join(", ")
+        rescue StandardError
+          "Illegal job arguments: #{h args.inspect}"
+        end
+      end
+
+      #
+      # Redirect to with falback
+      #
+      # @param [String] subpath the path to redirect to
+      #
+      # @return a redirect to the new subpath
+      #
+      def redirect_to(subpath)
+        if respond_to?(:to)
+          # Sinatra-based web UI
+          redirect to(subpath)
+        else
+          # Non-Sinatra based web UI (Sidekiq 4.2+)
+          redirect "#{root_path}#{subpath}"
+        end
+      end
+
+      #
+      # Gets a relative time as html
+      #
+      # @param [Time] time an instance of Time
+      #
+      # @return [String] a html safe string with relative time information
+      #
+      def _relative_time(time)
+        stamp = time.getutc.iso8601
+        %(<time class="ltr" dir="ltr" title="#{stamp}" datetime="#{stamp}">#{time}</time>)
+      end
+
+      #
+      # Gets a relative time as html without crashing
+      #
+      # @param [Float, Integer, String, Time] time a representation of a timestamp
+      #
+      # @return [String] a html safe string with relative time information
+      #
+      def _safe_relative_time(time)
+        return unless time
+
+        time = parse_time(time)
+
+        _relative_time(time)
+      end
+
+      #
+      # Constructs a time from a number of different types
+      #
+      # @param [Float, Integer, String, Time] time a representation of a timestamp
+      #
+      # @return [Time]
+      #
+      def parse_time(time)
+        case time
+        when Time
+          time
+        when Integer, Float
+          Time.at(time)
+        else
+          Time.parse(time.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/web/views/_paging.erb

@@ -0,0 +1,10 @@
+<ul class="pagination pull-right flip">
+  <% if @prev_cursor %>
+  <li>
+    <a href="<%= url %>?<%= cparams(filter: @filter, cursor: @prev_cursor, prev_cursor: @next_cursor) %>">Previous <%= @count %></a>
+  </li>
+  <% end %>
+  <li>
+    <a href="<%= url %>?<%= cparams(filter: @filter, cursor: @next_cursor, prev_cursor: @current_cursor) %>">Next <%= @count %></a>
+  </li>
+</ul>

data/lib/sidekiq_unique_jobs/web/views/changelogs.erb

@@ -0,0 +1,60 @@
+<header class="row">
+  <div class="col-sm-5">
+    <h3>
+      <%= t('Changelog Entries') %>
+    </h3>
+  </div>
+  <form action="<%= root_path %>changelogs" class="form form-inline" method="get">
+    <%= csrf_tag %>
+
+    <input name="filter" class="form-control" type="text" value="<%= @filter %>" />
+
+    <button class="btn btn-default" type="submit">
+      <%= t('Filter') %>
+    </button>
+  </form>
+
+  <% if @changelogs.any? && @total_size > @count.to_i %>
+    <div class="col-sm-4">
+      <%= erb unique_template(:_paging), locals: { url: "#{root_path}changelogs" } %>
+    </div>
+  <% end %>
+</header>
+
+<% if @changelogs.any? %>
+  <div class="table_container">
+    <form action="<%= root_path %>changelogs/delete_all" method="get">
+      <input class="btn btn-danger btn-xs" type="submit" name="delete_all" value="<%= t('DeleteAll') %>" data-confirm="<%= t('AreYouSure') %>" />
+    </form>
+    <br/>
+
+    <table class="table table-striped table-bordered table-hover">
+      <thead>
+        <tr>
+          <th><%= t('Time') %></th>
+          <th><%= t('Digest') %></th>
+          <th><%= t('Script') %></th>
+          <th><%= t('JID') %></th>
+          <th><%= t('Prev JID') %></th>
+          <th><%= t('Message') %></th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @changelogs.each do |changelog| %>
+          <tr  class="changelog-row">
+            <td><%= _safe_relative_time(changelog['time']) || "bogus" %></td>
+            <td><%= changelog["digest"] %></td>
+            <td><%= changelog["script"] %></td>
+            <td><%= changelog["job_id"] %></td>
+            <td><%= changelog["prev_jid"] %></td>
+            <td><%= changelog["message"] %></th>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+
+    <form action="<%= root_path %>changelogs/delete_all" method="get">
+      <input class="btn btn-danger btn-xs" type="submit" name="delete_all" value="<%= t('DeleteAll') %>" data-confirm="<%= t('AreYouSure') %>" />
+    </form>
+  </div>
+<% end %>

data/lib/sidekiq_unique_jobs/web/views/lock.erb

@@ -0,0 +1,110 @@
+<header class="row">
+  <div class="col-sm-5">
+    <h3>
+    <%= t('Lock information') %> <a class="btn btn-default btn-xs" href="<%= root_path %>locks"><%= t('GoBack') %></a>
+    </h3>
+  </div>
+  <div class="col-sm-7 table-responsive">
+    <% if @lock.info.none? %>
+    <h3>No Lock Information Available</h3>
+    <% unless SidekiqUniqueJobs.config.lock_info %>
+      <p>To use it turn the following setting on:
+        <code>SidekiqUniqueJobs.config.lock_info = true</code>
+      </p>
+    <% end %>
+    <% else %>
+    <table class="table table-striped table-bordered table-white table-hover">
+      <caption>Information about lock</caption>
+      <tbody>
+        <tr>
+          <th scope=row><%= t('Worker') %></td>
+          <td><%= @lock.info["worker"] %></td>
+        </tr>
+        <tr>
+          <th scope=row><%= t('Queue') %></td>
+          <td><%= @lock.info["queue"] %></td>
+        </tr>
+        <tr>
+          <th scope=row><%= t('Limit') %></td>
+          <td><%= @lock.info["limit"] %></td>
+        </tr>
+        <tr>
+          <th scope=row><%= t('TTL') %></td>
+          <td><%= @lock.info["ttl"] %></td>
+        </tr>
+        <tr>
+          <th scope=row><%= t('Timeout') %></td>
+          <td><%= @lock.info["timeout"] %></td>
+        </tr>
+        <tr>
+          <th scope=row><%= t('Args') %></td>
+          <td>
+            <code class="code-wrap">
+              <!-- We don't want to truncate any job arguments when viewing a single job's status page -->
+              <div class="args-extended"><%= display_lock_args(@lock.info["lock_args"], nil) %></div>
+            </code>
+          </td>
+        </tr>
+      </tbody>
+    </table>
+    <% end %>
+  </div>
+</header>
+<div class="row">
+  <div class="col-sm-6 table-responsive">
+    <table class="table table-striped table-bordered table-hover">
+      <caption>Digest: <strong class="text-muted"><%= @lock.key %></strong></caption>
+      <thead>
+        <tr>
+          <th scope="col"><%= t('Locked JIDs') %></th>
+          <th scope="col"><%= t('Since') %></th>
+          <th scope="col"></th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @lock.locked_jids(with_values: true).each do |job_id, time| %>
+        <tr>
+          <td><%= job_id %></td>
+          <td><%= _safe_relative_time(time.to_f) %></td>
+          <td>
+            <form action="<%= root_path %>locks/<%= @lock.key %>/jobs/<%= job_id %>/delete" method="get">
+              <%= csrf_tag %>
+              <input class="btn btn-danger btn-xs flip" type="submit" name="delete" value="<%= t('Unlock') %>" data-confirm="<%= t('AreYouSure') %>" />
+            </form>
+          </td>
+        </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+  <div class="col-sm-6 table-responsive">
+    <% if @lock.changelog.count.positive? %>
+    <table class="table table-striped table-bordered table-hover">
+      <caption>Changelogs</caption>
+      <thead>
+        <tr>
+          <th scope="col"><%= t('At') %></th>
+          <th scope="col"><%= t('JID') %></th>
+          <th scope="col"><%= t('Message') %></th>
+          <th scope="col"><%= t('Script') %></th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @lock.changelogs.each do |entry| %>
+        <tr>
+          <td scope="row"><%= _safe_relative_time(entry["time"].to_f) %></td>
+          <td><%= entry["job_id"] %></td>
+          <td><%= entry["message"] %></td>
+          <td><%= entry["script"] %></td>
+        </tr>
+        <% end %>
+      </tbody>
+    </table>
+    <% end %>
+  </div>
+</div>
+<form action="<%= root_path %>locks/<%= @lock.key %>/delete" method="get">
+  <%= csrf_tag %>
+  <a class="btn btn-default btn-xs" href="<%= root_path %>locks"><%= t('GoBack') %></a>
+  <input class="btn btn-danger btn-xs flip" type="submit" name="delete" value="<%= t('Delete') %>" data-confirm="<%= t('AreYouSure') %>" />
+</form>

data/lib/sidekiq_unique_jobs/web/views/locks.erb

@@ -0,0 +1,59 @@
+<header class="row">
+  <div class="col-sm-5">
+    <h3>
+    <%= t('Locks') %>
+    </h3>
+  </div>
+  <form action="<%= root_path %>locks" class="form form-inline" method="get">
+    <%= csrf_tag %>
+    <input name="filter" class="form-control" type="text" value="<%= @filter %>" />
+
+    <button class="btn btn-default" type="submit">
+      <%= t('Filter') %>
+    </button>
+
+  </form>
+
+  <% if @locks.any? && @total_size > @count %>
+    <div class="col-sm-4">
+      <%= erb unique_template(:_paging), locals: { url: "#{root_path}locks" } %>
+    </div>
+  <% end %>
+</header>
+
+<% if @locks.any? %>
+  <div class="table_container">
+    <table class="table table-striped table-bordered table-hover">
+      <thead>
+        <tr>
+          <th><%= t('Delete') %></th>
+          <th><%= t('Digest') %></th>
+          <th><%= t('Lock') %></th>
+          <th><%= t('Locks') %></th>
+          <th><%= t('Since') %></th>
+        </tr>
+      </thead>
+      <% @locks.each do |lock| %>
+        <tbody>
+          <tr class="lock-row">
+            <td>
+              <form action="<%= root_path %>locks/<%= lock.key %>/delete" method="get">
+                <%= csrf_tag %>
+                <input name="lock" value="<%= h lock.key %>" type="hidden" />
+                <input class="btn btn-danger btn-xs" type="submit" name="delete" value="<%= t('Delete') %>" data-confirm="<%= t('AreYouSure') %>" />
+              </form>
+            </td>
+            <td><a href="<%= root_path %>locks/<%= lock.key %>"><%= lock.key %></a></td>
+            <td><%= lock.info["lock"] %></td>
+            <td><%= lock.locked.count %></td>
+            <td><%= _safe_relative_time(lock.created_at) %></td>
+          </tr>
+        </tbody>
+      <% end %>
+    </table>
+
+    <form action="<%= root_path %>locks/delete_all" method="get">
+      <input class="btn btn-danger btn-xs" type="submit" name="delete_all" value="<%= t('DeleteAll') %>" data-confirm="<%= t('AreYouSure') %>" />
+    </form>
+  </div>
+<% end %>

data/lib/sidekiq_unique_jobs/web.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require_relative "web/helpers"
+
+module SidekiqUniqueJobs
+  # Utility module to help manage unique keys in redis.
+  # Useful for deleting keys that for whatever reason wasn't deleted
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  module Web
+    def self.registered(app) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      app.helpers do
+        include Web::Helpers
+      end
+
+      app.get "/changelogs" do
+        @filter         = h(params[:filter] || "*")
+        @filter         = "*" if @filter == ""
+        @count          = h(params[:count] || 100).to_i
+        @current_cursor = h(params[:cursor]).to_i
+        @prev_cursor    = h(params[:prev_cursor]).to_i
+        @total_size, @next_cursor, @changelogs = changelog.page(
+          cursor: @current_cursor,
+          pattern: @filter,
+          page_size: @count,
+        )
+
+        erb(unique_template(:changelogs))
+      end
+
+      app.get "/changelogs/delete_all" do
+        changelog.clear
+        redirect_to :changelogs
+      end
+
+      app.get "/locks" do
+        @filter         = h(params[:filter]) || "*"
+        @filter         = "*" if @filter == ""
+        @count          = h(params[:count] || 100).to_i
+        @current_cursor = h(params[:cursor]).to_i
+        @prev_cursor    = h(params[:prev_cursor]).to_i
+
+        @total_size, @next_cursor, @locks = digests.page(
+          cursor: @current_cursor,
+          pattern: @filter,
+          page_size: @count,
+        )
+
+        erb(unique_template(:locks))
+      end
+
+      app.get "/expiring_locks" do
+        @filter         = h(params[:filter]) || "*"
+        @filter         = "*" if @filter == ""
+        @count          = h(params[:count] || 100).to_i
+        @current_cursor = h(params[:cursor]).to_i
+        @prev_cursor    = h(params[:prev_cursor]).to_i
+
+        @total_size, @next_cursor, @locks = expiring_digests.page(
+          cursor: @current_cursor,
+          pattern: @filter,
+          page_size: @count,
+        )
+
+        erb(unique_template(:locks))
+      end
+
+      app.get "/locks/delete_all" do
+        digests.delete_by_pattern("*", count: digests.count)
+        expiring_digests.delete_by_pattern("*", count: digests.count)
+        redirect_to :locks
+      end
+
+      app.get "/locks/:digest" do
+        @digest = h(params[:digest])
+        @lock   = SidekiqUniqueJobs::Lock.new(@digest)
+
+        erb(unique_template(:lock))
+      end
+
+      app.get "/locks/:digest/delete" do
+        digests.delete_by_digest(h(params[:digest]))
+        expiring_digests.delete_by_digest(h(params[:digest]))
+        redirect_to :locks
+      end
+
+      app.get "/locks/:digest/jobs/:job_id/delete" do
+        @digest = h(params[:digest])
+        @job_id = h(params[:job_id])
+        @lock   = SidekiqUniqueJobs::Lock.new(@digest)
+        @lock.unlock(@job_id)
+
+        redirect_to "locks/#{@lock.key}"
+      end
+    end
+  end
+end
+
+begin
+  require "delegate" unless defined?(DelegateClass)
+  require "sidekiq/web" unless defined?(Sidekiq::Web)
+
+  Sidekiq::Web.register(SidekiqUniqueJobs::Web)
+  Sidekiq::Web.tabs["Locks"]          = "locks"
+  Sidekiq::Web.tabs["Expiring Locks"] = "expiring_locks"
+  Sidekiq::Web.tabs["Changelogs"]     = "changelogs"
+  Sidekiq::Web.settings.locales << File.join(File.dirname(__FILE__), "locales")
+rescue NameError, LoadError => ex
+  SidekiqUniqueJobs.logger.error(ex)
+end

data/lib/sidekiq_unique_jobs.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "concurrent/executor/ruby_single_thread_executor"
+require "concurrent/future"
+require "concurrent/map"
+require "concurrent/mutable_struct"
+require "concurrent/promises"
+require "concurrent/timer_task"
+require "digest"
+require "digest/sha1"
+require "erb"
+require "forwardable"
+require "json"
+require "pathname"
+require "redis_client"
+require "sidekiq"
+
+require "sidekiq_unique_jobs/script"
+
+require "sidekiq_unique_jobs/deprecation"
+require "sidekiq_unique_jobs/reflections"
+require "sidekiq_unique_jobs/reflectable"
+require "sidekiq_unique_jobs/timer_task"
+require "sidekiq_unique_jobs/version"
+require "sidekiq_unique_jobs/version_check"
+require "sidekiq_unique_jobs/constants"
+require "sidekiq_unique_jobs/json"
+require "sidekiq_unique_jobs/logging"
+require "sidekiq_unique_jobs/logging/middleware_context"
+require "sidekiq_unique_jobs/timing"
+require "sidekiq_unique_jobs/sidekiq_worker_methods"
+require "sidekiq_unique_jobs/connection"
+require "sidekiq_unique_jobs/exceptions"
+require "sidekiq_unique_jobs/script/caller"
+require "sidekiq_unique_jobs/normalizer"
+require "sidekiq_unique_jobs/job"
+require "sidekiq_unique_jobs/redis"
+require "sidekiq_unique_jobs/redis/entity"
+require "sidekiq_unique_jobs/redis/hash"
+require "sidekiq_unique_jobs/redis/list"
+require "sidekiq_unique_jobs/redis/set"
+require "sidekiq_unique_jobs/redis/sorted_set"
+require "sidekiq_unique_jobs/redis/string"
+require "sidekiq_unique_jobs/batch_delete"
+require "sidekiq_unique_jobs/orphans/reaper"
+require "sidekiq_unique_jobs/orphans/observer"
+require "sidekiq_unique_jobs/orphans/manager"
+require "sidekiq_unique_jobs/orphans/reaper_resurrector"
+require "sidekiq_unique_jobs/cli"
+require "sidekiq_unique_jobs/core_ext"
+require "sidekiq_unique_jobs/lock_timeout"
+require "sidekiq_unique_jobs/lock_ttl"
+require "sidekiq_unique_jobs/lock_type"
+require "sidekiq_unique_jobs/lock_args"
+require "sidekiq_unique_jobs/lock_digest"
+require "sidekiq_unique_jobs/unlockable"
+require "sidekiq_unique_jobs/key"
+require "sidekiq_unique_jobs/locksmith"
+require "sidekiq_unique_jobs/options_with_fallback"
+require "sidekiq_unique_jobs/lock"
+require "sidekiq_unique_jobs/lock_config"
+require "sidekiq_unique_jobs/lock_info"
+require "sidekiq_unique_jobs/lock/base_lock"
+require "sidekiq_unique_jobs/lock/until_executed"
+require "sidekiq_unique_jobs/lock/until_executing"
+require "sidekiq_unique_jobs/lock/until_expired"
+require "sidekiq_unique_jobs/lock/while_executing"
+require "sidekiq_unique_jobs/lock/while_executing_reject"
+require "sidekiq_unique_jobs/lock/until_and_while_executing"
+require "sidekiq_unique_jobs/middleware"
+require "sidekiq_unique_jobs/middleware/client"
+require "sidekiq_unique_jobs/middleware/server"
+require "sidekiq_unique_jobs/sidekiq_unique_ext"
+require "sidekiq_unique_jobs/on_conflict"
+require "sidekiq_unique_jobs/changelog"
+require "sidekiq_unique_jobs/digests"
+require "sidekiq_unique_jobs/expiring_digests"
+
+require "sidekiq_unique_jobs/config"
+require "sidekiq_unique_jobs/sidekiq_unique_jobs"
+require "sidekiq_unique_jobs/update_version"
+require "sidekiq_unique_jobs/upgrade_locks"
+require "sidekiq_unique_jobs/server"

data/lib/tasks/changelog.rake

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/MutableConstant
+CHANGELOG_CMD = %w[
+  github_changelog_generator
+  --no-verbose
+  --user
+  mhenrixon
+  --project
+  sidekiq-unique-jobs
+  --token
+]
+ADD_CHANGELOG_CMD = "git add --all"
+COMMIT_CHANGELOG_CMD = "git commit -a -m 'Update changelog'"
+# rubocop:enable Style/MutableConstant
+
+desc "Generate a Changelog"
+task :changelog do
+  sh("git checkout main")
+  sh(*CHANGELOG_CMD.push(ENV.fetch("CHANGELOG_GITHUB_TOKEN", nil)))
+  sh(ADD_CHANGELOG_CMD)
+  sh(COMMIT_CHANGELOG_CMD)
+end